Skip to content

Commit 9075be9

Browse files
AbhiPrasadAbhiPrasad
committed
test(e2e): Add cloudflare workers e2e test
1 parent 2d43b64 commit 9075be9

File tree

11 files changed

+331
-0
lines changed

11 files changed

+331
-0
lines changed

‎.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1046,6 +1046,8 @@ jobs:
10461046
exclude:
10471047
- is_dependabot: true
10481048
test-application: 'cloudflare-astro'
1049+
- is_dependabot: true
1050+
test-application: 'cloudflare-workers'
10491051

10501052
steps:
10511053
- name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
@@ -1125,6 +1127,7 @@ jobs:
11251127
test-application:
11261128
[
11271129
'cloudflare-astro',
1130+
'cloudflare-workers',
11281131
'react-send-to-sentry',
11291132
'node-express-send-to-sentry',
11301133
'debug-id-sourcemaps',

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/.npmrc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
@sentry:registry=http://127.0.0.1:4873
2+
@sentry-internal:registry=http://127.0.0.1:4873

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/.prettierrc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"printWidth": 140,
3+
"singleQuote": true,
4+
"semi": true,
5+
"useTabs": true
6+
}

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"name": "cloudflare-workers",
3+
"version": "0.0.0",
4+
"private": true,
5+
"scripts": {
6+
"deploy": "wrangler deploy",
7+
"dev": "wrangler dev --var E2E_TEST_DSN=$E2E_TEST_DSN",
8+
"build": "wrangler deploy --dry-run --var E2E_TEST_DSN=$E2E_TEST_DSN",
9+
"test": "vitest",
10+
"typecheck": "tsc --noEmit",
11+
"cf-typegen": "wrangler types",
12+
"test:build": "pnpm install && pnpm build",
13+
"test:assert": "pnpm typecheck"
14+
},
15+
"dependencies": {
16+
"@sentry/cloudflare": "latest || *"
17+
},
18+
"devDependencies": {
19+
"@cloudflare/vitest-pool-workers": "^0.4.5",
20+
"@cloudflare/workers-types": "^4.20240725.0",
21+
"typescript": "^5.5.2",
22+
"vitest": "1.5.0",
23+
"wrangler": "^3.60.3"
24+
},
25+
"volta": {
26+
"extends": "../../package.json"
27+
}
28+
}

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/**
2+
* Welcome to Cloudflare Workers! This is your first worker.
3+
*
4+
* - Run `npm run dev` in your terminal to start a development server
5+
* - Open a browser tab at http://localhost:8787/ to see your worker in action
6+
* - Run `npm run deploy` to publish your worker
7+
*
8+
* Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
9+
* `Env` object can be regenerated with `npm run cf-typegen`.
10+
*
11+
* Learn more at https://developers.cloudflare.com/workers/
12+
*/
13+
import * as Sentry from '@sentry/cloudflare';
14+
15+
export default Sentry.withSentry(
16+
(env: Env) => ({
17+
dsn: env.E2E_TEST_DSN,
18+
// Set tracesSampleRate to 1.0 to capture 100% of spans for tracing.
19+
tracesSampleRate: 1.0,
20+
}),
21+
{
22+
async fetch(request, env, ctx) {
23+
return new Response('Hello World!');
24+
},
25+
} satisfies ExportedHandler<Env>,
26+
);

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/test/index.spec.ts

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
import { describe, expect, it } from 'vitest';
2+
import worker from '../src/index';
3+
// test/index.spec.ts
4+
import { SELF, createExecutionContext, env, waitOnExecutionContext } from 'cloudflare:test';
5+
6+
// For now, you'll need to do something like this to get a correctly-typed
7+
// `Request` to pass to `worker.fetch()`.
8+
const IncomingRequest = Request<unknown, IncomingRequestCfProperties>;
9+
10+
describe('Hello World worker', () => {
11+
it('responds with Hello World! (unit style)', async () => {
12+
const request = new IncomingRequest('http://example.com');
13+
// Create an empty context to pass to `worker.fetch()`.
14+
const ctx = createExecutionContext();
15+
const response = await worker.fetch(request, env, ctx);
16+
// Wait for all `Promise`s passed to `ctx.waitUntil()` to settle before running test assertions
17+
await waitOnExecutionContext(ctx);
18+
expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
19+
});
20+
21+
it('responds with Hello World! (integration style)', async () => {
22+
const response = await SELF.fetch('https://example.com');
23+
expect(await response.text()).toMatchInlineSnapshot(`"Hello World!"`);
24+
});
25+
});

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/test/tsconfig.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": "../tsconfig.json",
3+
"compilerOptions": {
4+
"types": ["@cloudflare/workers-types/experimental", "@cloudflare/vitest-pool-workers"]
5+
},
6+
"include": ["./**/*.ts", "../src/env.d.ts"],
7+
"exclude": []
8+
}

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig.json to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Enable incremental compilation */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2021" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15+
"lib": ["es2021"] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
16+
"jsx": "react-jsx" /* Specify what JSX code is generated. */,
17+
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
22+
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
26+
/* Modules */
27+
"module": "es2022" /* Specify what module code is generated. */,
28+
// "rootDir": "./", /* Specify the root folder within your source files. */
29+
"moduleResolution": "Bundler" /* Specify how TypeScript looks up a file from a given module specifier. */,
30+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
31+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
32+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
33+
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
34+
"types": [
35+
"@cloudflare/workers-types/2023-07-01"
36+
] /* Specify type package names to be included without being referenced in a source file. */,
37+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
38+
"resolveJsonModule": true /* Enable importing .json files */,
39+
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
40+
41+
/* JavaScript Support */
42+
"allowJs": true /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */,
43+
"checkJs": false /* Enable error reporting in type-checked JavaScript files. */,
44+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
45+
46+
/* Emit */
47+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
48+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
49+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
50+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
51+
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
52+
// "outDir": "./", /* Specify an output folder for all emitted files. */
53+
// "removeComments": true, /* Disable emitting comments. */
54+
"noEmit": true /* Disable emitting files from a compilation. */,
55+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
56+
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
57+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
58+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
59+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
60+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
61+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
62+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
63+
// "newLine": "crlf", /* Set the newline character for emitting files. */
64+
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
65+
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
66+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
67+
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
68+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
69+
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
70+
71+
/* Interop Constraints */
72+
"isolatedModules": true /* Ensure that each file can be safely transpiled without relying on other imports. */,
73+
"allowSyntheticDefaultImports": true /* Allow 'import x from y' when a module doesn't have a default export. */,
74+
// "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
75+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
76+
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
77+
78+
/* Type Checking */
79+
"strict": true /* Enable all strict type-checking options. */,
80+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
81+
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
82+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
83+
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
84+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
85+
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
86+
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
87+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
88+
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
89+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
90+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
91+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
92+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
93+
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
94+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
95+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
96+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
97+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
98+
99+
/* Completeness */
100+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
101+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
102+
},
103+
"exclude": ["test"],
104+
"include": ["worker-configuration.d.ts", "src/**/*.ts"]
105+
}

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/vitest.config.mts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { defineWorkersConfig } from '@cloudflare/vitest-pool-workers/config';
2+
3+
export default defineWorkersConfig({
4+
test: {
5+
poolOptions: {
6+
workers: {
7+
wrangler: { configPath: './wrangler.toml' },
8+
},
9+
},
10+
},
11+
});

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/worker-configuration.d.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// Generated by Wrangler on Mon Jul 29 2024 21:44:31 GMT-0400 (Eastern Daylight Time)
2+
// by running `wrangler types`
3+
4+
interface Env {
5+
E2E_TEST_DSN: '';
6+
}

