Skip to content

Commit 9982203

Browse files
committed
fix: add warning when subdomain status does not match Wrangler config
Warn the user when the workers.dev or preview URLs status does not match their Wrangler config file.
1 parent 21dac0c commit 9982203

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

packages/wrangler/src/__tests__/deploy.test.ts

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6891,6 +6891,60 @@ addEventListener('fetch', event => {});`
68916891
expect(std.err).toMatchInlineSnapshot(`""`);
68926892
expect(std.warn).toMatchInlineSnapshot(`""`);
68936893
});
6894+
6895+
it("should warn the user if workers_dev default is different from remote", async () => {
6896+
writeWranglerConfig({}); // Default workers_dev should be true, since there's no routes.
6897+
writeWorkerSource();
6898+
mockSubDomainRequest();
6899+
mockUploadWorkerRequest();
6900+
mockGetWorkerSubdomain({ enabled: false });
6901+
mockUpdateWorkerSubdomain({ enabled: true });
6902+
await runWrangler("deploy ./index");
6903+
6904+
expect(std.out).toMatchInlineSnapshot(`
6905+
"Total Upload: xx KiB / gzip: xx KiB
6906+
Worker Startup Time: 100 ms
6907+
Uploaded test-name (TIMINGS)
6908+
Deployed test-name triggers (TIMINGS)
6909+
https://test-name.test-sub-domain.workers.dev
6910+
Current Version ID: Galaxy-Class"
6911+
`);
6912+
expect(std.err).toMatchInlineSnapshot(`""`);
6913+
expect(std.warn).toMatchInlineSnapshot(`
6914+
"▲ [WARNING] Worker has workers.dev disabled, but 'workers_dev' is not in the config.
6915+
6916+
Using fallback value 'workers_dev = true'.
6917+
6918+
"
6919+
`);
6920+
});
6921+
6922+
it("should warn the user if preview_urls default is different from remote", async () => {
6923+
writeWranglerConfig({}); // Default preview_urls should be false.
6924+
writeWorkerSource();
6925+
mockSubDomainRequest();
6926+
mockUploadWorkerRequest();
6927+
mockGetWorkerSubdomain({ enabled: true, previews_enabled: true });
6928+
mockUpdateWorkerSubdomain({ enabled: true, previews_enabled: false });
6929+
await runWrangler("deploy ./index");
6930+
6931+
expect(std.out).toMatchInlineSnapshot(`
6932+
"Total Upload: xx KiB / gzip: xx KiB
6933+
Worker Startup Time: 100 ms
6934+
Uploaded test-name (TIMINGS)
6935+
Deployed test-name triggers (TIMINGS)
6936+
https://test-name.test-sub-domain.workers.dev
6937+
Current Version ID: Galaxy-Class"
6938+
`);
6939+
expect(std.err).toMatchInlineSnapshot(`""`);
6940+
expect(std.warn).toMatchInlineSnapshot(`
6941+
"▲ [WARNING] Worker has preview URLs enabled, but 'preview_urls' is not in the config.
6942+
6943+
Using fallback value 'preview_urls = false'.
6944+
6945+
"
6946+
`);
6947+
});
68946948
});
68956949

68966950
describe("[define]", () => {

packages/wrangler/src/triggers/deploy.ts

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,28 @@ async function subdomainDeploy(
336336
const previewsInSync = wantPreviews === currPreviews;
337337
const allInSync = [workersDevInSync, previewsInSync].every((v) => v);
338338

339+
// Warn about mismatching config and current values.
340+
341+
if (config.workers_dev == undefined && !workersDevInSync) {
342+
const currWorkersDevStatus = currWorkersDev ? "enabled" : "disabled";
343+
logger.warn(
344+
[
345+
`Worker has workers.dev ${currWorkersDevStatus}, but 'workers_dev' is not in the config.`,
346+
`Using fallback value 'workers_dev = ${wantWorkersDev}'.`,
347+
].join("\n")
348+
);
349+
}
350+
351+
if (config.preview_urls == undefined && !previewsInSync) {
352+
const currPreviewsStatus = currPreviews ? "enabled" : "disabled";
353+
logger.warn(
354+
[
355+
`Worker has preview URLs ${currPreviewsStatus}, but 'preview_urls' is not in the config.`,
356+
`Using fallback value 'preview_urls = ${wantPreviews}'.`,
357+
].join("\n")
358+
);
359+
}
360+
339361
// workers.dev URL is only set if we want to deploy to workers.dev.
340362

341363
let workersDevURL: string | undefined;

0 commit comments

Comments
 (0)