Skip to content

feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

Sign up for GitHub

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
brkalow merged 4 commits into from
Oct 23, 2023
Merged

feat(remix): Support defer() usage in rootAuthLoader() #1926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
baabe78
feat(remix): Support defer() usage in rootAuthLoader()
brkalow Oct 20, 2023
15bd1c7
chore(repo): Add changeset
brkalow Oct 20, 2023
5e874e4
fix(remix): Remove unused import
brkalow Oct 20, 2023
62b8c24
Update playground/remix-node/app/root.tsx
brkalow Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/loud-peaches-travel.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.
13 changes: 13 additions & 0 deletions packages/remix/src/ssr/rootAuthLoader.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
assertValidHandlerResult,
injectAuthIntoRequest,
injectRequestStateIntoDeferredData,
injectRequestStateIntoResponse,
interstitialJsonResponse,
isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

// When using defer(), we need to inject the clerk auth state into its internal data object.
if (isDeferredData(handlerResult)) {
return injectRequestStateIntoDeferredData(
// This is necessary because the DeferredData type is not exported from remix.
handlerResult as unknown as ReturnType<typeof defer>,
requestState,
args.context,
);
}

if (isResponse(handlerResult)) {
try {
// respect and pass-through any redirects without modifying them
Expand Down
61 changes: 51 additions & 10 deletions packages/remix/src/ssr/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
context: AppLoadContext,
) => {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
const clone = response.clone();
const data = await clone.json();

const { clerkState, headers } = getResponseClerkState(requestState, context);

// set the correct content-type header in case the user returned a `Response` directly
// without setting the header, instead of using the `json()` helper
clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
headers.forEach((value, key) => {
clone.headers.set(key, value);
});

return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
data: ReturnType<typeof defer>,
requestState: RequestState,
context: AppLoadContext,
) {
const { clerkState, headers } = getResponseClerkState(requestState, context);

// Avoid creating a new object here to retain referential equality.
data.data.clerkState = clerkState.clerkState;

if (typeof data.init !== 'undefined') {
data.init.headers = new Headers(data.init.headers);

headers.forEach((value, key) => {
// @ts-expect-error -- We are ensuring headers is defined above
data.init.headers.set(key, value);
});
}

return data;
}

/**
* Returns the clerk state object and observability headers to be injected into a loader response.
*
* @internal
*/
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
const clerkState = wrapWithClerkState({
__clerk_ssr_state: rest.toAuth(),
__frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
__clerkJSUrl: getEnvVariable('CLERK_JS', context),
__clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
});
// set the correct content-type header in case the user returned a `Response` directly
// without setting the header, instead of using the `json()` helper
clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
clone.headers.set(key, value);
});

return json({ ...(data || {}), ...clerkState }, clone);
};
const headers = observabilityHeadersFromRequestState(requestState);

return {
clerkState,
headers,
};
}

