make publicUrl and sandboxMode env vars, installationId env or generated, inc expiration time

buckhalt · buckhalt · commit 43d62159db03 · 2024-10-16T08:08:22.000-07:00
diff --git a/actions/appSettings.ts b/actions/appSettings.ts
@@ -6,7 +6,6 @@ import { type z } from 'zod';
 import { env } from '~/env';
 import { DEFAULT_APP_SETTINGS } from '~/fresco.config';
 import { safeRevalidateTag } from '~/lib/cache';
-import { getAppSetting } from '~/queries/appSettings';
 import { appSettingsSchema } from '~/schemas/appSettings';
 import { createEnvironmentFormSchema } from '~/schemas/environment';
 import { requireApiAuth } from '~/utils/auth';
@@ -77,37 +76,19 @@ export async function storeEnvironment(formData: unknown) {
   }
 
   try {
-    const { uploadThingToken, publicUrl, installationId } = parsedFormData.data;
+    const { uploadThingToken } = parsedFormData.data;
 
     const data = [
       { key: 'uploadThingToken', value: uploadThingToken },
-      { key: 'sandboxMode', value: 'false' },
       { key: 'disableAnalytics', value: 'false' },
     ];
 
-    // Add optional env variables if they were provided
-    if (publicUrl) {
-      data.push({ key: 'publicUrl', value: publicUrl });
-    }
-
-    if (installationId) {
-      await setAppSetting('installationId', installationId);
-    } else {
-      // check for existing installationId in db (from env)
-      const existingInstallationId = await getAppSetting('installationId');
-      if (!existingInstallationId) {
-        // no env or installation id provided, generate one
-        await setAppSetting('installationId', createId());
-      }
-    }
-
     // insert the rest of the env variables
     await prisma.appSettings.createManyAndReturn({
       data,
       skipDuplicates: true,
     });
     safeRevalidateTag(`appSettings-uploadThingToken`);
-    safeRevalidateTag(`appSettings-sandboxMode`);
     safeRevalidateTag(`appSettings-disableAnalytics`);
 
     return { success: true };
@@ -127,7 +108,8 @@ export async function initializeWithDefaults() {
   })) as { key: InitializeKeys; value: string }[];
 
   // add installation id if there is one in the env
