Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(remix): Refactor getEnvVariable #1862

Merged
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/remix': patch
---

Internal improvements for retrieving environment variables.
43 changes: 13 additions & 30 deletions packages/remix/src/ssr/authenticateRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ 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')) {
deprecated('CLERK_API_KEY', 'Use `CLERK_SECRET_KEY` instead.');
Expand All @@ -41,8 +41,7 @@ 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')) {
deprecated('CLERK_FRONTEND_API', 'Use `CLERK_PUBLISHABLE_KEY` instead.');
Expand All @@ -51,31 +50,25 @@ export function authenticateRequest(args: LoaderFunctionArgs, opts: RootAuthLoad
}
}

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
14 changes: 11 additions & 3 deletions packages/remix/src/utils.ts
Original file line number Diff line number Diff 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 Down Expand 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): string => {
octoper marked this conversation as resolved.
Show resolved Hide resolved
// Node envs
if (typeof process !== 'undefined') {
return (process.env && process.env[name]) || '';
}

// Cloudflare pages
if (context) {
const contextEnv = context?.env as Record<string, string>;
octoper marked this conversation as resolved.
Show resolved Hide 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