backport vectorize e2e changes (#8520)

* Use a shared Vectorize index for the Vectorize E2E tests (#8492)

* shared resource

* address comments

* maybe trigger action?

* remove v3 warning

* normalise types e2e output

---------

Co-authored-by: Somhairle MacLeòid <[email protected]>

Author: emily-shen

.github/workflows/test-and-check.yml

@@ -2,6 +2,17 @@ name: CI
 
 on:
   pull_request:
+    types:
+      [
+        opened,
+        synchronize,
+        reopened,
+        labeled,
+        unlabeled,
+        edited,
+        ready_for_review,
+        converted_to_draft,
+      ]
 
 jobs:
   add-to-project:

packages/wrangler/e2e/dev-with-resources.test.ts

@@ -519,8 +519,14 @@ describe.sequential.each(RUNTIMES)("Bindings: $flags", ({ runtime, flags }) => {
 		}
 	});
 
+	// Refer to https://github.com/cloudflare/workers-sdk/pull/8492 for full context on why this test does different things to the others.
+	// In particular, it uses a shared resource across test runs
 	it("exposes Vectorize bindings", async () => {
-		const name = await helper.vectorize(32, "euclidean");
+		const name = await helper.vectorize(
+			32,
+			"euclidean",
+			"well-known-vectorize"
+		);
 
 		await helper.seed({
 			"wrangler.toml": dedent`
@@ -531,39 +537,37 @@ describe.sequential.each(RUNTIMES)("Bindings: $flags", ({ runtime, flags }) => {
 				binding = "VECTORIZE"
 				index_name = "${name}"
 				`,
-			"src/index.ts": dedent`
+			"src/index.ts": dedent/*javascript*/ `
 				export interface Env {
 					VECTORIZE: Vectorize;
 				}
 
-				async function waitForMutation(env: Env, mutationId: string) {
-					while((await env.VECTORIZE.describe()).processedUpToMutation != mutationId) {
-						await new Promise(resolve => setTimeout(resolve, 2000));
-					}
-				}
-
 				export default {
 					async fetch(request: Request, env: Env, ctx: any) {
-						await env.VECTORIZE.insert([{"id":"a44706aa-a366-48bc-8cc1-3feffd87d548","values":[0.2321,0.8121,0.6315,0.6151,0.4121,0.1512,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"Peter Piper picked a peck of pickled peppers"}}]);
-						await env.VECTORIZE.insert([{"id":"b0daca4a-ffd8-4865-926b-e24800af2a2d","values":[0.2331,1.0125,0.6131,0.9421,0.9661,0.8121,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"She sells seashells by the sea"}}]);
-						await waitForMutation(env, (await env.VECTORIZE.upsert([{"id":"b0daca4a-ffd8-4865-926b-e24800af2a2d","values":[0.2331,1.0125,0.6131,0.9421,0.9661,0.8121,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"She sells seashells by the seashore"}}])).mutationId);
-
-						let response = "";
-						response += JSON.stringify(await env.VECTORIZE.getByIds(["a44706aa-a366-48bc-8cc1-3feffd87d548"]));
-
-						const queryVector: Array<number> = [
-							0.13, 0.25, 0.44, 0.53, 0.62, 0.41, 0.59, 0.68, 0.29, 0.82, 0.37, 0.5,
-							0.74, 0.46, 0.57, 0.64, 0.28, 0.61, 0.73, 0.35, 0.78, 0.58, 0.42, 0.32,
-							0.77, 0.65, 0.49, 0.54, 0.31, 0.29, 0.71, 0.57,
-						]; // vector of dimension 32
-						const matches = await env.VECTORIZE.query(queryVector, {
-							topK: 3,
-							returnValues: true,
-							returnMetadata: "all",
-						});
-						response += " " + matches.count;
+						const url = new URL(request.url)
+						if(url.pathname === "/insert") {
+							await env.VECTORIZE.insert([{"id":"a44706aa-a366-48bc-8cc1-3feffd87d548","values":[0.2321,0.8121,0.6315,0.6151,0.4121,0.1512,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"Peter Piper picked a peck of pickled peppers"}}]);
+							await env.VECTORIZE.insert([{"id":"b0daca4a-ffd8-4865-926b-e24800af2a2d","values":[0.2331,1.0125,0.6131,0.9421,0.9661,0.8121,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"She sells seashells by the sea"}}]);
+							await env.VECTORIZE.upsert([{"id":"b0daca4a-ffd8-4865-926b-e24800af2a2d","values":[0.2331,1.0125,0.6131,0.9421,0.9661,0.8121,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],"metadata":{"text":"She sells seashells by the seashore"}}]);
+							return new Response("inserted")
+						}
+						if(url.pathname === "/query") {
+							let response = "";
+							response += JSON.stringify(await env.VECTORIZE.getByIds(["a44706aa-a366-48bc-8cc1-3feffd87d548"]));
+
+							const queryVector: Array<number> = [
+								0.13, 0.25, 0.44, 0.53, 0.62, 0.41, 0.59, 0.68, 0.29, 0.82, 0.37, 0.5,
+								0.74, 0.46, 0.57, 0.64, 0.28, 0.61, 0.73, 0.35, 0.78, 0.58, 0.42, 0.32,
+								0.77, 0.65, 0.49, 0.54, 0.31, 0.29, 0.71, 0.57,
+							]; // vector of dimension 32
+							const matches = await env.VECTORIZE.query(queryVector, {
+								topK: 3,
+								returnValues: true,
+								returnMetadata: "all",
+							});
 
-						return new Response(response);
+							return new Response(response);
+						}
 					}
 				}
 				`,
@@ -573,10 +577,11 @@ describe.sequential.each(RUNTIMES)("Bindings: $flags", ({ runtime, flags }) => {
 			`wrangler dev ${flags} --port ${port} --inspector-port ${inspectorPort} --experimental-vectorize-bind-to-prod`
 		);
 		const { url } = await worker.waitForReady();
-		const res = await fetch(url);
+		await fetch(`${url}/insert`);
+		const res = await fetch(`${url}/query`);
 
 		await expect(res.text()).resolves.toBe(
-			`[{"id":"a44706aa-a366-48bc-8cc1-3feffd87d548","namespace":null,"metadata":{"text":"Peter Piper picked a peck of pickled peppers"},"values":[0.2321,0.8121,0.6315,0.6151,0.4121,0.1512,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}] 2`
+			`[{"id":"a44706aa-a366-48bc-8cc1-3feffd87d548","namespace":null,"metadata":{"text":"Peter Piper picked a peck of pickled peppers"},"values":[0.2321,0.8121,0.6315,0.6151,0.4121,0.1512,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}]`
 		);
 	});
 

packages/wrangler/e2e/helpers/e2e-wrangler-test.ts

@@ -112,14 +112,18 @@ export class WranglerE2ETestHelper {
 		return { id, name };
 	}
 
-	async vectorize(dimensions: number, metric: string) {
+	async vectorize(dimensions: number, metric: string, resourceName?: string) {
 		// vectorize does not have a local dev mode yet, so we don't yet support the isLocal flag here
-		const name = generateResourceName("vectorize");
-		await this.run(
-			`wrangler vectorize create ${name} --dimensions ${dimensions} --metric ${metric}`
-		);
+		const name = resourceName ?? generateResourceName("vectorize");
+		if (!resourceName) {
+			await this.run(
+				`wrangler vectorize create ${name} --dimensions ${dimensions} --metric ${metric}`
+			);
+		}
 		onTestFinished(async () => {
-			await this.run(`wrangler vectorize delete ${name}`);
+			if (!resourceName) {
+				await this.run(`wrangler vectorize delete ${name}`);
+			}
 		});
 
 		return name;

packages/wrangler/e2e/helpers/normalize.ts

@@ -26,6 +26,7 @@ export function normalizeOutput(
 		normalizeDebugLogFilepath,
 		removeLocalPort,
 		removeZeroWidthSpaces,
+		removeV3Warning,
 	];
 	for (const f of functions) {
 		stdout = f(stdout);
@@ -94,6 +95,15 @@ function removeVersionHeader(str: string): string {
 	}
 }
 
+/**
+ * Remove the Wrangler v3 out of date warning
+ */
+function removeV3Warning(str: string): string {
+	return str.replace(
+		/\s*▲ \[WARNING\] The version of Wrangler you are using is now out-of-date.\s*Please update to the latest version to prevent critical errors.\s*Run `npm install --save-dev wrangler@4` to update to the latest version.\s*After installation, run Wrangler with `npx wrangler`./,
+		""
+	);
+}
 /**
  * Normalize error `X` markers.
  *

packages/wrangler/e2e/types.test.ts

@@ -4,6 +4,7 @@ import path from "node:path";
 import { describe, expect, it } from "vitest";
 import { dedent } from "../src/utils/dedent";
 import { WranglerE2ETestHelper } from "./helpers/e2e-wrangler-test";
+import { normalizeOutput } from "./helpers/normalize";
 
 const seed = {
 	"wrangler.toml": dedent`
@@ -147,7 +148,7 @@ describe("types", () => {
 			`wrangler types --x-include-runtime="./types.d.ts"`
 		);
 
-		expect(output.stderr).toBe("");
+		expect(normalizeOutput(output.stderr)).toBe("");
 		expect(output.status).toBe(0);
 	});
 	it("should include header with version information in the generated types", async () => {