Skip to content

Commit a3ea544

Browse files
committed
Rename to preview_urls
1 parent ce7540b commit a3ea544

File tree

9 files changed

+16
-26
lines changed

9 files changed

+16
-26
lines changed

.changeset/famous-mayflies-knock.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
"wrangler": minor
33
---
44

5-
Add `workers_dev_previews` toggle to `wrangler.toml`
5+
Add `preview_urls` toggle to `wrangler.toml`
66

7-
The current Preview URLs (beta) feature routes to version preview urls based on the status of the `workers_dev` config value. Beta users have requested the ability to enable deployment urls and preview urls separately on `workers.dev`, and the new `previews_enabled` field of the enable-subdomain API will allow that. This change separates the `workers_dev` and `workers_dev_previews` behavior during `wrangler triggers deploy` and `wrangler versions upload`. `wrangler_dev_previews` defaults to true, and does not implicitly depend on routes the way `wrangler_dev` does.
7+
The current Preview URLs (beta) feature routes to version preview urls based on the status of the `workers_dev` config value. Beta users have requested the ability to enable deployment urls and preview urls separately on `workers.dev`, and the new `previews_enabled` field of the enable-subdomain API will allow that. This change separates the `workers_dev` and `preview_urls` behavior during `wrangler triggers deploy` and `wrangler versions upload`. `wrangler_dev_previews` defaults to true, and does not implicitly depend on routes the way `wrangler_dev` does.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ describe("normalizeAndValidateConfig()", () => {
120120
wasm_modules: undefined,
121121
data_blobs: undefined,
122122
workers_dev: undefined,
123-
workers_dev_previews: true,
123+
preview_urls: true,
124124
zone_id: undefined,
125125
no_bundle: undefined,
126126
minify: undefined,

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -5183,7 +5183,7 @@ addEventListener('fetch', event => {});`
51835183
it("should sync the workers.dev domain if it has been enabled before but previews should be enabled", async () => {
51845184
writeWranglerConfig({
51855185
workers_dev: true,
5186-
workers_dev_previews: false,
5186+
preview_urls: false,
51875187
});
51885188
writeWorkerSource();
51895189
mockUploadWorkerRequest();
@@ -5271,7 +5271,7 @@ addEventListener('fetch', event => {});`
52715271
it("should sync the workers.dev domain if it is not available but previews should be disabled", async () => {
52725272
writeWranglerConfig({
52735273
workers_dev: false,
5274-
workers_dev_previews: false,
5274+
preview_urls: false,
52755275
});
52765276
writeWorkerSource();
52775277
mockUploadWorkerRequest();

packages/wrangler/src/__tests__/versions/versions.upload.test.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ describe("versions upload", () => {
140140
`);
141141
});
142142

143-
it("should not print preview url when workers_dev_previews is false", async () => {
143+
it("should not print preview url when preview_urls is false", async () => {
144144
mockGetScript();
145145
mockUploadVersion(true);
146146
mockGetWorkerSubdomain({ enabled: true, previews_enabled: false });

packages/wrangler/src/config/config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -355,7 +355,7 @@ export const defaultWranglerConfig: Config = {
355355
preserve_file_names: undefined,
356356
base_dir: undefined,
357357
workers_dev: undefined,
358-
workers_dev_previews: true,
358+
preview_urls: true,
359359
route: undefined,
360360
routes: undefined,
361361
tsconfig: undefined,

packages/wrangler/src/config/environment.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ interface EnvironmentInheritable {
155155
* @default `true`
156156
* @inheritable
157157
*/
158-
workers_dev_previews: boolean | undefined;
158+
preview_urls: boolean | undefined;
159159

160160
/**
161161
* A list of routes that your Worker should be published to.

packages/wrangler/src/config/validation.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -1122,11 +1122,11 @@ function normalizeAndValidateEnvironment(
11221122
undefined
11231123
);
11241124

1125-
const workers_dev_previews = inheritable(
1125+
const preview_urls = inheritable(
11261126
diagnostics,
11271127
topLevelEnv,
11281128
rawEnv,
1129-
"workers_dev_previews",
1129+
"preview_urls",
11301130
isBoolean,
11311131
true
11321132
);
@@ -1266,7 +1266,7 @@ function normalizeAndValidateEnvironment(
12661266
placement: normalizeAndValidatePlacement(diagnostics, topLevelEnv, rawEnv),
12671267
build,
12681268
workers_dev,
1269-
workers_dev_previews,
1269+
preview_urls,
12701270
// Not inherited fields
12711271
vars: notInheritable(
12721272
diagnostics,

packages/wrangler/src/init.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -941,7 +941,7 @@ async function getWorkerConfig(
941941
name: workerName,
942942
main: entrypoint,
943943
workers_dev: workersDev.enabled,
944-
workers_dev_previews: workersDev.previews_enabled,
944+
preview_urls: workersDev.previews_enabled,
945945
compatibility_date:
946946
serviceEnvMetadata.script.compatibility_date ??
947947
new Date().toISOString().substring(0, 10),

packages/wrangler/src/triggers/deploy.ts

+4-14
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import {
55
publishCustomDomains,
66
publishRoutes,
77
renderRoute,
8-
sleep,
98
updateQueueConsumers,
109
updateQueueProducers,
1110
validateRoutes,
@@ -96,7 +95,7 @@ export default async function triggersDeploy(
9695

9796
const deploymentInSync = deployToWorkersDev === available_on_subdomain;
9897
const previewsInSync =
99-
config.workers_dev_previews === previews_available_on_subdomain;
98+
config.preview_urls === previews_available_on_subdomain;
10099

101100
if (deployToWorkersDev) {
102101
// Deploy to a subdomain of `workers.dev`
@@ -116,21 +115,12 @@ export default async function triggersDeploy(
116115
method: "POST",
117116
body: JSON.stringify({
118117
enabled: true,
119-
previews_enabled: config.workers_dev_previews,
118+
previews_enabled: config.preview_urls,
120119
}),
121120
headers: {
122121
"Content-Type": "application/json",
123122
},
124-
})
125-
.then(() => [deploymentURL])
126-
// Add a delay when the subdomain is first created.
127-
// This is to prevent an issue where a negative cache-hit
128-
// causes the subdomain to be unavailable for 30 seconds.
129-
// This is a temporary measure until we fix this on the edge.
130-
.then(async (url) => {
131-
await sleep(3000);
132-
return url;
133-
})
123+
}).then(() => [deploymentURL])
134124
);
135125
}
136126
}
@@ -140,7 +130,7 @@ export default async function triggersDeploy(
140130
method: "POST",
141131
body: JSON.stringify({
142132
enabled: false,
143-
previews_enabled: config.workers_dev_previews,
133+
previews_enabled: config.preview_urls,
144134
}),
145135
headers: {
146136
"Content-Type": "application/json",

0 commit comments

Comments
 (0)