Skip to content
This repository was archived by the owner on Dec 19, 2024. It is now read-only.

Sentry: Add resolved url tag#600

Merged
danielbeardsley merged 6 commits into from
Aug 11, 2022
Merged

Sentry: Add resolved url tag #600

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0539a05
sentry: Add resolved url tag
masonmcelvain Aug 8, 2022
1d000ad
urlFromContext: Extract to @ifixit/helpers/nextjs
masonmcelvain Aug 9, 2022
a2cf614
setSentryPageContext: Accept `context` param
masonmcelvain Aug 9, 2022
2d0b9a8
sentry: Wrap `getServerSideProps`
masonmcelvain Aug 9, 2022
7e1519e
pnpm-lock: Run `pnpm install:all`
masonmcelvain Aug 9, 2022
16b6857
sentry SSR: Don't clear scope
masonmcelvain Aug 9, 2022
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
16 changes: 16 additions & 0 deletions frontend/helpers/next-helpers.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { GetServerSideProps } from 'next';
import { logAsync } from '@ifixit/helpers';
import { setSentryPageContext } from '@ifixit/sentry';

export function serverSidePropsWrapper<T>(
getServerSidePropsInternal: GetServerSideProps<T>
): GetServerSideProps<T> {
return async (context) => {
return logAsync('getServerSideProps', () =>
getServerSidePropsInternal(context)
).catch((err) => {
setSentryPageContext(context);
throw err;
});
};
}
12 changes: 8 additions & 4 deletions frontend/pages/Parts/[...deviceHandleItemType].tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,14 @@ import {
ProductListViewProps,
} from '@components/product-list';
import { ALGOLIA_PRODUCT_INDEX_NAME } from '@config/env';
import { serverSidePropsWrapper } from '@helpers/next-helpers';
import {
decodeDeviceTitle,
decodeDeviceItemType,
encodeDeviceTitle,
} from '@helpers/product-list-helpers';
import { invariant } from '@ifixit/helpers';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { getGlobalSettings } from '@models/global-settings';
import { findProductList } from '@models/product-list';
import { getStoreByCode, getStoreList } from '@models/store';
Expand All@@ -25,7 +27,7 @@ import { getServerState } from 'react-instantsearch-hooks-server';
type PageProps = WithLayoutProps<ProductListViewProps>;
type AppPageProps = WithProvidersProps<PageProps>;