-  const installationId = env.INSTALLATION_ID;
+  // if not, generate one
+  const installationId = env.INSTALLATION_ID ?? createId();
   if (installationId) {
     data.push({
       key: 'installationId',
diff --git a/app/(blobs)/(setup)/_components/EnvironmentForm.tsx b/app/(blobs)/(setup)/_components/EnvironmentForm.tsx
@@ -6,11 +6,7 @@ import { Input } from '~/components/ui/Input';
 import useZodForm from '~/hooks/useZodForm';
 import { createEnvironmentSchema } from '~/schemas/environment';
 
-export const EnvironmentForm = ({
-  installationId,
-}: {
-  installationId: string | null;
-}) => {
+export const EnvironmentForm = () => {
   const {
     register,
     formState: { errors, isValid },
@@ -30,27 +26,6 @@ export const EnvironmentForm = ({
           {...register('uploadThingToken')}
         />
       </div>
-      <div className="mb-6 flex flex-wrap">
-        <Input
-          label="Public URL"
-          hint="When using advanced deployment, this is required. Set to the domain name of your app."
-          type="text"
-          error={errors.publicUrl?.message}
-          {...register('publicUrl')}
-        />
-      </div>
-      {!installationId && (
-        <div className="mb-6 flex flex-wrap">
-          <Input
-            label="Installation Id"
-            hint="An optional unique identifier for your app, used for analytics. This will be generated automatically if not set."
-            type="text"
-            placeholder="installation-id..."
-            error={errors.installationId?.message}
-            {...register('installationId')}
-          />
-        </div>
-      )}
       <div className="flex flex-wrap">
         <Button disabled={!isValid} type="submit">
           Submit
diff --git a/app/(blobs)/(setup)/_components/OnboardSteps/ConfigureEnvironment.tsx b/app/(blobs)/(setup)/_components/OnboardSteps/ConfigureEnvironment.tsx
@@ -2,11 +2,7 @@ import Heading from '~/components/ui/typography/Heading';
 import Paragraph from '~/components/ui/typography/Paragraph';
 import { EnvironmentForm } from '../EnvironmentForm';
 
-function ConfigureEnvironment({
-  installationId,
-}: {
-  installationId: string | null;
-}) {
+function ConfigureEnvironment() {
   return (
     <div className="w-[30rem]">
       <div className="mb-4">
@@ -15,7 +11,7 @@ function ConfigureEnvironment({
           Next, configure your environment. Follow the steps in the deployment
           guide to set these values.
         </Paragraph>
-        <EnvironmentForm installationId={installationId} />
+        <EnvironmentForm />
       </div>
     </div>
   );
diff --git a/app/(blobs)/(setup)/_components/OnboardSteps/DeploymentSettings.tsx b/app/(blobs)/(setup)/_components/OnboardSteps/DeploymentSettings.tsx
@@ -4,13 +4,10 @@ import { Button } from '~/components/ui/Button';
 import Heading from '~/components/ui/typography/Heading';
 import Paragraph from '~/components/ui/typography/Paragraph';
 import DisableAnalyticsSwitch from '../DisableAnalyticsSwitch';
-import SandboxModeSwitch from '../SandboxModeSwitch';
 
 function DeploymentSettings({
-  sandboxMode,
   disableAnalytics,
 }: {
-  sandboxMode: boolean;
   disableAnalytics: boolean;
 }) {
   const [currentStep, setCurrentStep] = useQueryState(
@@ -31,15 +28,6 @@ function DeploymentSettings({
         </Paragraph>
       </div>
       <div className="mb-6 flex flex-col gap-2">
-        <SettingsSection
-          heading="Sandbox Mode"
-          controlArea={<SandboxModeSwitch sandboxMode={sandboxMode} />}
-        >
-          <Paragraph>
-            If enabled, the app will use the sandbox mode, which disables
-            resetting the database and other features.
-          </Paragraph>
-        </SettingsSection>
         <SettingsSection
           heading="Disable Analytics"
           controlArea={
diff --git a/app/(blobs)/(setup)/_components/SandboxCredentials.tsx b/app/(blobs)/(setup)/_components/SandboxCredentials.tsx
@@ -1,7 +1,9 @@
 import { KeyRound } from 'lucide-react';
 import { Alert, AlertDescription, AlertTitle } from '~/components/ui/Alert';
+import { env } from '~/env';
 
 export default function SandboxCredentials() {
+  if (!env.SANDBOX_MODE) return null;
   return (
     <Alert variant="info">
       <KeyRound className="h-4 w-4" />
diff --git a/app/(blobs)/(setup)/_components/SandboxModeSwitch.tsx b/app/(blobs)/(setup)/_components/SandboxModeSwitch.tsx
diff --git a/app/(blobs)/(setup)/setup/Setup.tsx b/app/(blobs)/(setup)/setup/Setup.tsx
@@ -25,8 +25,6 @@ export default function Setup({
     hasAuth,
     allowAnonymousRecruitment,
     limitInterviews,
-    installationId,
-    sandboxMode,
     disableAnalytics,
     hasUploadThingToken,
   } = use(setupDataPromise);
@@ -54,7 +52,6 @@ export default function Setup({
     if (hasAuth && step > 2) {
       if (
         !hasUploadThingToken ||
-        sandboxMode === null ||
         disableAnalytics === null ||
         allowAnonymousRecruitment === null ||
         limitInterviews === null
@@ -68,7 +65,6 @@ export default function Setup({
     step,
     setStep,
     hasUploadThingToken,
-    sandboxMode,
     disableAnalytics,
     allowAnonymousRecruitment,
     limitInterviews,
@@ -79,12 +75,9 @@ export default function Setup({
       <OnboardSteps />
       <div className={mainClasses}>
         {step === 1 && <CreateAccount />}
-        {step === 2 && <ConfigureEnvironment installationId={installationId} />}
-        {step === 3 && sandboxMode !== null && disableAnalytics !== null && (
-          <DeploymentSettings
-            sandboxMode={sandboxMode}
-            disableAnalytics={disableAnalytics}
-          />
+        {step === 2 && <ConfigureEnvironment />}
+        {step === 3 && disableAnalytics !== null && (
+          <DeploymentSettings disableAnalytics={disableAnalytics} />
         )}
         {step === 4 && <UploadProtocol />}
         {step === 5 &&
diff --git a/app/(blobs)/(setup)/setup/page.tsx b/app/(blobs)/(setup)/setup/page.tsx
@@ -20,9 +20,7 @@ async function getSetupData() {
     prisma.participant.count(),
   ]);
 
-  const sandboxMode = await getAppSetting('sandboxMode');
   const disableAnalytics = await getAppSetting('disableAnalytics');
-  const installationId = await getAppSetting('installationId');
   const uploadThingToken = await getAppSetting('uploadThingToken');
 
   return {
@@ -31,9 +29,7 @@ async function getSetupData() {
     limitInterviews,
     hasProtocol: otherData[0] > 0,
     hasParticipants: otherData[1] > 0,
-    sandboxMode,
     disableAnalytics,
-    installationId,
     hasUploadThingToken: !!uploadThingToken,
   };
 }
diff --git a/app/(blobs)/(setup)/signin/page.tsx b/app/(blobs)/(setup)/signin/page.tsx
@@ -1,6 +1,5 @@
 import { redirect } from 'next/navigation';
 import { containerClasses } from '~/components/ContainerClasses';
-import { getAppSetting } from '~/queries/appSettings';
 import { getServerSession } from '~/utils/auth';
 import { cn } from '~/utils/shadcn';
 import SandboxCredentials from '../_components/SandboxCredentials';
@@ -15,7 +14,6 @@ export const dynamic = 'force-dynamic';
 
 export default async function Page() {
   const session = await getServerSession();
-  const sandboxMode = await getAppSetting('sandboxMode');
 
   if (session) {
     // If the user is already signed in, redirect to the dashboard
@@ -25,7 +23,7 @@ export default async function Page() {
   return (
     <div className={cn(containerClasses, 'w-[25rem]')}>
       <h1 className="mb-6 text-2xl font-bold">Sign In To Fresco</h1>
-      {sandboxMode === true && <SandboxCredentials />}
+      <SandboxCredentials />
       <SignInForm />
     </div>
   );
diff --git a/app/(interview)/onboard/[protocolId]/route.ts b/app/(interview)/onboard/[protocolId]/route.ts
@@ -1,6 +1,7 @@
 import { cookies } from 'next/headers';
 import { NextResponse, type NextRequest } from 'next/server';
 import { createInterview } from '~/actions/interviews';
+import { env } from '~/env';
 import trackEvent from '~/lib/analytics';
 import { getAppSetting } from '~/queries/appSettings';
 
@@ -12,13 +13,11 @@ const handler = async (
 ) => {
   const protocolId = params.protocolId; // From route segment
 
-  const publicUrl = await getAppSetting('publicUrl');
-
   // when deployed via docker `req.url` and `req.nextUrl`
   // shows Docker Container ID instead of real host
   // issue: https://github.com/vercel/next.js/issues/65568
-  // workaround: use `publicUrl` to get the correct url
-  const url = new URL(publicUrl ?? req.nextUrl.clone());
+  // workaround: use `env.PUBLIC_URL` to get the correct url
+  const url = new URL(env.PUBLIC_URL ?? req.nextUrl.clone());
 
   // If no protocol ID is provided, redirect to the error page.
   if (!protocolId || protocolId === 'undefined') {
diff --git a/app/api/uploadthing/route.ts b/app/api/uploadthing/route.ts
@@ -1,4 +1,5 @@
 import { createRouteHandler } from 'uploadthing/next';
+import { env } from '~/env';
 import { getAppSetting } from '~/queries/appSettings';
 import { ourFileRouter } from './core';
 
@@ -9,8 +10,6 @@ if (!uploadThingToken) {
   throw new Error('Missing UploadThing environment variable');
 }
 
-const publicUrl = await getAppSetting('publicUrl');
-
 // Export routes for Next App Router
 export const { GET, POST } = createRouteHandler({
   router: ourFileRouter,
@@ -19,7 +18,7 @@ export const { GET, POST } = createRouteHandler({
     // UploadThing attempts to automatically detect this value based on the request URL and headers
     // However, the automatic detection fails in docker deployments
     // docs: https://docs.uploadthing.com/api-reference/server#config
-    callbackUrl: publicUrl ? `${publicUrl}/api/uploadthing` : undefined,
+    callbackUrl: env.PUBLIC_URL && `${env.PUBLIC_URL}/api/uploadthing`,
     token: uploadThingToken,
   },
 });
diff --git a/app/dashboard/settings/loading.tsx b/app/dashboard/settings/loading.tsx
@@ -5,10 +5,8 @@ import { Skeleton } from '~/components/ui/skeleton';
 import { SwitchSkeleton } from '~/components/ui/switch';
 import PageHeader from '~/components/ui/typography/PageHeader';
 import { env } from '~/env';
-import { getAppSetting } from '~/queries/appSettings';
 
-export default async function Loading() {
-  const sandboxMode = await getAppSetting('sandboxMode');
+export default function Loading() {
   return (
     <>
       <ResponsiveContainer>
@@ -24,7 +22,7 @@ export default async function Loading() {
         />
         <SettingsSectionSkeleton controlAreaSkelton={<SwitchSkeleton />} />
         <SettingsSectionSkeleton controlAreaSkelton={<SwitchSkeleton />} />
-        {!sandboxMode && (
+        {!env.SANDBOX_MODE && (
           <SettingsSectionSkeleton
             controlAreaSkelton={
               <ButtonSkeleton variant="destructive" className="w-full" />
diff --git a/app/dashboard/settings/page.tsx b/app/dashboard/settings/page.tsx
@@ -18,7 +18,6 @@ export default async function Settings() {
   await requirePageAuth();
 
   const installationIdPromise = getAppSetting('installationId');
-  const sandboxMode = await getAppSetting('sandboxMode');
 
   return (
     <>
@@ -61,7 +60,7 @@ export default async function Settings() {
             prevented.
           </Paragraph>
         </SettingsSection>
-        {(env.NODE_ENV === 'development' || !sandboxMode) && (
+        {(env.NODE_ENV === 'development' || !env.SANDBOX_MODE) && (
           <SettingsSection
             heading="Reset Settings"
             controlArea={<ResetButton />}
diff --git a/fresco.config.ts b/fresco.config.ts
@@ -1,7 +1,7 @@
 export const PROTOCOL_EXTENSION = '.netcanvas' as const;
 export const APP_SUPPORTED_SCHEMA_VERSIONS = [7];
-// If unconfigured, the app will shut down after 30 minutes (1800000 ms)
-export const UNCONFIGURED_TIMEOUT = 1800000 as const;
+// If unconfigured, the app will shut down after 2 hours (7200000 ms)
+export const UNCONFIGURED_TIMEOUT = 7200000 as const;
 
 // Display options for dates: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options
 export const dateOptions: Intl.DateTimeFormatOptions = {
diff --git a/prisma/migrations/20241016134934_app_settings_kv/migration.sql b/prisma/migrations/20241016134934_app_settings_kv/migration.sql
@@ -1,5 +1,5 @@
 -- CreateEnum
-CREATE TYPE "AppSetting" AS ENUM ('configured', 'allowAnonymousRecruitment', 'limitInterviews', 'initializedAt', 'installationId', 'sandboxMode', 'disableAnalytics', 'publicUrl', 'uploadThingToken');
+CREATE TYPE "AppSetting" AS ENUM ('configured', 'allowAnonymousRecruitment', 'limitInterviews', 'initializedAt', 'installationId',  'disableAnalytics',  'uploadThingToken');
 
 -- Temporary table to hold the data
 CREATE TEMPORARY TABLE _OldAppSettings AS SELECT * FROM "AppSettings";
diff --git a/prisma/schema.prisma b/prisma/schema.prisma
@@ -96,9 +96,7 @@ enum AppSetting {
   limitInterviews
   initializedAt
   installationId
-  sandboxMode
   disableAnalytics
-  publicUrl
   uploadThingToken
 }
 
diff --git a/schemas/__tests__/appSettings.test.ts b/schemas/__tests__/appSettings.test.ts
diff --git a/schemas/appSettings.ts b/schemas/appSettings.ts
diff --git a/schemas/environment.ts b/schemas/environment.ts
