Skip to content

Commit 9f0c175

Browse files
thomasgauvinemily-shen
thomasgauvin
and
emily-shen
authored
thomasgauvin: add rename command to kv wrangler (#9835)
* thomasgauvin: add rename command to kv wrangler * thomasgauvin: minor test adjustments, adding namespace does not exist test case for renaming * prettyify * thomasgauvin: fix linter * thomasgauvin: pr comments, clean up validation logic and assertions * Add changeset * Update .changeset/slimy-coins-create.md Co-authored-by: emily-shen <[email protected]> * Update packages/wrangler/src/metrics/send-event.ts Co-authored-by: emily-shen <[email protected]> * Update packages/wrangler/src/kv/index.ts Co-authored-by: emily-shen <[email protected]> * thomasgauvin: add dependent changes from pr comments * thomasgauvin: last nit tests from pr comments fix --------- Co-authored-by: emily-shen <[email protected]>
1 parent 81c9865 commit 9f0c175

File tree

6 files changed

+300
-0
lines changed

6 files changed

+300
-0
lines changed

‎.changeset/slimy-coins-create.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"wrangler": minor
3+
---
4+
5+
Added rename namespace command to Workers KV

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ describe("wrangler", () => {
221221
wrangler kv namespace create <namespace> Create a new namespace
222222
wrangler kv namespace list Output a list of all KV namespaces associated with your account id
223223
wrangler kv namespace delete Delete a given namespace.
224+
wrangler kv namespace rename [old-name] Rename a KV namespace
224225
225226
GLOBAL FLAGS
226227
-c, --config Path to Wrangler configuration file [string]

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

Lines changed: 180 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,186 @@ describe("wrangler", () => {
379379
expect(requests.count).toEqual(1);
380380
});
381381
});
382+
383+
describe("rename", () => {
384+
function mockUpdateRequest(
385+
expectedNamespaceId: string,
386+
expectedTitle: string
387+
) {
388+
const requests = { count: 0 };
389+
msw.use(
390+
http.put(
391+
"*/accounts/:accountId/storage/kv/namespaces/:namespaceId",
392+
async ({ request, params }) => {
393+
requests.count++;
394+
expect(params.accountId).toEqual("some-account-id");
395+
expect(params.namespaceId).toEqual(expectedNamespaceId);
396+
const body = (await request.json()) as Record<string, string>;
397+
expect(body.title).toEqual(expectedTitle);
398+
return HttpResponse.json(
399+
createFetchResult({
400+
id: expectedNamespaceId,
401+
title: expectedTitle,
402+
}),
403+
{ status: 200 }
404+
);
405+
},
406+
{ once: true }
407+
)
408+
);
409+
return requests;
410+
}
411+
412+
function mockListRequestForRename(namespaces: KVNamespaceInfo[]) {
413+
const requests = { count: 0 };
414+
msw.use(
415+
http.get(
416+
"*/accounts/:accountId/storage/kv/namespaces",
417+
async ({ request, params }) => {
418+
const url = new URL(request.url);
419+
requests.count++;
420+
expect(params.accountId).toEqual("some-account-id");
421+
expect(url.searchParams.get("per_page")).toEqual("100");
422+
expect(url.searchParams.get("order")).toEqual("title");
423+
expect(url.searchParams.get("direction")).toEqual("asc");
424+
expect(url.searchParams.get("page")).toEqual(`${requests.count}`);
425+
426+
const pageSize = Number(url.searchParams.get("per_page"));
427+
const page = Number(url.searchParams.get("page"));
428+
return HttpResponse.json(
429+
createFetchResult(
430+
namespaces.slice((page - 1) * pageSize, page * pageSize)
431+
)
432+
);
433+
}
434+
)
435+
);
436+
return requests;
437+
}
438+
439+
it("should display help for rename command", async () => {
440+
await expect(
441+
runWrangler("kv namespace rename --help")
442+
).resolves.toBeUndefined();
443+
444+
expect(std.out).toMatchInlineSnapshot(`
445+
"wrangler kv namespace rename [old-name]
446+
447+
Rename a KV namespace
448+
449+
POSITIONALS
450+
old-name The current name (title) of the namespace to rename [string]
451+
452+
GLOBAL FLAGS
453+
-c, --config Path to Wrangler configuration file [string]
454+
--cwd Run as if Wrangler was started in the specified directory instead of the current working directory [string]
455+
-e, --env Environment to use for operations, and for selecting .env and .dev.vars files [string]
456+
-h, --help Show help [boolean]
457+
-v, --version Show version number [boolean]
458+
459+
OPTIONS
460+
--namespace-id The id of the namespace to rename [string]
461+
--new-name The new name for the namespace [string] [required]"
462+
`);
463+
});
464+
465+
it("should error if neither name nor namespace-id is provided", async () => {
466+
await expect(
467+
runWrangler("kv namespace rename --new-name new-name")
468+
).rejects.toThrowErrorMatchingInlineSnapshot(
469+
`[Error: Either old-name (as first argument) or --namespace-id must be specified]`
470+
);
471+
});
472+
473+
it("should error if new-name is not provided", async () => {
474+
await expect(
475+
runWrangler("kv namespace rename")
476+
).rejects.toThrowErrorMatchingInlineSnapshot(
477+
`[Error: Missing required argument: new-name]`
478+
);
479+
});
480+
481+
it("should rename namespace by ID", async () => {
482+
const requests = mockUpdateRequest(
483+
"some-namespace-id",
484+
"new-namespace-name"
485+
);
486+
await runWrangler(
487+
"kv namespace rename --namespace-id some-namespace-id --new-name new-namespace-name"
488+
);
489+
expect(requests.count).toEqual(1);
490+
expect(std.out).toMatchInlineSnapshot(`
491+
"Resource location: remote
492+
Renaming KV namespace some-namespace-id to \\"new-namespace-name\\".
493+
✨ Successfully renamed namespace to \\"new-namespace-name\\""
494+
`);
495+
});
496+
497+
it("should rename namespace by old name", async () => {
498+
const listRequests = mockListRequestForRename([
499+
{ id: "some-namespace-id", title: "old-namespace-name" },
500+
{ id: "other-namespace-id", title: "other-namespace" },
501+
]);
502+
const updateRequests = mockUpdateRequest(
503+
"some-namespace-id",
504+
"new-namespace-name"
505+
);
506+
507+
await runWrangler(
508+
"kv namespace rename old-namespace-name --new-name new-namespace-name"
509+
);
510+
511+
expect(listRequests.count).toEqual(1);
512+
expect(updateRequests.count).toEqual(1);
513+
expect(std.out).toMatchInlineSnapshot(`
514+
"Resource location: remote
515+
Renaming KV namespace some-namespace-id to \\"new-namespace-name\\".
516+
✨ Successfully renamed namespace to \\"new-namespace-name\\""
517+
`);
518+
});
519+
520+
it("should error if namespace with old name is not found", async () => {
521+
mockListRequestForRename([
522+
{ id: "other-namespace-id", title: "other-namespace" },
523+
]);
524+
525+
await expect(
526+
runWrangler(
527+
"kv namespace rename nonexistent-name --new-name new-name"
528+
)
529+
).rejects.toThrowErrorMatchingInlineSnapshot(
530+
`[Error: No namespace found with the name "nonexistent-name". Use --namespace-id instead or check available namespaces with "wrangler kv namespace list".]`
531+
);
532+
});
533+
534+
it("should error if namespace ID does not exist", async () => {
535+
// Mock a 404 response for the namespace ID
536+
msw.use(
537+
http.put(
538+
"*/accounts/:accountId/storage/kv/namespaces/:namespaceId",
539+
({ params }) => {
540+
expect(params.accountId).toEqual("some-account-id");
541+
expect(params.namespaceId).toEqual("nonexistent-id");
542+
return HttpResponse.json(
543+
createFetchResult(null, false, [
544+
{ code: 10009, message: "Unknown namespace." },
545+
]),
546+
{ status: 404 }
547+
);
548+
},
549+
{ once: true }
550+
)
551+
);
552+
553+
await expect(
554+
runWrangler(
555+
"kv namespace rename --namespace-id nonexistent-id --new-name new-name"
556+
)
557+
).rejects.toThrowErrorMatchingInlineSnapshot(
558+
`[APIError: A request to the Cloudflare API (/accounts/some-account-id/storage/kv/namespaces/nonexistent-id) failed.]`
559+
);
560+
});
561+
});
382562
});
383563

