Skip to content

Commit f0f2054

Browse files
GregBrimbledevin-ai-integration[bot]
GregBrimble
and
devin-ai-integration[bot]
authored
Replace ignore-defaults with ignore-base-config CLI arg for Previews (#15152)
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
1 parent 7d4565d commit f0f2054

8 files changed

Lines changed: 33 additions & 39 deletions

File tree

‎.changeset/proud-icons-obey.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
"@cloudflare/deploy-helpers": minor
3+
"wrangler": minor
4+
---
5+
6+
[private beta]: Updates the `--ignore-defaults` flag to `--ignore-base-config` on `wrangler preview` commands.
7+
8+
`--ignore-base-config` now only takes effect on Preview creation, rather than on each deployment, since Preview base configuration is now copy-on-create rather than inherit-on-deploy.

‎packages/deploy-helpers/src/preview/api.ts‎

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ export type UpdatePreviewRequestParams = Omit<
124124
>;
125125

126126
export type PreviewRequestOptions = {
127-
ignoreDefaults?: boolean;
127+
ignoreBaseConfig?: boolean;
128128
};
129129

130130
export type PreviewDefaults = {
@@ -184,8 +184,8 @@ export async function createPreview(
184184
request: CreatePreviewRequestParams,
185185
options?: PreviewRequestOptions
186186
): Promise<PreviewResource> {
187-
const queryParams = options?.ignoreDefaults
188-
? new URLSearchParams({ ignore_defaults: "true" })
187+
const queryParams = options?.ignoreBaseConfig
188+
? new URLSearchParams({ ignore_base_config: "true" })
189189
: undefined;
190190

191191
return fetchResult<PreviewResource>(
@@ -205,13 +205,8 @@ export async function editPreview(
205205
accountId: string,
206206
workerName: string,
207207
previewIdentifier: string,
208-
request: UpdatePreviewRequestParams,
209-
options?: PreviewRequestOptions
208+
request: UpdatePreviewRequestParams
210209
): Promise<PreviewResource> {
211-
const queryParams = options?.ignoreDefaults
212-
? new URLSearchParams({ ignore_defaults: "true" })
213-
: undefined;
214-
215210
return fetchResult<PreviewResource>(
216211
config,
217212
`/accounts/${accountId}/workers/workers/${workerName}/previews/${encodeURIComponent(
@@ -221,8 +216,7 @@ export async function editPreview(
221216
method: "PATCH",
222217
headers: { "Content-Type": "application/json" },
223218
body: JSON.stringify(request),
224-
},
225-
queryParams
219+
}
226220
);
227221
}
228222

@@ -263,13 +257,8 @@ export async function createPreviewDeployment(
263257
accountId: string,
264258
workerName: string,
265259
previewIdentifier: string,
266-
request: Partial<CreatePreviewDeploymentRequestParams>,
267-
options?: PreviewRequestOptions
260+
request: Partial<CreatePreviewDeploymentRequestParams>
268261
): Promise<DeploymentResource> {
269-
const queryParams = options?.ignoreDefaults
270-
? new URLSearchParams({ ignore_defaults: "true" })
271-
: undefined;
272-
273262
return fetchResult<DeploymentResource>(
274263
config,
275264
`/accounts/${accountId}/workers/workers/${workerName}/previews/${encodeURIComponent(
@@ -279,8 +268,7 @@ export async function createPreviewDeployment(
279268
method: "POST",
280269
headers: { "Content-Type": "application/json" },
281270
body: JSON.stringify(request),
282-
},
283-
queryParams
271+
}
284272
);
285273
}
286274

‎packages/deploy-helpers/src/preview/preview.ts‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export type PreviewArgs = {
4949
tag?: string;
5050
message?: string;
5151
json?: boolean;
52-
ignoreDefaults: boolean;
52+
ignoreBaseConfig: boolean;
5353
workerName?: string;
5454
"worker-name"?: string;
5555
};
@@ -375,7 +375,7 @@ export async function preview(
375375
}
376376

377377
const previewIdentifier = previewName;
378-
const ignoreDefaults = args.ignoreDefaults;
378+
const ignoreBaseConfig = args.ignoreBaseConfig;
379379
const fallbackTag =
380380
!args.tag && shouldUseCIMetadataFallback() ? getHeadCommitRef() : undefined;
381381
const fallbackMessage =
@@ -405,7 +405,7 @@ export async function preview(
405405
accountId,
406406
workerName,
407407
{ name: previewName, ...assemblePreviewScriptSettings(config) },
408-
{ ignoreDefaults }
408+
{ ignoreBaseConfig }
409409
);
410410
} else {
411411
const previewRequest = assemblePreviewScriptSettings(config);
@@ -415,8 +415,7 @@ export async function preview(
415415
accountId,
416416
workerName,
417417
previewIdentifier,
418-
previewRequest,
419-
{ ignoreDefaults }
418+
previewRequest
420419
);
421420
} else {
422421
previewResource = existingPreview as PreviewResource;
@@ -440,8 +439,7 @@ export async function preview(
440439
accountId,
441440
workerName,
442441
previewResource.id,
443-
deploymentRequest,
444-
{ ignoreDefaults }
442+
deploymentRequest
445443
);
446444

447445
if (args.json) {

‎packages/wrangler/src/__tests__/preview.base-config.secret.test.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,19 +112,19 @@ describe("wrangler preview", () => {
112112
{ command: "put API_KEY", flag: "--name my-preview" },
113113
{ command: "put API_KEY", flag: '--message "add secret"' },
114114
{ command: "put API_KEY", flag: "--tag v1" },
115-
{ command: "put API_KEY", flag: "--ignore-defaults" },
115+
{ command: "put API_KEY", flag: "--ignore-base-config" },
116116
{ command: "delete REMOVE_ME", flag: "--name my-preview" },
117117
{ command: "delete REMOVE_ME", flag: '--message "delete secret"' },
118118
{ command: "delete REMOVE_ME", flag: "--tag v1" },
119-
{ command: "delete REMOVE_ME", flag: "--ignore-defaults" },
119+
{ command: "delete REMOVE_ME", flag: "--ignore-base-config" },
120120
{ command: "list", flag: "--name my-preview" },
121121
{ command: "list", flag: '--message "list secrets"' },
122122
{ command: "list", flag: "--tag v1" },
123-
{ command: "list", flag: "--ignore-defaults" },
123+
{ command: "list", flag: "--ignore-base-config" },
124124
{ command: "bulk", flag: "--name my-preview" },
125125
{ command: "bulk", flag: '--message "bulk secrets"' },
126126
{ command: "bulk", flag: "--tag v1" },
127-
{ command: "bulk", flag: "--ignore-defaults" },
127+
{ command: "bulk", flag: "--ignore-base-config" },
128128
])(
129129
"rejects Preview deployment flag $flag for $command",
130130
async ({ command, flag }, { expect }) => {

‎packages/wrangler/src/__tests__/preview.test.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1607,7 +1607,7 @@ describe("wrangler preview", () => {
16071607
expect(std.out).toContain("Deployment ID: deployment-id-compat");
16081608
});
16091609

1610-
test("should pass ignore_defaults query param when --ignore-defaults flag is used", async ({
1610+
test("should pass ignore_base_config query param when creating a Preview with --ignore-base-config", async ({
16111611
expect,
16121612
}) => {
16131613
let createPreviewUrl: string | undefined;
@@ -1667,9 +1667,9 @@ describe("wrangler preview", () => {
16671667
}
16681668
)
16691669
);
1670-
await runWrangler("preview --name test-preview --ignore-defaults");
1671-
expect(createPreviewUrl).toContain("?ignore_defaults=true");
1672-
expect(createDeploymentUrl).toContain("?ignore_defaults=true");
1670+
await runWrangler("preview --name test-preview --ignore-base-config");
1671+
expect(createPreviewUrl).toContain("?ignore_base_config=true");
1672+
expect(createDeploymentUrl).not.toContain("ignore_base_config");
16731673
});
16741674

16751675
test("should include assets payload for deployment when assets are configured", async ({

‎packages/wrangler/src/metrics/sanitization.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ export const COMMAND_ARG_ALLOW_LIST: AllowList = {
8383
nodeCompat: ALLOW,
8484
enableContainers: ALLOW,
8585
autoconfig: ALLOW,
86-
ignoreDefaults: ALLOW,
86+
ignoreBaseConfig: ALLOW,
8787
},
8888
tail: { status: ALLOW },
8989
types: {

‎packages/wrangler/src/preview/base-config/secrets/index.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ export function rejectUnsupportedPreviewArgs(args: Record<string, unknown>) {
1818
});
1919
}
2020
}
21-
if (args.ignoreDefaults === true) {
22-
throw new CommandLineArgsError("Unknown argument: ignore-defaults", {
21+
if (args.ignoreBaseConfig === true) {
22+
throw new CommandLineArgsError("Unknown argument: ignore-base-config", {
2323
telemetryMessage: "preview base-config unsupported flag",
2424
});
2525
}

‎packages/wrangler/src/preview/preview.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ export const previewCommand = createCommand({
4242
type: "boolean",
4343
default: false,
4444
},
45-
"ignore-defaults": {
45+
"ignore-base-config": {
4646
describe:
47-
"Only use settings from your config file, ignoring any Previews settings configured in the Cloudflare dashboard",
47+
"Only use settings from your config file, ignoring the Preview base config configured in the Cloudflare dashboard",
4848
type: "boolean",
4949
default: false,
5050
},

0 commit comments

Comments
 (0)