Skip to content

[wrangler] Add custom-domain Preview provisioning note #15522

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

Draft
yomna-shousha wants to merge 1 commit into
base: main
Choose a base branch
from
+219 −0
Draft

[wrangler] Add custom-domain Preview provisioning note #15522

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
8 changes: 8 additions & 0 deletions .changeset/calm-clouds-preview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@cloudflare/deploy-helpers": patch
"wrangler": patch
---

Add a provisioning delay note for custom-domain Previews

Wrangler now explains that DNS and TLS certificate provisioning may continue after a successful deployment with custom-domain Previews enabled.
16 changes: 16 additions & 0 deletions packages/deploy-helpers/src/triggers/deploy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,22 @@ export async function triggersDeploy(
logger.log("No targets deployed for", workerName, formatTime(deployMs));
}

const customDomainDeployment = completedDeployments.find(
(deployment) => deployment.category === "Custom domains"
);
if (
customDomainsOnly.some(
(domain) =>
"previews_enabled" in domain && domain.previews_enabled === true
) &&
customDomainDeployment !== undefined &&
customDomainDeployment.error === undefined
) {
logger.log(
"Note: DNS and TLS certificate provisioning for Preview domains may continue after this deploy. If a new Preview URL does not work immediately, wait a few minutes and retry."
);
}

const failedDeployments = completedDeployments.filter(
(deployment): deployment is TriggerDeployment & { error: Error } =>
deployment.error !== undefined
Expand Down
195 changes: 195 additions & 0 deletions packages/wrangler/src/__tests__/deploy/routes.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ import {
writeAssets,
} from "./helpers";

const PREVIEW_DOMAIN_PROVISIONING_NOTE =
"Note: DNS and TLS certificate provisioning for Preview domains may continue after this deploy. If a new Preview URL does not work immediately, wait a few minutes and retry.";

vi.mock("command-exists");
vi.mock("../../check/commands", async (importOriginal) => {
return {
Expand Down Expand Up @@ -503,6 +506,198 @@ describe("deploy", () => {
await runWrangler("deploy ./index");
expect(std.out).toContain("api.example.com (custom domain)");
expect(std.out).toContain("[enabled, previews: enabled]");
expect(std.out).toContain(PREVIEW_DOMAIN_PROVISIONING_NOTE);
expect(
std.out.indexOf(PREVIEW_DOMAIN_PROVISIONING_NOTE)
).toBeGreaterThan(std.out.indexOf("api.example.com (custom domain)"));
});

it("should print the Preview provisioning note in non-interactive terminals", async ({
expect,
}) => {
setIsTTY(false);
writeWranglerConfig({
routes: [
{
pattern: "api.example.com",
custom_domain: true,
previews_enabled: true,
},
],
});
writeWorkerSource();
mockUpdateWorkerSubdomain({ enabled: false });
mockUploadWorkerRequest({ expectedType: "esm" });
mockGetZones(expect, "api.example.com", [{ id: "api-example-com-id" }]);
mockGetZoneWorkerRoutes(expect, "api-example-com-id", []);
mockPublishCustomDomainsRequest({
publishFlags: {
override_scope: true,
override_existing_origin: true,
override_existing_dns_record: true,
},
domains: [
{
hostname: "api.example.com",
previews_enabled: true,
},
],
});

await runWrangler("deploy ./index");

expect(std.out).toContain(PREVIEW_DOMAIN_PROVISIONING_NOTE);
});

it("should print one Preview provisioning note for several Preview domains", async ({
expect,
}) => {
writeWranglerConfig({
routes: [
{
pattern: "api.example.com",
custom_domain: true,
previews_enabled: true,
},
{
pattern: "app.example.com",
custom_domain: true,
previews_enabled: true,
},
],
});
writeWorkerSource();
mockUpdateWorkerSubdomain({ enabled: false });
mockUploadWorkerRequest({ expectedType: "esm" });
mockGetZonesMulti(expect, {
"api.example.com": {
accountId: "some-account-id",
zones: [{ id: "api-example-com-id" }],
},
"app.example.com": {
accountId: "some-account-id",
zones: [{ id: "app-example-com-id" }],
},
});
mockGetZoneWorkerRoutesMulti(expect, {
"api-example-com-id": [],
"app-example-com-id": [],
});
mockCustomDomainsChangesetRequest({});
mockPublishCustomDomainsRequest({
publishFlags: {
override_scope: true,
override_existing_origin: false,
override_existing_dns_record: false,
},
domains: [
{
hostname: "api.example.com",
previews_enabled: true,
},
{
hostname: "app.example.com",
previews_enabled: true,
},
],
});

await runWrangler("deploy ./index");

expect(std.out.split(PREVIEW_DOMAIN_PROVISIONING_NOTE)).toHaveLength(2);
});

it("should not print the Preview provisioning note when previews_enabled is false or omitted", async ({
expect,
}) => {
writeWranglerConfig({
routes: [
{
pattern: "api.example.com",
custom_domain: true,
previews_enabled: false,
},
{
pattern: "app.example.com",
custom_domain: true,
},
],
});
writeWorkerSource();
mockUpdateWorkerSubdomain({ enabled: false });
mockUploadWorkerRequest({ expectedType: "esm" });
mockGetZonesMulti(expect, {
"api.example.com": {
accountId: "some-account-id",
zones: [{ id: "api-example-com-id" }],
},
"app.example.com": {
accountId: "some-account-id",
zones: [{ id: "app-example-com-id" }],
},
});
mockGetZoneWorkerRoutesMulti(expect, {
"api-example-com-id": [],
"app-example-com-id": [],
});
mockCustomDomainsChangesetRequest({});
mockPublishCustomDomainsRequest({
publishFlags: {
override_scope: true,
override_existing_origin: false,
override_existing_dns_record: false,
},
domains: [
{
hostname: "api.example.com",
previews_enabled: false,
},
{ hostname: "app.example.com" },
],
});

await runWrangler("deploy ./index");

expect(std.out).not.toContain(PREVIEW_DOMAIN_PROVISIONING_NOTE);
});

it("should not print the Preview provisioning note when custom-domain publishing fails", async ({
expect,
}) => {
writeWranglerConfig({
routes: [
{
pattern: "api.example.com",
custom_domain: true,
previews_enabled: true,
},
],
});
writeWorkerSource();
mockUpdateWorkerSubdomain({ enabled: false });
mockUploadWorkerRequest({ expectedType: "esm" });
mockGetZones(expect, "api.example.com", [{ id: "api-example-com-id" }]);
mockGetZoneWorkerRoutes(expect, "api-example-com-id", []);
mockCustomDomainsChangesetRequest({});
msw.use(
http.put(
"*/accounts/:accountId/workers/scripts/:scriptName/domains/records",
() =>
HttpResponse.json(
createFetchResult(null, false, [
{
code: 100159,
message: "Custom-domain publishing failed",
},
])
),
{ once: true }
)
);

await expect(runWrangler("deploy ./index")).rejects.toThrow();

expect(std.out).not.toContain(PREVIEW_DOMAIN_PROVISIONING_NOTE);
});

it("should confirm override if custom domain deploy would override an existing domain", async ({
Expand Down
Loading