Skip to content

Commit

Permalink
wip: sentry config changes
Browse files Browse the repository at this point in the history
- add: tunnel
- wip: added test page / route
  • Loading branch information
joonatank committed Nov 21, 2024
1 parent 04febb1 commit 1b23d7e
Show file tree
Hide file tree
Showing 5 changed files with 153 additions and 10 deletions.
26 changes: 17 additions & 9 deletions .github/workflows/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ concurrency:

env:
SKIP_ENV_VALIDATION: "true"
NEXT_PUBLIC_BASE_URL: ""
# TODO do we need to add this to the next build (.env.local)
SENTRY_LOG_LEVEL: "debug"

jobs:
# Disabled because it broke, and no idea why.
Expand Down Expand Up @@ -42,6 +45,7 @@ jobs:
pnpm lint --filter=admin-ui...
pnpm lint:css --filter=admin-ui...
build-admin-ui:
name: Build admin ui
runs-on: ubuntu-latest
Expand All @@ -50,8 +54,6 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: "Set up Docker Buildx"
uses: docker/setup-buildx-action@v3
- uses: pnpm/action-setup@v4
- uses: actions/setup-node@v4
with:
Expand All @@ -62,6 +64,8 @@ jobs:
- uses: dtinth/setup-github-actions-caching-for-turbo@v1
- name: Build ui
run: pnpm build --filter admin-ui...
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}

test-admin-ui:
name: Test admin ui
Expand Down Expand Up @@ -98,7 +102,6 @@ jobs:
- name: Install dependencies
run: pnpm install --frozen-lockfile
- uses: dtinth/setup-github-actions-caching-for-turbo@v1

- name: Lint ui
run: |
pnpm tsc:check --filter=ui...
Expand All @@ -110,8 +113,6 @@ jobs:
runs-on: ubuntu-latest
# needs: [changed-packages]
# if: needs.changed-packages.outputs.ui_changed == 'true'
env:
SKIP_ENV_VALIDATION: 'true'
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand All @@ -122,17 +123,24 @@ jobs:
cache: 'pnpm'
- name: Install dependencies
run: pnpm install --frozen-lockfile
- uses: dtinth/setup-github-actions-caching-for-turbo@v1
# FIXME enable cache after we are done with the source maps
#- uses: dtinth/setup-github-actions-caching-for-turbo@v1
# FIXME sourcemap upload fails with 413 Request Entity Too Large
# have to copy the build envs to file otherwise nextjs can't find them
# TODO make the app base path configurable `apps/ui` (from monorepo root)
- name: Build ui
run: pnpm build --filter ui...
run: |
touch apps/ui/.env.local
echo SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }} >> apps/ui/.env.local
pnpm build --filter ui...
env:
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}

test-ui:
name: Unit tests ui
runs-on: ubuntu-latest
# needs: [changed-packages]
# if: needs.changed-packages.outputs.ui_changed == 'true'
env:
SKIP_ENV_VALIDATION: 'true'
steps:
- name: Checkout code
uses: actions/checkout@v4
Expand Down
3 changes: 3 additions & 0 deletions apps/ui/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@
# cypress
cypress/screenshots
cypress/videos

# Sentry Config File
.env.sentry-build-plugin
35 changes: 34 additions & 1 deletion apps/ui/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,20 @@ const nextConfig = {
// NOTE webpack.experimental.topLevelAwait breaks middleware (it hangs forever)
};

// Testing stuff
// eslint-disable-next-line no-console
console.log("env: ", env);
// eslint-disable-next-line no-console
console.log("process.env: ", process.env);

