Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(studio): restore workers secrets page FE-4280 (#49762)

Jordi Enricb885b69bffc2
diff --git a/apps/studio/TANSTACK_MIGRATION.md b/apps/studio/TANSTACK_MIGRATION.md
index 13644b1c7ea..e41b2b124dd 100644
--- a/apps/studio/TANSTACK_MIGRATION.md
+++ b/apps/studio/TANSTACK_MIGRATION.md
@@ -232,6 +232,7 @@ These are the layout-only TanStack files. Most hold a single product layout comp
- [x] A `routes/project/$ref/workers/index.tsx` ← `pages/project/[ref]/workers/index.tsx`
- [x] A `routes/project/$ref/workers/$name.tsx` ← `pages/project/[ref]/workers/[name].tsx`
+- [x] A `routes/project/$ref/workers/secrets.tsx` ← `pages/project/[ref]/workers/secrets.tsx`
### Project shell — `/functions/*`
diff --git a/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets.tsx b/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets.tsx
index 589f111693b..b7f60af7cd8 100644
--- a/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets.tsx
+++ b/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets.tsx
@@ -1,5 +1,5 @@
import { PermissionAction } from '@supabase/shared-types/out/constants'
-import { useParams } from 'common'
+import { useFlag, useParams } from 'common'
import { Search } from 'lucide-react'
import { parseAsString, useQueryState } from 'nuqs'
import { useEffect, useMemo, useState } from 'react'
@@ -27,6 +27,7 @@ import { DOCS_URL } from '@/lib/constants'
export const EdgeFunctionSecrets = () => {
const { ref: projectRef } = useParams()
+ const workersEnabled = useFlag('workers')
const [searchString, setSearchString] = useState('')
const { can: canReadSecrets, isLoading: isLoadingSecretsPermissions } = useAsyncCheckPermissions(
@@ -231,10 +232,18 @@ export const EdgeFunctionSecrets = () => {
}
}}
>
- <p className="text-sm">
- Ensure none of your edge functions are actively using this secret before deleting it. This
- action cannot be undone.
- </p>
+ {workersEnabled ? (
+ <p className="text-sm">
+ Ensure none of your <span className="font-medium">edge functions</span> or{' '}
+ <span className="font-medium">workers</span> are actively using this secret before
+ deleting it. This action cannot be undone.
+ </p>
+ ) : (
+ <p className="text-sm">
+ Ensure none of your edge functions are actively using this secret before deleting it.
+ This action cannot be undone.
+ </p>
+ )}
</ConfirmationModal>
</>
)
diff --git a/apps/studio/components/layouts/WorkersLayout/WorkersLayout.tsx b/apps/studio/components/layouts/WorkersLayout/WorkersLayout.tsx
index 3931a524d21..928c72d5733 100644
--- a/apps/studio/components/layouts/WorkersLayout/WorkersLayout.tsx
+++ b/apps/studio/components/layouts/WorkersLayout/WorkersLayout.tsx
@@ -26,6 +26,12 @@ const useGenerateWorkersMenu = (): ProductMenuGroup[] => {
url: `/project/${projectRef}/workers`,
items: [],
},
+ {
+ name: 'Secrets',
+ key: 'secrets',
+ url: `/project/${projectRef}/workers/secrets`,
+ items: [],
+ },
],
},
],
diff --git a/apps/studio/pages/project/[ref]/workers/secrets.tsx b/apps/studio/pages/project/[ref]/workers/secrets.tsx
new file mode 100644
index 00000000000..f4fe171b6ae
--- /dev/null
+++ b/apps/studio/pages/project/[ref]/workers/secrets.tsx
@@ -0,0 +1,106 @@
+import type { PropsWithChildren } from 'react'
+import { Admonition } from 'ui-patterns/Admonition'
+import { PageContainer } from 'ui-patterns/PageContainer'
+import {
+ PageHeader,
+ PageHeaderDescription,
+ PageHeaderMeta,
+ PageHeaderSummary,
+ PageHeaderTitle,
+} from 'ui-patterns/PageHeader'
+import { PageSection, PageSectionContent } from 'ui-patterns/PageSection'
+
+import { DefaultEdgeFunctionSecrets } from '@/components/interfaces/Functions/EdgeFunctionSecrets/DefaultEdgeFunctionSecrets'
+import { DEFAULT_EDGE_FUNCTION_SECRETS } from '@/components/interfaces/Functions/EdgeFunctionSecrets/DefaultEdgeFunctionSecrets.utils'
+import { EdgeFunctionSecrets } from '@/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets'
+import { DefaultLayout } from '@/components/layouts/DefaultLayout'
+import { WorkersLayout } from '@/components/layouts/WorkersLayout/WorkersLayout'
+import { DocsButton } from '@/components/ui/DocsButton'
+import { useDeploymentMode } from '@/hooks/misc/useDeploymentMode'
+import { DOCS_URL, IS_PLATFORM } from '@/lib/constants'
+import type { NextPageWithLayout } from '@/types'
+
+const WorkerSecretsPage: NextPageWithLayout = () => {
+ const { isCli, isSelfHosted } = useDeploymentMode()
+
+ if (!IS_PLATFORM) {
+ return (
+ <PageContainer size="large">
+ <PageSection>
+ <PageSectionContent className="space-y-4 md:space-y-8">
+ {isCli && (
+ <Admonition
+ type="default"
+ title="Local development with the Supabase CLI"
+ description={<p>Add custom secrets from the Supabase CLI.</p>}
+ />
+ )}
+ {isSelfHosted && (
+ <Admonition
+ type="default"
+ title="Self-hosted Supabase"
+ description={<p>Set custom secrets via environment variables.</p>}
+ />
+ )}
+ <section className="space-y-4">
+ <div className="flex flex-col md:flex-row md:items-center justify-between gap-2">
+ <div className="space-y-1">
+ <h3 className="text-foreground text-base">Default secrets</h3>
+ <p className="text-sm text-foreground-light">
+ Reserved secrets available in every project
+ </p>
+ </div>
+ <DocsButton href={`${DOCS_URL}/guides/functions/secrets#default-secrets`} />
+ </div>
+ <DefaultEdgeFunctionSecrets
+ secrets={DEFAULT_EDGE_FUNCTION_SECRETS.filter((secret) => !secret.isRuntime)}
+ />
+ </section>
+ </PageSectionContent>
+ </PageSection>
+ </PageContainer>
+ )
+ }
+
+ return (
+ <PageContainer size="large">
+ <PageSection>
+ <PageSectionContent className="space-y-4 md:space-y-8">
+ <Admonition
+ type="default"
+ title="Secrets are shared between Edge Functions and Workers"
+ />
+ <EdgeFunctionSecrets />
+ </PageSectionContent>
+ </PageSection>
+ </PageContainer>
+ )
+}
+
+// Hoisted out of `getLayout` so the TanStack route can import it directly.
+export const WorkerSecretsPageWrapper = ({ children }: PropsWithChildren) => (
+ <div className="w-full min-h-full flex flex-col items-stretch">
+ <PageHeader size="large">
+ <PageHeaderMeta>
+ <PageHeaderSummary>
+ <PageHeaderTitle>Secrets</PageHeaderTitle>
+ <PageHeaderDescription>
+ Environment variables loaded into every worker at start-up
+ </PageHeaderDescription>
+ </PageHeaderSummary>
+ </PageHeaderMeta>
+ </PageHeader>
+
+ {children}
+ </div>
+)
+
+WorkerSecretsPage.getLayout = (page) => (
+ <DefaultLayout>
+ <WorkersLayout title="Secrets">
+ <WorkerSecretsPageWrapper>{page}</WorkerSecretsPageWrapper>
+ </WorkersLayout>
+ </DefaultLayout>
+)
+
+export default WorkerSecretsPage
diff --git a/apps/studio/routeTree.gen.ts b/apps/studio/routeTree.gen.ts
index 7be3871d460..8c15cc0547c 100644
--- a/apps/studio/routeTree.gen.ts
+++ b/apps/studio/routeTree.gen.ts
@@ -100,6 +100,7 @@ import { Route as ApiPlatformProfileIndexRouteImport } from './routes/api/platfo
import { Route as ApiPlatformOrganizationsIndexRouteImport } from './routes/api/platform/organizations/index'
import { Route as AppOrgSlugIndexRouteImport } from './routes/_app/org/$slug/index'
import { Route as AppAccountTokensIndexRouteImport } from './routes/_app/account/tokens/index'
+import { Route as ProjectRefWorkersSecretsRouteImport } from './routes/project/$ref/workers/secrets'
import { Route as ProjectRefWorkersNameRouteImport } from './routes/project/$ref/workers/$name'
import { Route as ProjectRefStorageS3RouteImport } from './routes/project/$ref/storage/s3'
import { Route as ProjectRefSqlTemplatesRouteImport } from './routes/project/$ref/sql/templates'
@@ -794,6 +795,12 @@ const AppAccountTokensIndexRoute = AppAccountTokensIndexRouteImport.update({
path: '/tokens/',
getParentRoute: () => AppAccountRoute,
} as any)
+const ProjectRefWorkersSecretsRoute =
+ ProjectRefWorkersSecretsRouteImport.update({
+ id: '/secrets',
+ path: '/secrets',
+ getParentRoute: () => ProjectRefWorkersRoute,
+ } as any)
const ProjectRefWorkersNameRoute = ProjectRefWorkersNameRouteImport.update({
id: '/$name',
path: '/$name',
@@ -2277,6 +2284,7 @@ export interface FileRoutesByFullPath {
'/project/$ref/sql/templates': typeof ProjectRefSqlTemplatesRoute
'/project/$ref/storage/s3': typeof ProjectRefStorageS3Route
'/project/$ref/workers/$name': typeof ProjectRefWorkersNameRoute
+ '/project/$ref/workers/secrets': typeof ProjectRefWorkersSecretsRoute
'/account/tokens/': typeof AppAccountTokensIndexRoute
'/org/$slug/': typeof AppOrgSlugIndexRoute
'/api/platform/organizations/': typeof ApiPlatformOrganizationsIndexRoute
@@ -2580,6 +2588,7 @@ export interface FileRoutesByTo {
'/project/$ref/sql/templates': typeof ProjectRefSqlTemplatesRoute
'/project/$ref/storage/s3': typeof ProjectRefStorageS3Route
'/project/$ref/workers/$name': typeof ProjectRefWorkersNameRoute
+ '/project/$ref/workers/secrets': typeof ProjectRefWorkersSecretsRoute
'/account/tokens': typeof AppAccountTokensIndexRoute
'/org/$slug': typeof AppOrgSlugIndexRoute
'/api/platform/organizations': typeof ApiPlatformOrganizationsIndexRoute
@@ -2900,6 +2909,7 @@ export interface FileRoutesById {
'/project/$ref/sql/templates': typeof ProjectRefSqlTemplatesRoute
'/project/$ref/storage/s3': typeof ProjectRefStorageS3Route
'/project/$ref/workers/$name': typeof ProjectRefWorkersNameRoute
+ '/project/$ref/workers/secrets': typeof ProjectRefWorkersSecretsRoute
'/_app/account/tokens/': typeof AppAccountTokensIndexRoute
'/_app/org/$slug/': typeof AppOrgSlugIndexRoute
'/api/platform/organizations/': typeof ApiPlatformOrganizationsIndexRoute
@@ -3219,6 +3229,7 @@ export interface FileRouteTypes {
| '/project/$ref/sql/templates'
| '/project/$ref/storage/s3'
| '/project/$ref/workers/$name'
+ | '/project/$ref/workers/secrets'
| '/account/tokens/'
| '/org/$slug/'
| '/api/platform/organizations/'
@@ -3522,6 +3533,7 @@ export interface FileRouteTypes {
| '/project/$ref/sql/templates'
| '/project/$ref/storage/s3'
| '/project/$ref/workers/$name'
+ | '/project/$ref/workers/secrets'
| '/account/tokens'
| '/org/$slug'
| '/api/platform/organizations'
@@ -3841,6 +3853,7 @@ export interface FileRouteTypes {
| '/project/$ref/sql/templates'
| '/project/$ref/storage/s3'
| '/project/$ref/workers/$name'
+ | '/project/$ref/workers/secrets'
| '/_app/account/tokens/'
| '/_app/org/$slug/'
| '/api/platform/organizations/'
@@ -4744,6 +4757,13 @@ declare module '@tanstack/react-router' {
preLoaderRoute: typeof AppAccountTokensIndexRouteImport
parentRoute: typeof AppAccountRoute
}
+ '/project/$ref/workers/secrets': {
+ id: '/project/$ref/workers/secrets'
+ path: '/secrets'
+ fullPath: '/project/$ref/workers/secrets'
+ preLoaderRoute: typeof ProjectRefWorkersSecretsRouteImport
+ parentRoute: typeof ProjectRefWorkersRoute
+ }
'/project/$ref/workers/$name': {
id: '/project/$ref/workers/$name'
path: '/$name'
@@ -6948,11 +6968,13 @@ const ProjectRefStorageRouteWithChildren =
interface ProjectRefWorkersRouteChildren {
ProjectRefWorkersNameRoute: typeof ProjectRefWorkersNameRoute
+ ProjectRefWorkersSecretsRoute: typeof ProjectRefWorkersSecretsRoute
ProjectRefWorkersIndexRoute: typeof ProjectRefWorkersIndexRoute
}
const ProjectRefWorkersRouteChildren: ProjectRefWorkersRouteChildren = {
ProjectRefWorkersNameRoute: ProjectRefWorkersNameRoute,
+ ProjectRefWorkersSecretsRoute: ProjectRefWorkersSecretsRoute,
ProjectRefWorkersIndexRoute: ProjectRefWorkersIndexRoute,
}
diff --git a/apps/studio/routes/project/$ref/workers/secrets.tsx b/apps/studio/routes/project/$ref/workers/secrets.tsx
new file mode 100644
index 00000000000..05d44c5e778
--- /dev/null
+++ b/apps/studio/routes/project/$ref/workers/secrets.tsx
@@ -0,0 +1,18 @@
+import { createFileRoute } from '@tanstack/react-router'
+
+import WorkerSecretsPage, { WorkerSecretsPageWrapper } from '@/pages/project/[ref]/workers/secrets'
+
+export const Route = createFileRoute('/project/$ref/workers/secrets')({
+ component: WorkerSecretsRoute,
+ staticData: {
+ workersLayoutTitle: 'Secrets',
+ },
+})
+
+function WorkerSecretsRoute() {
+ return (
+ <WorkerSecretsPageWrapper>
+ <WorkerSecretsPage dehydratedState={undefined} />
+ </WorkerSecretsPageWrapper>
+ )
+}