export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (
context
) => {
context.res.setHeader(
Expand DownExpand Up@@ -87,14 +89,12 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (

const title = `iFixit | ${productList.title}`;

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
const url = `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
const indexName = ALGOLIA_PRODUCT_INDEX_NAME;

const appProps: AppProvidersProps = {
algolia: {
indexName,
url,
url: urlFromContext(context),
apiKey: productList.algolia.apiKey,
},
};
Expand DownExpand Up@@ -130,6 +130,10 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
};
};

export const getServerSideProps = serverSidePropsWrapper(
getServerSidePropsInternal
);

const ProductListPage: NextPageWithLayout<PageProps> = (pageProps) => {
return <ProductListView {...pageProps} />;
};
Expand Down
13 changes: 7 additions & 6 deletions frontend/pages/Parts/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,9 +13,11 @@ import { ALGOLIA_PRODUCT_INDEX_NAME } from '@config/env';
import { getGlobalSettings } from '@models/global-settings';
import { findProductList } from '@models/product-list';
import { getStoreByCode, getStoreList } from '@models/store';
import { logAsync, logAsyncWrap } from '@ifixit/helpers';
import { logAsync } from '@ifixit/helpers';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { GetServerSideProps } from 'next';
import { getServerState } from 'react-instantsearch-hooks-server';
import { serverSidePropsWrapper } from '@helpers/next-helpers';

type PageProps = WithLayoutProps<ProductListViewProps>;
type AppPageProps = WithProvidersProps<PageProps>;
Expand DownExpand Up@@ -47,14 +49,12 @@ const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (

const title = `iFixit | ${productList.title}`;

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
const url = `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
const indexName = ALGOLIA_PRODUCT_INDEX_NAME;

const appProps: AppProvidersProps = {
algolia: {
indexName,
url,
url: urlFromContext(context),
apiKey: productList.algolia.apiKey,
},
};
Expand DownExpand Up@@ -92,8 +92,9 @@ const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (
};
};

export const getServerSideProps: GetServerSideProps<AppPageProps> =
logAsyncWrap('getServerSideProps', getServerSidePropsInternal);
export const getServerSideProps = serverSidePropsWrapper(
getServerSidePropsInternal
);

const ProductListPage: NextPageWithLayout<PageProps> = (pageProps) => {
return <ProductListView {...pageProps} />;
Expand Down
13 changes: 7 additions & 6 deletions frontend/pages/Shop/[handle].tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,9 @@ import {
ProductListViewProps,
} from '@components/product-list';
import { ALGOLIA_PRODUCT_INDEX_NAME } from '@config/env';
import { invariant, logAsync, logAsyncWrap } from '@ifixit/helpers';
import { serverSidePropsWrapper } from '@helpers/next-helpers';
import { invariant, logAsync } from '@ifixit/helpers';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { getGlobalSettings } from '@models/global-settings';
import { findProductList } from '@models/product-list';
import { getStoreByCode, getStoreList } from '@models/store';
Expand DownExpand Up@@ -66,14 +68,12 @@ const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (

const title = `iFixit | ${productList.title}`;

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
const url = `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
const indexName = ALGOLIA_PRODUCT_INDEX_NAME;

const appProps: AppProvidersProps = {
algolia: {
indexName,
url,
url: urlFromContext(context),
apiKey: productList.algolia.apiKey,
},
};
Expand DownExpand Up@@ -111,8 +111,9 @@ const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (
};
};

export const getServerSideProps: GetServerSideProps<AppPageProps> =
logAsyncWrap('getServerSideProps', getServerSidePropsInternal);
export const getServerSideProps = serverSidePropsWrapper(
getServerSidePropsInternal
);

const ProductListPage: NextPageWithLayout<PageProps> = (pageProps) => {
return <ProductListView {...pageProps} />;
Expand Down
12 changes: 8 additions & 4 deletions frontend/pages/Tools/[handle].tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,9 @@ import {
ProductListViewProps,
} from '@components/product-list';
import { ALGOLIA_PRODUCT_INDEX_NAME } from '@config/env';
import { serverSidePropsWrapper } from '@helpers/next-helpers';
import { invariant } from '@ifixit/helpers';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { getGlobalSettings } from '@models/global-settings';
import { findProductList } from '@models/product-list';
import { getStoreByCode, getStoreList } from '@models/store';
Expand All@@ -20,7 +22,7 @@ import { getServerState } from 'react-instantsearch-hooks-server';
type PageProps = WithLayoutProps<ProductListViewProps>;
type AppPageProps = WithProvidersProps<PageProps>;

export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (
context
) => {
context.res.setHeader(
Expand DownExpand Up@@ -60,14 +62,12 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (

const title = `iFixit | ${productList.title}`;

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
const url = `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
const indexName = ALGOLIA_PRODUCT_INDEX_NAME;

const appProps: AppProvidersProps = {
algolia: {
indexName,
url,
url: urlFromContext(context),
apiKey: productList.algolia.apiKey,
},
};
Expand DownExpand Up@@ -103,6 +103,10 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
};
};

export const getServerSideProps = serverSidePropsWrapper(
getServerSidePropsInternal
);

const ProductListPage: NextPageWithLayout<PageProps> = (pageProps) => {
return <ProductListView {...pageProps} />;
};
Expand Down
12 changes: 8 additions & 4 deletions frontend/pages/Tools/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,13 +13,15 @@ import { ALGOLIA_PRODUCT_INDEX_NAME } from '@config/env';
import { getGlobalSettings } from '@models/global-settings';
import { findProductList } from '@models/product-list';
import { getStoreByCode, getStoreList } from '@models/store';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { GetServerSideProps } from 'next';
import { getServerState } from 'react-instantsearch-hooks-server';
import { serverSidePropsWrapper } from '@helpers/next-helpers';

type PageProps = WithLayoutProps<ProductListViewProps>;
type AppPageProps = WithProvidersProps<PageProps>;

export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
const getServerSidePropsInternal: GetServerSideProps<AppPageProps> = async (
context
) => {
context.res.setHeader(
Expand DownExpand Up@@ -47,14 +49,12 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (

const title = `iFixit | ${productList.title}`;

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
const url = `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
const indexName = ALGOLIA_PRODUCT_INDEX_NAME;

const appProps: AppProvidersProps = {
algolia: {
indexName,
url,
url: urlFromContext(context),
apiKey: productList.algolia.apiKey,
},
};
Expand DownExpand Up@@ -90,6 +90,10 @@ export const getServerSideProps: GetServerSideProps<AppPageProps> = async (
};
};

export const getServerSideProps = serverSidePropsWrapper(
getServerSidePropsInternal
);

const ProductListPage: NextPageWithLayout<PageProps> = (pageProps) => {
return <ProductListView {...pageProps} />;
};
Expand Down
14 changes: 0 additions & 14 deletions packages/helpers/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,20 +41,6 @@ export function logAsync<T>(
return asyncFunction().finally(done);
}

/**
* Wrap a promise-returning function and logs the time it takes to resolve
* the promise.
*/
export function logAsyncWrap<Args extends any[], T>(
name: string,
asyncFunction: (...args: Args) => Promise<T>
): (...args: Args) => Promise<T> {
return (...args) => {
const done = time(name);
return asyncFunction(...args).finally(done);
};
}

export function logSync<T>(name: string, syncFunction: () => T): T {
const done = time(name);
const response = syncFunction();
Expand Down
6 changes: 6 additions & 0 deletions packages/helpers/nextjs.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { GetServerSidePropsContext } from 'next';

export function urlFromContext(context: GetServerSidePropsContext): string {

@masonmcelvainmasonmcelvainAug 9, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

FYI I didn't include this in @ifixit/helpers/nextjs because doing so would cause a cyclic dependency between @ifixit/sentry and @ifixit/helpers.

const protocol = context.req.headers.referer?.split('://')[0] || 'https';
return `${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
}
Comment on lines +3 to +6

@jarstelfoxjarstelfoxAug 9, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You could use the actual URL object. I know you may toString it later, but the class may be nice down the road

Suggested change
exportfunctionurlFromContext(context: GetServerSidePropsContext): string{
constprotocol=context.req.headers.referer?.split('://')[0]||'https';
return`${protocol}://${context.req.headers.host}${context.resolvedUrl}`;
}
exportfunctionurlFromContext(context: GetServerSidePropsContext): URL{
constprotocol=context.req.headers.referer?.split('://')[0]||'https';
returnnewURL(`${protocol}://${context.req.headers.host}${context.resolvedUrl}`);
}

@masonmcelvainmasonmcelvainAug 9, 2022

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I agree, but we use string urls throughout most of this app unfortunately, so this would be a more siginificant refactor if we were to do it right. I'd rather leave it to another pull.

4 changes: 4 additions & 0 deletions packages/helpers/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,10 @@
"main": "./index.tsx",
"types": "./index.tsx",
"license": "MIT",
"exports": {
".": "./index.tsx",
"./nextjs": "./nextjs.tsx"
},
"devDependencies": {
"@ifixit/tsconfig": "workspace:*",
"typescript": "4.5.3"
Expand Down
6 changes: 6 additions & 0 deletions packages/sentry/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import * as Sentry from '@sentry/nextjs';
import { urlFromContext } from '@ifixit/helpers/nextjs';
import { GetServerSidePropsContext } from 'next';

export const sentryFetch: typeof fetch = async (resource, options) => {
const context = {
Expand DownExpand Up@@ -27,3 +29,7 @@ export const sentryFetch: typeof fetch = async (resource, options) => {
throw error;
});
};

export const setSentryPageContext = (context: GetServerSidePropsContext) => {
Sentry.setTag('resolved_url', urlFromContext(context));
};
3 changes: 2 additions & 1 deletion packages/sentry/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,8 @@
"types": "./index.tsx",
"license": "MIT",
"dependencies": {
"@sentry/nextjs": "^7.0.0"
"@ifixit/helpers": "workspace:*",
"@sentry/nextjs": "^7.8.1"
},
"peerDependencies": {
"next": "11.1.3",
Expand Down
2 changes: 1 addition & 1 deletion packages/sentry/tsconfig.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
{
"extends": "@ifixit/tsconfig/base.json",
"extends": "@ifixit/tsconfig/react-library.json",
"include": ["."],
"exclude": ["dist", "build", "node_modules"]
}
Loading