export default withSentryConfig(nextConfig, {
// For all available options, see:
// https://github.com/getsentry/sentry-webpack-plugin#options
org: "city-of-helsinki",
project: "tilavaraus-ui",
sentryUrl: "https://sentry.test.hel.ninja/",
// TODO make configurable using env because we have different urls for different environments
// no that doesn't work, we need to upload to both urls when building docker
sentryUrl: "https://sentry.test.hel.ninja",
authToken: env.SENTRY_AUTH_TOKEN,
// Only print logs for uploading source maps in CI
silent: !process.env.CI,
Expand All @@ -55,4 +63,29 @@ export default withSentryConfig(nextConfig, {

// Automatically tree-shake Sentry logger statements to reduce bundle size
disableLogger: true,
// For all available options, see:
// https://github.com/getsentry/sentry-webpack-plugin#options

// For all available options, see:
// https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/

// Upload a larger set of source maps for prettier stack traces (increases build time)
widenClientFileUpload: true,

// Automatically annotate React components to show their full name in breadcrumbs and session replay
reactComponentAnnotation: {
enabled: false,
},

// Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
// This can increase your server load as well as your hosting bill.
// Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
// side errors will fail.
tunnelRoute: "/monitoring",

// Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)
// See the following for more information:
// https://docs.sentry.io/product/crons/
// https://vercel.com/docs/cron-jobs
// automaticVercelMonitors: true,
});
4 changes: 4 additions & 0 deletions apps/ui/pages/api/sentry-example-api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
// A faulty API route to test Sentry's error monitoring
export default function handler(_req: unknown, _res: unknown) {
throw new Error("Sentry Example API Route Error");
}
95 changes: 95 additions & 0 deletions apps/ui/pages/sentry-example-page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import Head from "next/head";
import * as Sentry from "@sentry/nextjs";
import { getCommonServerSideProps } from "@/modules/serverUtils";

type Props = Awaited<ReturnType<typeof getServerSideProps>>["props"];

export function getServerSideProps() {
const commonProps = getCommonServerSideProps();
return {
props: {
...commonProps,
},
};
}

export default function Page(_props: Props) {
return (
<div>
<Head>
<title>Sentry Onboarding</title>
<meta name="description" content="Test Sentry for your Next.js app!" />
</Head>

<main
style={{
minHeight: "100vh",
display: "flex",
flexDirection: "column",
justifyContent: "center",
alignItems: "center",
}}
>
<h1 style={{ fontSize: "4rem", margin: "14px 0" }}>
<svg
style={{
height: "1em",
}}
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 200 44"
>
<path
fill="currentColor"
d="M124.32,28.28,109.56,9.22h-3.68V34.77h3.73V15.19l15.18,19.58h3.26V9.22h-3.73ZM87.15,23.54h13.23V20.22H87.14V12.53h14.93V9.21H83.34V34.77h18.92V31.45H87.14ZM71.59,20.3h0C66.44,19.06,65,18.08,65,15.7c0-2.14,1.89-3.59,4.71-3.59a12.06,12.06,0,0,1,7.07,2.55l2-2.83a14.1,14.1,0,0,0-9-3c-5.06,0-8.59,3-8.59,7.27,0,4.6,3,6.19,8.46,7.52C74.51,24.74,76,25.78,76,28.11s-2,3.77-5.09,3.77a12.34,12.34,0,0,1-8.3-3.26l-2.25,2.69a15.94,15.94,0,0,0,10.42,3.85c5.48,0,9-2.95,9-7.51C79.75,23.79,77.47,21.72,71.59,20.3ZM195.7,9.22l-7.69,12-7.64-12h-4.46L186,24.67V34.78h3.84V24.55L200,9.22Zm-64.63,3.46h8.37v22.1h3.84V12.68h8.37V9.22H131.08ZM169.41,24.8c3.86-1.07,6-3.77,6-7.63,0-4.91-3.59-8-9.38-8H154.67V34.76h3.8V25.58h6.45l6.48,9.2h4.44l-7-9.82Zm-10.95-2.5V12.6h7.17c3.74,0,5.88,1.77,5.88,4.84s-2.29,4.86-5.84,4.86Z M29,2.26a4.67,4.67,0,0,0-8,0L14.42,13.53A32.21,32.21,0,0,1,32.17,40.19H27.55A27.68,27.68,0,0,0,12.09,17.47L6,28a15.92,15.92,0,0,1,9.23,12.17H4.62A.76.76,0,0,1,4,39.06l2.94-5a10.74,10.74,0,0,0-3.36-1.9l-2.91,5a4.54,4.54,0,0,0,1.69,6.24A4.66,4.66,0,0,0,4.62,44H19.15a19.4,19.4,0,0,0-8-17.31l2.31-4A23.87,23.87,0,0,1,23.76,44H36.07a35.88,35.88,0,0,0-16.41-31.8l4.67-8a.77.77,0,0,1,1.05-.27c.53.29,20.29,34.77,20.66,35.17a.76.76,0,0,1-.68,1.13H40.6q.09,1.91,0,3.81h4.78A4.59,4.59,0,0,0,50,39.43a4.49,4.49,0,0,0-.62-2.28Z"
/>
</svg>
</h1>

<p>Get started by sending us a sample error:</p>
<button
type="button"
style={{
padding: "12px",
cursor: "pointer",
backgroundColor: "#AD6CAA",
borderRadius: "4px",
border: "none",
color: "white",
fontSize: "14px",
margin: "18px",
}}
onClick={async () => {
await Sentry.startSpan(
{
name: "Example Frontend Span",
op: "test",
},
async () => {
const res = await fetch("/api/sentry-example-api");
if (!res.ok) {
throw new Error("Sentry Example Frontend Error");
}
}
);
}}
>
Throw error!
</button>

<p>
Next, look for the error on the{" "}
<a href="https://sentry.io/organizations/city-of-helsinki/issues/?project=22">
Issues Page
</a>
.
</p>
<p style={{ marginTop: "24px" }}>
For more information, see{" "}
<a href="https://docs.sentry.io/platforms/javascript/guides/nextjs/">
https://docs.sentry.io/platforms/javascript/guides/nextjs/
</a>
</p>
</main>
</div>
);
}

0 comments on commit 1b23d7e

Please sign in to comment.