zaid.marzguioui/myeasycms-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor key access and role warning in Supabase clients

Browse Source 
The update simplifies accessing environment keys and role warnings in Supabase clients by moving them to new functions 'getSupabaseClientKeys' and 'getServiceRoleKey'. The redundancy in the code is reduced promoting clearer and more maintainable code. The '@epic-web/invariant' import has been removed from files as it is no longer needed.
This commit is contained in:
giancarlo
2024-04-13 12:57:56 +08:00
parent 7f11905fc1
commit 87e8376af6
14 changed files with 1912 additions and 1948 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
apps/web/app/(dashboard)/home/[account]/billing/return/page.tsx
View File

@@ -18,9 +18,7 @@ interface SessionPageProps {
const LazyEmbeddedCheckout = dynamic(
async () => {
const { EmbeddedCheckout } = await import(
'@kit/billing-gateway/components'
);
const { EmbeddedCheckout } = await import('@kit/billing-gateway/checkout');
return EmbeddedCheckout;
},

3
apps/web/app/server-sitemap.xml/route.ts
View File

@@ -1,12 +1,9 @@
import { invariant } from '@epic-web/invariant';
import { getServerSideSitemap } from 'next-sitemap';
import { createCmsClient } from '@kit/cms';
import appConfig from '~/config/app.config';
invariant(appConfig.url, 'No NEXT_PUBLIC_SITE_URL environment variable found');
export async function GET() {
const urls = getSiteUrls();

1873
apps/web/lib/database.types.ts
View File

File diff suppressed because it is too large Load Diff

4
apps/web/lib/i18n/i18n.resolver.ts
View File

@@ -4,8 +4,8 @@
*/
export async function i18nResolver(language: string, namespace: string) {
const data = await import(
`../../public/locales/${language}/${namespace}.json`,
);
`../../public/locales/${language}/${namespace}.json`
);
return data as Record<string, string>;
}

1
apps/web/package.json
View File

@@ -29,7 +29,6 @@
"supabase:typegen:app": "supabase gen types typescript --local > ./lib/database.types.ts"
},
"dependencies": {
"@epic-web/invariant": "^1.0.0",
"@hookform/resolvers": "^3.3.4",
"@kit/accounts": "workspace:^",
"@kit/admin": "workspace:^",

2
packages/supabase/package.json
View File

@@ -23,7 +23,6 @@
"./database": "./src/database.types.ts"
},
"devDependencies": {
"@epic-web/invariant": "^1.0.0",
"@kit/eslint-config": "workspace:*",
"@kit/prettier-config": "workspace:*",
"@kit/tailwind-config": "workspace:*",
@@ -38,7 +37,6 @@
"zod": "^3.22.4"
},
"peerDependencies": {
"@epic-web/invariant": "^1.0.0",
"@supabase/ssr": "^0.3.0",
"@supabase/supabase-js": "^2.42.0",
"@tanstack/react-query": "^5.28.6",

10
packages/supabase/src/clients/browser.client.ts
View File

@@ -1,18 +1,14 @@
import { invariant } from '@epic-web/invariant';
import { createBrowserClient } from '@supabase/ssr';
import { Database } from '../database.types';
import { getSupabaseClientKeys } from '../get-supabase-client-keys';
/**
* @name getSupabaseBrowserClient
* @description Get a Supabase client for use in the Browser
*/
export function getSupabaseBrowserClient<GenericSchema = Database>() {
const SUPABASE_URL = process.env.NEXT_PUBLIC_SUPABASE_URL;
const SUPABASE_ANON_KEY = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY;
const keys = getSupabaseClientKeys();
invariant(SUPABASE_URL, `Supabase URL was not provided`);
invariant(SUPABASE_ANON_KEY, `Supabase Anon key was not provided`);
return createBrowserClient<GenericSchema>(SUPABASE_URL, SUPABASE_ANON_KEY);
return createBrowserClient<GenericSchema>(keys.url, keys.anonKey);
}

13
packages/supabase/src/clients/route-handler.client.ts
View File

@@ -6,6 +6,7 @@ import type { CookieOptions } from '@supabase/ssr';
import { createServerClient } from '@supabase/ssr';
import { Database } from '../database.types';
import { getServiceRoleKey } from '../get-service-role-key';
import { getSupabaseClientKeys } from '../get-supabase-client-keys';
/**
@@ -20,17 +21,7 @@ export function getSupabaseRouteHandlerClient<GenericSchema = Database>(
const keys = getSupabaseClientKeys();
if (params.admin) {
const serviceRoleKey = process.env.SUPABASE_SERVICE_ROLE_KEY;
if (process.env.NODE_ENV !== 'production') {
console.warn(
`[Dev Only] You are using the Supabase Service Role. Make sure it's the right call.`,
);
}
if (!serviceRoleKey) {
throw new Error('Supabase Service Role Key not provided');
}
const serviceRoleKey = getServiceRoleKey();
return createServerClient<GenericSchema>(keys.url, serviceRoleKey, {
auth: {

13
packages/supabase/src/clients/server-actions.client.ts
View File

@@ -5,6 +5,7 @@ import { cookies } from 'next/headers';
import { createServerClient } from '@supabase/ssr';
import { Database } from '../database.types';
import { getServiceRoleKey } from '../get-service-role-key';
import { getSupabaseClientKeys } from '../get-supabase-client-keys';
function createServerSupabaseClient() {
@@ -22,17 +23,7 @@ export function getSupabaseServerActionClient<
const admin = params?.admin ?? false;
if (admin) {
const serviceRoleKey = process.env.SUPABASE_SERVICE_ROLE_KEY;
if (process.env.NODE_ENV !== 'production') {
console.warn(
`[Dev Only] You are using the Supabase Service Role. Make sure it's the right call.`,
);
}
if (!serviceRoleKey) {
throw new Error('Supabase Service Role Key not provided');
}
const serviceRoleKey = getServiceRoleKey();
return createServerClient<GenericSchema>(keys.url, serviceRoleKey, {
auth: {

13
packages/supabase/src/clients/server-component.client.ts
View File

@@ -5,6 +5,7 @@ import { cookies } from 'next/headers';
import { createServerClient } from '@supabase/ssr';
import { Database } from '../database.types';
import { getServiceRoleKey } from '../get-service-role-key';
import { getSupabaseClientKeys } from '../get-supabase-client-keys';
/**
@@ -19,17 +20,7 @@ export function getSupabaseServerComponentClient<GenericSchema = Database>(
const keys = getSupabaseClientKeys();
if (params.admin) {
const serviceRoleKey = process.env.SUPABASE_SERVICE_ROLE_KEY;
if (process.env.NODE_ENV !== 'production') {
console.warn(
`[Dev Only] You are using the Supabase Service Role. Make sure it's the right call.`,
);
}
if (!serviceRoleKey) {
throw new Error('Supabase Service Role Key not provided');
}
const serviceRoleKey = getServiceRoleKey();
return createServerClient<GenericSchema>(keys.url, serviceRoleKey, {
auth: {

1873
packages/supabase/src/database.types.ts
View File

File diff suppressed because it is too large Load Diff

18
packages/supabase/src/get-service-role-key.ts Normal file
View File

@@ -0,0 +1,18 @@
import { z } from 'zod';
/**
* @name getServiceRoleKey
* @description Get the Supabase Service Role Key.
* ONLY USE IN SERVER-SIDE CODE. DO NOT EXPOSE THIS TO CLIENT-SIDE CODE.
*/
export function getServiceRoleKey() {
const serviceRoleKey = process.env.SUPABASE_SERVICE_ROLE_KEY;
if (process.env.NODE_ENV !== 'production') {
console.warn(
`[Dev Only] You are using the Supabase Service Role. Make sure it's the right call.`,
);
}
return z.string().min(1).parse(serviceRoleKey);
}

24
packages/supabase/src/get-supabase-client-keys.ts
View File

@@ -1,20 +1,16 @@
import { invariant } from '@epic-web/invariant';
import { z } from 'zod';
/**
* Returns and validates the Supabase client keys from the environment.
*/
export function getSupabaseClientKeys() {
const env = process.env;
invariant(env.NEXT_PUBLIC_SUPABASE_URL, `Supabase URL not provided`);
invariant(
env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
`Supabase Anon Key not provided`,
);
return {
url: env.NEXT_PUBLIC_SUPABASE_URL,
anonKey: env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
};
return z
.object({
url: z.string().min(1),
anonKey: z.string().min(1),
})
.parse({
url: process.env.NEXT_PUBLIC_SUPABASE_URL,
anonKey: process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY,
});
}

9
pnpm-lock.yaml generated
View File

@@ -47,9 +47,6 @@ importers:
apps/web:
dependencies:
'@epic-web/invariant':
specifier: ^1.0.0
version: 1.0.0
'@hookform/resolvers':
specifier: ^3.3.4
version: 3.3.4(react-hook-form@7.51.3)
@@ -1003,9 +1000,6 @@ importers:
packages/supabase:
devDependencies:
'@epic-web/invariant':
specifier: ^1.0.0
version: 1.0.0
'@kit/eslint-config':
specifier: workspace:*
version: link:../../tooling/eslint
@@ -1691,9 +1685,6 @@ packages:
resolution: {integrity: sha512-EsBwpc7hBUJWAsNPBmJy4hxWx12v6bshQsldrVmjxJoc3isbxhOrF2IcCpaXxfvq03NwkI7sbsOLXbYuqF/8Ww==}
dev: false
/@epic-web/invariant@1.0.0:
resolution: {integrity: sha512-lrTPqgvfFQtR/eY/qkIzp98OGdNJu0m5ji3q/nJI8v3SXkRKEnWiOxMmbvcSoAIzv/cGiuvRy57k4suKQSAdwA==}
/@esbuild/aix-ppc64@0.19.11:
resolution: {integrity: sha512-FnzU0LyE3ySQk7UntJO4+qIiQgI7KoODnZg5xzXIrFJlKd2P2gwHsHY4927xj9y5PJmJSzULiUCWmv7iWnNa7g==}
engines: {node: '>=12'}