feat(remix): Refactor getEnvVariable#1862

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

feat(remix): Refactor getEnvVariable#1862

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
c8d1c4d
feat(remix): Refactor getEnvVariable to support Cloudflare Pages
octoper Oct 11, 2023
b3aa940
chore(repo): Adds changeset
octoper Oct 12, 2023
f5f6114
chore(repo): Update Changeset
octoper Oct 12, 2023
4717fef
fix(remix): Updated all uses of getEnvVariable to use the Remix context
octoper Oct 13, 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/thin-geese-peel.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': patch
---

Internal improvements for retrieving environment variables.
47 changes: 15 additions & 32 deletions packages/remix/src/ssr/authenticateRequest.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
// 2. Then try from process.env if exists (Node).
// 3. Then try from globalThis (Cloudflare Workers).
// 4. Then from loader context (Cloudflare Pages).
const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
if (apiKey) {
if (getEnvVariable('CLERK_API_KEY')) {
if (getEnvVariable('CLERK_API_KEY', context)) {
deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
} else {
deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
throw new Error(noSecretKeyOrApiKeyError);
}

const frontendApi =
opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
if (frontendApi) {
if (getEnvVariable('CLERK_FRONTEND_API')) {
if (getEnvVariable('CLERK_FRONTEND_API', context)) {
deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
} else {
deprecated('frontendApi', 'Use `publishableKey` instead.');
}
}

const publishableKey =
opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
const apiUrl = getEnvVariable('CLERK_API_URL', context);

const domain =
handleValueOrFn(opts.domain, new URL(request.url)) ||
getEnvVariable('CLERK_DOMAIN') ||
(context?.CLERK_DOMAIN as string) ||
'';
const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

const isSatellite =
handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
(context?.CLERK_IS_SATELLITE as string) === 'true' ||
getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
false;

const requestURL = buildRequestUrl(request);

const relativeOrAbsoluteProxyUrl = handleValueOrFn(
opts?.proxyUrl,
requestURL,
getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
getEnvVariable('CLERK_PROXY_URL', context),
);

let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
proxyUrl = relativeOrAbsoluteProxyUrl;
}

const signInUrl =
opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

const signUpUrl =
opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

const afterSignInUrl =
opts.afterSignInUrl ||
getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
(context?.CLERK_AFTER_SIGN_IN_URL as string) ||
'';
const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

const afterSignUpUrl =
opts.afterSignUpUrl ||
getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
(context?.CLERK_AFTER_SIGN_UP_URL as string) ||
'';
const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

if (isSatellite && !proxyUrl && !domain) {
throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down
2 changes: 1 addition & 1 deletion packages/remix/src/ssr/getAuth.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
}

if (requestState.isInterstitial) {
throw interstitialJsonResponse(requestState, { loader: 'nested' });
throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
}

return sanitizeAuthObject(requestState.toAuth());
Expand Down
8 changes: 4 additions & 4 deletions packages/remix/src/ssr/rootAuthLoader.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
}

if (requestState.isInterstitial) {
throw interstitialJsonResponse(requestState, { loader: 'root' });
throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
}

if (!handler) {
// if the user did not provide a handler, simply inject requestState into an empty response
return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
}

const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
}
// clone and try to inject requestState into all json-like responses
// if this fails, the user probably didn't return a json object or a valid json string
return injectRequestStateIntoResponse(handlerResult, requestState);
return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
} catch (e) {
throw new Error(invalidRootLoaderCallbackReturn);
}
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
// if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
const responseBody = JSON.stringify(handlerResult ?? {});

