feat(backend,clerk-sdk-node): Simplify the authenticateRequest signature by anagstef · Pull Request #1329 · clerk/javascript

anagstef · 2023-06-09T00:08:15Z

Type of change

Packages affected

Description

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

This PR simplifies the signature of authenticateRequest for better DX on both @clerk/backend and @clerk/clerk-sdk-node packages:

One pair of legacy or new instance keys are required now and not all 4 of them
@clerk/backend now can handle the "Bearer " prefix in Authorization header for better DX
host parameter is now optional in @clerk/backend

Example of using `authenticateRequest`

Before:

import clerkClient from '@clerk/clerk-sdk-node';

// `Bearer asdgfjdkhgmsfngl`
const authHeader = request.headers.get('authorization') || '';
const authToken = authHeader.split(` `)[1];

const res = await clerkClient.authenticateRequest({
  headerToken: authToken,
  publishableKey: process.env.CLERK_PUB_KEY,
  secretKey: process.env.CLERK_SECRET_KEY,
  apiKey: ``,
  frontendApi: ``,
  host: ``,
});

...

After this PR:

import clerkClient from '@clerk/clerk-sdk-node';

const res = await clerkClient.authenticateRequest({
  headerToken: request.headers.get('authorization'),
  publishableKey: process.env.CLERK_PUB_KEY,
  secretKey: process.env.CLERK_SECRET_KEY
});

...

changeset-bot · 2023-06-09T00:08:18Z

🦋 Changeset detected

Latest commit: c2f124f

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

This PR includes changesets to release 6 packages

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

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-12T09:38:04Z

!snapshot

clerk-cookie · 2023-06-12T09:40:42Z

Hey @nikosdouvlis - the snapshot version command generated the following package versions:

Package	Version
@clerk/backend	0.22.0-snap.af9b738
@clerk/chrome-extension	0.3.8-snap.af9b738
@clerk/clerk-js	4.45.1-snap.af9b738
eslint-config-custom	0.3.0
@clerk/clerk-expo	0.17.8-snap.af9b738
@clerk/fastify	0.4.6-snap.af9b738
gatsby-plugin-clerk	4.3.7-snap.af9b738
@clerk/localizations	1.17.1-snap.af9b738
@clerk/nextjs	4.20.0-snap.af9b738
@clerk/clerk-react	4.19.0-snap.af9b738
@clerk/remix	2.6.6-snap.af9b738
@clerk/clerk-sdk-node	4.10.4-snap.af9b738
@clerk/shared	0.18.0-snap.af9b738
@clerk/themes	1.7.5
@clerk/types	3.41.1-snap.af9b738

Tip: use the snippet copy button below to quickly install the required packages.

# @clerk/backend
npm i @clerk/backend@0.22.0-snap.af9b738

# @clerk/chrome-extension
npm i @clerk/chrome-extension@0.3.8-snap.af9b738

# @clerk/clerk-js
npm i @clerk/clerk-js@4.45.1-snap.af9b738

# eslint-config-custom
npm i eslint-config-custom@0.3.0

# @clerk/clerk-expo
npm i @clerk/clerk-expo@0.17.8-snap.af9b738

# @clerk/fastify
npm i @clerk/fastify@0.4.6-snap.af9b738

# gatsby-plugin-clerk
npm i gatsby-plugin-clerk@4.3.7-snap.af9b738

# @clerk/localizations
npm i @clerk/localizations@1.17.1-snap.af9b738

# @clerk/nextjs
npm i @clerk/nextjs@4.20.0-snap.af9b738

# @clerk/clerk-react
npm i @clerk/clerk-react@4.19.0-snap.af9b738

# @clerk/remix
npm i @clerk/remix@2.6.6-snap.af9b738

# @clerk/clerk-sdk-node
npm i @clerk/clerk-sdk-node@4.10.4-snap.af9b738

# @clerk/shared
npm i @clerk/shared@0.18.0-snap.af9b738

