Move scg config schema validation to lib

Author: vetlek

packages/extension/client/src/scg.ts

@@ -563,10 +563,9 @@
     "test_with_coverage": "pnpm build && nyc mocha --import ts-node/esm --require source-map-support/register --recursive server/src/test/**/*.test.ts "
   },
   "dependencies": {
+    "@equinor/septic-config-lib": "workspace:*",
     "@vscode/prompt-tsx": "^0.4.0-alpha.5",
-    "ajv": "^8.12.0",
-    "js-yaml": "^4.1.1",
-    "@equinor/septic-config-lib": "workspace:*"
+    "js-yaml": "^4.1.1"
   },
   "devDependencies": {
     "@types/vscode": "^1.105.0",

packages/extension/package.json

@@ -286,6 +286,7 @@ export class DocumentProvider {
             this.cache.set(uri, doc);
             return doc;
         } catch {
+            console.log(`Failed to open document from file system: ${uri}`);
             return undefined;
         }
     }

packages/extension/server/src/documentProvider.ts

@@ -5,10 +5,8 @@
 
 import { Connection, Emitter, Event } from "vscode-languageserver";
 import { DocumentProvider } from "./documentProvider";
-import * as YAML from "js-yaml";
 import * as path from "path";
-import * as protocol from "./protocol";
-import { ScgConfig, ScgContext } from "@equinor/septic-config-lib";
+import { scgConfigFromYAML, ScgContext } from "@equinor/septic-config-lib";
 import { SepticConfigProvider } from "./configProvider";
 
 export class ScgContextManager {
@@ -83,10 +81,11 @@ export class ScgContextManager {
 
         try {
             await this.updateScgContext(uri);
-        } catch {
+        } catch (error) {
             console.log(
                 `Error updating context ${context.name}. Removing context from manager!`,
             );
+            console.log(error);
             this.contexts.delete(context.name);
         }
         return;
@@ -115,18 +114,12 @@ export class ScgContextManager {
         if (!doc) {
             return;
         }
-        const scgConfig = YAML.load(doc.getText()) as ScgConfig;
-        const filesInTemplatePath = await this.connection.sendRequest(
-            protocol.globFiles,
-            {
-                uri: path.parse(uri).dir + "/" + scgConfig.templatepath,
-            },
-        );
+        const scgConfig = scgConfigFromYAML(doc.getText());
+
         const scgContext = new ScgContext(
             uri,
             uri,
             scgConfig,
-            filesInTemplatePath,
             this.cnfgProvider,
         );
         this.contexts.set(scgContext.name, scgContext);

packages/extension/server/src/scgContextManager.ts

@@ -17,8 +17,8 @@ export {
     SepticTokenType,
 } from "./elements";
 export type { SepticReference } from "./reference";
-export { ScgContext } from "./scgContext";
-export type { ScgConfig } from "./scgContext";
+export { ScgContext, validate_scg, scgConfigFromYAML } from "./scg";
+export type { ScgConfigSchema } from "./scg";
 export { fromCalcIndexToParamIndex } from "./calc";
 export { findAlgCycles } from "./cycle";
 export type { SepticContext } from "./context";

…extension/schemas/scg_config.schema.json …ges/septic/public/scg_config.schema.jsonpackages/extension/schemas/scg_config.schema.json renamed to packages/septic/public/scg_config.schema.json packages/extension/schemas/scg_config.schema.json renamed to packages/septic/public/scg_config.schema.json

@@ -6,6 +6,7 @@
 import * as YAML from "js-yaml";
 import * as fs from "fs";
 import * as path from "path";
+import { getBasePublicPath } from "./path";
 
 export const defaultObjectLevel = 2;
 export const defaultObjectSymbolKind = "object";
@@ -236,24 +237,6 @@ export class SepticMetaInfoProvider {
     }
 }
 
-function getBasePublicPath(): string {
-    // Use a different base path for tests if NODE_ENV is 'test'
-    if (process.env.NODE_ENV === "test") {
-        return path.join(__dirname, `../public`);
-    }
-
-    // Check for assets in the bundled location (e.g. dist/assets)
-    // This works when the extension is bundled and assets are copied next to the bundle
-    const bundledPath = path.join(__dirname, "public");
-    if (fs.existsSync(bundledPath)) {
-        return bundledPath;
-    }
-
-    // Fallback to development/library structure (e.g. packages/septic/assets)
-    // This works when running via ts-node or from the compiled lib folder
-    return path.join(__dirname, "../public");
-}
-
 function updateDatatypeParams(params: SepticCalcParameterInfo[] | undefined) {
     if (!params) {
         return [];

packages/septic/src/index.ts

@@ -14,30 +14,48 @@ import { SepticObject } from "./elements";
 import { ISepticConfigProvider } from "./configProvider";
 import { SepticCnfg } from "./cnfg";
 import { updateParentObjects } from "./hierarchy";
+import { readFileSync } from "fs";
+import * as yaml from "js-yaml";
 
-export interface ScgConfig {
-    outputfile?: string;
-
-    templatepath: string;
-
-    verifycontent: boolean;
+import Ajv from "ajv";
+import { getBasePublicPath } from "./path";
 
-    adjustsspacing: boolean;
+const ajv = new Ajv();
+const scgSchemaPath = getBasePublicPath() + "/scg_config.schema.json";
+const scgSchema = JSON.parse(readFileSync(scgSchemaPath, "utf-8"));
+export const validate_scg = ajv.compile<ScgConfigSchema>(scgSchema);
 
-    sources: ScgSource[];
-    layout: ScgTemplate[];
-}
-
-export interface ScgSource {
-    filename: string;
-    id: string;
-    sheet: string;
+export interface ScgConfigSchema {
+    outputfile?: string;
+    templatepath: string;
+    adjustspacing?: boolean;
+    verifycontent?: boolean;
+    counters?: {
+        name: string;
+        value: number;
+    }[];
+    sources: {
+        filename: string;
+        id: string;
+        sheet?: string;
+        delimiter?: string;
+    }[];
+    layout: {
+        name: string;
+        source?: string;
+        include?: object;
+    }[];
 }
 
-export interface ScgTemplate {
-    name: string;
-    source?: string;
-    include?: string[];
+export function scgConfigFromYAML(yamlContent: string): ScgConfigSchema {
+    const config = yaml.load(yamlContent);
+    const valid = validate_scg(config);
+    if (!valid) {
+        throw new Error(
+            `Invalid SCG config: ${ajv.errorsText(validate_scg.errors)}`,
+        );
+    }
+    return config;
 }
 
 export class ScgContext implements SepticContext {
@@ -51,45 +69,30 @@ export class ScgContext implements SepticContext {
     constructor(
         name: string,
         filePath: string,
-        config: ScgConfig,
-        filesInTemplateDir: string[],
+        config: ScgConfigSchema,
         cnfgProvider: ISepticConfigProvider,
     ) {
         this.name = name;
         this.filePath = filePath;
         this.cnfgProvider = cnfgProvider;
 
-        this.files = this.getFiles(config, filesInTemplateDir);
+        this.files = this.getFiles(config);
     }
 
     public fileInContext(file: string): boolean {
         return this.files.includes(file);
     }
 
-    private getFiles(
-        scgConfig: ScgConfig,
-        filesInTemplateDir: string[],
-    ): string[] {
-        const files = [];
-        for (const template of scgConfig.layout) {
-            if (path.extname(template.name) !== ".cnfg") {
-                continue;
-            }
-            let found = false;
-            for (const file of filesInTemplateDir) {
-                if (template.name === path.basename(file)) {
-                    files.push(file);
-                    found = true;
-                    break;
-                }
-            }
-            if (!found) {
-                console.log(
-                    `Could not find template: ${template.name} in template dir for context ${this.name}`,
-                );
-            }
-        }
-        return files;
+    private getFiles(scgConfig: ScgConfigSchema): string[] {
+        return scgConfig.layout.map((layout) => {
+            return (
+                path.dirname(this.filePath) +
+                "/" +
+                scgConfig.templatepath +
+                "/" +
+                layout.name
+            );
+        });
     }
 
     public async load(): Promise<void> {
@@ -137,9 +140,6 @@ export class ScgContext implements SepticContext {
         for (const file of this.files) {
             const cnfg = this.cnfgCache.get(file);
             if (!cnfg) {
-                console.log(
-                    `Could not get config for ${file} in context ${this.name}`,
-                );
                 continue;
             }
             const localReferences = cnfg.getReferences(name);

packages/septic/src/metaInfoProvider.ts

@@ -40,7 +40,8 @@
         "skipLibCheck": true,
         "outDir": "./dist",
         "rootDir": "./src",
-        "composite": true
+        "composite": true,
+        "resolveJsonModule": true
     },
     "include": ["src"],
     "exclude": ["node_modules", "src/test", "dist"]