Merge pull request #3203 from serlo/3199-simplify-env-system

simplify env vars and better debug output

apps/web/.env

@@ -1,18 +1,3 @@
 # Uncomment the next line to test a local API / Auth
 #NEXT_PUBLIC_ENV=local
-NEXT_PUBLIC_ENV=staging
-NEXT_PUBLIC_SERLO_DOMAIN_PRODUCTION=serlo.org
-NEXT_PUBLIC_SERLO_DOMAIN_STAGING=serlo-staging.dev
-NEXT_PUBLIC_SERLO_DOMAIN_LOCAL=serlo.localhost:4567
-# empty string if not on vercel
-NEXT_PUBLIC_VERCEL_URL=
-# empty string if not on vercel
-NEXT_PUBLIC_COMMIT_SHA=
-HYDRA_CLIENT_ID_STAGING=frontend
-HYDRA_CLIENT_SECRET_STAGING=YjgwZThhZDk0MTYxMTA4ODY1NzYxZmJk
-HYDRA_HOST_STAGING=https://hydra.${NEXT_PUBLIC_SERLO_DOMAIN_STAGING}
-HYDRA_CLIENT_ID_LOCAL=frontend.serlo.org
-HYDRA_CLIENT_SECRET_LOCAL=frontend.serlo.org
-HYDRA_HOST_LOCAL=http://localhost:4444
-KRATOS_HOST_STAGING=https://kratos.${NEXT_PUBLIC_SERLO_DOMAIN_STAGING}
-KRATOS_HOST_LOCAL=http://localhost:4433
+NEXT_PUBLIC_ENV=staging

apps/web/env.d.ts

@@ -2,42 +2,11 @@ declare namespace NodeJS {
   interface ProcessEnv {
     // Environment to use
     NEXT_PUBLIC_ENV: 'production' | 'staging' | 'local'
-    // Serlo domain for production environment
-    NEXT_PUBLIC_SERLO_DOMAIN_PRODUCTION: string
-    // Serlo domain to be used in staging environment
-    NEXT_PUBLIC_SERLO_DOMAIN_STAGING: string
     // Sentry DSN (defined in preview & production)
     NEXT_PUBLIC_SENTRY_DSN: string | undefined
-    // Google Analytics Tracking ID (defined in production)
-    NEXT_PUBLIC_GA_TRACKING_ID: string | undefined
     // The GitHub SHA of the commit the deployment was triggered by (defined in preview & production)
-    NEXT_PUBLIC_COMMIT_SHA: string | undefined
+    NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA: string | undefined
     // The public facing url of the deployment (defined in preview & production)
     NEXT_PUBLIC_VERCEL_URL: string | undefined
-
-    // Hydra client id for production environment (defined in preview & production, only exposed to server)
-    HYDRA_CLIENT_ID_PRODUCTION: string | undefined
-    // Hydra client id for staging environment (only exposed to server)
-    HYDRA_CLIENT_ID_STAGING: string
-    // Hydra client id for local environment (only exposed to server)
-    HYDRA_CLIENT_ID_LOCAL: string
-    // Hydra client secret for production environment (defined in preview & production, only exposed to server)
-    HYDRA_CLIENT_SECRET_PRODUCTION: string | undefined
-    // Hydra client secret for staging environment (only exposed to server)
-    HYDRA_CLIENT_SECRET_STAGING: string
-    // Hydra client secret for local environment (only exposed to server)
-    HYDRA_CLIENT_SECRET_LOCAL: string
-    // Hydra host for production environment (defined in preview & production, only exposed to server)
-    HYDRA_HOST_PRODUCTION: string | undefined
-    // Hydra host for staging environment (only exposed to server)
-    HYDRA_HOST_STAGING: string
-    // Hydra host for local environment (only exposed to server)
-    HYDRA_HOST_LOCAL: string
-    // Kratos host for production environment (defined in preview & production, only exposed to server)
-    KRATOS_HOST_PRODUCTION: string | undefined
-    // Kratos host for staging environment (only exposed to server)
-    KRATOS_HOST_STAGING: string
-    // Kratos host for local environment (only exposed to server)
-    KRATOS_HOST_LOCAL: string
   }
 }

