chore(backend,nextjs,clerk-sdk-node): Drop legacy return response in BAPI responses #2126
Conversation
🦋 Changeset detectedLatest commit: fa0aa4b The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
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 |
| if (!payload) { | ||
| assert.false(true, 'This assertion should never fail. We need to check for payload to make TS happy.'); | ||
| return; | ||
| } |
There was a problem hiding this comment.
assertResponse / assertErrorResponse helpers were introduced to drop the !payload check.
| @@ -38,7 +38,12 @@ export const createClerkExpressRequireAuth = (createOpts: CreateClerkExpressMidd | |||
| clerkClient, | |||
| requestState, | |||
| }); | |||
| return handleInterstitialCase(res, requestState, interstitial); | |||
| if (interstitial.errors) { | |||
| // TODO(@dimkl): return interstitial errors ? | |||
There was a problem hiding this comment.
@nikosdouvlis WDYT about passing the errors of the interstitial request to the end-user?
We would probably remove this handling if we drop the remotePrivateInterstitial().
There was a problem hiding this comment.
Did we remove remotePrivateIntestitial?
Also, what errors can be returned here? Im a bit skeptical to pass the errors to the user as that makes the error a public API
There was a problem hiding this comment.
We haven't removed it yet, since we need to decide if we want to enforce the publishableKey in all our SDKs.
The local interstitial won't ever return an error but if the publishableKey is missing, fetching interstitial from BAPI will be triggered and that could result to the following errors (based on the Go backend):
- 401 due to missing secretKey or invalid Key
- 500
dimkl
force-pushed
the
sdk-782-drop-deprecations-backend
branch
from
9be55f9
to
07edf5b
Compare
dimkl
force-pushed
the
sdk-91-drop-legacy-response
branch
from
bbdb0cd
to
8647965
Compare
dimkl
force-pushed
the
sdk-782-drop-deprecations-backend
branch
3 times, most recently
from
6b8d70b
to
92bbeb9
Compare
dimkl
force-pushed
the
sdk-782-drop-deprecations-backend
branch
from
92bbeb9
to
53bef9c
Compare
dimkl
force-pushed
the
sdk-91-drop-legacy-response
branch
2 times, most recently
from
28244ea
to
19cb42b
Compare
dimkl
force-pushed
the
sdk-91-drop-legacy-response
branch
from
9dc8bfc
to
b5196ad
Compare
dimkl
force-pushed
the
sdk-91-drop-legacy-response
branch
from
b5196ad
to
e50a198
Compare
| @@ -38,7 +38,12 @@ export const createClerkExpressRequireAuth = (createOpts: CreateClerkExpressMidd | |||
| clerkClient, | |||
| requestState, | |||
| }); | |||
| return handleInterstitialCase(res, requestState, interstitial); | |||
| if (interstitial.errors) { | |||
| // TODO(@dimkl): return interstitial errors ? | |||
There was a problem hiding this comment.
Did we remove remotePrivateIntestitial?
Also, what errors can be returned here? Im a bit skeptical to pass the errors to the user as that makes the error a public API
dimkl
force-pushed
the
sdk-91-drop-legacy-response
branch
from
e50a198
to
fa0aa4b
Compare
Description
Currently the BAPI responses are in
{ data: unknown | null, errors: [] | null }format but to avoid introducing a breaking change we convert those responses and return only thedatapart orthrowan error if there areerrors.With this PR we will drop the transformation and return the actual response. This is a breaking change since from now on
errorsprop in the return value to verify if the request succeededdataprop in the return valueChecklist
npm testruns as expected.npm run buildruns as expected.Type of change
Packages affected
@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/clerk-expo@clerk/fastifygatsby-plugin-clerk@clerk/localizations@clerk/nextjs@clerk/clerk-react@clerk/remix@clerk/clerk-sdk-node@clerk/shared@clerk/themes@clerk/typesbuild/tooling/chore