Make S2 env vars optional

Author: myftija

apps/webapp/app/env.server.ts

@@ -25,6 +25,27 @@ const GithubAppEnvSchema = z.preprocess(
   ])
 );
 
+// eventually we can make all S2 env vars required once the S2 OSS version is out
+const S2EnvSchema = z.preprocess(
+  (val) => {
+    const obj = val as any;
+    if (!obj || !obj.S2_ENABLED) {
+      return { ...obj, S2_ENABLED: "0" };
+    }
+    return obj;
+  },
+  z.discriminatedUnion("S2_ENABLED", [
+    z.object({
+      S2_ENABLED: z.literal("1"),
+      S2_ACCESS_TOKEN: z.string(),
+      S2_DEPLOYMENT_LOGS_BASIN_NAME: z.string(),
+    }),
+    z.object({
+      S2_ENABLED: z.literal("0"),
+    }),
+  ])
+);
+
 const EnvironmentSchema = z
   .object({
     NODE_ENV: z.union([z.literal("development"), z.literal("production"), z.literal("test")]),
@@ -1201,11 +1222,9 @@ const EnvironmentSchema = z
     EVENT_LOOP_MONITOR_UTILIZATION_SAMPLE_RATE: z.coerce.number().default(0.05),
 
     VERY_SLOW_QUERY_THRESHOLD_MS: z.coerce.number().int().optional(),
-
-    S2_ACCESS_TOKEN: z.string(),
-    S2_DEPLOYMENT_LOGS_BASIN_NAME: z.string(),
   })
-  .and(GithubAppEnvSchema);
+  .and(GithubAppEnvSchema)
+  .and(S2EnvSchema);
 
 export type Environment = z.infer<typeof EnvironmentSchema>;
 export const env = EnvironmentSchema.parse(process.env);

apps/webapp/app/presenters/v3/DeploymentPresenter.server.ts

@@ -145,27 +145,32 @@ export class DeploymentPresenter {
       ? ExternalBuildData.safeParse(deployment.externalBuildData)
       : undefined;
 
-    const s2 = new S2({ accessToken: env.S2_ACCESS_TOKEN });
-    const projectS2AccessToken = await s2.accessTokens.issue({
-      id: `${project.externalRef}-${new Date().getTime()}`,
-      expires_at: new Date(Date.now() + 60 * 60 * 1000).toISOString(), // 1 hour
-      scope: {
-        ops: ["read"],
-        basins: {
-          exact: env.S2_DEPLOYMENT_LOGS_BASIN_NAME,
-        },
-        streams: {
-          prefix: `projects/${project.externalRef}/deployments/`,
+    let s2Logs = undefined;
+    if (env.S2_ENABLED === "1") {
+      const s2 = new S2({ accessToken: env.S2_ACCESS_TOKEN });
+      const projectS2AccessToken = await s2.accessTokens.issue({
+        id: `${project.externalRef}-${new Date().getTime()}`,
+        expires_at: new Date(Date.now() + 60 * 60 * 1000).toISOString(), // 1 hour
+        scope: {
+          ops: ["read"],
+          basins: {
+            exact: env.S2_DEPLOYMENT_LOGS_BASIN_NAME,
+          },
+          streams: {
+            prefix: `projects/${project.externalRef}/deployments/`,
+          },
         },
-      },
-    });
+      });
 
-    return {
-      s2Logs: {
+      s2Logs = {
         basin: env.S2_DEPLOYMENT_LOGS_BASIN_NAME,
         stream: `projects/${project.externalRef}/deployments/${deployment.shortCode}`,
         accessToken: projectS2AccessToken.access_token,
-      },
+      };
+    }
+
+    return {
+      s2Logs,
       deployment: {
         id: deployment.id,
         shortCode: deployment.shortCode,

apps/webapp/app/routes/_app.orgs.$organizationSlug.projects.$projectParam.env.$envParam.deployments.$deploymentParam/route.tsx

@@ -80,11 +80,14 @@ export default function Page() {
   const location = useLocation();
   const page = new URLSearchParams(location.search).get("page");
 
+  const logsDisabled = s2Logs === undefined;
   const [logs, setLogs] = useState<LogEntry[]>([]);
   const [isStreaming, setIsStreaming] = useState(true);
   const [streamError, setStreamError] = useState<string | null>(null);
 
   useEffect(() => {
+    if (logsDisabled) return;
+
     const abortController = new AbortController();
 
     setLogs([]);
@@ -150,7 +153,7 @@ export default function Page() {
     return () => {
       abortController.abort();
     };
-  }, [s2Logs.basin, s2Logs.stream]);
+  }, [s2Logs?.basin, s2Logs?.stream]);
 
   return (
     <div className="grid h-full max-h-full grid-rows-[2.5rem_1fr] overflow-hidden bg-background-bright">
@@ -243,17 +246,19 @@ export default function Page() {
                   />
                 </Property.Value>
               </Property.Item>
-              <Property.Item>
-                <Property.Label>Logs</Property.Label>
-                <LogsDisplay
-                  logs={logs}
-                  isStreaming={isStreaming}
-                  streamError={streamError}
-                  initialCollapsed={(
-                    ["PENDING", "DEPLOYED", "TIMED_OUT"] satisfies (typeof deployment.status)[]
-                  ).includes(deployment.status)}
-                />
-              </Property.Item>
+              {!logsDisabled && (
+                <Property.Item>
+                  <Property.Label>Logs</Property.Label>
+                  <LogsDisplay
+                    logs={logs}
+                    isStreaming={isStreaming}
+                    streamError={streamError}
+                    initialCollapsed={(
+                      ["PENDING", "DEPLOYED", "TIMED_OUT"] satisfies (typeof deployment.status)[]
+                    ).includes(deployment.status)}
+                  />
+                </Property.Item>
+              )}
               {deployment.canceledAt && (
                 <Property.Item>
                   <Property.Label>Canceled at</Property.Label>