feat(backend): Introduce `createIsomorphicRequest` #1393

anagstef · 2023-06-20T13:25:05Z

Type of change

Packages affected

Description

npm test runs as expected.
npm run build runs as expected.

Introducing the new utility createIsomorphicRequest for the @clerk/backend package, so that the authenticateRequest signature will be more simplified, and it will be easier to integrate with more frameworks.

changeset-bot · 2023-06-20T13:25:08Z

🦋 Changeset detected

Latest commit: ee55518

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

Name	Type
gatsby-plugin-clerk	Minor
@clerk/clerk-sdk-node	Minor
@clerk/backend	Minor
@clerk/fastify	Minor
@clerk/nextjs	Minor
@clerk/remix	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

jit-ci

✅ Great news! Jit hasn't found any security issues in your PR. Good Job! 🏆

nikosdouvlis · 2023-06-23T01:39:33Z

packages/backend/src/tokens/request.ts

@@ -133,6 +134,7 @@ export type AuthenticateRequestOptions = InstanceKeys &
     * @experimental
     */
    signInUrl?: string;
+    request?: Request;


This needs to be turned into a new signature - lets take this offline

dimkl · 2023-06-26T15:44:09Z

packages/backend/src/tokens/request.ts

+    forwardedProto:
+      options.forwardedProto || isomorphicRequest?.headers?.get(constants.Headers.ForwardedProto) || undefined,
+    referrer: options.referrer || isomorphicRequest?.headers?.get(constants.Headers.Referrer) || undefined,
+    userAgent: options.userAgent || isomorphicRequest?.headers?.get(constants.Headers.UserAgent) || undefined,


🙃 could we create a helper method for the repetitive parts to reduce the length of each size and make it more readable?
Example:

const getFromReq = (req, key) => req?.headers?.get(key) || undefined ; // usage options = { // ... forwardedProto: options.forwardedProto || getFromReq(isomorphicRequest, constants.Headers.ForwardedProto) //... }

packages/sdk-node/src/authenticateRequest.ts

packages/sdk-node/src/__tests__/__snapshots__/exports.test.ts.snap

dimkl · 2023-06-26T15:51:39Z

packages/fastify/src/withClerkMiddleware.ts

