Skip to content

docs(cloudflare): Change onboarding script for Cloudflare Workers #105640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Jan 8, 2026
+2 −2
Merged

docs(cloudflare): Change onboarding script for Cloudflare Workers #105640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion static/app/gettingStartedDocs/node-cloudflare-workers/logs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const logs = getNodeLogsOnboarding({
code: `import * as Sentry from "${packageName}";

export default Sentry.withSentry(
env => ({
(env: Env) => ({
dsn: "${params.dsn.public}",
integrations: [
// send console.log, console.warn, and console.error calls as logs to Sentry
Expand Down
2 changes: 1 addition & 1 deletion static/app/gettingStartedDocs/node-cloudflare-workers/onboarding.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const getSdkSetupSnippet = (params: DocsParams) => `
import * as Sentry from "@sentry/cloudflare";

export default Sentry.withSentry(
env => ({
(env: Env) => ({
Copy link
Contributor

@sentry sentry bot Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The Cloudflare Workers onboarding guide provides a code snippet using the Env type but omits the required wrangler types command to generate it, causing a TypeScript error.
Severity: CRITICAL | Confidence: High

🔍 Detailed Analysis

The onboarding documentation for Cloudflare Workers provides code snippets that use the Env type, for example in (env: Env) => and satisfies ExportedHandler<Env>. However, the Env type is not globally available and must be generated by running the wrangler types command. The current onboarding instructions do not mention this prerequisite step. Consequently, users who copy and paste the provided code into their TypeScript project will encounter a compilation error: "Cannot find name 'Env'". This blocks them from successfully completing the SDK setup as documented.

💡 Suggested Fix

Update the Cloudflare Workers onboarding documentation to include a step instructing the user to run npx wrangler types before they are prompted to use the code snippet. This will ensure the Env type definition is generated and available to the TypeScript compiler.

🤖 Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent.
Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not
valid.

Location: static/app/gettingStartedDocs/node-cloudflare-workers/onboarding.tsx#L28

Potential issue: The onboarding documentation for Cloudflare Workers provides code
snippets that use the `Env` type, for example in `(env: Env) =>` and `satisfies
ExportedHandler<Env>`. However, the `Env` type is not globally available and must be
generated by running the `wrangler types` command. The current onboarding instructions
do not mention this prerequisite step. Consequently, users who copy and paste the
provided code into their TypeScript project will encounter a compilation error: "Cannot
find name 'Env'". This blocks them from successfully completing the SDK setup as
documented.

Did we get this right? 👍 / 👎 to inform future reviews.
Reference ID: 8175928

dsn: "${params.dsn.public}",${
params.isPerformanceSelected
? `
Expand Down
Loading