Skip to content

Commit 0111edb

Browse files
garvit-guptagarvit-gupta
authored
[Vectorize] Replace the Vectorize Beta banner with the GA Announcement Banner (#6999)
1 parent 924ec18 commit 0111edb

17 files changed

+60
-39
lines changed

‎.changeset/early-parents-run.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"wrangler": minor
3+
---
4+
5+
docs: Vectorize GA Announcement Banner

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

+17-8
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,10 @@ describe("vectorize help", () => {
4646
-v, --version Show version number [boolean]
4747
4848
--------------------
49-
📣 Vectorize is currently in open beta
49+
📣 Vectorize is now Generally Available.
5050
📣 Please use the '--deprecated-v1' flag to create, get, list, delete and insert vectors into legacy Vectorize indexes
51-
📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
51+
📣 Creation of legacy Vectorize indexes will be blocked by December 2024. Other operations will continue to function
52+
📣 See the Vectorize docs to get started: https://developers.cloudflare.com/vectorize
5253
📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
5354
📣 To give feedback, visit https://discord.cloudflare.com/
5455
--------------------"
@@ -94,9 +95,10 @@ describe("vectorize help", () => {
9495
-v, --version Show version number [boolean]
9596
9697
--------------------
97-
📣 Vectorize is currently in open beta
98+
📣 Vectorize is now Generally Available.
9899
📣 Please use the '--deprecated-v1' flag to create, get, list, delete and insert vectors into legacy Vectorize indexes
99-
📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
100+
📣 Creation of legacy Vectorize indexes will be blocked by December 2024. Other operations will continue to function
101+
📣 See the Vectorize docs to get started: https://developers.cloudflare.com/vectorize
100102
📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
101103
📣 To give feedback, visit https://discord.cloudflare.com/
102104
--------------------"
@@ -134,9 +136,10 @@ describe("vectorize help", () => {
134136
--deprecated-v1 Fetch a deprecated V1 Vectorize index. This must be enabled if the index was created with V1 option. [boolean] [default: false]
135137
136138
--------------------
137-
📣 Vectorize is currently in open beta
139+
📣 Vectorize is now Generally Available.
138140
📣 Please use the '--deprecated-v1' flag to create, get, list, delete and insert vectors into legacy Vectorize indexes
139-
📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
141+
📣 Creation of legacy Vectorize indexes will be blocked by December 2024. Other operations will continue to function
142+
📣 See the Vectorize docs to get started: https://developers.cloudflare.com/vectorize
140143
📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
141144
📣 To give feedback, visit https://discord.cloudflare.com/
142145
--------------------"
@@ -186,9 +189,10 @@ describe("vectorize help", () => {
186189
Filter the query results.
187190
188191
--------------------
189-
📣 Vectorize is currently in open beta
192+
📣 Vectorize is now Generally Available.
190193
📣 Please use the '--deprecated-v1' flag to create, get, list, delete and insert vectors into legacy Vectorize indexes
191-
📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
194+
📣 Creation of legacy Vectorize indexes will be blocked by December 2024. Other operations will continue to function
195+
📣 See the Vectorize docs to get started: https://developers.cloudflare.com/vectorize
192196
📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
193197
📣 To give feedback, visit https://discord.cloudflare.com/
194198
--------------------"
@@ -221,6 +225,11 @@ describe("vectorize commands", () => {
221225
await runWrangler(
222226
"vectorize create some-index --dimensions=768 --metric=cosine --deprecated-v1=true"
223227
);
228+
expect(std.warn).toMatchInlineSnapshot(`
229+
"▲ [WARNING] Creation of legacy Vectorize indexes will be blocked by December 2024
230+
231+
"
232+
`);
224233
expect(std.out).toMatchInlineSnapshot(`
225234
"🚧 Creating index: 'some-index'
226235
✅ Successfully created a new Vectorize index: 'test-index'

‎packages/wrangler/src/vectorize/common.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
import { logger } from "../logger";
22
import type { Interface as RLInterface } from "node:readline";
33

4-
export const vectorizeBetaWarning = `--------------------
5-
📣 Vectorize is currently in open beta
4+
export const vectorizeGABanner = `--------------------
5+
📣 Vectorize is now Generally Available.
66
📣 Please use the '--deprecated-v1' flag to create, get, list, delete and insert vectors into legacy Vectorize indexes
7-
📣 See the Vectorize docs for how to get started and known issues: https://developers.cloudflare.com/vectorize
7+
📣 Creation of legacy Vectorize indexes will be blocked by December 2024. Other operations will continue to function
8+
📣 See the Vectorize docs to get started: https://developers.cloudflare.com/vectorize
89
📣 Please report any bugs to https://github.com/cloudflare/workers-sdk/issues/new/choose
910
📣 To give feedback, visit https://discord.cloudflare.com/
1011
--------------------

‎packages/wrangler/src/vectorize/create.ts

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { stringify } from "@iarna/toml";
22
import { readConfig } from "../config";
33
import { logger } from "../logger";
44
import { createIndex } from "./client";
5-
import { deprecatedV1DefaultFlag, vectorizeBetaWarning } from "./common";
5+
import { deprecatedV1DefaultFlag, vectorizeGABanner } from "./common";
66
import type {
77
CommonYargsArgv,
88
StrictYargsOptionsToInterface,
@@ -62,7 +62,7 @@ export function options(yargs: CommonYargsArgv) {
6262
describe:
6363
"Create a deprecated Vectorize V1 index. This is not recommended and indexes created with this option need all other Vectorize operations to have this option enabled.",
6464
})
65-
.epilogue(vectorizeBetaWarning);
65+
.epilogue(vectorizeGABanner);
6666
}
6767

6868
export async function handler(
@@ -90,6 +90,12 @@ export async function handler(
9090
return;
9191
}
9292

93+
if (args.deprecatedV1) {
94+
logger.warn(
95+
"Creation of legacy Vectorize indexes will be blocked by December 2024"
96+
);
97+
}
98+
9399
const index = {
94100
name: args.name,
95101
description: args.description,

‎packages/wrangler/src/vectorize/createMetadataIndex.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { createMetadataIndex } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -30,7 +30,7 @@ export function options(yargs: CommonYargsArgv) {
3030
description:
3131
"The type of metadata property to index. Valid types are 'string', 'number' and 'boolean'.",
3232
})
33-
.epilogue(vectorizeBetaWarning);
33+
.epilogue(vectorizeGABanner);
3434
}
3535

3636
export async function handler(

‎packages/wrangler/src/vectorize/delete.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { readConfig } from "../config";
22
import { confirm } from "../dialogs";
33
import { logger } from "../logger";
44
import { deleteIndex } from "./client";
5-
import { deprecatedV1DefaultFlag, vectorizeBetaWarning } from "./common";
5+
import { deprecatedV1DefaultFlag, vectorizeGABanner } from "./common";
66
import type {
77
CommonYargsArgv,
88
StrictYargsOptionsToInterface,
@@ -26,7 +26,7 @@ export function options(yargs: CommonYargsArgv) {
2626
default: deprecatedV1DefaultFlag,
2727
describe: "Delete a deprecated Vectorize V1 index.",
2828
})
29-
.epilogue(vectorizeBetaWarning);
29+
.epilogue(vectorizeGABanner);
3030
}
3131

3232
export async function handler(

‎packages/wrangler/src/vectorize/deleteByIds.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { deleteByIds } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -24,7 +24,7 @@ export function options(yargs: CommonYargsArgv) {
2424
coerce: (arg: unknown[]) => arg.map((a) => a?.toString() ?? ""),
2525
},
2626
})
27-
.epilogue(vectorizeBetaWarning);
27+
.epilogue(vectorizeGABanner);
2828
}
2929

3030
export async function handler(

‎packages/wrangler/src/vectorize/deleteMetadataIndex.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { deleteMetadataIndex } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -20,7 +20,7 @@ export function options(yargs: CommonYargsArgv) {
2020
demandOption: true,
2121
description: "The name of the metadata property to index.",
2222
})
23-
.epilogue(vectorizeBetaWarning);
23+
.epilogue(vectorizeGABanner);
2424
}
2525

2626
export async function handler(

‎packages/wrangler/src/vectorize/get.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { getIndex } from "./client";
4-
import { deprecatedV1DefaultFlag, vectorizeBetaWarning } from "./common";
4+
import { deprecatedV1DefaultFlag, vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -25,7 +25,7 @@ export function options(yargs: CommonYargsArgv) {
2525
describe:
2626
"Fetch a deprecated V1 Vectorize index. This must be enabled if the index was created with V1 option.",
2727
})
28-
.epilogue(vectorizeBetaWarning);
28+
.epilogue(vectorizeGABanner);
2929
}
3030

3131
export async function handler(

‎packages/wrangler/src/vectorize/getByIds.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { getByIds } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -24,7 +24,7 @@ export function options(yargs: CommonYargsArgv) {
2424
coerce: (arg: unknown[]) => arg.map((a) => a?.toString() ?? ""),
2525
},
2626
})
27-
.epilogue(vectorizeBetaWarning);
27+
.epilogue(vectorizeGABanner);
2828
}
2929

3030
export async function handler(

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { vectorizeBetaWarning } from "./common";
1+
import { vectorizeGABanner } from "./common";
22
import { handler as createHandler, options as createOptions } from "./create";
33
import {
44
handler as createMetadataIndexHandler,
@@ -104,5 +104,5 @@ export function vectorize(yargs: CommonYargsArgv) {
104104
deleteMetadataIndexOptions,
105105
deleteMetadataIndexHandler
106106
)
107-
.epilogue(vectorizeBetaWarning);
107+
.epilogue(vectorizeGABanner);
108108
}

‎packages/wrangler/src/vectorize/info.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { indexInfo } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -19,7 +19,7 @@ export function options(yargs: CommonYargsArgv) {
1919
type: "boolean",
2020
default: false,
2121
})
22-
.epilogue(vectorizeBetaWarning);
22+
.epilogue(vectorizeGABanner);
2323
}
2424

2525
export async function handler(

‎packages/wrangler/src/vectorize/insert.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {
1111
VECTORIZE_MAX_UPSERT_VECTOR_RECORDS,
1212
VECTORIZE_UPSERT_BATCH_SIZE,
1313
VECTORIZE_V1_MAX_BATCH_SIZE,
14-
vectorizeBetaWarning,
14+
vectorizeGABanner,
1515
} from "./common";
1616
import type {
1717
CommonYargsArgv,
@@ -50,7 +50,7 @@ export function options(yargs: CommonYargsArgv) {
5050
"Insert into a deprecated V1 Vectorize index. This must be enabled if the index was created with the V1 option.",
5151
},
5252
})
53-
.epilogue(vectorizeBetaWarning);
53+
.epilogue(vectorizeGABanner);
5454
}
5555

5656
export async function handler(

‎packages/wrangler/src/vectorize/list.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { listIndexes } from "./client";
4-
import { deprecatedV1DefaultFlag, vectorizeBetaWarning } from "./common";
4+
import { deprecatedV1DefaultFlag, vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -19,7 +19,7 @@ export function options(yargs: CommonYargsArgv) {
1919
default: deprecatedV1DefaultFlag,
2020
describe: "List deprecated Vectorize V1 indexes for your account.",
2121
})
22-
.epilogue(vectorizeBetaWarning);
22+
.epilogue(vectorizeGABanner);
2323
}
2424

2525
export async function handler(

‎packages/wrangler/src/vectorize/listMetadataIndex.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { listMetadataIndex } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -19,7 +19,7 @@ export function options(yargs: CommonYargsArgv) {
1919
type: "boolean",
2020
default: false,
2121
})
22-
.epilogue(vectorizeBetaWarning);
22+
.epilogue(vectorizeGABanner);
2323
}
2424

2525
export async function handler(

‎packages/wrangler/src/vectorize/query.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { readConfig } from "../config";
22
import { logger } from "../logger";
33
import { queryIndex } from "./client";
4-
import { vectorizeBetaWarning } from "./common";
4+
import { vectorizeGABanner } from "./common";
55
import type {
66
CommonYargsArgv,
77
StrictYargsOptionsToInterface,
@@ -85,7 +85,7 @@ export function options(yargs: CommonYargsArgv) {
8585
" Filter the query results.",
8686
],
8787
])
88-
.epilogue(vectorizeBetaWarning);
88+
.epilogue(vectorizeGABanner);
8989
}
9090

9191
export async function handler(

‎packages/wrangler/src/vectorize/upsert.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import {
88
getBatchFromFile,
99
VECTORIZE_MAX_BATCH_SIZE,
1010
VECTORIZE_MAX_UPSERT_VECTOR_RECORDS,
11-
vectorizeBetaWarning,
11+
vectorizeGABanner,
1212
} from "./common";
1313
import type {
1414
CommonYargsArgv,
@@ -41,7 +41,7 @@ export function options(yargs: CommonYargsArgv) {
4141
default: false,
4242
},
4343
})
44-
.epilogue(vectorizeBetaWarning);
44+
.epilogue(vectorizeGABanner);
4545
}
4646

4747
export async function handler(

0 commit comments

Comments
 (0)