return injectRequestStateIntoResponse(new Response(responseBody), requestState);
return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};
21 changes: 15 additions & 6 deletions packages/remix/src/ssr/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
requestState: RequestState,
opts: { loader: 'root' | 'nested' },
context: AppLoadContext,
) => {
return json(
wrapWithClerkState({
__loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
publishableKey: requestState.publishableKey,
// TODO: This needs to be the version of clerk/remix not clerk/react
// pkgVersion: LIB_VERSION,
clerkJSUrl: getEnvVariable('CLERK_JS'),
clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
clerkJSUrl: getEnvVariable('CLERK_JS', context),
clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
proxyUrl: requestState.proxyUrl,
isSatellite: requestState.isSatellite,
domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
);
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
response: Response,
requestState: RequestState,
context: AppLoadContext,
) => {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
__afterSignInUrl: requestState.afterSignInUrl,
__afterSignUpUrl: requestState.afterSignUpUrl,
__clerk_debug: debugRequestState(requestState),
__clerkJSUrl: getEnvVariable('CLERK_JS'),
__clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
__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
Expand Down
14 changes: 11 additions & 3 deletions packages/remix/src/utils.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
* @param name
* @returns
*/
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
// Node envs
if (typeof process !== 'undefined') {
return (process.env && process.env[name]) || '';
}

// Cloudflare pages
if (typeof context !== 'undefined') {
const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.

return contextEnv[name] || (context[name] as string) || '';
}

// Cloudflare workers
try {
// @ts-expect-error
return globalThis[name];
return globalThis[name as keyof typeof globalThis];
} catch (_) {
// This will raise an error in Cloudflare Pages
}
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

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

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

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

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

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

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down

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

Skip to content
feat(remix): Refactor getEnvVariable#1862

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

octoper
merged 4 commits into

from

Oct 14, 2023
 Merged


feat(remix): Refactor getEnvVariable#1862
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
c8d1c4d

feat(remix): Refactor getEnvVariable to support Cloudflare Pages


octoper Oct 11, 2023
b3aa940

chore(repo): Adds changeset


octoper Oct 12, 2023
f5f6114

chore(repo): Update Changeset


octoper Oct 12, 2023
4717fef

fix(remix): Updated all uses of getEnvVariable to use the Remix context


octoper Oct 13, 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/thin-geese-peel.md

View file


Open in desktop

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

Internal improvements for retrieving environment variables.

47 changes: 15 additions & 32 deletions
packages/remix/src/ssr/authenticateRequest.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -27,10 +27,10 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 // 2. Then try from process.env if exists (Node).
 // 3. Then try from globalThis (Cloudflare Workers).
 // 4. Then from loader context (Cloudflare Pages).
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY') || (context?.CLERK_SECRET_KEY as string) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY') || (context?.CLERK_API_KEY as string) || '';
 const secretKey = opts.secretKey || getEnvVariable('CLERK_SECRET_KEY', context) || '';
 const apiKey = opts.apiKey || getEnvVariable('CLERK_API_KEY', context) || '';
 if (apiKey) {
 if (getEnvVariable('CLERK_API_KEY')) {
 if (getEnvVariable('CLERK_API_KEY', context)) {
 deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
 } else {
 deprecated('apiKey', 'Use `secretKey` instead.');
Expand All@@ -41,41 +41,34 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 throw new Error(noSecretKeyOrApiKeyError);
 }

 const frontendApi =
 opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API') || (context?.CLERK_FRONTEND_API as string) || '';
 const frontendApi = opts.frontendApi || getEnvVariable('CLERK_FRONTEND_API', context) || '';
 if (frontendApi) {
 if (getEnvVariable('CLERK_FRONTEND_API')) {
 if (getEnvVariable('CLERK_FRONTEND_API', context)) {
 deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
 } else {
 deprecated('frontendApi', 'Use `publishableKey` instead.');
 }
 }

 const publishableKey =
 opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY') || (context?.CLERK_PUBLISHABLE_KEY as string) || '';
 const publishableKey = opts.publishableKey || getEnvVariable('CLERK_PUBLISHABLE_KEY', context) || '';

 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY') || (context?.CLERK_JWT_KEY as string);
 const jwtKey = opts.jwtKey || getEnvVariable('CLERK_JWT_KEY', context);

 const apiUrl = getEnvVariable('CLERK_API_URL') || (context?.CLERK_API_URL as string);
 const apiUrl = getEnvVariable('CLERK_API_URL', context);

 const domain =
 handleValueOrFn(opts.domain, new URL(request.url)) ||
 getEnvVariable('CLERK_DOMAIN') ||
 (context?.CLERK_DOMAIN as string) ||
 '';
 const domain = handleValueOrFn(opts.domain, new URL(request.url)) || getEnvVariable('CLERK_DOMAIN', context) || '';

 const isSatellite =
 handleValueOrFn(opts.isSatellite, new URL(request.url)) ||
 getEnvVariable('CLERK_IS_SATELLITE') === 'true' ||
 (context?.CLERK_IS_SATELLITE as string) === 'true' ||
 getEnvVariable('CLERK_IS_SATELLITE', context) === 'true' ||
 false;

 const requestURL = buildRequestUrl(request);

 const relativeOrAbsoluteProxyUrl = handleValueOrFn(
 opts?.proxyUrl,
 requestURL,
 getEnvVariable('CLERK_PROXY_URL') || (context?.CLERK_PROXY_URL as string),
 getEnvVariable('CLERK_PROXY_URL', context),
 );

 let proxyUrl;
Expand All@@ -85,23 +78,13 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
 proxyUrl = relativeOrAbsoluteProxyUrl;
 }

 const signInUrl =
 opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL') || (context?.CLERK_SIGN_IN_URL as string) || '';
 const signInUrl = opts.signInUrl || getEnvVariable('CLERK_SIGN_IN_URL', context) || '';

 const signUpUrl =
 opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL') || (context?.CLERK_SIGN_UP_URL as string) || '';
 const signUpUrl = opts.signUpUrl || getEnvVariable('CLERK_SIGN_UP_URL', context) || '';

 const afterSignInUrl =
 opts.afterSignInUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_IN_URL') ||
 (context?.CLERK_AFTER_SIGN_IN_URL as string) ||
 '';
 const afterSignInUrl = opts.afterSignInUrl || getEnvVariable('CLERK_AFTER_SIGN_IN_URL', context) || '';

 const afterSignUpUrl =
 opts.afterSignUpUrl ||
 getEnvVariable('CLERK_AFTER_SIGN_UP_URL') ||
 (context?.CLERK_AFTER_SIGN_UP_URL as string) ||
 '';
 const afterSignUpUrl = opts.afterSignUpUrl || getEnvVariable('CLERK_AFTER_SIGN_UP_URL', context) || '';

 if (isSatellite && !proxyUrl && !domain) {
 throw new Error(satelliteAndMissingProxyUrlAndDomain);
Expand Down

2 changes: 1 addition & 1 deletion
packages/remix/src/ssr/getAuth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,7 +18,7 @@ export async function getAuth(args: LoaderFunctionArgs, opts?: GetAuthOptions):
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'nested' });
 throw interstitialJsonResponse(requestState, { loader: 'nested' }, args.context);
 }

 return sanitizeAuthObject(requestState.toAuth());
Expand Down

8 changes: 4 additions & 4 deletions
packages/remix/src/ssr/rootAuthLoader.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,12 +53,12 @@ export const rootAuthLoader: RootAuthLoader = async (
 }

 if (requestState.isInterstitial) {
 throw interstitialJsonResponse(requestState, { loader: 'root' });
 throw interstitialJsonResponse(requestState, { loader: 'root' }, args.context);
 }

 if (!handler) {
 // if the user did not provide a handler, simply inject requestState into an empty response
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState);
 return injectRequestStateIntoResponse(new Response(JSON.stringify({})), requestState, args.context);
 }

 const handlerResult = await handler(injectAuthIntoRequest(args, sanitizeAuthObject(requestState.toAuth())));
Expand All@@ -72,7 +72,7 @@ export const rootAuthLoader: RootAuthLoader = async (
 }
 // clone and try to inject requestState into all json-like responses
 // if this fails, the user probably didn't return a json object or a valid json string
 return injectRequestStateIntoResponse(handlerResult, requestState);
 return injectRequestStateIntoResponse(handlerResult, requestState, args.context);
 } catch (e) {
 throw new Error(invalidRootLoaderCallbackReturn);
 }