apps/web/next.config.js

@@ -2,10 +2,30 @@ import bundleAnalyzer from '@next/bundle-analyzer'
 import path from 'path'
 import { fileURLToPath } from 'url'
 
+// check and display env variables
 console.log(
-  'current active environment (staging or production):',
+  '[NEXT_PUBLIC_ENV] selected environment (staging or production):',
   process.env.NEXT_PUBLIC_ENV
 )
+console.log(
+  '[NEXT_PUBLIC_SENTRY_DSN] sentry dsn:',
+  process.env.NEXT_PUBLIC_SENTRY_DSN ?? '---'
+)
+console.log(
+  '[NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA] commit sha:',
+  process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA ?? '---'
+)
+console.log(
+  '[NEXT_PUBLIC_VERCEL_URL] deployment url:',
+  process.env.NEXT_PUBLIC_VERCEL_URL ?? '---'
+)
+console.log(
+  '[DATABASE_URL] planetscale integration:',
+  process.env.DATABASE_URL &&
+    process.env.DATABASE_URL.includes('serlo_planetscale')
+    ? 'available'
+    : 'not available'
+)
 
 /**
  * @type {import('next').NextConfig}

apps/web/src/auth/cookie/cookie-domain.ts

@@ -1,6 +1,6 @@
 const COOKIE_DOMAINS = {
-  production: process.env.NEXT_PUBLIC_SERLO_DOMAIN_PRODUCTION,
-  staging: process.env.NEXT_PUBLIC_SERLO_DOMAIN_STAGING,
+  production: 'serlo.org',
+  staging: 'serlo-staging.dev',
   local: 'localhost',
 }
 

apps/web/src/helper/urls/serlo-domain.ts

@@ -1,4 +1,4 @@
 export const serloDomain =
   process.env.NEXT_PUBLIC_ENV === 'production'
-    ? process.env.NEXT_PUBLIC_SERLO_DOMAIN_PRODUCTION
-    : process.env.NEXT_PUBLIC_SERLO_DOMAIN_STAGING
+    ? 'serlo.org'
+    : 'serlo-staging.dev'

apps/web/src/pages/_document.tsx

@@ -16,7 +16,7 @@ const sentryLoader = `
     window.Sentry.init({
       environment: "${process.env.NEXT_PUBLIC_ENV}",
       release: "frontend@${
-        process.env.NEXT_PUBLIC_COMMIT_SHA?.substring(0, 7) ?? ''
+        process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA?.substring(0, 7) ?? ''
       }",
       beforeSend(event, hint) {
         /* ignore safari warning in JsonLd component */
@@ -108,7 +108,7 @@ export default class MyDocument extends Document {
             />
           )}
           {process.env.NEXT_PUBLIC_SENTRY_DSN !== undefined &&
-            process.env.NEXT_PUBLIC_COMMIT_SHA !== undefined && (
+            process.env.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA !== undefined && (
               <script
                 dangerouslySetInnerHTML={{
                   __html: sentryLoader,

apps/web/src/pages/api/.ory/[...paths].ts

@@ -3,8 +3,8 @@ import { createApiHandler, config } from '@ory/integrations/next-edge'
 export { config }
 
 const COOKIE_DOMAINS = {
-  production: process.env.NEXT_PUBLIC_SERLO_DOMAIN_PRODUCTION,
-  staging: process.env.NEXT_PUBLIC_SERLO_DOMAIN_STAGING,
+  production: 'serlo.org',
+  staging: 'serlo-staging.dev',
   local: 'localhost',
 }
 
@@ -16,9 +16,9 @@ export const COOKIE_DOMAIN =
       : COOKIE_DOMAINS['local']
 
 const KRATOS_HOSTS = {
-  production: process.env.KRATOS_HOST_PRODUCTION,
-  staging: process.env.KRATOS_HOST_STAGING,
-  local: process.env.KRATOS_HOST_LOCAL,
+  production: 'https://kratos.serlo.org',
+  staging: 'https://kratos.serlo-staging.dev',
+  local: 'http://localhost:4433',
 }
 
 // if env is not set, it's a production build running on localhost, use staging as default