# @clerk/themes
npm i @clerk/themes@1.7.5

# @clerk/types
npm i @clerk/types@3.41.1-snap.af9b738

nikosdouvlis

Good job @anagstef :)

nikosdouvlis · 2023-06-14T21:45:22Z

+      publishableKey: string;
+      /**
+       * @deprecated Use `publishableKey` instead.
+       */
+      frontendApi: string;


Why can we have both?

You have wayy more context that me here so please ignore if it doesn't make sense, however, the usual way to write this would be:

type ExclusiveAOrB = { a: string; b?: never; } | { a?: never; b: string; }

(notice the ?)

Why can we have both?

@nikosdouvlis Isn't this a breaking change (on the type-level) of anyone passing both?

- One pair of legacy or new instance keys are required instead of all 4 of them in `authenticateRequest` - `@clerk/backend` now can handle the `Bearer` prefix in Authorization header for better DX - `host` parameter is now optional in `@clerk/backend`

clerk-cookie · 2024-06-19T00:01:32Z

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.

anagstef requested a review from dimkl June 9, 2023 00:08

anagstef requested a review from SokratisVidros as a code owner June 9, 2023 00:08

anagstef self-assigned this Jun 9, 2023

anagstef requested a review from nikosdouvlis as a code owner June 9, 2023 00:08

github-actions Bot added backend sdk-node labels Jun 9, 2023

jit-ci Bot reviewed Jun 9, 2023

View reviewed changes

anagstef force-pushed the stefanos/js-455-improve-the-dx-of-the-signature-of-authenticaterequest-for branch 2 times, most recently from 6da8e5e to af9b738 Compare June 9, 2023 12:14

panteliselef approved these changes Jun 10, 2023

View reviewed changes

anagstef mentioned this pull request Jun 13, 2023

Introduce RequestAdapter interface for authenticateRequest #1348

Closed

22 tasks

dimkl reviewed Jun 13, 2023

View reviewed changes

Comment thread packages/sdk-node/src/authenticateRequest.ts

dimkl approved these changes Jun 13, 2023

View reviewed changes

Comment thread packages/backend/src/util/request.ts Outdated

nikosdouvlis approved these changes Jun 14, 2023

View reviewed changes

SokratisVidros approved these changes Jun 19, 2023

View reviewed changes

anagstef force-pushed the stefanos/js-455-improve-the-dx-of-the-signature-of-authenticaterequest-for branch from af9b738 to 680f728 Compare June 19, 2023 11:46

anagstef force-pushed the stefanos/js-455-improve-the-dx-of-the-signature-of-authenticaterequest-for branch from 680f728 to c2f124f Compare June 19, 2023 15:40

dimkl approved these changes Jun 19, 2023

View reviewed changes

nikosdouvlis merged commit de2347f into main Jun 19, 2023

nikosdouvlis deleted the stefanos/js-455-improve-the-dx-of-the-signature-of-authenticaterequest-for branch June 19, 2023 16:48

clerk-cookie mentioned this pull request Jun 19, 2023

Version Packages #1385

Merged

clerk locked as resolved and limited conversation to collaborators Jun 19, 2024

Uh oh!

Conversation

anagstef commented Jun 9, 2023

Type of change

Packages affected

Description

Example of using authenticateRequest

Uh oh!

changeset-bot Bot commented Jun 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

jit-ci Bot left a comment

Choose a reason for hiding this comment

Uh oh!

nikosdouvlis commented Jun 12, 2023

Uh oh!

clerk-cookie commented Jun 12, 2023

Uh oh!

Uh oh!

Uh oh!

nikosdouvlis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nikosdouvlis Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

nikosdouvlis Jun 14, 2023

Choose a reason for hiding this comment

Uh oh!

anagstef Jun 19, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

clerk-cookie commented Jun 19, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Example of using `authenticateRequest`

changeset-bot Bot commented Jun 9, 2023 •

edited

Loading