Skip to content
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.

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

fix(nextjs): Export serverside data-fetcher wrappers from client #7256

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions packages/nextjs/src/client/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,29 @@ export {
withSentryServerSideAppGetInitialProps,
wrapAppGetInitialPropsWithSentry,
} from './wrapAppGetInitialPropsWithSentry';

export {
// eslint-disable-next-line deprecation/deprecation
withSentryServerSideDocumentGetInitialProps,
wrapDocumentGetInitialPropsWithSentry,
} from './wrapDocumentGetInitialPropsWithSentry';

export {
// eslint-disable-next-line deprecation/deprecation
withSentryServerSideErrorGetInitialProps,
wrapErrorGetInitialPropsWithSentry,
} from './wrapErrorGetInitialPropsWithSentry';

export {
// eslint-disable-next-line deprecation/deprecation
withSentryGetServerSideProps,
wrapGetServerSidePropsWithSentry,
} from './wrapGetServerSidePropsWithSentry';

export {
// eslint-disable-next-line deprecation/deprecation
withSentryGetStaticProps,
wrapGetStaticPropsWithSentry,
} from './wrapGetStaticPropsWithSentry';

export { wrapAppDirComponentWithSentry } from './wrapAppDirComponentWithSentry';
18 changes: 18 additions & 0 deletions packages/nextjs/src/client/wrapGetServerSidePropsWithSentry.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import type { GetServerSideProps } from 'next';

/**
* A passthrough function in case this function is used on the clientside. We need to make the returned function async
* so we are consistent with the serverside implementation.
*/
export function wrapGetServerSidePropsWithSentry(origGetServerSideProps: GetServerSideProps): GetServerSideProps {
return new Proxy(origGetServerSideProps, {
apply: async (wrappingTarget, thisArg, args: Parameters<GetServerSideProps>) => {
return await wrappingTarget.apply(thisArg, args);
},
});
}

/**
* @deprecated Use `withSentryGetServerSideProps` instead.
*/
export const withSentryGetServerSideProps = wrapGetServerSidePropsWithSentry;
20 changes: 20 additions & 0 deletions packages/nextjs/src/client/wrapGetStaticPropsWithSentry.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import type { GetStaticProps } from 'next';

type Props = { [key: string]: unknown };

/**
* A passthrough function in case this function is used on the clientside. We need to make the returned function async
* so we are consistent with the serverside implementation.
*/
export function wrapGetStaticPropsWithSentry(origGetStaticProps: GetStaticProps<Props>): GetStaticProps<Props> {
return new Proxy(origGetStaticProps, {
apply: async (wrappingTarget, thisArg, args: Parameters<GetStaticProps<Props>>) => {
return await wrappingTarget.apply(thisArg, args);
},
});
}

/**
* @deprecated Use `wrapGetStaticPropsWithSentry` instead.
*/
export const withSentryGetStaticProps = wrapGetStaticPropsWithSentry;
40 changes: 40 additions & 0 deletions packages/nextjs/src/index.types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,46 @@ export declare function withSentryServerSideErrorGetInitialProps<F extends (...a
getInitialProps: F,
): (...args: Parameters<F>) => ReturnType<F> extends Promise<unknown> ? ReturnType<F> : Promise<ReturnType<F>>;

/**
* Wraps a `getServerSideProps` function with Sentry error and performance instrumentation.
*
* @param origGetServerSideProps The `getServerSideProps` function
* @param parameterizedRoute The page's parameterized route
* @returns A wrapped version of the function
*/
export declare function wrapGetServerSidePropsWithSentry<F extends (...args: any[]) => any>(
origGetServerSideProps: F,
parameterizedRoute: string,
): (...args: Parameters<F>) => ReturnType<F> extends Promise<unknown> ? ReturnType<F> : Promise<ReturnType<F>>;

/**
* @deprecated Use `wrapGetServerSidePropsWithSentry` instead.
*/
export declare function withSentryGetServerSideProps<F extends (...args: any[]) => any>(
origGetServerSideProps: F,
parameterizedRoute: string,
): (...args: Parameters<F>) => ReturnType<F> extends Promise<unknown> ? ReturnType<F> : Promise<ReturnType<F>>;

/**
* Wraps a `getStaticProps` function with Sentry error and performance instrumentation.
*
* @param origGetStaticProps The `getStaticProps` function
* @param parameterizedRoute The page's parameterized route
* @returns A wrapped version of the function
*/
export declare function wrapGetStaticPropsWithSentry<F extends (...args: any[]) => any>(
origGetStaticPropsa: F,
parameterizedRoute: string,
): (...args: Parameters<F>) => ReturnType<F> extends Promise<unknown> ? ReturnType<F> : Promise<ReturnType<F>>;

/**
* @deprecated Use `wrapGetStaticPropsWithSentry` instead.
*/
export declare function withSentryGetStaticProps<F extends (...args: any[]) => any>(
origGetStaticPropsa: F,
parameterizedRoute: string,
): (...args: Parameters<F>) => ReturnType<F> extends Promise<unknown> ? ReturnType<F> : Promise<ReturnType<F>>;

/**
* Wraps an `app` directory component with Sentry error instrumentation. (Currently only reports errors for server components)
*/
Expand Down