/**
* Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down
19 changes: 12 additions & 7 deletions playground/remix-node/app/root.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
return rootAuthLoader(
args,
({ request }) => {
const { user } = request;
const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

console.log('root User:', user);

return { user };
return defer({ user, data }, { headers: { 'x-clerk': '1' } })
},
{ loadUser: true },
);
Expand All@@ -27,10 +29,8 @@ export function headers({
loaderHeaders: Headers;
parentHeaders: Headers;
}) {
return {
'x-parent-header': parentHeaders.get('x-parent-header'),
...getClerkDebugHeaders(loaderHeaders),
};
console.log(loaderHeaders)
return loaderHeaders
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
<Links />
</head>
<body>
<Suspense fallback="Loading...">
<Await resolve={loaderData.data}>
{val => (<>Hello {val.foo}</>)}
</Await>
</Suspense>
<Outlet />
<ScrollRestoration />
<Scripts />
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(remix): Support defer() usage in rootAuthLoader() by brkalow · Pull Request #1926 · clerk/javascript · GitHub
Skip to content
feat(remix): Support defer() usage in rootAuthLoader()#1926

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.

 Sign up for GitHub

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

brkalow
merged 4 commits into

from

Oct 23, 2023
 Merged


feat(remix): Support defer() usage in rootAuthLoader()
#1926
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
baabe78

feat(remix): Support defer() usage in rootAuthLoader()


brkalow Oct 20, 2023
15bd1c7

chore(repo): Add changeset


brkalow Oct 20, 2023
5e874e4

fix(remix): Remove unused import


brkalow Oct 20, 2023
62b8c24

Update playground/remix-node/app/root.tsx


brkalow Oct 20, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/loud-peaches-travel.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': minor
---

Support usage of Remix's `defer()` method in the loader passed to `rootAuthLoader()`.

13 changes: 13 additions & 0 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
import { sanitizeAuthObject } from '@clerk/backend';
import type { defer } from '@remix-run/server-runtime';
import { isDeferredData } from '@remix-run/server-runtime/dist/responses';

import { invalidRootLoaderCallbackReturn } from '../errors';
import { authenticateRequest } from './authenticateRequest';
import type { LoaderFunctionArgs, LoaderFunctionReturn, RootAuthLoaderCallback, RootAuthLoaderOptions } from './types';
import {
 assertValidHandlerResult,
 injectAuthIntoRequest,
 injectRequestStateIntoDeferredData,
 injectRequestStateIntoResponse,
 interstitialJsonResponse,
 isRedirect,
Expand DownExpand Up@@ -64,6 +67,16 @@ export const rootAuthLoader: RootAuthLoader = async (
 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
 assertValidHandlerResult(handlerResult, invalidRootLoaderCallbackReturn);

 // When using defer(), we need to inject the clerk auth state into its internal data object.
 if (isDeferredData(handlerResult)) {
 return injectRequestStateIntoDeferredData(
 // This is necessary because the DeferredData type is not exported from remix.
 handlerResult as unknown as ReturnType<typeof defer>,
 requestState,
 args.context,
 );
 }

 if (isResponse(handlerResult)) {
 try {
 // respect and pass-through any redirects without modifying them
Expand Down

61 changes: 51 additions & 10 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { AuthObject, RequestState } from '@clerk/backend';
import { constants, debugRequestState, loadInterstitialFromLocal } from '@clerk/backend';
import type { AppLoadContext } from '@remix-run/server-runtime';
import type { AppLoadContext, defer } from '@remix-run/server-runtime';
import { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -108,9 +108,51 @@ export const injectRequestStateIntoResponse = async (
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
 const data = await clone.json();

 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 headers.forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};

export function injectRequestStateIntoDeferredData(
 data: ReturnType<typeof defer>,
 requestState: RequestState,
 context: AppLoadContext,
) {
 const { clerkState, headers } = getResponseClerkState(requestState, context);

 // Avoid creating a new object here to retain referential equality.
 data.data.clerkState = clerkState.clerkState;

 if (typeof data.init !== 'undefined') {
 data.init.headers = new Headers(data.init.headers);

 headers.forEach((value, key) => {
 // @ts-expect-error -- We are ensuring headers is defined above
 data.init.headers.set(key, value);
 });
 }

 return data;
}

/**
 * Returns the clerk state object and observability headers to be injected into a loader response.
 *
 * @internal
 */
export function getResponseClerkState(requestState: RequestState, context: AppLoadContext) {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clerkState = wrapWithClerkState({
 __clerk_ssr_state: rest.toAuth(),
 __frontendApi: requestState.frontendApi,
Expand All@@ -126,15 +168,14 @@ export const injectRequestStateIntoResponse = async (
 __clerkJSUrl: getEnvVariable('CLERK_JS', context),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 });
 // set the correct content-type header in case the user returned a `Response` directly
 // without setting the header, instead of using the `json()` helper
 clone.headers.set(constants.Headers.ContentType, constants.ContentTypes.Json);
 observabilityHeadersFromRequestState(requestState).forEach((value, key) => {
 clone.headers.set(key, value);
 });

 return json({ ...(data || {}), ...clerkState }, clone);
};
 const headers = observabilityHeadersFromRequestState(requestState);

 return {
 clerkState,
 headers,
 };
}

/**
 * Wraps obscured clerk internals with a readable `clerkState` key.
Expand Down

19 changes: 12 additions & 7 deletions
playground/remix-node/app/root.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
import type { DataFunctionArgs, Headers } from '@remix-run/node';
import { defer, type DataFunctionArgs, type Headers } from '@remix-run/node';
import type { MetaFunction } from '@remix-run/react';
import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { Await, Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration, useLoaderData } from '@remix-run/react';
import { getClerkDebugHeaders, rootAuthLoader } from '@clerk/remix/ssr.server';
import { ClerkApp, ClerkErrorBoundary } from '@clerk/remix';
import { Suspense } from 'react';

export const loader = (args: DataFunctionArgs) => {
 return rootAuthLoader(
 args,
 ({ request }) => {
 const { user } = request;
 const data: Promise<{ foo: string }> = new Promise(r => r({ foo: 'bar' }))

 console.log('root User:', user);

 return { user };
 return defer({ user, data }, { headers: { 'x-clerk': '1' } })
 },
 { loadUser: true },
 );
Expand All@@ -27,10 +29,8 @@ export function headers({
 loaderHeaders: Headers;
 parentHeaders: Headers;
}) {
 return {
 'x-parent-header': parentHeaders.get('x-parent-header'),
 ...getClerkDebugHeaders(loaderHeaders),
 };
 console.log(loaderHeaders)
 return loaderHeaders 
}

export const meta: MetaFunction = () => {
Expand DownExpand Up@@ -60,6 +60,11 @@ function App() {
 <Links />
 </head>
 <body>
 <Suspense fallback="Loading...">
 <Await resolve={loaderData.data}>
 {val => (<>Hello {val.foo}</>)}
 </Await>
 </Suspense>
 <Outlet />
 <ScrollRestoration />
 <Scripts />
Expand Down