384564
describe("kv key", () => {

‎packages/wrangler/src/index.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ import {
100100
kvNamespaceDeleteCommand,
101101
kvNamespaceListCommand,
102102
kvNamespaceNamespace,
103+
kvNamespaceRenameCommand,
103104
} from "./kv";
104105
import { logBuildFailure, logger, LOGGER_LEVELS } from "./logger";
105106
import { getMetricsDispatcher } from "./metrics";
@@ -667,6 +668,10 @@ export function createCLIParser(argv: string[]) {
667668
command: "wrangler kv namespace delete",
668669
definition: kvNamespaceDeleteCommand,
669670
},
671+
{
672+
command: "wrangler kv namespace rename",
673+
definition: kvNamespaceRenameCommand,
674+
},
670675
{ command: "wrangler kv key put", definition: kvKeyPutCommand },
671676
{ command: "wrangler kv key list", definition: kvKeyListCommand },
672677
{ command: "wrangler kv key get", definition: kvKeyGetCommand },

‎packages/wrangler/src/kv/helpers.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,32 @@ export async function listKVNamespaceKeys(
118118
);
119119
}
120120

121+
/**
122+
* Update a KV namespace title under the given `accountId` with the given `namespaceId`.
123+
*
124+
* @returns the updated namespace information.
125+
*/
126+
export async function updateKVNamespace(
127+
complianceConfig: ComplianceConfig,
128+
accountId: string,
129+
namespaceId: string,
130+
title: string
131+
): Promise<KVNamespaceInfo> {
132+
return await fetchResult<KVNamespaceInfo>(
133+
complianceConfig,
134+
`/accounts/${accountId}/storage/kv/namespaces/${namespaceId}`,
135+
{
136+
method: "PUT",
137+
headers: {
138+
"Content-Type": "application/json",
139+
},
140+
body: JSON.stringify({
141+
title,
142+
}),
143+
}
144+
);
145+
}
146+
121147
export async function deleteKVNamespace(
122148
complianceConfig: ComplianceConfig,
123149
accountId: string,

‎packages/wrangler/src/kv/index.ts‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { strict as assert } from "node:assert";
12
import { Blob } from "node:buffer";
23
import { arrayBuffer } from "node:stream/consumers";
34
import { StringDecoder } from "node:string_decoder";
@@ -27,6 +28,7 @@ import {
2728
putKVBulkKeyValue,
2829
putKVKeyValue,
2930
unexpectedKVKeyValueProps,
31+
updateKVNamespace,
3032
usingLocalNamespace,
3133
} from "./helpers";
3234
import type { EventNames } from "../metrics";
@@ -217,6 +219,87 @@ export const kvNamespaceDeleteCommand = createCommand({
217219
},
218220
});
219221

222+
export const kvNamespaceRenameCommand = createCommand({
223+
metadata: {
224+
description: "Rename a KV namespace",
225+
status: "stable",
226+
owner: "Product: KV",
227+
},
228+
positionalArgs: ["old-name"],
229+
args: {
230+
"old-name": {
231+
type: "string",
232+
describe: "The current name (title) of the namespace to rename",
233+
},
234+
"namespace-id": {
235+
type: "string",
236+
describe: "The id of the namespace to rename",
237+
},
238+
"new-name": {
239+
type: "string",
240+
describe: "The new name for the namespace",
241+
demandOption: true,
242+
},
243+
},
244+
245+
validateArgs(args) {
246+
// Check if both name and namespace-id are provided
247+
if (args.oldName && args.namespaceId) {
248+
throw new CommandLineArgsError(
249+
"Cannot specify both old-name and --namespace-id. Use either old-name (as first argument) or --namespace-id flag, not both."
250+
);
251+
}
252+
253+
// Require either old-name or namespace-id
254+
if (!args.namespaceId && !args.oldName) {
255+
throw new CommandLineArgsError(
256+
"Either old-name (as first argument) or --namespace-id must be specified"
257+
);
258+
}
259+
260+
// Validate new-name length (API limit is 512 characters)
261+
if (args.newName && args.newName.length > 512) {
262+
throw new CommandLineArgsError(
263+
`new-name must be 512 characters or less (current: ${args.newName.length})`
264+
);
265+
}
266+
},
267+
268+
async handler(args) {
269+
const config = readConfig(args);
270+
printResourceLocation("remote");
271+
const accountId = await requireAuth(config);
272+
273+
let namespaceId = args.namespaceId;
274+
275+
// If no namespace ID provided, find it by current name
276+
if (!namespaceId && args.oldName) {
277+
const namespaces = await listKVNamespaces(config, accountId);
278+
const namespace = namespaces.find((ns) => ns.title === args.oldName);
279+
280+
if (!namespace) {
281+
throw new UserError(
282+
`No namespace found with the name "${args.oldName}". ` +
283+
`Use --namespace-id instead or check available namespaces with "wrangler kv namespace list".`
284+
);
285+
}
286+
namespaceId = namespace.id;
287+
}
288+
289+
assert(namespaceId, "namespaceId should be defined");
290+
logger.log(`Renaming KV namespace ${namespaceId} to "${args.newName}".`);
291+
const updatedNamespace = await updateKVNamespace(
292+
config,
293+
accountId,
294+
namespaceId,
295+
args.newName
296+
);
297+
logger.log(
298+
`✨ Successfully renamed namespace to "${updatedNamespace.title}"`
299+
);
300+
},
301+
});
302+
220303
export const kvKeyPutCommand = createCommand({
221304
metadata: {
222305
description: "Write a single key/value pair to the given namespace",

0 commit comments

Comments
 (0)