Repository navigation
feat(backend): add experimental POPPY metadata helper - #10404
Draft
thiskevinwang wants to merge 3 commits into
Draft
thiskevinwang wants to merge 3 commits into
thiskevinwang wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 7aaa946 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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 |
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Comment |
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/electron
@clerk/electron-passkeys
@clerk/eslint-plugin
@clerk/expo
@clerk/expo-biometrics
@clerk/expo-google-signin
@clerk/expo-native-components
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/mosaic
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add
clerkClient.__experimental_getPoppyMetadata()so server routes can fetch the instance's FAPI discovery document and return it on the customer's domain.The helper defaults to the configured publishable key's FAPI hostname. An explicit
proxyUrloption supports instances that use a customer proxy without a FAPI CNAME. The proxy path prefix is retained. Proxy failures do not fall back to a direct request.Both paths send no credentials, reject redirects, and return parsed JSON as
unknownwithout a local POPPY interface or shape checks. HTTP errors retain their status. Each call fetches fresh metadata. No backend/experimentalentry exists, so the method uses the repository's experimental prefix.For a proxy-only instance, pass the configured absolute proxy URL. Resolve relative proxy paths at the caller:
The shared backend client also exposes the method through Express, Hono, and TanStack Start. These examples assume configured Clerk SDKs consuming this backend version. They illustrate the proposed API; framework routes have not been run end to end.
Express
Hono
TanStack Start
For example, place this route in
src/routes/[.]well-known/poppy[.]json.ts. The escaped dots keep the literal discovery path. The handler follows TanStack Start's server route convention.Part of AIE-1940. Requires the FAPI metadata endpoint. The returned organization domain remains the instance primary domain; selecting another configured customer domain remains separate work.
Checklist
pnpm --filter @clerk/backend testpasses in Node and Edge runtimes, with 1,712 tests passed in each, including the existing customer proxy request path.pnpm buildruns as expected for@clerk/backendand its dependencies.Type of change