Merge branch 'master' into constantinius/feat/dynamic-sampling/organization-settings

* master: (511 commits)
  docs(cloudflare): several semantic and stylistic fixes in code examples for cloudflare workers (#12482)
  chore(replay): Clarify network bandwidth and show how to reduce perf impact for mobile SDKs (#12479)
  chore(replay): Update product docs FAQ (#12474)
  ref: Drop remaining usage of `<Note>` (#12476)
  Update debugmeta.mdx (#12436)
  Fix queue_producer_transaction string termination error in example code (#12463)
  Adjust for sentry-ruby changes (#12455)
  Fixed incorrect instrument.mjs filename (#12454)
  Updating feature flags docs location (#12453)
  ref: Remove `<Note>` component in favor of using `<Alert>` (#12467)
  feat: send content feedback plausible events (#12400)
  docs(native): document how to set attribute on spans/transactions
  feat(express): Add warning about express v5 (#12465)
  chore(jira): Add instructions for installing Jira for self-hosted sentry users (#12433)
  chore: Update Codecov Bundler Plugin Version (#12459)
  Bump API schema to 421589ca (#12461)
  fix(platform): Enable scrolling via keyboard buttons (#12460)
  feat: Update `Expandable` style (#12457)
  Add Kotlin examples and fix typo in Java and Android Scopes docs (#12458)
  doc(js): Document how to set attribute on all spans (#12449)
  ...

Author: jan-auer

.env.example

@@ -3,5 +3,5 @@
 # warning: variables prefixed with NEXT_PUBLIC_ will be made available to client-side code
 # be careful not to expose sensitive data (in this case your Algolia admin key)
 
-NEXT_PUBLIC_ALGOLIA_APP_ID=OOK48W9UCL
-NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=ca98597f559459c216891b75989832f8
+NEXT_PUBLIC_ALGOLIA_APP_ID=
+NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=

.env.production

@@ -1,24 +1,10 @@
-/* eslint-env node */
-/* eslint import/no-nodejs-modules:0 */
-
 module.exports = {
   extends: ['sentry-docs', 'plugin:@next/next/recommended'],
   globals: {
-    jest: true,
     Atomics: 'readonly',
     SharedArrayBuffer: 'readonly',
   },
   rules: {
     'import/no-nodejs-modules': 'off',
   },
-  overrides: [
-    {
-      files: ['*.ts', '*.tsx'],
-      rules: {
-        // Reach is vendored into gatsby. They have their own webpack
-        // resolution for it which this eslint plugin can't seem to detect
-        'import/no-unresolved': ['error', {ignore: ['@reach']}],
-      },
-    },
-  ],
 };

.env.test

@@ -36,12 +36,12 @@
 # /src/docs/product/discover-queries/ @getsentry/visibility
 # /src/docs/product/performance/ @getsentry/visibility
 
-# /src/docs/product/cli/dif/ @getsentry/owners-native
+# /src/docs/cli/dif.mdx @getsentry/owners-native
 
-# /.github/labels.yml @getsentry/open-source
-# /.github/workflows/react-to-product-owners-yml-changes.yml @getsentry/open-source
-# /bin/react-to-product-owners-yml-changes.py @getsentry/open-source
-# /bin/react-to-product-owners-yml-changes.sh @getsentry/open-source
+# /.github/labels.yml @getsentry/dev-infra
+# /.github/workflows/react-to-product-owners-yml-changes.yml @getsentry/dev-infra
+# /bin/react-to-product-owners-yml-changes.py @getsentry/dev-infra
+# /bin/react-to-product-owners-yml-changes.sh @getsentry/dev-infra
 
 # ###### Replays #######
 
@@ -51,4 +51,6 @@
 # /src/platforms/javascript/common/session-replay/                  @getsentry/replay @getsentry/replay-sdk-web
 # /src/wizard/javascript/replay-onboarding/                         @getsentry/replay @getsentry/replay-sdk-web
 
+# /src/docs/product/dev-toolbar/                                    @getsentry/replay
+
 # ###### End Replays #######

.eslintrc.js

@@ -25,7 +25,7 @@ jobs:
               - 'develop-docs/**'
       - uses: oven-sh/setup-bun@v2
         with:
-          bun-version: latest
+          bun-version: '1.1.34'
 
       - uses: actions/cache@v4
         id: cache

.github/CODEOWNERS

@@ -12,13 +12,19 @@ jobs:
     name: 'Bump API Schema SHA'
     steps:
       - uses: actions/[email protected]
+      - name: Get auth token
+        id: token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        with:
+          app-id: ${{ vars.SENTRY_INTERNAL_APP_ID }}
+          private-key: ${{ secrets.SENTRY_INTERNAL_APP_PRIVATE_KEY }}
       - name: 'Bump API Schema SHA'
         shell: bash
         env:
           # An elevated token is necessary because with plain github.token
           # GitHub does not recursively call workflows, which means CI does not
           # kick off for the PR we're about to create.
-          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }}
+          GITHUB_TOKEN: ${{ steps.token.outputs.token }}
         run: |
           set -euo pipefail
 

.github/workflows/algolia-index.yml

@@ -25,7 +25,7 @@ jobs:
               - 'platform-includes/**'
             dev-docs:
               - 'develop-docs/**'
-      - uses: oven-sh/setup-bun@v1
+      - uses: oven-sh/setup-bun@v2
         with:
           bun-version: latest
 

.github/workflows/bump-api-schema-sha.yml

@@ -13,14 +13,20 @@ jobs:
     runs-on: ubuntu-latest
     name: "Release a new version"
     steps:
+      - name: Get auth token
+        id: token
+        uses: actions/create-github-app-token@5d869da34e18e7287c1daad50e0b8ea0f506ce69 # v1.11.0
+        with:
+          app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
+          private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}
       - uses: actions/[email protected]
         with:
-          token: ${{ secrets.GH_RELEASE_PAT }}
+          token: ${{ steps.token.outputs.token }}
           fetch-depth: 0
       - name: Prepare release
         uses: getsentry/action-prepare-release@v1
         env:
-          GITHUB_TOKEN: ${{ secrets.GH_RELEASE_PAT }}
+          GITHUB_TOKEN: ${{ steps.token.outputs.token }}
         with:
           version: ${{ github.event.inputs.version }}
           force: ${{ github.event.inputs.force }}

.github/workflows/lint-404s.yml

@@ -13,7 +13,7 @@ repos:
       - id: detect-private-key
         exclude: |
           (?x)^(
-              develop-docs/application/config.mdx|
+              develop-docs/backend/config.mdx|
               develop-docs/integrations/github.mdx|
               develop-docs/self-hosted/sso.mdx
           )$

.github/workflows/prepare-release.yml

@@ -12,5 +12,8 @@
   "git.ignoreLimitWarning": true,
   "search.exclude": {
     "**/src/wizard/**": true
-  }
+  },
+  "cSpell.words": [
+    "laravel"
+  ]
 }

.pre-commit-config.yaml

@@ -11,7 +11,12 @@ We use Next.js, `yarn` and `volta` to manage the environment.
 ```
 cp .env.example .env.development
 yarn
+
+# Start dev server for user docs
 yarn dev
+
+# Start dev server for developer docs
+yarn dev:developer-docs
 ```
 
 With that, the repo is fully set up and you are ready to open local docs under http://localhost:3000

.vscode/settings.json

@@ -58,7 +58,8 @@ function MDXLayoutRenderer({mdxSource, ...rest}) {
   return <MDXLayout components={mdxComponentsWithWrapper} {...rest} />;
 }
 
-export default async function Page({params}: {params: {path?: string[]}}) {
+export default async function Page(props: {params: Promise<{path?: string[]}>}) {
+  const params = await props.params;
   // get frontmatter of all docs in tree
   const rootNode = await getDocsRootNode();
 
@@ -172,9 +173,9 @@ export default async function Page({params}: {params: {path?: string[]}}) {
 }
 
 type MetadataProps = {
-  params: {
+  params: Promise<{
     path?: string[];
-  };
+  }>;
 };
 
 // Helper function to clean up canonical tags missing leading or trailing slash
@@ -188,7 +189,8 @@ function formatCanonicalTag(tag: string) {
   return tag;
 }
 
-export async function generateMetadata({params}: MetadataProps): Promise<Metadata> {
+export async function generateMetadata(props: MetadataProps): Promise<Metadata> {
+  const params = await props.params;
   const domain = isDeveloperDocs
     ? 'https://develop.sentry.dev'
     : 'https://docs.sentry.io';
@@ -198,10 +200,14 @@ export async function generateMetadata({params}: MetadataProps): Promise<Metadat
     : domain;
   let title =
     'Sentry Docs | Application Performance Monitoring &amp; Error Tracking Software';
-  let customCanonicalTag;
+  let customCanonicalTag: string = '';
   let description =
     'Self-hosted and cloud-based application performance monitoring &amp; error tracking that helps software teams see clearer, solve quicker, &amp; learn continuously.';
-  const images = [{url: `${previewDomain ?? domain}/meta.jpg`, width: 1200, height: 822}];
+  // show og image on the home page only
+  const images =
+    ((await props.params).path ?? []).length === 0
+      ? [{url: `${previewDomain ?? domain}/og.png`, width: 1200, height: 630}]
+      : [];
 
   const rootNode = await getDocsRootNode();
 

CONTRIBUTING.md

@@ -13,6 +13,7 @@
   --accent: var(--accent-purple);
   --foreground: var(--gray-12);
   --cursor-checkbox: pointer;
+  --default-font-family: var(--font-rubik) !important;
   ::selection {
     background-color: var(--accent-a7);
   }
@@ -159,3 +160,8 @@ body {
     opacity: 1;
   }
 }
+
+#kapa-widget-portal a[href="https://sentry.io/privacy/"]
+{
+  color: rgb(134, 142, 150) !important;
+}

app/[[...path]]/page.tsx

@@ -4,6 +4,7 @@ import {Theme} from '@radix-ui/themes';
 import type {Metadata} from 'next';
 import {Rubik} from 'next/font/google';
 import Script from 'next/script';
+import PlausibleProvider from 'next-plausible';
 
 import {ThemeProvider} from 'sentry-docs/components/theme-provider';
 
@@ -30,8 +31,11 @@ export const metadata: Metadata = {
 
 export default function RootLayout({children}: {children: React.ReactNode}) {
   return (
-    <html lang="en">
-      <body className={`${rubik.variable}`}>
+    <html lang="en" suppressHydrationWarning>
+      <head>
+        <PlausibleProvider domain="docs.sentry.io,rollup.sentry.io" />
+      </head>
+      <body className={rubik.variable} suppressHydrationWarning>
         <ThemeProvider
           attribute="class"
           defaultTheme="system"
@@ -42,13 +46,20 @@ export default function RootLayout({children}: {children: React.ReactNode}) {
             {children}
           </Theme>
         </ThemeProvider>
+        <Script
+          async
+          src="https://widget.kapa.ai/kapa-widget.bundle.js"
+          data-website-id="cac7cc70-969e-4bc1-a968-55534a839be4"
+          data-button-hide // do not render kapa ai button
+          data-modal-override-open-class="kapa-ai-class" // all elements with this class will open the kapa ai modal
+          data-project-name="Sentry"
+          data-project-color="#6A5FC1"
+          data-project-logo="https://avatars.githubusercontent.com/u/1396951?s=280&v=4"
+          data-font-family="var(--font-rubik)"
+          data-modal-disclaimer="Please note: This is a tool that searches publicly available sources. Do not include any sensitive or personal information in your queries. For more on how Sentry handles your data, see our [Privacy Policy](https://sentry.io/privacy/)."
+          data-modal-example-questions="How to set up Sentry for Next.js?,What are tracePropagationTargets?"
+        />
       </body>
-      <Script
-        defer
-        data-domain="docs.sentry.io,rollup.sentry.io"
-        data-api="https://plausible.io/api/event"
-        src="https://plausible.io/js/script.tagged-events.js"
-      />
     </html>
   );
 }

app/globals.css

@@ -1,3 +1,4 @@
+import {Metadata} from 'next';
 import {redirect} from 'next/navigation';
 
 import {Alert} from 'sentry-docs/components/alert';
@@ -7,17 +8,28 @@ import {SmartLink} from 'sentry-docs/components/smartLink';
 import {extractPlatforms, getDocsRootNode, nodeForPath} from 'sentry-docs/docTree';
 import {setServerContext} from 'sentry-docs/serverContext';
 
-export default async function Page({
-  searchParams: {next = '', platform},
-}: {
-  searchParams: {[key: string]: string | string[] | undefined};
+import {sanitizeNext} from './utils';
+
+export const metadata: Metadata = {
+  robots: 'noindex',
+  title: 'Platform Specific Content',
+  description:
+    'The page you are looking for is customized for each platform. Select your platform below and we’ll direct you to the most specific documentation on it.',
+};
+
+export default async function Page(props: {
+  searchParams: Promise<{[key: string]: string | string[] | undefined}>;
 }) {
+  const searchParams = await props.searchParams;
+
+  let next = searchParams.next || '';
+  const platform = searchParams.platform;
+
   if (Array.isArray(next)) {
     next = next[0];
   }
 
-  // discard the hash
-  const [pathname, _] = next.split('#');
+  const pathname = sanitizeNext(next);
   const rootNode = await getDocsRootNode();
   const defaultTitle = 'Platform Specific Content';
   let description = '';
@@ -53,7 +65,7 @@ export default async function Page({
       p => p.key === requestedPlatform?.toLowerCase()
     );
     if (isValidPlatform) {
-      return redirect(`/platforms/${requestedPlatform}${next}`);
+      return redirect(`/platforms/${requestedPlatform}${pathname}`);
     }
   }
 
@@ -67,12 +79,12 @@ export default async function Page({
 
   return (
     <DocPage frontMatter={frontMatter}>
-      <Alert level="info">{platformInfo}</Alert>
+      <Alert>{platformInfo}</Alert>
 
       <ul>
         {platformList.map(p => (
           <li key={p.key}>
-            <SmartLink to={`/platforms/${p.key}${next}`}>
+            <SmartLink to={`/platforms/${p.key}${pathname}`}>
               <PlatformIcon
                 size={16}
                 platform={p.icon ?? p.key}

app/layout.tsx

@@ -0,0 +1,46 @@
+import {describe, expect, it} from 'vitest';
+
+import {sanitizeNext} from './utils';
+
+describe('sanitizeNext', () => {
+  it('should return an empty string for external URLs', () => {
+    expect(sanitizeNext('http://example.com')).toBe('');
+    expect(sanitizeNext('https://example.com')).toBe('');
+    expect(sanitizeNext('//example.com')).toBe('');
+  });
+
+  it('should prepend a slash if missing', () => {
+    expect(sanitizeNext('path/to/resource')).toBe('/path/to/resource');
+  });
+
+  it('should not modify a valid internal path', () => {
+    expect(sanitizeNext('/path/to/resource')).toBe('/path/to/resource');
+  });
+
+  it('should remove unsafe characters', () => {
+    expect(sanitizeNext('/path/to/resource?query=1')).toBe('/path/to/resource');
+    expect(sanitizeNext('/path/to/resource#hash')).toBe('/path/to/resource');
+  });
+
+  it('should allow alphanumeric and hyphens', () => {
+    expect(sanitizeNext('/path-to/resource123')).toBe('/path-to/resource123');
+  });
+
+  it('should return an empty string for paths with colons', () => {
+    expect(sanitizeNext('/path:to/resource')).toBe('');
+  });
+
+  it('should return an empty string for the root path', () => {
+    expect(sanitizeNext('/')).toBe('');
+  });
+
+  it('should decode URL encoded characters', () => {
+    expect(sanitizeNext('/path%2Fwith%2Fslashes')).toBe('/path/with/slashes');
+  });
+
+  it('should return an empty string for a malformed URI component', () => {
+    const input = '%E0%A4%A'; // Malformed URI
+    const expectedOutput = '';
+    expect(sanitizeNext(input)).toBe(expectedOutput);
+  });
+});