centralized env load and validation

Author: Saitharun279

.github/workflows/pre-commit-tests.yaml

@@ -1,7 +1,7 @@
 name: pre-merge-checks
 on:
-  pull_request:
-    branches: [main, develop]
+  push:
+    branches: test/issue#257-2
 jobs:
   Run-Tests:
     runs-on: ubuntu-latest

.github/workflows/register-commands-staging.yaml

@@ -1,9 +1,32 @@
 name: Register and deploy Slash Commands
 on:
   push:
-    branches: develop
+    branches: test/issue#257-2
 jobs:
+  Environment-Variables-Check:
+    runs-on: ubuntu-latest
+    environment: staging
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.2
+      - run: npm install
+      - run: npm run env-var-check
+        env:
+          DISCORD_APPLICATION_ID: ${{secrets.DISCORD_APPLICATION_ID}}
+          DISCORD_GUILD_ID: ${{secrets.DISCORD_GUILD_ID}}
+          DISCORD_TOKEN: ${{secrets.DISCORD_TOKEN}}
+          DISCORD_PUBLIC_KEY: ${{secrets.DISCORD_PUBLIC_KEY}}
+          CLOUDFLARE_API_TOKEN: ${{secrets.CLOUDFLARE_API_TOKEN}}
+          CLOUDFLARE_ACCOUNT_ID: ${{secrets.CLOUDFLARE_ACCOUNT_ID}}
+          BOT_PRIVATE_KEY: ${{secrets.BOT_PRIVATE_KEY}}
+          RDS_SERVERLESS_PUBLIC_KEY: ${{secrets.RDS_SERVERLESS_PUBLIC_KEY}}
+          CRON_JOBS_PUBLIC_KEY: ${{secrets.CRON_JOBS_PUBLIC_KEY}}
+          IDENTITY_SERVICE_PUBLIC_KEY: ${{secrets.IDENTITY_SERVICE_PUBLIC_KEY}}
+
   Register-Commands:
+    needs: [Environment-Variables-Check]
     runs-on: ubuntu-latest
     environment: staging
     steps:

config/envVarCheck.ts

@@ -0,0 +1,46 @@
+import { env } from "../src/typeDefinitions/default.types";
+import { config } from "dotenv";
+
+export function loadEnv (
+  env: env,
+  fromWorkerEnv: boolean
+): env {
+  const Env:env = {
+    CURRENT_ENVIRONMENT: fromWorkerEnv ? env.CURRENT_ENVIRONMENT : process.env.CURRENT_ENVIRONMENT || '',
+    DISCORD_APPLICATION_ID: fromWorkerEnv ? env.DISCORD_APPLICATION_ID : process.env.DISCORD_APPLICATION_ID || '',
+    DISCORD_GUILD_ID: fromWorkerEnv ? env.DISCORD_GUILD_ID : process.env.DISCORD_GUILD_ID || '',
+    DISCORD_TOKEN: fromWorkerEnv ? env.DISCORD_TOKEN : process.env.DISCORD_TOKEN || '',
+    DISCORD_PUBLIC_KEY: fromWorkerEnv ? env.DISCORD_PUBLIC_KEY : process.env.DISCORD_PUBLIC_KEY || '',
+    CLOUDFLARE_API_TOKEN: fromWorkerEnv ? env.CLOUDFLARE_API_TOKEN : process.env.CLOUDFLARE_API_TOKEN || '',
+    CLOUDFLARE_ACCOUNT_ID: fromWorkerEnv ? env.CLOUDFLARE_ACCOUNT_ID : process.env.CLOUDFLARE_ACCOUNT_ID || '',
+    BOT_PRIVATE_KEY: fromWorkerEnv ? env.BOT_PRIVATE_KEY : process.env.BOT_PRIVATE_KEY || '',
+    RDS_SERVERLESS_PUBLIC_KEY: fromWorkerEnv ? env.RDS_SERVERLESS_PUBLIC_KEY : process.env.RDS_SERVERLESS_PUBLIC_KEY || '',
+    CRON_JOBS_PUBLIC_KEY: fromWorkerEnv ? env.CRON_JOBS_PUBLIC_KEY : process.env.CRON_JOBS_PUBLIC_KEY || '',
+    IDENTITY_SERVICE_PUBLIC_KEY: fromWorkerEnv ? env.IDENTITY_SERVICE_PUBLIC_KEY : process.env.IDENTITY_SERVICE_PUBLIC_KEY || ''
+  }
+  return Env;
+}
+
+
+config();
+validateEnv();
+
+
+
+/**
+ * Validate if all the required environment variables defined in the schema above are set
+ * and are in the correct format else throw an error
+ * ---
+ */
+export default function validateEnv (){
+    const env: env = loadEnv({}, false);
+    const missingEnvVars = Object.keys(env).filter((key) => env[key] !== "");
+
+    // Logging missing environment variables and exit if any are missing
+    if (missingEnvVars.length > 0) {
+      console.error(`Missing environment variables: ${missingEnvVars.join(', ')}`);
+      process.exit(1); // Exit with code 1 if any required env var is missing
+    } else {
+      console.log('All required environment variables are set.');
+    }   
+}

package.json

@@ -15,7 +15,8 @@
     "format-fix": "prettier --write .",
     "fix": "npm run lint-fix && npm run format-fix",
     "ngrok": "ngrok http 8787",
-    "register": "ts-node-esm src/register.ts"
+    "register": "ts-node-esm src/register.ts",
+    "env-var-check": "ts-node-esm config/envVarCheck.ts"
   },
   "keywords": [],
   "author": "",
@@ -35,7 +36,8 @@
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.4",
-    "wrangler": "^3.1.1"
+    "wrangler": "^3.1.1",
+    "zod": "^3.23.8"
   },
   "dependencies": {
     "@tsndr/cloudflare-worker-jwt": "^2.2.1",

src/index.ts

@@ -23,6 +23,7 @@ import { sendProfileBlockedMessage } from "./controllers/profileHandler";
 import { sendTaskUpdatesHandler } from "./controllers/taskUpdatesHandler";
 
 import config from "./../config/config";
+import { loadEnv } from "../config/envVarCheck";
 
 const router = Router();
 
@@ -107,10 +108,10 @@ export default {
         return new JSONResponse(response.BAD_SIGNATURE, { status: 401 });
       }
     }
-    return router.handle(request, env, ctx);
+    return router.handle(request, loadEnv(env,true), ctx);
   },
 
   async scheduled(req: Request, env: env, ctx: ExecutionContext) {
-    ctx.waitUntil(send(env));
+    ctx.waitUntil(send(loadEnv(env,true)));
   },
 };