@static-suite/static-suite-data-server 0.0.14 → 0.0.15

package/README.md

@@ -21,6 +21,10 @@ Data Server supports static JSON includes (`entityInclude`, `configInclude`, `lo
 - `runMode` / `--run-mode`: "dev" or "prod". Default is "prod". Optional.
 - `--port`: port number for the HTTP endpoint. Default is `57471`. Optional.
 
+## Options from file.
+
+Data Server looks for `dataserver.config.json` in the current working directory. Filename and location can be changed with `DATASERVER_CONFIG_FILE` environment variable.
+
 ## Usage
 
 There are three main use cases:

package/dataserver.test.config.json

@@ -0,0 +1,11 @@
+{
+    "port": 57471,
+    "dataDir": "./src/__tests__/fixtures/data",
+    "workDir": "./src/__tests__/fixtures/work",
+    "queryDir": "./src/__tests__/fixtures/query",
+    "hookDir": "./src/__tests__/fixtures/hook",
+    "taskDir": "./src/__tests__/fixtures/task",
+    "runMode": "dev",
+    "logLevel": "debug"
+}
+

package/dist/bin/serve.js

@@ -5,12 +5,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
 const yargs_1 = __importDefault(require("yargs/yargs"));
 const helpers_1 = require("yargs/helpers");
 const httpServer_1 = require("../http/httpServer");
 const dataServer_1 = require("../lib/dataServer");
 const dataServer_types_1 = require("../lib/dataServer.types");
 const logger_types_1 = require("../lib/utils/logger/logger.types");
+const configFile = process.env.DATASERVER_CONFIG_FILE ?? 'dataserver.config.json';
+const config = fs_1.default.existsSync(configFile)
+    ? JSON.parse(fs_1.default.readFileSync(configFile).toString())
+    : {};
 const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
     .usage('Usage: $0 http --data-dir [path]')
     .command(['http [--port]'], 'Start an HTTP server')
@@ -78,6 +83,7 @@ const argv = (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
         done(['query-dir', 'data-dir']);
     }, 500);
 })
+    .config(config)
     .parseSync();
 const logLevel = logger_types_1.LogLevel[argv['log-level'].toUpperCase()];
 const logFileLevel = argv['log-file-level']

package/dist/http/README.md

@@ -21,6 +21,10 @@ Data Server supports static JSON includes (`entityInclude`, `configInclude`, `lo
 - `runMode` / `--run-mode`: "dev" or "prod". Default is "prod". Optional.
 - `--port`: port number for the HTTP endpoint. Default is `57471`. Optional.
 
+## Options from file.
+
+Data Server looks for `dataserver.config.json` in the current working directory. Filename and location can be changed with `DATASERVER_CONFIG_FILE` environment variable.
+
 ## Usage
 
 There are three main use cases:

package/dist/lib/store/storeManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"storeManager.d.ts","sourceRoot":"","sources":["../../../src/lib/store/storeManager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAuH7C,eAAO,MAAM,YAAY,EAAE,YAmG1B,CAAC"}
+{"version":3,"file":"storeManager.d.ts","sourceRoot":"","sources":["../../../src/lib/store/storeManager.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AA+H7C,eAAO,MAAM,YAAY,EAAE,YAmG1B,CAAC"}

package/dist/lib/store/storeManager.js

@@ -12,9 +12,10 @@ const dependencyTagger_1 = require("./dependency/dependencyTagger");
  * Sets a file into the store, regardless of being already added or not.
  *
  * @param relativeFilepath - Relative file path, inside dataDir, to the file to be added.
- * @param options - Configuration options.
  *
- * @returns Object with two properties, "raw" and "json".
+ * @returns Object with two properties:
+ *  fileContent: the contents of the stored file
+ *  previousStoredData: the contents of the previously stored file
  */
 const setFileIntoStore = (relativeFilepath) => {
     const absoluteFilePath = `${config_1.config.dataDir}/${relativeFilepath}`;
@@ -26,45 +27,51 @@ const setFileIntoStore = (relativeFilepath) => {
     });
     let previousStoredData = null;
     const dataToStore = fileContent.json || fileContent.raw;
-    const previousData = _1.store.data.get(relativeFilepath);
+    const currentData = _1.store.data.get(relativeFilepath);
     let skipUpdating = false;
     if (fileContent.json) {
         // Check if the object already exists to make sure we don't break the reference
         if (dataToStore && typeof dataToStore === 'object') {
-            if (previousData) {
+            if (currentData) {
                 // Delete include dependencies.
-                dependencyFileHelper_1.dependencyIncludeHelper.deleteIncludeDependencies(relativeFilepath, dataToStore);
+                dependencyFileHelper_1.dependencyIncludeHelper.deleteIncludeDependencies(relativeFilepath, currentData);
                 // Remove previous data from URL index.
-                const url = previousData.data?.content?.url?.path;
+                const url = currentData.data?.content?.url?.path;
                 if (url) {
                     _1.store.index.url.delete(url);
                 }
                 // Remove previous data from UUID index.
-                const uuid = previousData.data?.content?.uuid;
-                const langcode = previousData.data?.content?.langcode?.value;
+                const uuid = currentData.data?.content?.uuid;
+                const langcode = currentData.data?.content?.langcode?.value;
                 if (uuid && langcode) {
                     _1.store.index.uuid.get(langcode)?.delete(uuid);
                 }
                 // Delete all referenced object properties and copy them to another object.
-                previousStoredData = previousData.data?.content
+                previousStoredData = currentData.data?.content
                     ? { data: { content: {} } }
                     : {};
-                if (previousData.metadata) {
+                if (currentData.metadata) {
                     // We cannot use structuredClone to clone the whole JSON,
                     // since proxies used by queries are not supported by structuredClone.
-                    previousStoredData.metadata = structuredClone(previousData.metadata);
+                    previousStoredData.metadata = structuredClone(currentData.metadata);
                 }
                 const previousStoredDataPointer = previousStoredData.data?.content || previousStoredData;
-                const previousDataPointer = previousData.data?.content || previousData;
-                Object.keys(previousDataPointer).forEach(key => {
-                    previousStoredDataPointer[key] = previousDataPointer[key];
-                    delete previousDataPointer[key];
+                const currentDataPointer = currentData.data?.content || currentData;
+                Object.keys(currentDataPointer).forEach(key => {
+                    previousStoredDataPointer[key] = currentDataPointer[key];
+                    delete currentDataPointer[key];
                 });
                 // Hydrate new object properties into referenced object
                 const dataToStorePointer = dataToStore.data?.content || dataToStore;
                 Object.keys(dataToStorePointer).forEach(key => {
-                    previousDataPointer[key] = dataToStorePointer[key];
+                    currentDataPointer[key] = dataToStorePointer[key];
                 });
+                if (dataToStore.metadata) {
+                    currentData.metadata = dataToStore.metadata;
+                }
+                else {
+                    delete currentData.metadata;
+                }
                 skipUpdating = true;
             }
             // Add data to UUID index.
@@ -85,7 +92,7 @@ const setFileIntoStore = (relativeFilepath) => {
         }
     }
     else {
-        previousStoredData = previousData;
+        previousStoredData = currentData;
     }
     if (!skipUpdating) {
         _1.store.data.set(relativeFilepath, dataToStore);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-suite/static-suite-data-server",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "A flexible, fast and developer friendly Data Server for Static Suite",
   "main": "./dist/lib/index.js",
   "typings": "./dist/lib/index.d.ts",
@@ -42,7 +42,7 @@
     "dev": "tsc-watch --onSuccess \"yarn lint\"",
     "build": "rm -Rf dist && yarn copy-http-files-to-src && yarn lint && tsc && yarn api-extractor run --local --verbose && yarn post-build && yarn copy-http-files-to-dist",
     "post-build": "yarn rimraf dist/**/*__tests__",
-    "serve": "node ./dist/bin/serve.js http --port=57471 --data-dir=./src/__tests__/fixtures/data --work-dir=./src/__tests__/fixtures/work --query-dir=./src/__tests__/fixtures/query  --hook-dir=./src/__tests__/fixtures/hook --task-dir=./src/__tests__/fixtures/task --run-mode=dev --log-level=debug",
+    "serve": "export DATASERVER_CONFIG_FILE=dataserver.test.config.json && node ./dist/bin/serve.js http",
     "lint": "eslint . --ext .ts",
     "docs": "yarn typedoc --out docs src/lib/",
     "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",

package/src/bin/serve.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 /* eslint-disable import/first */
 
+import fs from 'fs';
 import yargs from 'yargs/yargs';
 import { hideBin } from 'yargs/helpers';
 
@@ -9,6 +10,12 @@ import { dataServer } from '../lib/dataServer';
 import { RunMode, RunModeStrings } from '../lib/dataServer.types';
 import { LogLevel, LogLevelStrings } from '../lib/utils/logger/logger.types';
 
+const configFile =
+  process.env.DATASERVER_CONFIG_FILE ?? 'dataserver.config.json';
+const config = fs.existsSync(configFile)
+  ? JSON.parse(fs.readFileSync(configFile).toString())
+  : {};
+
 const argv = yargs(hideBin(process.argv))
   .usage('Usage: $0 http --data-dir [path]')
   .command(['http [--port]'], 'Start an HTTP server')
@@ -77,6 +84,7 @@ const argv = yargs(hideBin(process.argv))
       done(['query-dir', 'data-dir']);
     }, 500);
   })
+  .config(config)
   .parseSync();
 
 const logLevel = LogLevel[argv['log-level'].toUpperCase() as LogLevelStrings];

package/src/lib/store/storeManager.ts

@@ -12,9 +12,10 @@ import { dependencyTagger } from './dependency/dependencyTagger';
  * Sets a file into the store, regardless of being already added or not.
  *
  * @param relativeFilepath - Relative file path, inside dataDir, to the file to be added.
- * @param options - Configuration options.
  *
- * @returns Object with two properties, "raw" and "json".
+ * @returns Object with two properties:
+ *  fileContent: the contents of the stored file
+ *  previousStoredData: the contents of the previously stored file
  */
 const setFileIntoStore = (
   relativeFilepath: string,
@@ -34,53 +35,60 @@ const setFileIntoStore = (
   let previousStoredData: any = null;
 
   const dataToStore = fileContent.json || fileContent.raw;
-  const previousData = store.data.get(relativeFilepath);
+  const currentData = store.data.get(relativeFilepath);
   let skipUpdating = false;
   if (fileContent.json) {
     // Check if the object already exists to make sure we don't break the reference
     if (dataToStore && typeof dataToStore === 'object') {
-      if (previousData) {
+      if (currentData) {
         // Delete include dependencies.
         dependencyIncludeHelper.deleteIncludeDependencies(
           relativeFilepath,
-          dataToStore,
+          currentData,
         );
 
         // Remove previous data from URL index.
-        const url = previousData.data?.content?.url?.path;
+        const url = currentData.data?.content?.url?.path;
         if (url) {
           store.index.url.delete(url);
         }
 
         // Remove previous data from UUID index.
-        const uuid = previousData.data?.content?.uuid;
-        const langcode = previousData.data?.content?.langcode?.value;
+        const uuid = currentData.data?.content?.uuid;
+        const langcode = currentData.data?.content?.langcode?.value;
         if (uuid && langcode) {
           store.index.uuid.get(langcode)?.delete(uuid);
         }
 
         // Delete all referenced object properties and copy them to another object.
-        previousStoredData = previousData.data?.content
+        previousStoredData = currentData.data?.content
           ? { data: { content: {} } }
           : {};
-        if (previousData.metadata) {
+        if (currentData.metadata) {
           // We cannot use structuredClone to clone the whole JSON,
           // since proxies used by queries are not supported by structuredClone.
-          previousStoredData.metadata = structuredClone(previousData.metadata);
+          previousStoredData.metadata = structuredClone(currentData.metadata);
         }
         const previousStoredDataPointer =
           previousStoredData.data?.content || previousStoredData;
-        const previousDataPointer = previousData.data?.content || previousData;
-        Object.keys(previousDataPointer).forEach(key => {
-          previousStoredDataPointer[key] = previousDataPointer[key];
-          delete previousDataPointer[key];
+        const currentDataPointer = currentData.data?.content || currentData;
+        Object.keys(currentDataPointer).forEach(key => {
+          previousStoredDataPointer[key] = currentDataPointer[key];
+          delete currentDataPointer[key];
         });
 
         // Hydrate new object properties into referenced object
         const dataToStorePointer = dataToStore.data?.content || dataToStore;
         Object.keys(dataToStorePointer).forEach(key => {
-          previousDataPointer[key] = dataToStorePointer[key];
+          currentDataPointer[key] = dataToStorePointer[key];
         });
+
+        if (dataToStore.metadata) {
+          currentData.metadata = dataToStore.metadata;
+        } else {
+          delete currentData.metadata;
+        }
+
         skipUpdating = true;
       }
 
@@ -107,7 +115,7 @@ const setFileIntoStore = (
       );
     }
   } else {
-    previousStoredData = previousData;
+    previousStoredData = currentData;
   }
 
   if (!skipUpdating) {