feat: add config validation to db:check command

Author: n1k0

check-db.js

@@ -1,11 +1,12 @@
 require("dotenv").config();
 const { Elm } = require("./check-db-app");
-const { getProcessesAsString } = require("./lib");
+const { getComponentConfigAsString, getProcessesAsString } = require("./lib");
 
 const elmApp = Elm.CheckDb.init({
   flags: {
-    detailedProcesses: getProcessesAsString((detailed = true)),
-    nonDetailedProcesses: getProcessesAsString((detailed = false)),
+    detailedProcessesJson: getProcessesAsString((detailed = true)),
+    nonDetailedProcessesJson: getProcessesAsString((detailed = false)),
+    componentConfigJson: getComponentConfigAsString(),
   },
 });
 

lib/index.js

@@ -55,6 +55,10 @@ function setupTracker(spec) {
   };
 }
 
+function getComponentConfigAsString() {
+  return fs.readFileSync("public/data/components/config.json", "utf8").toString();
+}
+
 function getProcessesAsString(detailed = false) {
   return JSON.stringify(
     JSON.parse(
@@ -76,6 +80,7 @@ const dataFiles = {
 
 module.exports = {
   dataFiles,
+  getComponentConfigAsString,
   getProcessesAsString,
   setupTracker,
 };

src/CheckDb.elm

@@ -1,6 +1,7 @@
 port module CheckDb exposing (main)
 
 import Data.Component as Component exposing (Component)
+import Data.Component.Config as ComponentConfig
 import Data.Example exposing (Example)
 import Data.Process as Process exposing (Process)
 import Data.Scope as Scope
@@ -12,8 +13,9 @@ import Static.Db as StaticDb exposing (Db)
 
 
 type alias Flags =
-    { detailedProcesses : String
-    , nonDetailedProcesses : String
+    { componentConfigJson : String
+    , detailedProcessesJson : String
+    , nonDetailedProcessesJson : String
     }
 
 
@@ -54,6 +56,16 @@ backtick string =
     "`" ++ string ++ "`"
 
 
+{-| Validates component config JSON against a static database.
+-}
+checkComponentConfig : Db -> String -> List Error
+checkComponentConfig db =
+    ComponentConfig.parse db
+        >> Result.mapError List.singleton
+        >> Result.map (always [])
+        >> Result.withDefault []
+
+
 {-| Returns missing component ids referenced by a component item.
 -}
 checkComponentItemId : Set String -> Component.Item -> List String
@@ -250,10 +262,10 @@ checkProcessId knownProcessStringIds component fieldName processId =
         []
 
 
-{-| Checks a static database and returns a list of errors.
+{-| Checks a static database and config comformity, then returns a list of errors.
 -}
-checkStaticDatabase : String -> Result String Db -> List Error
-checkStaticDatabase dbName dbResult =
+checkStaticDatabase : String -> String -> Result String Db -> List Error
+checkStaticDatabase config dbName dbResult =
     let
         section title =
             dbName ++ " - " ++ title
@@ -273,16 +285,17 @@ checkStaticDatabase dbName dbResult =
                 |> addGroupedErrors (section "Examples components checks") (checkExamplesComponentIds knownComponentStringIds db)
                 |> addGroupedErrors (section "Components processes checks") (checkComponentsProcessIds knownProcessStringIds db)
                 |> addGroupedErrors (section "Scoping checks") (checkExamplesScope db)
+                |> addGroupedErrors (section "Component config checks") (checkComponentConfig db config)
 
 
 {-| Decodes both static databases, executes checks, and returns grouped errors.
 -}
 checkStaticDatabases : Flags -> Result (List Error) ()
-checkStaticDatabases { detailedProcesses, nonDetailedProcesses } =
+checkStaticDatabases { componentConfigJson, detailedProcessesJson, nonDetailedProcessesJson } =
     case
-        List.concatMap (\( dbName, dbResult ) -> checkStaticDatabase dbName dbResult)
-            [ ( "Detailed Db", StaticDb.db detailedProcesses )
-            , ( "Non-detailed Db", StaticDb.db nonDetailedProcesses )
+        List.concatMap (\( dbName, dbResult ) -> checkStaticDatabase componentConfigJson dbName dbResult)
+            [ ( "Detailed Db", StaticDb.db detailedProcessesJson )
+            , ( "Non-detailed Db", StaticDb.db nonDetailedProcessesJson )
             ]
     of
         [] ->