Skip to content

fix: correctly detect Cloudflare Workers when either main or assets key exists #13844

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/happy-beers-remain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/adapter-cloudflare': patch
---

fix: correctly warn users when assets key is missing
2 changes: 1 addition & 1 deletion packages/adapter-auto/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
"@sveltejs/vite-plugin-svelte": "^5.0.1",
"@types/node": "^18.19.48",
"typescript": "^5.3.3",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/kit": "^2.0.0"
Expand Down
16 changes: 1 addition & 15 deletions packages/adapter-cloudflare/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { copyFileSync, existsSync, writeFileSync } from 'node:fs';
import path from 'node:path';
import process from 'node:process';
import { fileURLToPath } from 'node:url';
import { is_building_for_cloudflare_pages } from './utils.js';
import { getPlatformProxy, unstable_readConfig } from 'wrangler';

/** @type {import('./index.js').default} */
Expand Down Expand Up @@ -301,20 +301,6 @@ function validate_config(config_file = undefined) {
return wrangler_config;
}

/**
* @param {import('wrangler').Unstable_Config} wrangler_config
* @returns {boolean}
*/
function is_building_for_cloudflare_pages(wrangler_config) {
return (
!!process.env.CF_PAGES ||
!wrangler_config.configPath ||
!!wrangler_config.pages_build_output_dir ||
!wrangler_config.main ||
!wrangler_config.assets
);
}

/** @param {string} str */
function posixify(str) {
return str.replace(/\\/g, '/');
Expand Down
7 changes: 5 additions & 2 deletions packages/adapter-cloudflare/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
"format": "pnpm lint --write",
"check": "tsc --skipLibCheck",
"prepublishOnly": "pnpm build",
"test": "pnpm build && pnpm -r --workspace-concurrency 1 --filter=\"./test/**\" test"
"test:unit": "vitest run",
"test:e2e": "pnpm build && pnpm -r --workspace-concurrency 1 --filter=\"./test/**\" test",
"test": "pnpm test:unit && pnpm test:e2e"
},
"dependencies": {
"@cloudflare/workers-types": "^4.20250507.0",
Expand All @@ -49,7 +51,8 @@
"@sveltejs/kit": "workspace:^",
"@types/node": "^18.19.48",
"esbuild": "^0.25.4",
"typescript": "^5.3.3"
"typescript": "^5.3.3",
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/kit": "^2.0.0",
Expand Down
9 changes: 8 additions & 1 deletion packages/adapter-cloudflare/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,12 @@
"lib": ["es2021"],
"types": ["@cloudflare/workers-types"]
},
"include": ["index.js", "utils.js", "test/utils.js", "internal.d.ts", "src/worker.js"]
"include": [
"index.js",
"utils.js",
"utils.spec.js",
"test/utils.js",
"internal.d.ts",
"src/worker.js"
]
}
17 changes: 17 additions & 0 deletions packages/adapter-cloudflare/utils.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import process from 'node:process';

/**
* @param {import('wrangler').Unstable_Config} wrangler_config
* @returns {boolean}
*/
export function is_building_for_cloudflare_pages(wrangler_config) {
if (process.env.CF_PAGES || wrangler_config.pages_build_output_dir) {
return true;
}

if (wrangler_config.main || wrangler_config.assets) {
return false;
}

return true;
}
67 changes: 67 additions & 0 deletions packages/adapter-cloudflare/utils.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import { describe, test, vi, expect } from 'vitest';
import { is_building_for_cloudflare_pages } from './utils.js';

describe('detects Cloudflare Pages project', () => {
test('by default', () => {
expect(
is_building_for_cloudflare_pages(/** @type {import('wrangler').Unstable_Config} */ ({}))
).toBe(true);
});

test('CF_PAGES environment variable', () => {
vi.stubEnv('CF_PAGES', '1');
const result = is_building_for_cloudflare_pages(
/** @type {import('wrangler').Unstable_Config} */ ({})
);
vi.unstubAllEnvs();
expect(result).toBe(true);
});

test('empty Wrangler configuration file', () => {
expect(
is_building_for_cloudflare_pages(
/** @type {import('wrangler').Unstable_Config} */ ({
configPath: 'wrangler.jsonc'
})
)
).toBe(true);
});

test('pages_build_output_dir config key', () => {
expect(
is_building_for_cloudflare_pages(
/** @type {import('wrangler').Unstable_Config} */ ({
configPath: 'wrangler.jsonc',
pages_build_output_dir: 'dist'
})
)
).toBe(true);
});
});

describe('detects Cloudflare Workers project', () => {
test('main config key', () => {
expect(
is_building_for_cloudflare_pages(
/** @type {import('wrangler').Unstable_Config} */ ({
configPath: 'wrangler.jsonc',
main: 'dist/index.js'
})
)
).toBe(false);
});

test('assets config key', () => {
expect(
is_building_for_cloudflare_pages(
/** @type {import('wrangler').Unstable_Config} */ ({
configPath: 'wrangler.jsonc',
assets: {
directory: 'dist/assets',
binding: 'ASSETS'
}
})
)
).toBe(false);
});
});
2 changes: 1 addition & 1 deletion packages/adapter-netlify/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"@types/set-cookie-parser": "^2.4.7",
"rollup": "^4.14.2",
"typescript": "^5.3.3",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/kit": "^2.4.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"polka": "^1.0.0-next.28",
"sirv": "^3.0.0",
"typescript": "^5.3.3",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"dependencies": {
"@rollup/plugin-commonjs": "^28.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-vercel/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"@sveltejs/vite-plugin-svelte": "^5.0.1",
"@types/node": "^18.19.48",
"typescript": "^5.3.3",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/kit": "^2.4.0"
Expand Down
2 changes: 1 addition & 1 deletion packages/enhanced-img/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"svelte": "^5.23.1",
"typescript": "^5.6.3",
"vite": "^6.2.7",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/vite-plugin-svelte": "^5.0.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/kit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"svelte-preprocess": "^6.0.0",
"typescript": "^5.3.3",
"vite": "^6.2.7",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"peerDependencies": {
"@sveltejs/vite-plugin-svelte": "^3.0.0 || ^4.0.0-next.1 || ^5.0.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/kit/test/build-errors/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
},
"type": "module",
"devDependencies": {
"vitest": "^3.1.1"
"vitest": "catalog:"
}
}
2 changes: 1 addition & 1 deletion packages/kit/test/prerendering/basics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"svelte-check": "^4.1.1",
"typescript": "^5.5.4",
"vite": "^6.2.7",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"type": "module"
}
2 changes: 1 addition & 1 deletion packages/kit/test/prerendering/options/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"svelte-check": "^4.1.1",
"typescript": "^5.5.4",
"vite": "^6.2.7",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"type": "module"
}
2 changes: 1 addition & 1 deletion packages/kit/test/prerendering/paths-base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"svelte-check": "^4.1.1",
"typescript": "^5.5.4",
"vite": "^6.2.7",
"vitest": "^3.1.1"
"vitest": "catalog:"
},
"type": "module"
}
Loading
Loading