Skip to content

fix(cloudflare): preserve existing KV namespace bindings when injecting SESSION #16555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matthewp merged 1 commit into from
May 1, 2026
Merged

fix(cloudflare): preserve existing KV namespace bindings when injecting SESSION #16555

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions packages/integrations/cloudflare/src/wrangler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ interface CloudflareConfigOptions {
imagesBindingName?: string | false | undefined;
}

type KVNamespace = NonNullable<WorkerConfig['kv_namespaces']>[number];

function withSessionKVBinding(
existing: KVNamespace[] | undefined,
sessionBinding: string,
): KVNamespace[] {
const namespaces: KVNamespace[] = existing ? [...existing] : [];
namespaces.push({ binding: sessionBinding });
return namespaces;
}

/**
* Returns a config customizer that sets up the Astro Cloudflare defaults.
* Sets the main entrypoint and adds bindings for auto-provisioning.
Expand All @@ -36,19 +47,15 @@ export function cloudflareConfigCustomizer(
nonInheritableConfig: WorkerConfig['previews'],
): WorkerConfig['previews'] => {
const hasSessionBinding = nonInheritableConfig?.kv_namespaces?.some(
(kv) => kv.binding === sessionKVBindingName,
(kv: KVNamespace) => kv.binding === sessionKVBindingName,
);
const hasImagesBinding = nonInheritableConfig?.images?.binding !== undefined;

return {
kv_namespaces:
!needsSessionKVBinding || hasSessionBinding
? undefined
: [
{
binding: sessionKVBindingName,
},
],
: withSessionKVBinding(nonInheritableConfig?.kv_namespaces, sessionKVBindingName),
images:
hasImagesBinding || !imagesBindingName
? undefined
Expand Down
19 changes: 18 additions & 1 deletion packages/integrations/cloudflare/test/wrangler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,10 @@ describe('cloudflareConfigCustomizer', () => {
kv_namespaces: [{ binding: 'OTHER_KV', id: 'other-id' }],
});

assert.deepEqual(result.kv_namespaces, [{ binding: DEFAULT_SESSION_KV_BINDING_NAME }]);
assert.deepEqual(result.kv_namespaces, [
{ binding: 'OTHER_KV', id: 'other-id' },
{ binding: DEFAULT_SESSION_KV_BINDING_NAME },
]);
});

it('does not add SESSION binding when session KV binding is disabled', () => {
Expand Down Expand Up @@ -157,6 +160,20 @@ describe('cloudflareConfigCustomizer', () => {
assert.equal(result.previews?.images, undefined);
});

it('preserves existing previews KV bindings when adding SESSION binding', () => {
const customizer = cloudflareConfigCustomizer();
const result = customizer({
previews: {
kv_namespaces: [{ binding: 'OTHER_KV', id: 'other-id' }],
},
});

assert.deepEqual(result.previews?.kv_namespaces, [
{ binding: 'OTHER_KV', id: 'other-id' },
{ binding: DEFAULT_SESSION_KV_BINDING_NAME },
]);
});

it('adds SESSION binding to previews even when top-level has it', () => {
const customizer = cloudflareConfigCustomizer();
const result = customizer({
Expand Down
Loading