Skip to content

Commit eff365d

Browse files
committed
fix: config preview_urls defaults to undefined (falsy) instead of true
We want preview_urls to be opt-in, rather than opt-out. For this reason its default value will be falsy.
1 parent 080f33f commit eff365d

File tree

7 files changed

+18
-10
lines changed

7 files changed

+18
-10
lines changed

.changeset/ready-banks-repair.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"wrangler": minor
3+
---
4+
5+
Beta feature preview_urls is now disabled by default.
6+
7+
This change makes preview_urls disabled by default when it's not provided, making
8+
the feature opt-in instead of opt-out.

packages/wrangler/src/__tests__/config/configuration.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ describe("normalizeAndValidateConfig()", () => {
130130
wasm_modules: undefined,
131131
data_blobs: undefined,
132132
workers_dev: undefined,
133-
preview_urls: true,
133+
preview_urls: undefined,
134134
zone_id: undefined,
135135
no_bundle: undefined,
136136
minify: undefined,

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1898,7 +1898,7 @@ Update them to point to this script instead?`,
18981898
});
18991899
await mockAUSRequest([]);
19001900
mockSubDomainRequest();
1901-
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: true });
1901+
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: false });
19021902
mockUploadWorkerRequest({
19031903
expectedAssets: {
19041904
jwt: "<<aus-completion-token>>",
@@ -1983,7 +1983,7 @@ Update them to point to this script instead?`,
19831983
});
19841984
await mockAUSRequest([]);
19851985
mockSubDomainRequest();
1986-
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: true });
1986+
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: false });
19871987
mockUploadWorkerRequest({
19881988
expectedAssets: {
19891989
jwt: "<<aus-completion-token>>",
@@ -2046,7 +2046,7 @@ Update them to point to this script instead?`,
20462046
writeWorkerSource();
20472047
await mockAUSRequest([]);
20482048
mockSubDomainRequest();
2049-
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: true });
2049+
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: false });
20502050
mockUploadWorkerRequest({
20512051
expectedAssets: {
20522052
jwt: "<<aus-completion-token>>",
@@ -2116,7 +2116,7 @@ Update them to point to this script instead?`,
21162116
});
21172117
await mockAUSRequest([]);
21182118
mockSubDomainRequest();
2119-
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: true });
2119+
mockUpdateWorkerSubdomain({ enabled: false, previews_enabled: false });
21202120
mockUploadWorkerRequest({
21212121
expectedAssets: {
21222122
jwt: "<<aus-completion-token>>",

packages/wrangler/src/__tests__/helpers/mock-workers-subdomain.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export function mockSubDomainRequest(
3636
/** Create a mock handler to fetch the <script>.<user>.workers.dev subdomain status*/
3737
export function mockGetWorkerSubdomain({
3838
enabled,
39-
previews_enabled = true,
39+
previews_enabled = false,
4040
env,
4141
legacyEnv = false,
4242
expectedScriptName = "test-name" + (legacyEnv && env ? `-${env}` : ""),
@@ -73,7 +73,7 @@ export function mockGetWorkerSubdomain({
7373
/** Create a mock handler to toggle a <script>.<user>.workers.dev subdomain status */
7474
export function mockUpdateWorkerSubdomain({
7575
enabled,
76-
previews_enabled = true,
76+
previews_enabled = false,
7777
env,
7878
legacyEnv = false,
7979
expectedScriptName = "test-name",

packages/wrangler/src/config/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ export const defaultWranglerConfig: Config = {
346346
preserve_file_names: undefined,
347347
base_dir: undefined,
348348
workers_dev: undefined,
349-
preview_urls: true,
349+
preview_urls: undefined,
350350
route: undefined,
351351
routes: undefined,
352352
tsconfig: undefined,

packages/wrangler/src/config/environment.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ interface EnvironmentInheritable {
312312
* Whether we use <version>-<name>.<subdomain>.workers.dev to
313313
* serve Preview URLs for your Worker.
314314
*
315-
* @default true
315+
* @default false
316316
* @inheritable
317317
*/
318318
preview_urls: boolean | undefined;

packages/wrangler/src/config/validation.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1059,7 +1059,7 @@ function normalizeAndValidateEnvironment(
10591059
rawEnv,
10601060
"preview_urls",
10611061
isBoolean,
1062-
true
1062+
undefined
10631063
);
10641064

10651065
const build = normalizeAndValidateBuild(

0 commit comments

Comments
 (0)