build(fetch-schema-plugin): added vite plugin to fetch schemas from e…

…verest framework

Closes #131

Signed-off-by: Lukas Mertens <[email protected]>

commit-id:bb068b2d

build-tools/fetch-schemas-plugin.ts

@@ -0,0 +1,37 @@
+import {remoteSchemas} from "../schemas.config";
+import yaml from 'js-yaml';
+import crypto from 'crypto';
+import fs from "fs";
+
+
+export function vitePluginFetchSchemas() {
+    return {
+        name: 'vite-plugin-fetch-schema',
+        buildStart() {
+            fetchRemoteSchemas();
+        }
+    };
+}
+
+function sha256(data: string): string {
+    return crypto.createHash('sha256').update(data, 'utf8').digest('hex');
+}
+
+export function fetchRemoteSchemas() {
+    remoteSchemas.forEach(async (schema) => {
+        if (!fs.existsSync(`./public/schemas/${schema.name}.json`)) {
+            const fetchedSchemaYAML = await fetch(schema.url).then(res => res.text());
+            const fetchedSchemaHash = sha256(fetchedSchemaYAML);
+            if (fetchedSchemaHash !== schema.hash) {
+                throw new Error(`Schema hash mismatch for ${schema.url}. Expected: ${schema.hash}, got: ${fetchedSchemaHash}`);
+            }
+            const schemaJSON = yaml.load(fetchedSchemaYAML);
+
+            schema.hash = fetchedSchemaHash;
+            fs.mkdirSync('./public/schemas', {recursive: true});
+            fs.writeFileSync(`./public/schemas/${schema.name}.json`, JSON.stringify(schemaJSON));
+
+            console.log(`${schema.url} fetched and cached successfully.`);
+        }
+    });
+}

public/schemas/.gitignore

@@ -0,0 +1 @@
+*.json

schemas.config.ts

@@ -0,0 +1,23 @@
+// configure the release branch here
+const releaseBranch = 'release/2024.3.0-rc1';
+
+export type RemoteSchema = {
+    url: string;
+    name: string;
+    hash: string;
+}
+
+// TODO : Currently we reference the schemas from a branch of the git repo.
+// TODO : In the future we might want to release the schemas separately with a version number.
+export const remoteSchemas: RemoteSchema[] = [
+    {
+        url: `https://raw.githubusercontent.com/EVerest/everest-framework/${releaseBranch}/schemas/config.yaml`,
+        name: 'config',
+        hash: 'cd2296cdf0bd29bfffa58e920e5052d1bd5d2f1d2fd63d92fd5ac7e8af64d80b'
+    },
+    {
+        url: `https://raw.githubusercontent.com/EVerest/everest-framework/${releaseBranch}/schemas/interface.yaml`,
+        name: 'interface',
+        hash: '9b1059249c4073737bec94753a6735f664d77b97321d4379b9de3179ea0a9cd5'
+    }
+];

tsconfig.node.json

@@ -6,6 +6,8 @@
     "allowSyntheticDefaultImports": true
   },
   "include": [
-    "vite.config.ts"
+    "vite.config.ts",
+    "build-tools/fetch-schemas-plugin.ts",
+    "schemas.config.ts"
   ]
 }

vite.config.ts

@@ -7,7 +7,8 @@ import {defineConfig, loadEnv} from "vite";
 import {commonjsDeps} from '@koumoul/vjsf/utils/build';
 import {fileURLToPath} from "node:url";
 import commonjs from "@rollup/plugin-commonjs";
-import { VitePWA } from 'vite-plugin-pwa';
+import {VitePWA} from 'vite-plugin-pwa';
+import {vitePluginFetchSchemas} from "./build-tools/fetch-schemas-plugin";
 
 export default defineConfig(({ mode}) => {
     loadEnv(mode, process.cwd(), '');
@@ -33,7 +34,8 @@ export default defineConfig(({ mode}) => {
         Vuetify({
             autoImport: true,
         }),
-        VitePWA({ registerType: 'autoUpdate' })
+        VitePWA({registerType: 'autoUpdate'}),
+        vitePluginFetchSchemas(),
     ],
     resolve: {
         alias: {