Refactor envs validator: split schema and migrate to vite (#3140)

* migrate to vite

* split validation schema

Author: tom2drum

Dockerfile

@@ -165,7 +165,7 @@ COPY --from=builder /app/public ./public
 COPY --from=builder /app/package.json ./package.json
 
 # Copy tools
-COPY --from=builder /app/deploy/tools/envs-validator/index.js ./envs-validator.js
+COPY --from=builder /app/deploy/tools/envs-validator/dist/index.js ./envs-validator/index.js
 COPY --from=builder /app/deploy/tools/feature-reporter/index.js ./feature-reporter.js
 COPY --from=builder /app/deploy/tools/multichain-config-generator/dist ./deploy/tools/multichain-config-generator/dist
 COPY --from=builder /app/deploy/tools/llms-txt-generator/dist ./deploy/tools/llms-txt-generator/dist

deploy/scripts/validate_envs.sh

@@ -7,7 +7,7 @@ if [ -f .env ]; then
 fi
 
 # Check run-time ENVs values integrity
-node "$(dirname "$0")/envs-validator.js" "$input"
+node "$(dirname "$0")/envs-validator/index.js" "$input"
 if [ $? != 0 ]; then                   
    exit 1
 fi

deploy/tools/envs-validator/.gitignore

@@ -1,5 +1,6 @@
 /node_modules
 /public
+/dist
 .env
 .env.registry
 .env.secrets

deploy/tools/envs-validator/index.ts

@@ -1,11 +1,15 @@
 /* eslint-disable no-console */
-import fs from 'fs';
-import path from 'path';
+import fs from 'node:fs';
+import { dirname, resolve as resolvePath } from 'node:path';
 import type { ValidationError } from 'yup';
 
-import { buildExternalAssetFilePath } from '../../../configs/app/utils';
+import { buildExternalAssetFilePath } from 'configs/app/utils';
 import schema from './schema';
 import schemaMultichain from './schema_multichain';
+import { fileURLToPath } from 'node:url';
+
+const currentFilePath = fileURLToPath(import.meta.url);
+const distDir = dirname(currentFilePath);
 
 const silent = process.argv.includes('--silent');
 
@@ -80,7 +84,7 @@ async function getExternalJsonContent(envName: string): Promise<string | void> {
   return new Promise((resolve, reject) => {
     const fileName = `./public${ buildExternalAssetFilePath(envName, 'https://foo.bar/baz.json') }`;
 
-    fs.readFile(path.resolve(__dirname, fileName), 'utf8', (err, data) => {
+    fs.readFile(resolvePath(distDir, '..', fileName), 'utf8', (err, data) => {
       if (err) {
         console.log(`🚨 Unable to read file: ${ fileName }`);
         reject(err);
@@ -96,8 +100,8 @@ async function checkPlaceholdersCongruity(envsMap: Record<string, string>) {
   try {
     !silent && console.log(`🌀 Checking environment variables and their placeholders congruity...`);
 
-    const runTimeEnvs = await getEnvsPlaceholders(path.resolve(__dirname, '.env.registry'));
-    const buildTimeEnvs = await getEnvsPlaceholders(path.resolve(__dirname, '.env'));
+    const runTimeEnvs = await getEnvsPlaceholders(resolvePath(distDir, '..', '.env.registry'));
+    const buildTimeEnvs = await getEnvsPlaceholders(resolvePath(distDir, '..', '.env'));
     const envs = Object.keys(envsMap).filter((env) => !buildTimeEnvs.includes(env));
 
     const inconsistencies: Array<string> = [];
@@ -121,7 +125,7 @@ async function checkPlaceholdersCongruity(envsMap: Record<string, string>) {
 
     !silent && console.log('👍 All good!\n');
   } catch (error) {
-    console.log('🚨 Congruity check failed.\n');
+    console.log('🚨 Congruity check failed.\n', error);
     throw error;
   }
 }

deploy/tools/envs-validator/package.json

@@ -1,21 +1,18 @@
 {
   "name": "envs-validator",
+  "type": "module",
   "version": "1.0.0",
-  "main": "index.js",
+  "main": "dist/index.js",
   "license": "MIT",
   "scripts": {
-    "build": "yarn webpack-cli -c ./webpack.config.js",
-    "validate": "node ./index.js",
+    "build": "vite build --logLevel error",
+    "validate": "node ./dist/index.js",
     "test": "./test.sh"
   },
-  "dependencies": {
-    "ts-loader": "^9.4.4",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4",
-    "yup": "^1.2.0"
-  },
   "devDependencies": {
+    "yup": "^1.2.0",
     "dotenv-cli": "^7.2.1",
-    "tsconfig-paths-webpack-plugin": "^4.1.0"
+    "typescript": "5.4.2",
+    "vite": "6.4.1"
   }
 }