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 request check in node 16 #1250

Merged
merged 3 commits into from
Jun 13, 2023
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/handlers/auth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { HandleCallback } from './callback';
import { HandleProfile } from './profile';
import { HandlerError } from '../utils/errors';
import { AppRouteHandlerFn, AppRouteHandlerFnContext, Handler } from './router-helpers';
import { isRequest } from '../utils/req-helpers';

/**
* If you want to add some custom behavior to the default auth handlers, you can pass in custom handlers for
Expand Down Expand Up @@ -183,7 +184,7 @@ export default function handlerFactory({
const pageRouteHandler = pageRouteHandlerFactory(customHandlers, onError as PageRouterOnError);

return (req: NextRequest | NextApiRequest, resOrCtx: NextApiResponse | AppRouteHandlerFnContext) => {
if ('params' in resOrCtx) {
if (isRequest(req)) {
return appRouteHandler(req as NextRequest, resOrCtx as AppRouteHandlerFnContext);
}
return pageRouteHandler(req as NextApiRequest, resOrCtx as NextApiResponse);
Expand Down
11 changes: 7 additions & 4 deletions src/handlers/router-helpers.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { NextRequest } from 'next/server';
import { NextApiRequest, NextApiResponse } from 'next';
import { isRequest } from '../utils/req-helpers';

export type AppRouteHandlerFnContext = {
params: Record<string, string | string[]>;
Expand Down Expand Up @@ -65,16 +66,18 @@ export const getHandler =
resOrCtx: NextApiResponse | AppRouteHandlerFnContext,
options?: Opts
) => {
if (reqOrOptions instanceof Request) {
return appRouteHandler(reqOrOptions, resOrCtx as AppRouteHandlerFnContext, options);
if (isRequest(reqOrOptions)) {
return appRouteHandler(reqOrOptions as NextRequest, resOrCtx as AppRouteHandlerFnContext, options);
}
if ('socket' in reqOrOptions) {
return pageRouteHandler(reqOrOptions as NextApiRequest, resOrCtx as NextApiResponse, options);
}
return (req: NextApiRequest | NextRequest, resOrCtxInner: NextApiResponse | AppRouteHandlerFnContext) => {
const opts = typeof reqOrOptions === 'function' ? (reqOrOptions as OptionsProvider<Opts>)(req) : reqOrOptions;
const opts = (
typeof reqOrOptions === 'function' ? (reqOrOptions as OptionsProvider<Opts>)(req) : reqOrOptions
) as Opts;

if (req instanceof Request) {
if (isRequest(req)) {
return appRouteHandler(req as NextRequest, resOrCtxInner as AppRouteHandlerFnContext, opts);
}
return pageRouteHandler(req as NextApiRequest, resOrCtxInner as NextApiResponse, opts);
Expand Down
8 changes: 6 additions & 2 deletions src/helpers/with-api-auth-required.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { NextApiResponse, NextApiRequest, NextApiHandler } from 'next';
import { NextRequest, NextResponse } from 'next/server';
import { get, SessionCache } from '../session';
import { assertReqRes } from '../utils/assert';
import { isRequest } from '../utils/req-helpers';

/**
* This contains `param`s, which is an object containing the dynamic route parameters for the current route.
Expand Down Expand Up @@ -90,8 +91,11 @@ export default function withApiAuthFactory(sessionCache: SessionCache): WithApiA

return (apiRoute: AppRouteHandlerFn | NextApiHandler): any =>
(req: NextRequest | NextApiRequest, resOrParams: AppRouteHandlerFnContext | NextApiResponse) => {
if (req instanceof Request) {
return appRouteHandler(apiRoute as AppRouteHandlerFn)(req, resOrParams as AppRouteHandlerFnContext);
if (isRequest(req)) {
return appRouteHandler(apiRoute as AppRouteHandlerFn)(
req as NextRequest,
resOrParams as AppRouteHandlerFnContext
);
}
return (pageRouteHandler as WithApiAuthRequiredPageRoute)(apiRoute as NextApiHandler)(
req as NextApiRequest,
Expand Down
9 changes: 5 additions & 4 deletions src/session/cache.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@ import {
Auth0NextRequest,
Auth0NextResponse
} from '../http';
import { isNextApiRequest, isRequest } from '../utils/req-helpers';

type Req = IncomingMessage | NextRequest | NextApiRequest;
type Res = ServerResponse | NextResponse | NextApiResponse;

const getAuth0Req = (req: Req) => {
if (typeof Request !== undefined && req instanceof Request) {
return new Auth0NextRequest(req);
if (isRequest(req)) {
return new Auth0NextRequest(req as NextRequest);
}
if ('previewData' in req) {
return new Auth0NextApiRequest(req);
if (isNextApiRequest(req)) {
return new Auth0NextApiRequest(req as NextApiRequest);
}
return new NodeRequest(req as IncomingMessage);
};
Expand Down
13 changes: 13 additions & 0 deletions src/utils/req-helpers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import type { IncomingMessage } from 'http';
import { NextApiRequest } from 'next';
import { NextRequest } from 'next/server';

type Req = IncomingMessage | NextApiRequest | NextRequest | Request | Record<string, any>;

export const isRequest = (req: Req): boolean => {
return req instanceof Request || req.headers instanceof Headers;
};

export const isNextApiRequest = (req: Req) => {
return !isRequest(req) && 'query' in req;
};
34 changes: 34 additions & 0 deletions tests/utils/req-helpers.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { Socket } from 'net';
import { IncomingMessage } from 'http';
import { NextRequest } from 'next/server';
import { isRequest, isNextApiRequest } from '../../src/utils/req-helpers';

describe('req-helpers', () => {
const req = new Request(new URL('http://example.com'));
const reqNode16 = new Proxy(req, {});
const reqNext = new NextRequest(new URL('http://example.com'));
const nodeReq = new IncomingMessage(new Socket());
class NextApiRequest extends IncomingMessage {
constructor() {
super(new Socket());
}
query = {};
}
const nextApiReq = new NextApiRequest();

test('#isRequest', () => {
expect(isRequest(req)).toBe(true);
expect(isRequest(reqNode16)).toBe(true);
expect(isRequest(reqNext)).toBe(true);
expect(isRequest(nodeReq)).toBe(false);
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this include expect(isRequest(nextApiReq)).toBe(false);?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure - let me add that too

expect(isRequest(nextApiReq)).toBe(false);
});

test('#isNextApiRequest', () => {
expect(isNextApiRequest(req)).toBe(false);
expect(isNextApiRequest(reqNode16)).toBe(false);
expect(isNextApiRequest(reqNext)).toBe(false);
expect(isNextApiRequest(nodeReq)).toBe(false);
expect(isNextApiRequest(nextApiReq)).toBe(true);
});
});