fix(elements): Fix elements router usage (#4513)

alexcarpenter · brkalow · web-flow · commit f7472e22877f · 2024-11-07T21:21:48.000-06:00
Co-authored-by: Bryce Kalow &lt;bryce@clerk.dev&gt;
diff --git a/.changeset/empty-dots-confess.md b/.changeset/empty-dots-confess.md
@@ -0,0 +1,9 @@
+---
+'@clerk/elements': patch
+'@clerk/nextjs': patch
+'@clerk/shared': patch
+'@clerk/types': patch
+'@clerk/clerk-js': patch
+---
+
+Fixes issues in `ClerkRouter` that were causing inaccurate pathnames within Elements flows. Also fixes a dependency issue where `@clerk/elements` was pulling in the wrong version of `@clerk/shared`.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/clerk-js/bundlewatch.config.json b/packages/clerk-js/bundlewatch.config.json
@@ -3,7 +3,7 @@
     { "path": "./dist/clerk.js", "maxSize": "707kB" },
     { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
     { "path": "./dist/clerk.headless.js", "maxSize": "48kB" },
-    { "path": "./dist/ui-common*.js", "maxSize": "87KB" },
+    { "path": "./dist/ui-common*.js", "maxSize": "88KB" },
     { "path": "./dist/vendors*.js", "maxSize": "70KB" },
     { "path": "./dist/coinbase*.js", "maxSize": "58KB" },
     { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
diff --git a/packages/clerk-js/jest.setup.ts b/packages/clerk-js/jest.setup.ts
@@ -35,6 +35,7 @@ if (typeof window !== 'undefined') {
 
   global.__PKG_NAME__ = '';
   global.__PKG_VERSION__ = '';
+  global.BUILD_ENABLE_NEW_COMPONENTS = '';
 
   //@ts-expect-error
   global.IntersectionObserver = class IntersectionObserver {
diff --git a/packages/clerk-js/rspack.config.js b/packages/clerk-js/rspack.config.js
@@ -42,6 +42,7 @@ const common = ({ mode }) => {
         __DEV__: isDevelopment(mode),
         __PKG_VERSION__: JSON.stringify(packageJSON.version),
         __PKG_NAME__: JSON.stringify(packageJSON.name),
+        BUILD_ENABLE_NEW_COMPONENTS: JSON.stringify(process.env.BUILD_ENABLE_NEW_COMPONENTS),
       }),
       new rspack.EnvironmentPlugin({
         CLERK_ENV: mode,
diff --git a/packages/clerk-js/src/core/clerk.ts b/packages/clerk-js/src/core/clerk.ts
@@ -340,12 +340,14 @@ export class Clerk implements ClerkInterface {
       this.#loaded = await this.#loadInNonStandardBrowser();
     }
 
-    if (clerkIsLoaded(this)) {
-      this.__experimental_ui = new UI({
-        router: this.#options.__experimental_router,
-        clerk: this,
-        options: this.#options,
-      });
+    if (BUILD_ENABLE_NEW_COMPONENTS) {
+      if (clerkIsLoaded(this)) {
+        this.__experimental_ui = new UI({
+          router: this.#options.__experimental_router,
+          clerk: this,
+          options: this.#options,
+        });
+      }
     }
   };
 
diff --git a/packages/clerk-js/src/global.d.ts b/packages/clerk-js/src/global.d.ts
@@ -2,3 +2,5 @@ declare module '@clerk/ui/styles.css' {
   const content: string;
   export default content;
 }
+
+declare const BUILD_ENABLE_NEW_COMPONENTS: string;
diff --git a/packages/clerk-js/src/ui/new/index.tsx b/packages/clerk-js/src/ui/new/index.tsx
@@ -33,21 +33,23 @@ export class UI {
     this.clerk = clerk;
     this.options = options;
 
-    // register components
-    this.register('SignIn', {
-      type: 'component',
-      load: () =>
-        import(/* webpackChunkName: "rebuild--sign-in" */ '@clerk/ui/sign-in').then(({ SignIn }) => ({
-          default: SignIn,
-        })),
-    });
-    this.register('SignUp', {
-      type: 'component',
-      load: () =>
-        import(/* webpackChunkName: "rebuild--sign-up" */ '@clerk/ui/sign-up').then(({ SignUp }) => ({
-          default: SignUp,
-        })),
-    });
+    if (BUILD_ENABLE_NEW_COMPONENTS) {
+      // register components
+      this.register('SignIn', {
+        type: 'component',
+        load: () =>
+          import(/* webpackChunkName: "rebuild--sign-in" */ '@clerk/ui/sign-in').then(({ SignIn }) => ({
+            default: SignIn,
+          })),
+      });
+      this.register('SignUp', {
+        type: 'component',
+        load: () =>
+          import(/* webpackChunkName: "rebuild--sign-up" */ '@clerk/ui/sign-up').then(({ SignUp }) => ({
+            default: SignUp,
+          })),
+      });
+    }
   }
 
   // Mount a component from the registry
diff --git a/packages/clerk-js/turbo.json b/packages/clerk-js/turbo.json
@@ -2,6 +2,7 @@
   "extends": ["//"],
   "tasks": {
     "build": {
+      "env": ["BUILD_ENABLE_NEW_COMPONENTS"],
       "inputs": [
         "*.d.ts",
         "bundlewatch.config.json",
diff --git a/packages/elements/package.json b/packages/elements/package.json
@@ -71,7 +71,6 @@
     "test:cache:clear": "jest --clearCache --useStderr"
   },
   "dependencies": {
-    "@clerk/shared": "2.11.5",
     "@clerk/types": "^4.30.0",
     "@radix-ui/react-form": "^0.1.0",
     "@radix-ui/react-slot": "^1.1.0",
@@ -82,6 +81,7 @@
   "devDependencies": {
     "@clerk/clerk-react": "5.15.1",
     "@clerk/eslint-config-custom": "*",
+    "@clerk/shared": "2.11.5",
     "@statelyai/inspect": "^0.4.0",
     "@types/node": "^18.19.33",
     "@types/react": "*",
@@ -94,6 +94,8 @@
     "typescript": "*"
   },
   "peerDependencies": {
+    "@clerk/shared": "2.x",
+    "next": "^13.5.4 || ^14.0.3 || ^15",
     "react": "^18.0.0 || ^19.0.0-beta",
     "react-dom": "^18.0.0 || ^19.0.0-beta"
   },
diff --git a/packages/elements/src/internals/machines/third-party/third-party.actors.ts b/packages/elements/src/internals/machines/third-party/third-party.actors.ts
@@ -80,8 +80,8 @@ export const handleRedirectCallback = fromCallback<AnyEventObject, HandleRedirec
       {
         signInForceRedirectUrl: ClerkJSNavigationEvent.complete,
         signInFallbackRedirectUrl: ClerkJSNavigationEvent.complete,
-        signUpForceRedirectUrl: ClerkJSNavigationEvent.signUp,
-        signUpFallbackRedirectUrl: ClerkJSNavigationEvent.signUp,
+        signUpForceRedirectUrl: ClerkJSNavigationEvent.complete,
+        signUpFallbackRedirectUrl: ClerkJSNavigationEvent.complete,
         continueSignUpUrl: ClerkJSNavigationEvent.continue,
         firstFactorUrl: ClerkJSNavigationEvent.signIn,
         resetPasswordUrl: ClerkJSNavigationEvent.resetPassword,
diff --git a/packages/elements/src/react/router/index.ts b/packages/elements/src/react/router/index.ts
@@ -1,2 +1,3 @@
-export { Route, Router, useClerkRouter } from '@clerk/shared/router';
+export { Route, Router, useClerkRouter, ClerkHostRouterContext } from '@clerk/shared/router';
 export { useVirtualRouter } from './virtual';
+export { useNextRouter } from './next';
diff --git a/packages/elements/src/react/router/next.ts b/packages/elements/src/react/router/next.ts
@@ -0,0 +1,35 @@
+import type { ClerkHostRouter } from '@clerk/types';
+import { usePathname, useRouter, useSearchParams } from 'next/navigation';
+
+import { NEXT_WINDOW_HISTORY_SUPPORT_VERSION } from '~/internals/constants';
+
+import { usePathnameWithoutCatchAll } from '../utils/path-inference/next';
+
+/**
+ * Clerk Elements router integration with Next.js's router.
+ */
+export const useNextRouter = (): ClerkHostRouter => {
+  const router = useRouter();
+  const pathname = usePathname();
+  const searchParams = useSearchParams();
+  const inferredBasePath = usePathnameWithoutCatchAll();
+
+  // The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
+  // preserve internal state between steps.
+  const canUseWindowHistoryAPIs =
+    typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;
+
+  return {
+    mode: 'path',
+    name: 'NextRouter',
+    push: (path: string) => router.push(path),
+    replace: (path: string) =>
+      canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
+    shallowPush(path: string) {
+      canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
+    },
+    pathname: () => pathname,
+    searchParams: () => searchParams,
+    inferredBasePath: () => inferredBasePath,
+  };
+};
diff --git a/packages/elements/src/react/sign-in/root.tsx b/packages/elements/src/react/sign-in/root.tsx
@@ -1,5 +1,4 @@
 import { useClerk } from '@clerk/shared/react';
-import { useClerkHostRouter } from '@clerk/shared/router';
 import { eventComponentMounted } from '@clerk/shared/telemetry';
 import { useSelector } from '@xstate/react';
 import React, { useEffect } from 'react';
@@ -10,11 +9,10 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
 import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
 import { SignInRouterMachine } from '~/internals/machines/sign-in';
 import { inspect } from '~/internals/utils/inspector';
-import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
+import { ClerkHostRouterContext, Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
 import { SignInRouterCtx } from '~/react/sign-in/context';
 
 import { Form } from '../common/form';
-import { removeOptionalCatchAllSegment } from '../utils/path-inference/utils';
 
 type SignInFlowProviderProps = {
   children: React.ReactNode;
@@ -118,9 +116,9 @@ export function SignInRoot({
   routing = ROUTING.path,
 }: SignInRootProps): JSX.Element | null {
   const clerk = useClerk();
-  const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
+  const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
   const pathname = router.pathname();
-  const inferredPath = removeOptionalCatchAllSegment(pathname);
+  const inferredPath = router.inferredBasePath?.();
   const path = pathProp || inferredPath || SIGN_IN_DEFAULT_BASE_PATH;
   const isRootPath = path === pathname;
 
@@ -134,19 +132,18 @@ export function SignInRoot({
   );
 
   return (
-    <Router
-      basePath={path}
-      router={router}
-    >
-      <FormStoreProvider>
-        <SignInFlowProvider
-          exampleMode={exampleMode}
-          fallback={fallback}
-          isRootPath={isRootPath}
-        >
-          {children}
-        </SignInFlowProvider>
-      </FormStoreProvider>
-    </Router>
+    <ClerkHostRouterContext.Provider value={router}>
+      <Router basePath={path}>
+        <FormStoreProvider>
+          <SignInFlowProvider
+            exampleMode={exampleMode}
+            fallback={fallback}
+            isRootPath={isRootPath}
+          >
+            {children}
+          </SignInFlowProvider>
+        </FormStoreProvider>
+      </Router>
+    </ClerkHostRouterContext.Provider>
   );
 }
diff --git a/packages/elements/src/react/sign-up/root.tsx b/packages/elements/src/react/sign-up/root.tsx
@@ -1,5 +1,4 @@
 import { useClerk } from '@clerk/shared/react';
-import { useClerkHostRouter } from '@clerk/shared/router';
 import { eventComponentMounted } from '@clerk/shared/telemetry';
 import { useSelector } from '@xstate/react';
 import { useEffect } from 'react';
@@ -10,11 +9,10 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
 import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
 import { SignUpRouterMachine } from '~/internals/machines/sign-up';
 import { inspect } from '~/internals/utils/inspector';
-import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
+import { ClerkHostRouterContext, Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
 import { SignUpRouterCtx } from '~/react/sign-up/context';
 
 import { Form } from '../common/form';
-import { removeOptionalCatchAllSegment } from '../utils/path-inference/utils';
 
 type SignUpFlowProviderProps = {
   children: React.ReactNode;
@@ -117,9 +115,9 @@ export function SignUpRoot({
   routing = ROUTING.path,
 }: SignUpRootProps): JSX.Element | null {
   const clerk = useClerk();
-  const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
+  const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
   const pathname = router.pathname();
-  const inferredPath = removeOptionalCatchAllSegment(pathname);
+  const inferredPath = router.inferredBasePath?.();
   const path = pathProp || inferredPath || SIGN_UP_DEFAULT_BASE_PATH;
   const isRootPath = path === pathname;
 
@@ -133,19 +131,18 @@ export function SignUpRoot({
   );
 
   return (
-    <Router
-      basePath={path}
-      router={router}
-    >
-      <FormStoreProvider>
-        <SignUpFlowProvider
-          exampleMode={exampleMode}
-          fallback={fallback}
-          isRootPath={isRootPath}
-        >
-          {children}
-        </SignUpFlowProvider>
-      </FormStoreProvider>
-    </Router>
+    <ClerkHostRouterContext.Provider value={router}>
+      <Router basePath={path}>
+        <FormStoreProvider>
+          <SignUpFlowProvider
+            exampleMode={exampleMode}
+            fallback={fallback}
+            isRootPath={isRootPath}
+          >
+            {children}
+          </SignUpFlowProvider>
+        </FormStoreProvider>
+      </Router>
+    </ClerkHostRouterContext.Provider>
   );
 }
diff --git a/packages/nextjs/src/app-router/client/ClerkProvider.tsx b/packages/nextjs/src/app-router/client/ClerkProvider.tsx
diff --git a/packages/nextjs/src/pages/ClerkProvider.tsx b/packages/nextjs/src/pages/ClerkProvider.tsx
diff --git a/packages/types/src/router.ts b/packages/types/src/router.ts

Original file line number	Diff line number	Diff line change
`@@ -2,3 +2,5 @@ declare module '@clerk/ui/styles.css' {`
`2`	`2`	`const content: string;`
`3`	`3`	`export default content;`
`4`	`4`	`}`
	`5`	`+`
	`6`	`+declare const BUILD_ENABLE_NEW_COMPONENTS: string;`