chore(nextjs-approuter): update example and docs

rollbar · Mar 15, 2024 · b422e16 · b422e16
1 parent 5f8f5e7
commit b422e16
Show file tree

Hide file tree

Showing 11 changed files with 446 additions and 156 deletions.
diff --git a/examples/nextjs-approuter/package-lock.json b/examples/nextjs-approuter/package-lock.json
diff --git a/examples/nextjs-approuter/package.json b/examples/nextjs-approuter/package.json
@@ -12,6 +12,7 @@
     "@rollbar/react": "file:.yalc/@rollbar/react",
     "next": "14.1.3",
     "react": "^18",
+    "react-code-blocks": "^0.1.6",
     "react-dom": "^18",
     "rollbar": "^2.26.3"
   },

diff --git a/examples/nextjs-approuter/src/app/global-error.tsx b/examples/nextjs-approuter/src/app/global-error.tsx
@@ -1,7 +1,8 @@
 'use client';
 
-import { rollbarInstance } from '@/rollbar';
 import { useEffect } from 'react';
+import { rollbarInstance } from '@/rollbar';
+import { ResetPage } from '@/components/ResetPage';
 
 export default function GlobalError({
   error,
@@ -17,8 +18,7 @@ export default function GlobalError({
   return (
     <html>
       <body>
-        <h2>Something went wrong!</h2>
-        <button onClick={() => reset()}>Try again</button>
+        <ResetPage reset={reset} />;
       </body>
     </html>
   );

diff --git a/examples/nextjs-approuter/src/app/layout.tsx b/examples/nextjs-approuter/src/app/layout.tsx
@@ -1,28 +1,9 @@
 import type { Metadata } from 'next';
 import { Inter } from 'next/font/google';
 import './globals.css';
-import { Provider, ErrorBoundary } from '@rollbar/react';
-import Fallback from './fallback';
-import Callback from './callback';
 
 const inter = Inter({ subsets: ['latin'] });
 
-const rollbarConfig = {
-  accessToken: process.env.NEXT_PUBLIC_ROLLBAR_TOKEN,
-  hostSafeList: ['localhost:3000', 'localhost:4000'],
-  captureUncaught: true,
-  captureUnhandledRejections: true,
-  payload: {
-    environment: 'development',
-    client: {
-      javascript: {
-        code_version: '1.0.0',
-        source_map_enabled: true,
-      },
-    },
-  },
-};
-
 export const metadata: Metadata = {
   title: 'Create Next App',
   description: 'Generated by create next app',
@@ -35,19 +16,7 @@ export default function RootLayout({
 }>) {
   return (
     <html lang="en">
-      <body className={inter.className}>
-        <Provider config={rollbarConfig}>
-          <ErrorBoundary
-            level="critical"
-            errorMessage="example error boundary message"
-            fallbackUI={Fallback}
-            extra={{ more: 'data' }}
-            callback={Callback}
-          >
-            {children}
-          </ErrorBoundary>
-        </Provider>
-      </body>
+      <body className={inter.className}>{children}</body>
     </html>
   );
 }
diff --git a/examples/nextjs-approuter/src/app/next_error_handler/error.tsx b/examples/nextjs-approuter/src/app/next_error_handler/error.tsx
@@ -1,7 +1,8 @@
 'use client'; // Error components must be Client Components
 
-import { rollbarInstance } from '@/rollbar';
 import { useEffect } from 'react';
+import { rollbarInstance } from '@/rollbar';
+import { ResetPage } from '@/components/ResetPage';
 
 export default function Error({
   error,
@@ -14,10 +15,5 @@ export default function Error({
     rollbarInstance.error(error);
   }, [error]);
 
-  return (
-    <div>
-      <h2>Something went wrong!</h2>
-      <button onClick={() => reset()}>Try again</button>
-    </div>
-  );
+  return <ResetPage reset={reset} />;
 }
diff --git a/examples/nextjs-approuter/src/app/next_error_handler/page.tsx b/examples/nextjs-approuter/src/app/next_error_handler/page.tsx
@@ -3,6 +3,7 @@
 export default function NextErrorHandlerGenerator() {
   return (
     <button
+      className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded"
       onClick={() => {
         throw new Error('Something handled by NextJS');
       }}

diff --git a/examples/nextjs-approuter/src/app/page.tsx b/examples/nextjs-approuter/src/app/page.tsx
@@ -1,113 +1,33 @@
-import Image from 'next/image';
+import * as fs from 'fs';
+import { Code } from '@/components/Code';
+import Link from 'next/link';
+
+const code = fs.readFileSync('./src/rollbar.ts', 'utf-8');
 
 export default function Home() {
   return (
-    <main className="flex min-h-screen flex-col items-center justify-between p-24">
-      <div className="z-10 max-w-5xl w-full items-center justify-between font-mono text-sm lg:flex">
-        <p className="fixed left-0 top-0 flex w-full justify-center border-b border-gray-300 bg-gradient-to-b from-zinc-200 pb-6 pt-8 backdrop-blur-2xl dark:border-neutral-800 dark:bg-zinc-800/30 dark:from-inherit lg:static lg:w-auto  lg:rounded-xl lg:border lg:bg-gray-200 lg:p-4 lg:dark:bg-zinc-800/30">
-          Get started by editing&nbsp;
-          <code className="font-mono font-bold">src/app/page.tsx</code>
-        </p>
-        <div className="fixed bottom-0 left-0 flex h-48 w-full items-end justify-center bg-gradient-to-t from-white via-white dark:from-black dark:via-black lg:static lg:h-auto lg:w-auto lg:bg-none">
-          <a
-            className="pointer-events-none flex place-items-center gap-2 p-8 lg:pointer-events-auto lg:p-0"
-            href="https://vercel.com?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-            target="_blank"
-            rel="noopener noreferrer"
-          >
-            By{' '}
-            <Image
-              src="/vercel.svg"
-              alt="Vercel Logo"
-              className="dark:invert"
-              width={100}
-              height={24}
-              priority
-            />
-          </a>
-        </div>
-      </div>
-
-      <div className="relative flex place-items-center before:absolute before:h-[300px] before:w-full sm:before:w-[480px] before:-translate-x-1/2 before:rounded-full before:bg-gradient-radial before:from-white before:to-transparent before:blur-2xl before:content-[''] after:absolute after:-z-20 after:h-[180px] after:w-full sm:after:w-[240px] after:translate-x-1/3 after:bg-gradient-conic after:from-sky-200 after:via-blue-200 after:blur-2xl after:content-[''] before:dark:bg-gradient-to-br before:dark:from-transparent before:dark:to-blue-700 before:dark:opacity-10 after:dark:from-sky-900 after:dark:via-[#0141ff] after:dark:opacity-40 before:lg:h-[360px] z-[-1]">
-        <Image
-          className="relative dark:drop-shadow-[0_0_0.3rem_#ffffff70] dark:invert"
-          src="/next.svg"
-          alt="Next.js Logo"
-          width={180}
-          height={37}
-          priority
-        />
-      </div>
-
-      <div className="mb-32 grid text-center lg:max-w-5xl lg:w-full lg:mb-0 lg:grid-cols-4 lg:text-left">
-        <a
-          href="https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Docs{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Find in-depth information about Next.js features and API.
-          </p>
-        </a>
-
-        <a
-          href="https://nextjs.org/learn?utm_source=create-next-app&utm_medium=appdir-template-tw&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Learn{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Learn about Next.js in an interactive course with&nbsp;quizzes!
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/templates?framework=next.js&utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Templates{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50`}>
-            Explore starter templates for Next.js.
-          </p>
-        </a>
-
-        <a
-          href="https://vercel.com/new?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app"
-          className="group rounded-lg border border-transparent px-5 py-4 transition-colors hover:border-gray-300 hover:bg-gray-100 hover:dark:border-neutral-700 hover:dark:bg-neutral-800/30"
-          target="_blank"
-          rel="noopener noreferrer"
-        >
-          <h2 className={`mb-3 text-2xl font-semibold`}>
-            Deploy{' '}
-            <span className="inline-block transition-transform group-hover:translate-x-1 motion-reduce:transform-none">
-              -&gt;
-            </span>
-          </h2>
-          <p className={`m-0 max-w-[30ch] text-sm opacity-50 text-balance`}>
-            Instantly deploy your Next.js site to a shareable URL with Vercel.
-          </p>
-        </a>
-      </div>
+    <main className="flex min-h-screen flex-col items-start p-24 space-y-8">
+      <header>
+        <h1 className="mb-4 text-4xl font-extrabold leading-none">
+          Rollbar: Next.js App Router Example
+        </h1>
+      </header>
+      <p>
+        Using Rollbar with the Next.js App Router is quick and easy to
+        implement. The first step for any integration will be creating your own
+        Rollbar instance. This can be done as follows:
+      </p>
+      <Code code={code} />
+      <p>
+        This will create a rollbar instance that you can use to capture your
+        errors. It can be used within the{' '}
+        <Link href="/next_error_handler">Next.JS App Router error handler</Link>{' '}
+        or using the{' '}
+        <Link href="/rollbar_error_boundary">
+          {`<ErrorBoundary`} from the @rollbar/react package
+        </Link>{' '}
+        . It can also be used server side within Next.js middleware
+      </p>
     </main>
   );
 }
diff --git a/examples/nextjs-approuter/src/app/rollbar_error_boundary/page.tsx b/examples/nextjs-approuter/src/app/rollbar_error_boundary/page.tsx
@@ -2,12 +2,14 @@
 import { Provider as RollbarProvider, ErrorBoundary } from '@rollbar/react';
 
 import { rollbarInstance } from '../../rollbar';
+import { ResetPage } from '@/components/ResetPage';
 
 export default function RollbarErrorBoundary() {
   return (
     <RollbarProvider instance={rollbarInstance}>
-      <ErrorBoundary>
+      <ErrorBoundary fallbackUI={() => <ResetPage reset={() => {}} />}>
         <button
+          className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded"
           onClick={() => {
             throw new Error('Something broke');
           }}

diff --git a/examples/nextjs-approuter/src/components/Code.tsx b/examples/nextjs-approuter/src/components/Code.tsx
@@ -0,0 +1,7 @@
+'use client';
+
+import { CodeBlock } from 'react-code-blocks';
+
+export function Code({ code }: { code: string }) {
+  return <CodeBlock text={code} language="javascript" showLineNumbers={true} />;
+}
diff --git a/examples/nextjs-approuter/src/components/ResetPage.tsx b/examples/nextjs-approuter/src/components/ResetPage.tsx
@@ -0,0 +1,10 @@
+'use client';
+
+export function ResetPage({ reset }: { reset: () => void }) {
+  return (
+    <div>
+      <h2>Something went wrong!</h2>
+      <button onClick={() => reset()}>Try again</button>
+    </div>
+  );
+}
diff --git a/examples/nextjs-approuter/src/rollbar.ts b/examples/nextjs-approuter/src/rollbar.ts
@@ -3,7 +3,7 @@ import Rollbar from 'rollbar';
 export const rollbarInstance = new Rollbar({
   accessToken:
     typeof window === 'undefined'
-      ? process.env.POST_SERVER_ITEM_TOKEN
+      ? process.env.NEXT_PUBLIC_POST_CLIENT_ITEM_TOKEN
       : process.env.NEXT_PUBLIC_POST_CLIENT_ITEM_TOKEN,
   captureUncaught: true,
   captureUnhandledRejections: true,