Repository navigation
feat(previews): sign in to PR previews with a shared access key #1506
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
31d33ec
feat(previews): sign in to PR previews with a shared access key
Makisuo 9ec744c
fix(domain): regenerate anticipated errors for preview sign-in
Makisuo b198288
fix(previews): pin the reviewer to its Preview org, time out the stat…
Makisuo 20464fd
docs(agents): how to sign in to a PR preview
Makisuo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import { apiBaseUrl } from "@/lib/services/common/api-base-url" | ||
| import { tracedFetch } from "@/lib/services/common/telemetry" | ||
|
|
||
| const PREVIEW_SIGN_IN_URL = `${apiBaseUrl}/api/auth/preview/sign-in` | ||
|
|
||
| /** The sign-in route waits on this probe, so a slow API must not hold back Clerk's card. */ | ||
| const STATUS_TIMEOUT_MS = 3_000 | ||
|
|
||
| /** PR previews answer `enabled: true`; everywhere else, or on any failure or timeout, it is false. */ | ||
| export const loadPreviewSignInEnabled = () => | ||
| tracedFetch("maple-api", PREVIEW_SIGN_IN_URL, { signal: AbortSignal.timeout(STATUS_TIMEOUT_MS) }) | ||
| .then((response) => (response.ok ? (response.json() as Promise<{ enabled?: unknown }>) : null)) | ||
| .then((body) => body?.enabled === true) | ||
| .catch(() => false) | ||
|
|
||
| export async function requestPreviewTicket(key: string) { | ||
| const response = await tracedFetch("maple-api", PREVIEW_SIGN_IN_URL, { | ||
| method: "POST", | ||
| headers: { "content-type": "application/json" }, | ||
| body: JSON.stringify({ key }), | ||
| }) | ||
| if (!response.ok) { | ||
| const errorBody = (await response.json().catch(() => null)) as { message?: string } | null | ||
| throw new Error(errorBody?.message ?? "Preview sign-in failed") | ||
| } | ||
| return ((await response.json()) as { ticket: string }).ticket | ||
| } | ||
|
|
||
| /** Reload `/sign-in` with the ticket; Clerk's `<SignIn>` redeems `__clerk_ticket` on mount. */ | ||
| export const openTicketSignIn = (ticket: string, redirectUrl: string | null) => { | ||
| const params = new URLSearchParams({ __clerk_ticket: ticket }) | ||
| if (redirectUrl) params.set("redirect_url", redirectUrl) | ||
| window.location.assign(`/sign-in?${params.toString()}`) | ||
| } | ||
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.