+  return value?.split(',')[0]?.trim() || '';
+}
+
+const isRelativeUrl = (url: string) => {


🙃 let's add a comment for this one to move it to shared package or somewhere else and re-use it from there. I believe we have that code somewhere too.

packages/fastify/src/withClerkMiddleware.ts

SokratisVidros · 2023-06-29T08:13:39Z

packages/backend/src/util/IsomorphicRequest.ts

+
+type IsomorphicRequestOptions = (Request: Request, Headers: Headers) => Request;
+
+export const createIsomorphicRequest = (cb: IsomorphicRequestOptions): Request => {


❓ Why are we calling this an IsomorphicRequest since it's just the global.Request?

I recommended the IsomorphicRequest name because it's a Request that can run on any platform, even platforms that natively do not support global.Request (older node runtimes etc).

Would createRequest make more sense to you? I didn't choose this one because it doesn't make the difference between new Request and createRequest apparent. Happy to change the name though :)

packages/backend/src/tokens/request.ts

SokratisVidros · 2023-06-29T08:16:09Z

packages/fastify/src/withClerkMiddleware.ts

@@ -1,39 +1,40 @@
-import { parse } from 'cookie';
+import { createIsomorphicRequest } from '@clerk/backend';
 import type { FastifyReply, FastifyRequest } from 'fastify';

 import { clerkClient } from './clerkClient';
 import * as constants from './constants';
 import type { ClerkFastifyOptions } from './types';
 import { getSingleValueFromArrayHeader } from './utils';


🔧 This also feels it belongs to the request utility

What do you mean exactly? This is the fastify package importing the utility from backend as we have designed with @nikosdouvlis

packages/fastify/src/withClerkMiddleware.ts

packages/nextjs/src/server/authenticateRequest.ts

nikosdouvlis · 2023-06-29T08:38:42Z

packages/remix/src/ssr/authenticateRequest.ts

    signInUrl,
+    request: createIsomorphicRequest((Request: any, Headers: any) => {


❓ Similar to my other comment, why don't we just pass req directly?

We do some sanitization actions first for the Request URL. That's why we need to create it ourselves.

packages/sdk-node/src/authenticateRequest.ts

packages/fastify/src/withClerkMiddleware.ts

jit-ci

❌ Jit has detected important findings in this PR that you should review.
Click here to view these findings on Jit.

jit-ci

✅ Great news! All security issues were resolved. Good Job! 🏆

Introducing the new utility `createIsomorphicRequest` for the `@clerk/backend` package, so that the `authenticateRequest` signature will be more simplified, and it will be easier to integrate with more frameworks.

… createIsomorphicRequest chore(backend): Add changeset for `createIsomorphicRequest` refactor(clerk-sdk-node,backend): Remove sdk-node cookie dependency Also refactor authenticateRequest options fix(backend): Refactor the new IsomorphicRequest utilities Also, manipulate headers objects to be compatible with Headers constructor chore(repo): Revert `package-lock.json` changes

RobZuazua · 2023-07-22T21:42:00Z

@anagstef, this change broke my setup (AWS amplify serverless express lambdas)

I rolled back to previous version (4.10.15) and everything worked again.

{ "errorType": "Runtime.UnhandledPromiseRejection", "errorMessage": "TypeError [ERR_INVALID_URL]: Invalid URL", "reason": { "errorType": "TypeError", "errorMessage": "Invalid URL", "code": "ERR_INVALID_URL", "input": "/api/s3/upload/0718/MP3", "stack": [ "TypeError [ERR_INVALID_URL]: Invalid URL", " at new NodeError (node:internal/errors:387:5)", " at URL.onParseError (node:internal/url:565:9)", " at new URL (node:internal/url:641:5)", " at new Request (/var/task/node_modules/node-fetch-native/dist/shared/node-fetch-native.8afd3fea.cjs:6006:16)", " at /var/task/node_modules/@clerk/clerk-sdk-node/dist/cjs/index.js:143:12", " at createIsomorphicRequest (/var/task/node_modules/@clerk/backend/dist/index.js:1829:10)", " at authenticateRequest (/var/task/node_modules/@clerk/clerk-sdk-node/dist/cjs/index.js:141:72)", " at /var/task/node_modules/@clerk/clerk-sdk-node/dist/cjs/index.js:211:34", " at Layer.handle [as handle_request] (/var/task/node_modules/express/lib/router/layer.js:95:5)", " at next (/var/task/node_modules/express/lib/router/route.js:144:13)" ] }, "promise": {}, "stack": [ "Runtime.UnhandledPromiseRejection: TypeError [ERR_INVALID_URL]: Invalid URL", " at process.<anonymous> (file:///var/runtime/index.mjs:1186:17)", " at process.emit (node:events:513:28)", " at process.emit (node:domain:489:12)", " at emit (node:internal/process/promises:140:20)", " at processPromiseRejections (node:internal/process/promises:274:27)", " at processTicksAndRejections (node:internal/process/task_queues:97:32)" ] }

clerk-cookie · 2024-07-22T00:01:31Z

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

clerk-cookie added backend fastify gatsby nextjs remix sdk-node labels Jun 20, 2023

jit-ci bot reviewed Jun 20, 2023

View reviewed changes

anagstef changed the title ~~feat(backend): Introduce createIsomorphicRequest~~ [WIP] feat(backend): Introduce createIsomorphicRequest Jun 20, 2023

nikosdouvlis reviewed Jun 23, 2023

View reviewed changes

This was referenced Jun 23, 2023

chore(backend): Use tsup to bundle the package for both cjs and esm #1314

Closed

Introduce RequestAdapter interface for authenticateRequest #1348

Closed

anagstef changed the title ~~[WIP] feat(backend): Introduce createIsomorphicRequest~~ feat(backend): Introduce createIsomorphicRequest Jun 23, 2023

anagstef marked this pull request as ready for review June 23, 2023 17:01

anagstef requested review from dimkl and SokratisVidros as code owners June 23, 2023 17:01

anagstef force-pushed the stefanos/js-464-introduce-isomorphic-request branch from 048725d to 33ae931 Compare June 26, 2023 11:42

clerk-cookie added the playground label Jun 26, 2023

dimkl approved these changes Jun 26, 2023

View reviewed changes

dimkl mentioned this pull request Jun 29, 2023

Support experimental_ignoreInterstitial option and use it for api routes #1429

Closed

22 tasks

SokratisVidros suggested changes Jun 29, 2023

View reviewed changes

nikosdouvlis requested changes Jun 29, 2023

View reviewed changes

anagstef requested a review from nikosdouvlis June 29, 2023 13:23

anagstef force-pushed the stefanos/js-464-introduce-isomorphic-request branch from 8fc6fed to a06196f Compare June 30, 2023 11:15

anagstef mentioned this pull request Jul 6, 2023

feat(backend): Add methods for uploading images to User and Organization #1456

Merged

22 tasks

anagstef requested a review from SokratisVidros July 7, 2023 08:50

nikosdouvlis approved these changes Jul 7, 2023

View reviewed changes

anagstef force-pushed the stefanos/js-464-introduce-isomorphic-request branch from 0473ca4 to c34134e Compare July 7, 2023 09:45

clerk-cookie added clerk-js react labels Jul 7, 2023

clerk-cookie added localizations expo chrome-extension labels Jul 7, 2023

jit-ci bot reviewed Jul 7, 2023

View reviewed changes

anagstef force-pushed the stefanos/js-464-introduce-isomorphic-request branch from c34134e to 04045b1 Compare July 7, 2023 10:01

clerk-cookie removed clerk-js react localizations expo chrome-extension labels Jul 7, 2023

jit-ci bot reviewed Jul 7, 2023

View reviewed changes

anagstef and others added 4 commits July 7, 2023 13:09

feat(backend): Introduce createIsomorphicRequest

38a31f7

Introducing the new utility `createIsomorphicRequest` for the `@clerk/backend` package, so that the `authenticateRequest` signature will be more simplified, and it will be easier to integrate with more frameworks.

fix(backend): Align build scripts

5c4cd59

fix(backend): Correctly export fetch apis using subpath imports

ab57e58

anagstef force-pushed the stefanos/js-464-introduce-isomorphic-request branch from 04045b1 to ee55518 Compare July 7, 2023 10:09

nikosdouvlis merged commit fd692af into main Jul 7, 2023
9 checks passed

nikosdouvlis deleted the stefanos/js-464-introduce-isomorphic-request branch July 7, 2023 10:33

clerk-cookie mentioned this pull request Jul 7, 2023

Version Packages #1461

Merged

RobZuazua mentioned this pull request Jul 22, 2023

createIsomorphicRequest change broke my setup in 4.11.0 #1512

Closed

clerk locked as resolved and limited conversation to collaborators Jul 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(backend): Introduce `createIsomorphicRequest` #1393

feat(backend): Introduce `createIsomorphicRequest` #1393

anagstef commented Jun 20, 2023 •

edited

Loading

changeset-bot bot commented Jun 20, 2023 •

edited

Loading

jit-ci bot left a comment

nikosdouvlis Jun 23, 2023

dimkl Jun 26, 2023

dimkl Jun 26, 2023

SokratisVidros Jun 29, 2023

nikosdouvlis Jun 29, 2023

SokratisVidros Jun 29, 2023

anagstef Jun 29, 2023

nikosdouvlis Jun 29, 2023

anagstef Jun 29, 2023

jit-ci bot left a comment

jit-ci bot left a comment

RobZuazua commented Jul 22, 2023 •

edited

Loading

clerk-cookie commented Jul 22, 2024


		type IsomorphicRequestOptions = (Request: Request, Headers: Headers) => Request;

		export const createIsomorphicRequest = (cb: IsomorphicRequestOptions): Request => {

		signInUrl,
		request: createIsomorphicRequest((Request: any, Headers: any) => {

feat(backend): Introduce createIsomorphicRequest #1393

feat(backend): Introduce createIsomorphicRequest #1393

Conversation

anagstef commented Jun 20, 2023 • edited Loading

Type of change

Packages affected

Description

changeset-bot bot commented Jun 20, 2023 • edited Loading

🦋 Changeset detected

jit-ci bot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jit-ci bot left a comment

Choose a reason for hiding this comment

jit-ci bot left a comment

Choose a reason for hiding this comment

RobZuazua commented Jul 22, 2023 • edited Loading

clerk-cookie commented Jul 22, 2024

feat(backend): Introduce `createIsomorphicRequest` #1393

feat(backend): Introduce `createIsomorphicRequest` #1393

anagstef commented Jun 20, 2023 •

edited

Loading

changeset-bot bot commented Jun 20, 2023 •

edited

Loading

RobZuazua commented Jul 22, 2023 •

edited

Loading