Expand All@@ -81,5 +81,5 @@ export const rootAuthLoader: RootAuthLoader = async (
 // if the return value of the user's handler is null or a plain object, create an empty response to inject Clerk's state into
 const responseBody = JSON.stringify(handlerResult ?? {});

 return injectRequestStateIntoResponse(new Response(responseBody), requestState);
 return injectRequestStateIntoResponse(new Response(responseBody), requestState, args.context);
};

21 changes: 15 additions & 6 deletions
packages/remix/src/ssr/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +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 { json } from '@remix-run/server-runtime';
import cookie from 'cookie';

Expand DownExpand Up@@ -75,7 +76,11 @@ export const unknownResponse = (requestState: RequestState) => {
 return json(null, { status: 401, headers: observabilityHeadersFromRequestState(requestState) });
};

export const interstitialJsonResponse = (requestState: RequestState, opts: { loader: 'root' | 'nested' }) => {
export const interstitialJsonResponse = (
 requestState: RequestState,
 opts: { loader: 'root' | 'nested' },
 context: AppLoadContext,
) => {
 return json(
 wrapWithClerkState({
 __loader: opts.loader,
Expand All@@ -85,8 +90,8 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 publishableKey: requestState.publishableKey,
 // TODO: This needs to be the version of clerk/remix not clerk/react
 // pkgVersion: LIB_VERSION,
 clerkJSUrl: getEnvVariable('CLERK_JS'),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 clerkJSUrl: getEnvVariable('CLERK_JS', context),
 clerkJSVersion: getEnvVariable('CLERK_JS_VERSION', context),
 proxyUrl: requestState.proxyUrl,
 isSatellite: requestState.isSatellite,
 domain: requestState.domain,
Expand All@@ -97,7 +102,11 @@ export const interstitialJsonResponse = (requestState: RequestState, opts: { loa
 );
};

export const injectRequestStateIntoResponse = async (response: Response, requestState: RequestState) => {
export const injectRequestStateIntoResponse = async (
 response: Response,
 requestState: RequestState,
 context: AppLoadContext,
) => {
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const { reason, message, isSignedIn, isInterstitial, ...rest } = requestState;
 const clone = response.clone();
Expand All@@ -114,8 +123,8 @@ export const injectRequestStateIntoResponse = async (response: Response, request
 __afterSignInUrl: requestState.afterSignInUrl,
 __afterSignUpUrl: requestState.afterSignUpUrl,
 __clerk_debug: debugRequestState(requestState),
 __clerkJSUrl: getEnvVariable('CLERK_JS'),
 __clerkJSVersion: getEnvVariable('CLERK_JS_VERSION'),
 __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
Expand Down

14 changes: 11 additions & 3 deletions
packages/remix/src/utils.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
import type { AppLoadContext } from '@remix-run/server-runtime';

import type { ClerkState } from './client/types';
import { invalidClerkStatePropError, noClerkStateError } from './errors';

Expand DownExpand Up@@ -29,16 +31,22 @@ export function assertValidClerkState(val: any): asserts val is ClerkState | und
 * @param name
 * @returns
 */
export const getEnvVariable = (name: string): string => {
export const getEnvVariable = (name: string, context: AppLoadContext | undefined): string => {
 // Node envs
 if (typeof process !== 'undefined') {
 return (process.env && process.env[name]) || '';
 }

 // Cloudflare pages
 if (typeof context !== 'undefined') {
 const contextEnv = context?.env as Record<string, string>;
Comment thread
octoper marked this conversation as resolved.


 return contextEnv[name] || (context[name] as string) || '';
 }

 // Cloudflare workers
 try {
 // @ts-expect-error
 return globalThis[name];
 return globalThis[name as keyof typeof globalThis];
 } catch (_) {
 // This will raise an error in Cloudflare Pages
 }
Expand Down