From 5b129385f9cce2a0cf5a210c2c857c193d49a94a Mon Sep 17 00:00:00 2001 From: liruifengv Date: Thu, 9 Jan 2025 15:29:26 +0800 Subject: [PATCH 1/4] fix(errors): fix error messages rendering incorrectly --- packages/astro/src/core/errors/errors-data.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/astro/src/core/errors/errors-data.ts b/packages/astro/src/core/errors/errors-data.ts index 2fde7bbac615..78f5632247e3 100644 --- a/packages/astro/src/core/errors/errors-data.ts +++ b/packages/astro/src/core/errors/errors-data.ts @@ -879,7 +879,7 @@ export const SessionStorageInitError = { name: 'SessionStorageInitError', title: 'Session storage could not be initialized.', message: (error: string, driver?: string) => - `Error when initializing session storage${driver ? ` with driver ${driver}` : ''}. ${error ?? ''}`, + `Error when initializing session storage${driver ? ` with driver \`${driver}\`` : ''}. ${error ?? ''}`, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData; @@ -894,7 +894,7 @@ export const SessionStorageSaveError = { name: 'SessionStorageSaveError', title: 'Session data could not be saved.', message: (error: string, driver?: string) => - `Error when saving session data${driver ? ` with driver ${driver}` : ''}. ${error ?? ''}`, + `Error when saving session data${driver ? ` with driver \`${driver}\`` : ''}. ${error ?? ''}`, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData; From 193c71b25a4d34e3873fbe652e17fbd58e3404ca Mon Sep 17 00:00:00 2001 From: liruifengv Date: Thu, 9 Jan 2025 15:33:13 +0800 Subject: [PATCH 2/4] fix(errors): fix error messages rendering incorrectly --- packages/astro/src/core/errors/errors-data.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/astro/src/core/errors/errors-data.ts b/packages/astro/src/core/errors/errors-data.ts index 78f5632247e3..8ac80d8dd314 100644 --- a/packages/astro/src/core/errors/errors-data.ts +++ b/packages/astro/src/core/errors/errors-data.ts @@ -879,7 +879,7 @@ export const SessionStorageInitError = { name: 'SessionStorageInitError', title: 'Session storage could not be initialized.', message: (error: string, driver?: string) => - `Error when initializing session storage${driver ? ` with driver \`${driver}\`` : ''}. ${error ?? ''}`, + `Error when initializing session storage${driver ? ` with driver \`${driver}\`` : ''}. \`${error ?? ''}\``, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData; @@ -894,7 +894,7 @@ export const SessionStorageSaveError = { name: 'SessionStorageSaveError', title: 'Session data could not be saved.', message: (error: string, driver?: string) => - `Error when saving session data${driver ? ` with driver \`${driver}\`` : ''}. ${error ?? ''}`, + `Error when saving session data${driver ? ` with driver \`${driver}\`` : ''}. \`${error ?? ''}\``, hint: 'For more information, see https://docs.astro.build/en/reference/experimental-flags/sessions/', } satisfies ErrorData; From 5dffcf8dc73cad3da34aca321bc652c6e7589133 Mon Sep 17 00:00:00 2001 From: liruifengv Date: Fri, 10 Jan 2025 08:47:19 +0800 Subject: [PATCH 3/4] add `@message` for jsdoc --- packages/astro/src/core/errors/errors-data.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/astro/src/core/errors/errors-data.ts b/packages/astro/src/core/errors/errors-data.ts index 8ac80d8dd314..251063621967 100644 --- a/packages/astro/src/core/errors/errors-data.ts +++ b/packages/astro/src/core/errors/errors-data.ts @@ -870,6 +870,7 @@ export const AstroResponseHeadersReassigned = { /** * @docs + * @message Error when initializing session storage with driver `DRIVER`. `ERROR` * @see * - [experimental.session](https://docs.astro.build/en/reference/experimental-flags/sessions/) * @description @@ -885,6 +886,7 @@ export const SessionStorageInitError = { /** * @docs + * @message Error when saving session data with driver `DRIVER`. `ERROR` * @see * - [experimental.session](https://docs.astro.build/en/reference/experimental-flags/sessions/) * @description From a675f1523d78b3cf7a762e5f14a0149fb7b212b5 Mon Sep 17 00:00:00 2001 From: Florian Lefebvre Date: Fri, 10 Jan 2025 10:26:01 +0100 Subject: [PATCH 4/4] Create tame-hats-kiss.md --- .changeset/tame-hats-kiss.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/tame-hats-kiss.md diff --git a/.changeset/tame-hats-kiss.md b/.changeset/tame-hats-kiss.md new file mode 100644 index 000000000000..5b634a73de84 --- /dev/null +++ b/.changeset/tame-hats-kiss.md @@ -0,0 +1,5 @@ +--- +"astro": patch +--- + +Improves the session error messages