Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-03-24 23:21:57 -05:00
Code Issues Activity

actions: Throw error on missing server output (#11028)

Browse source 
* feat: throw error on missing server output

* chore: changeset

* refactor: use isServerLikeOutput

* feat: add errors-data on actions build output

* chore: add jsdoc
This commit is contained in:
Ben Holmes 2024-05-14 13:29:27 -04:00 • committed by GitHub
parent ad9227c7d1
commit 771d1f7654
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 29 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/many-news-rescue.md Normal file
View file

@ -0,0 +1,5 @@
---
"astro": patch
---
Throw on missing server output when using Astro Actions.

10
packages/astro/src/actions/index.ts
View file

@ -1,14 +1,22 @@
import { mkdir, readFile, writeFile } from 'node:fs/promises';
import type { Plugin as VitePlugin } from 'vite';
import type { AstroIntegration } from '../@types/astro.js';
import { viteID } from '../core/util.js';
import { viteID, isServerLikeOutput } from '../core/util.js';
import { ACTIONS_TYPES_FILE, RESOLVED_VIRTUAL_MODULE_ID, VIRTUAL_MODULE_ID } from './consts.js';
import { AstroError } from '../core/errors/errors.js';
import { ActionsWithoutServerOutputError } from '../core/errors/errors-data.js';
export default function astroActions(): AstroIntegration {
return {
name: VIRTUAL_MODULE_ID,
hooks: {
async 'astro:config:setup'(params) {
if (!isServerLikeOutput(params.config)) {
const error = new AstroError(ActionsWithoutServerOutputError);
error.stack = undefined;
throw error;
}
const stringifiedActionsImport = JSON.stringify(
viteID(new URL('./actions', params.config.srcDir))
);

15
packages/astro/src/core/errors/errors-data.ts
View file

@ -1493,6 +1493,21 @@ export const DuplicateContentEntrySlugError = {
},
} satisfies ErrorData;
/**
* @docs
* @see
* - [On-demand rendering](https://docs.astro.build/en/basics/rendering-modes/#on-demand-rendered)
* @description
* Your project must have a server output to create backend functions with Actions.
*/
export const ActionsWithoutServerOutputError = {
name: 'ActionsWithoutServerOutputError',
title: 'Actions must be used with server output.',
message:
'Actions enabled without setting a server build output. A server is required to create callable backend functions. To deploy routes to a server, add a server adapter to your astro config.',
hint: 'Learn about on-demand rendering: https://docs.astro.build/en/basics/rendering-modes/#on-demand-rendered',
} satisfies ErrorData;
/**
* @docs
* @see