‎dev-packages/e2e-tests/test-applications/cloudflare-workers/wrangler.toml

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
#:schema node_modules/wrangler/config-schema.json
2+
name = "cloudflare-workers"
3+
main = "src/index.ts"
4+
compatibility_date = "2024-07-25"
5+
compatibility_flags = ["nodejs_compat"]
6+
7+
# [vars]
8+
# E2E_TEST_DSN = ""
9+
10+
# Automatically place your workloads in an optimal location to minimize latency.
11+
# If you are running back-end logic in a Worker, running it closer to your back-end infrastructure
12+
# rather than the end user may result in better performance.
13+
# Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
14+
# [placement]
15+
# mode = "smart"
16+
17+
# Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
18+
# Docs:
19+
# - https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
20+
# Note: Use secrets to store sensitive data.
21+
# - https://developers.cloudflare.com/workers/configuration/secrets/
22+
# [vars]
23+
# MY_VARIABLE = "production_value"
24+
25+
# Bind the Workers AI model catalog. Run machine learning models, powered by serverless GPUs, on Cloudflare’s global network
26+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#workers-ai
27+
# [ai]
28+
# binding = "AI"
29+
30+
# Bind an Analytics Engine dataset. Use Analytics Engine to write analytics within your Pages Function.
31+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#analytics-engine-datasets
32+
# [[analytics_engine_datasets]]
33+
# binding = "MY_DATASET"
34+
35+
# Bind a headless browser instance running on Cloudflare's global network.
36+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#browser-rendering
37+
# [browser]
38+
# binding = "MY_BROWSER"
39+
40+
# Bind a D1 database. D1 is Cloudflare’s native serverless SQL database.
41+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#d1-databases
42+
# [[d1_databases]]
43+
# binding = "MY_DB"
44+
# database_name = "my-database"
45+
# database_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
46+
47+
# Bind a dispatch namespace. Use Workers for Platforms to deploy serverless functions programmatically on behalf of your customers.
48+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#dispatch-namespace-bindings-workers-for-platforms
49+
# [[dispatch_namespaces]]
50+
# binding = "MY_DISPATCHER"
51+
# namespace = "my-namespace"
52+
53+
# Bind a Durable Object. Durable objects are a scale-to-zero compute primitive based on the actor model.
54+
# Durable Objects can live for as long as needed. Use these when you need a long-running "server", such as in realtime apps.
55+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#durable-objects
56+
# [[durable_objects.bindings]]
57+
# name = "MY_DURABLE_OBJECT"
58+
# class_name = "MyDurableObject"
59+
60+
# Durable Object migrations.
61+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#migrations
62+
# [[migrations]]
63+
# tag = "v1"
64+
# new_classes = ["MyDurableObject"]
65+
66+
# Bind a Hyperdrive configuration. Use to accelerate access to your existing databases from Cloudflare Workers.
67+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#hyperdrive
68+
# [[hyperdrive]]
69+
# binding = "MY_HYPERDRIVE"
70+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
71+
72+
# Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
73+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#kv-namespaces
74+
# [[kv_namespaces]]
75+
# binding = "MY_KV_NAMESPACE"
76+
# id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
77+
78+
# Bind an mTLS certificate. Use to present a client certificate when communicating with another service.
79+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#mtls-certificates
80+
# [[mtls_certificates]]
81+
# binding = "MY_CERTIFICATE"
82+
# certificate_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
83+
84+
# Bind a Queue producer. Use this binding to schedule an arbitrary task that may be processed later by a Queue consumer.
85+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
86+
# [[queues.producers]]
87+
# binding = "MY_QUEUE"
88+
# queue = "my-queue"
89+
90+
# Bind a Queue consumer. Queue Consumers can retrieve tasks scheduled by Producers to act on them.
91+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#queues
92+
# [[queues.consumers]]
93+
# queue = "my-queue"
94+
95+
# Bind an R2 Bucket. Use R2 to store arbitrarily large blobs of data, such as files.
96+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#r2-buckets
97+
# [[r2_buckets]]
98+
# binding = "MY_BUCKET"
99+
# bucket_name = "my-bucket"
100+
101+
# Bind another Worker service. Use this binding to call another Worker without network overhead.
102+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
103+
# [[services]]
104+
# binding = "MY_SERVICE"
105+
# service = "my-service"
106+
107+
# Bind a Vectorize index. Use to store and query vector embeddings for semantic search, classification and other vector search use-cases.
108+
# Docs: https://developers.cloudflare.com/workers/wrangler/configuration/#vectorize-indexes
109+
# [[vectorize]]
110+
# binding = "MY_INDEX"
111+
# index_name = "my-index"

0 commit comments

Comments
 (0)