feat: add Google One Tap response handler by darcyYe · Pull Request #1126 · logto-io/docs

darcyYe · 2025-05-29T04:04:31Z

Summary

Use Google One Tap JS API instead of HTML API and add Google One Tap response handler, resolves LOG-11509

Copilot

Pull Request Overview

This PR introduces a cross-domain authentication status check that verifies admin token validity using an iframe-based approach and integrates it into the Docusaurus layout. Key changes include:

Adding new types and enum definitions for auth status checking in src/theme/Layout/types.ts.
Implementing the auth status check mechanism, including debug logging, polling, and global exposure of auth state in src/theme/Layout/index.tsx.
Updating the Docusaurus configuration to support the new auth status check feature via new customFields.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File	Description
src/theme/Layout/types.ts	Added types and enums to define the cross-domain auth status check functionality.
src/theme/Layout/index.tsx	Integrated auth status checking into the layout with appropriate debug logging and polling.
docusaurus.config.ts	Updated customFields to include new environment variables for the auth status check feature.

Copilot · 2025-05-29T04:04:56Z

+        if (isIframeVisible) {
+          // In debug mode, delay removal to allow inspection
+          iframe.style.border = '2px solid green'; // Change border color to indicate success
+          setTimeout(() => {


Consider extracting the various timeout durations (e.g., 5000ms and 10000ms) into named constants for better maintainability and consistency across the auth status check implementation.

cloudflare-workers-and-pages · 2025-05-29T04:05:48Z

Deploying logto-docs-tutorials with Cloudflare Pages

Latest commit:	`c833d2b`
Status:	✅ Deploy successful!
Preview URL:	https://b826e951.logto-docs-tutorials.pages.dev
Branch Preview URL:	https://yemq-add-auth-status-check.logto-docs-tutorials.pages.dev

View logs

cloudflare-workers-and-pages · 2025-05-29T04:21:25Z

Deploying logto-docs with Cloudflare Pages

Latest commit:	`c833d2b`
Status:	✅ Deploy successful!
Preview URL:	https://41344087.logto-docs.pages.dev
Branch Preview URL:	https://yemq-add-auth-status-check.logto-docs.pages.dev

View logs

* feat: add GOT callback handler * fix: fix CSP, refactor GOT credential verifier * chore: test GET verify API * chore: use otp landing page * chore: add frame-ancestor config * chore: pop up fallback mechanism * chore: redirect in-place and try POST * chore: test without CSP headers for CF * chore: test experience google credential * chore: add debug log and check/grant storage access * chore: update console landing page

charIeszhao · 2025-07-21T10:03:16Z

+        // Build Logto sign-in URL with credential
+        const signInUrl = buildSignInUrl(response);
+
+        localStorage.setItem(isGoogleOneTapTriggeredKey, '1');


Should we set local storage after the signInUrl check?

charIeszhao · 2025-07-21T10:06:10Z

+        } else {
+          debugLogger.error('Failed to build sign-in URL');
+        }
+      } catch (error) {
+        debugLogger.error('Failed to open sign-in URL:', error);
+      }


I think these two error handling is unnecessary, as the error log should've been already logged if the buildSignInUrl fails.

charIeszhao · 2025-07-21T10:58:06Z

+  return useMemo(() => createDebugLogger(isDebugMode), [isDebugMode]);
+}
+
+export function useApiBaseUrl(siteConfig: SiteConfig): {


You can call

const { siteConfig } = useDocusaurusContext();

in this hook, instead of passing the siteConfig through the properties. This makes the hook easier to call at component level, as it has less dependencies of other hooks.

charIeszhao · 2025-07-21T10:59:24Z

+    siteConfig.customFields?.logtoApiBaseUrl,
+    siteConfig.customFields?.isDevFeatureEnabled,
+    siteConfig.customFields?.logtoAdminConsoleUrl,


nit: Use destructure instead of repeating the prefix siteConfig.customFields.

charIeszhao · 2025-07-21T11:00:06Z

+export function useGoogleOneTapConfig(
+  siteConfig: SiteConfig,
+  debugLogger: DebugLogger
+): { config: Optional<GoogleOneTapConfig> } {


Same here, you can call other hooks in your hook, instead of passing the results through properties.

charIeszhao · 2025-07-21T11:02:41Z

+        const parsedConfig = googleOneTapConfigSchema.safeParse(
+          // eslint-disable-next-line no-restricted-syntax
+          trySafe(() => JSON.parse(rawConfig) as unknown)
+        );


nit: Would it be easier if we just use parse without safeParse or trySafe? Let them throw the errors since you have a try-catch block outside.

darcyYe · 2025-07-22T06:10:34Z

Merge this to its parent PR for easier review.

* feat: check auth status on cloud console * refactor: refactor code * fix: fix page * chore: fix content not render bug * chore: resume least changes * refactor: apply try-retry instead of polling * refactor: use google API instead of HTML component * revert: restore pnpm-lock.yaml to base branch version * refactor: apply browser only to GOT and add referrer policy header * refactor: apply thorough CSP * feat: add GOT callback handler (#1166) * feat: add GOT callback handler * fix: fix CSP, refactor GOT credential verifier * chore: test GET verify API * chore: use otp landing page * chore: add frame-ancestor config * chore: pop up fallback mechanism * chore: redirect in-place and try POST * chore: test without CSP headers for CF * chore: test experience google credential * chore: add debug log and check/grant storage access * chore: update console landing page * refactor: remove unnecessary code * feat: only trigger GOT once * chore: remove unused code * refactor: refactor code

darcyYe requested review from a team and Copilot May 29, 2025 04:04

Copilot AI reviewed May 29, 2025

View reviewed changes

darcyYe force-pushed the yemq-add-auth-status-check branch from aa6815f to 8087b48 Compare May 29, 2025 04:05

charIeszhao reviewed Jun 16, 2025

View reviewed changes

Comment thread src/theme/Layout/index.tsx Outdated

charIeszhao reviewed Jun 17, 2025

View reviewed changes

Comment thread docusaurus.config.ts Outdated

charIeszhao reviewed Jun 17, 2025

View reviewed changes

Comment thread src/theme/Layout/index.tsx Outdated

darcyYe force-pushed the yemq-add-local-google-one-tap branch from 2b9f070 to 1d52165 Compare June 23, 2025 08:43

darcyYe force-pushed the yemq-add-auth-status-check branch 4 times, most recently from 6b0e102 to 344e1f9 Compare June 30, 2025 03:42

darcyYe force-pushed the yemq-add-auth-status-check branch 2 times, most recently from 35d5879 to 8da27fd Compare June 30, 2025 13:48

darcyYe force-pushed the yemq-add-local-google-one-tap branch from cea2bd3 to 2f1ff0e Compare June 30, 2025 14:00

Darcy Ye added 7 commits June 30, 2025 22:03

feat: check auth status on cloud console

e3d9248

refactor: refactor code

ec32a11

fix: fix page

c58b6d9

chore: fix content not render bug

1067fe5

chore: resume least changes

2eea205

refactor: apply try-retry instead of polling

dccfdc6

refactor: use google API instead of HTML component

4c407b1

darcyYe force-pushed the yemq-add-auth-status-check branch from 8da27fd to 4c407b1 Compare June 30, 2025 14:04

Darcy Ye added 2 commits July 1, 2025 10:24

revert: restore pnpm-lock.yaml to base branch version

ff2e45c

refactor: apply browser only to GOT and add referrer policy header

5e901be

darcyYe force-pushed the yemq-add-auth-status-check branch from b08dd86 to 49fdcbb Compare July 1, 2025 04:41

refactor: apply thorough CSP

1a3e917

darcyYe force-pushed the yemq-add-auth-status-check branch from 49fdcbb to 1a3e917 Compare July 1, 2025 05:21

Darcy Ye added 3 commits July 21, 2025 14:54

refactor: remove unnecessary code

455ed19

feat: only trigger GOT once

37e6e2c

darcyYe changed the title ~~feat: check auth status on cloud console~~ feat: add Google One Tap response handler Jul 21, 2025

chore: remove unused code

1e88b47

charIeszhao reviewed Jul 21, 2025

View reviewed changes

refactor: refactor code

c833d2b

darcyYe force-pushed the yemq-add-auth-status-check branch from 8fc8c53 to c833d2b Compare July 21, 2025 14:19

darcyYe merged commit f22a447 into yemq-add-local-google-one-tap Jul 22, 2025
12 of 13 checks passed

darcyYe deleted the yemq-add-auth-status-check branch July 22, 2025 06:10

Navigation Menu

Uh oh!

Uh oh!

feat: add Google One Tap response handler - #1126

feat: add Google One Tap response handler#1126
darcyYe merged 15 commits into
yemq-add-local-google-one-tapfrom
yemq-add-auth-status-check

darcyYe commented May 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 29, 2025

Uh oh!

cloudflare-workers-and-pages Bot commented May 29, 2025 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages Bot commented May 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

charIeszhao Jul 21, 2025

Uh oh!

darcyYe commented Jul 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

darcyYe commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 29, 2025

Choose a reason for hiding this comment

Uh oh!

cloudflare-workers-and-pages Bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying logto-docs-tutorials with Cloudflare Pages

Uh oh!

cloudflare-workers-and-pages Bot commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying logto-docs with Cloudflare Pages

Uh oh!

Uh oh!

Uh oh!

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

charIeszhao Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

darcyYe commented Jul 22, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

darcyYe commented May 29, 2025 •

edited

Loading

cloudflare-workers-and-pages Bot commented May 29, 2025 •

edited

Loading

cloudflare-workers-and-pages Bot commented May 29, 2025 •

edited

Loading