@static-suite/static-suite-data-server 0.0.1

package/src/http/routes/index.ts

@@ -0,0 +1,47 @@
+import { Router } from 'express';
+import { home } from './home';
+import { queryIndex, runQuery } from './query';
+import { cacheIndex, cacheClear } from './cache';
+import {
+  statusBasic,
+  statusDiff,
+  statusIndex,
+  statusIndexCustom,
+  statusIndexUrl,
+  statusIndexUuid,
+} from './status';
+import { data } from './data';
+import { docs } from './docs';
+import { runTask, taskIndex } from './task';
+import {
+  dumpIndex,
+  dumpIncremental,
+  dumpFull,
+  dumpMetadataShow,
+  dumpMetadataReset,
+} from './dump';
+
+const routes = Router();
+
+routes.get('/', home);
+routes.get('/docs', docs);
+routes.get('/status/basic', statusBasic);
+routes.get('/status/index/url', statusIndexUrl);
+routes.get('/status/index/uuid', statusIndexUuid);
+routes.get('/status/index/custom', statusIndexCustom);
+routes.get('/status/diff', statusDiff);
+routes.get('/status', statusIndex);
+routes.get('/query', queryIndex);
+routes.get('/query/*', runQuery);
+routes.get('/task', taskIndex);
+routes.get('/task/*', runTask);
+routes.get('/cache', cacheIndex);
+routes.get('/cache/*/clear', cacheClear);
+routes.get('/dump', dumpIndex);
+routes.get('/dump/incremental', dumpIncremental);
+routes.get('/dump/full', dumpFull);
+routes.get('/dump/metadata/show', dumpMetadataShow);
+routes.get('/dump/metadata/reset', dumpMetadataReset);
+routes.get(['/data/*', '/data'], data);
+
+export default routes;

package/src/http/routes/query.ts

@@ -0,0 +1,27 @@
+import { Request, Response } from 'express';
+import { dataDirManager } from '@lib/store/dataDir';
+import { queryRunner, queryManager } from '@lib/query';
+import {
+  QueryErrorResponse,
+  QuerySuccessfulResponse,
+} from '@lib/query/query.types';
+
+const queryIndex = (req: Request, res: Response): void => {
+  const queryIds = Array.from(queryManager.getModuleGroupInfo().keys());
+  res.render('queryIndex', {
+    queryIds:
+      queryIds.length > 0 ? queryIds.map(query => `/query/${query}`) : null,
+  });
+};
+
+const runQuery = (req: Request, res: Response): void => {
+  dataDirManager.update();
+  const queryDefinition = req.originalUrl.replace(/^\/query\//, '');
+  const response: QuerySuccessfulResponse | QueryErrorResponse =
+    queryRunner.run(queryDefinition);
+  res.status(200);
+  res.set('application/json');
+  res.send(response);
+};
+
+export { queryIndex, runQuery };

package/src/http/routes/status.ts

@@ -0,0 +1,89 @@
+// import microtime from 'microtime';
+import { Request, Response } from 'express';
+import { dataDirManager } from '@lib/store/dataDir';
+import { queryRunner } from '@lib/query';
+import { config } from '@lib/config';
+import { cache } from '@lib/utils/cache';
+import { store } from '@lib/store';
+import { jsonify } from '@lib/utils/object';
+import { diffManager } from '@lib/store/diff/diffManager';
+import { ObjectType } from '@lib/utils/object/object.types';
+import { dependencyManager } from '@lib/store/dependency/dependencyManager';
+import {
+  dependencyTree,
+  getReversedDependencyTree,
+} from '@lib/store/dependency/dependencyTagger';
+
+const statusIndex = (req: Request, res: Response): void => {
+  res.render('statusIndex', {
+    links: {
+      '/status/basic': 'Basic status info',
+      '/status/index/url': 'List of indexed URLs',
+      '/status/index/uuid': 'List of indexed UUIDs by language',
+      '/status/index/include': 'List of indexed includes',
+      '/status/index/custom': 'List of custom indexes',
+      '/status/diff': 'Executes a diff operation',
+    },
+  });
+};
+
+const statusBasic = (req: Request, res: Response): void => {
+  dataDirManager.update();
+
+  const response = {
+    config,
+    dataDirLastUpdate: dataDirManager.getModificationDate(),
+    query: {
+      numberOfExecutions: queryRunner.getCount(),
+      numberOfCachedQueries: cache.bin('query').size,
+    },
+    dependencyTree: jsonify(dependencyTree),
+    reversedDependencyTree: jsonify(getReversedDependencyTree()),
+    invalidatedFilepaths: dependencyManager.getInvalidatedFilepaths(),
+  };
+
+  res.status(200);
+  res.set({ 'Content-Type': 'application/json' });
+  res.send(response);
+};
+
+const statusIndexUrl = (req: Request, res: Response): void => {
+  const response = Array.from(store.index.url.keys());
+  res.status(200);
+  res.set({ 'Content-Type': 'application/json' });
+  res.send(response);
+};
+
+const statusIndexUuid = (req: Request, res: Response): void => {
+  const response: ObjectType = {};
+  store.index.uuid.forEach((uuids: Map<string, any>, langcode: string) => {
+    response[langcode] = Array.from(uuids.keys());
+  });
+
+  res.status(200);
+  res.set({ 'Content-Type': 'application/json' });
+  res.send(response);
+};
+
+const statusIndexCustom = (req: Request, res: Response): void => {
+  const response = Array.from(store.index.custom.keys());
+  res.status(200);
+  res.set({ 'Content-Type': 'application/json' });
+  res.send(response);
+};
+
+const statusDiff = (req: Request, res: Response): void => {
+  const response = jsonify(diffManager.getDiff());
+  res.status(200);
+  res.set({ 'Content-Type': 'application/json' });
+  res.send(response);
+};
+
+export {
+  statusIndex,
+  statusBasic,
+  statusIndexUrl,
+  statusIndexUuid,
+  statusIndexCustom,
+  statusDiff,
+};

package/src/http/routes/task.ts

@@ -0,0 +1,29 @@
+import { Request, Response } from 'express';
+import { dataDirManager } from '@lib/store/dataDir';
+import { taskRunner, taskManager } from '@lib/task';
+import {
+  TaskErrorResponse,
+  TaskSuccessfulResponse,
+} from '@lib/task/task.types';
+
+const taskIndex = (req: Request, res: Response): void => {
+  const taskIds = Array.from(taskManager.getModuleGroupInfo().keys());
+  res.render('taskIndex', {
+    taskIds: taskIds.length > 0 ? taskIds.map(task => `/task/${task}`) : null,
+  });
+};
+
+const runTask = (req: Request, res: Response): void => {
+  dataDirManager.update();
+  const args: any = req.query;
+  const taskId = req.params[0];
+  const response: TaskSuccessfulResponse | TaskErrorResponse = taskRunner.run(
+    taskId,
+    args,
+  );
+  res.status(200);
+  res.set('application/json');
+  res.send(response);
+};
+
+export { taskIndex, runTask };

package/src/http/views/cacheClear.pug

@@ -0,0 +1,17 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Clear cache bin | Static Suite Data Server"
+
+block breadcrumbs
+  li
+    a(href="/cache")="cache"
+
+block content
+  h1(class="title is-1")=`Clear cache bin "${cacheBinId}"`
+  table(class="table is-fullwidth is-hoverable")
+    tbody
+      if done
+        p(href=cacheBinId)=`Cache bin "${cacheBinId}" cleared`
+      else
+        p=`Cache bin "${cacheBinId}" not found`

package/src/http/views/cacheIndex.pug

@@ -0,0 +1,19 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Available cache bins | Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Available cache bins"
+  table(class="table is-fullwidth  is-hoverable")
+    tbody
+      if cacheBins
+        each cacheBin in cacheBins
+          tr
+            td= cacheBin
+            td
+              a(href=`/cache/${cacheBin}/clear`)="Clear"
+      else
+        tr
+          td="No cache bins available"
+

package/src/http/views/data.pug

@@ -0,0 +1,68 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Data | Static Suite Data Server"
+
+block assets
+  link(rel='stylesheet', href='https://cdn.jsdelivr.net/npm/simple-datatables@latest/dist/style.css')
+  link(rel='stylesheet', href='https://cdn.jsdelivr.net/npm/bulma-tooltip@3.0.2/dist/css/bulma-tooltip.min.css')
+  script(src="https://cdn.jsdelivr.net/npm/simple-datatables@latest")
+  script(src="https://cdn.jsdelivr.net/npm/clipboard@2.0.8/dist/clipboard.min.js")
+
+  script.
+    const dataTable = new simpleDatatables.DataTable("#data-table", {
+      paging: false
+            });
+    new ClipboardJS('#copy-to-clipboard');
+
+block breadcrumbs
+  li
+    a(href="/data")="data"
+  each breadcrumb in breadcrumbs
+    li
+      a(href=`/data/${breadcrumb.url}`)=breadcrumb.title
+
+block content
+  h1(class="title is-1" id="data-path")=`${path}`
+    span(class="icon is-medium ml-5")
+      button(id="copy-to-clipboard" class="button  is-light" data-clipboard-text=`data${path}` style="padding-left:5px; padding-right:0" title="Copy to clipboard")
+        span(class="has-tooltip-arrow" data-tooltip="Copy to clipboard")
+          svg(xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 1024 896")
+            path(d="M128 768h256v64H128v-64z m320-384H128v64h320v-64z m128 192V448L384 640l192 192V704h320V576H576z m-288-64H128v64h160v-64zM128 704h160v-64H128v64z m576 64h64v128c-1 18-7 33-19 45s-27 18-45 19H64c-35 0-64-29-64-64V192c0-35 29-64 64-64h192C256 57 313 0 384 0s128 57 128 128h192c35 0 64 29 64 64v320h-64V320H64v576h640V768zM128 256h512c0-35-29-64-64-64h-64c-35 0-64-29-64-64s-29-64-64-64-64 29-64 64-29 64-64 64h-64c-35 0-64 29-64 64z")
+  h2(class="subtitle")=`${count} items`
+
+  table(id="data-table" class="table is-fullwidth is-striped is-hoverable")
+    thead
+      tr
+        th="Item"
+        th="Type"
+        if hasContentInfo
+          th="Id"
+          th="Entity Type"
+          th="Bundle"
+          th="Published"
+          th="Title"
+          th="Filename"
+    tbody
+      for item in items
+        tr
+          td
+            a(href=`/data/${base}${item.name}`)= item.name
+          td=item.type
+          if item.info
+            td=item.info.id
+            td=item.info.type
+            td=item.info.bundle
+            td=item.info.isPublished
+            td=item.info.title
+            td=item.info.filename
+          else if hasContentInfo
+            td
+            td
+            td
+            td
+            td
+            td
+
+
+

package/src/http/views/docs.pug

@@ -0,0 +1,7 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Static Suite Data Server"
+
+block content
+  div(class="content")!=marked(readme)

package/src/http/views/dumpIndex.pug

@@ -0,0 +1,14 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Dump | Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Dump"
+  table(class="table is-fullwidth is-hoverable")
+    tbody
+      each description, link in links
+        tr
+          td
+            a(href=link)= link
+          td=description

package/src/http/views/home.pug

@@ -0,0 +1,15 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Static Suite Data Server"
+  h2(class="subtitle")="Table of Contents"
+  table(class="table is-fullwidth is-hoverable")
+    tbody
+      each description, link in links
+        tr
+          td
+            a(href=link)= link
+          td=description

package/src/http/views/includes/layout.pug

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+html
+  block vars
+  head
+    title #{title}
+    meta(name='viewport', content='width=device-width, initial-scale=1.0')
+    link(rel='stylesheet', href='https://cdn.jsdelivr.net/npm/bulma@0.9.3/css/bulma.min.css')
+  body
+   section(class="section")
+    div(class="container")
+      nav(class="breadcrumb" aria-label="breadcrumbs")
+        ul
+          li
+            span(class="icon-text")
+              span(class="icon")
+                svg(xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24")
+                  path(d="M21 13v10h-6v-6h-6v6h-6v-10h-3l12-12 12 12h-3zm-1-5.907v-5.093h-3v2.093l3 3z")
+            span
+              a(href="/")="Home"
+          block breadcrumbs
+      block content
+  block assets
+

package/src/http/views/queryIndex.pug

@@ -0,0 +1,17 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Available queries | Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Available queries"
+  table(class="table is-fullwidth  is-hoverable")
+    tbody
+      if queryIds
+        each queryId in queryIds
+          tr
+            td
+              a(href=queryId)= queryId
+      else
+        tr
+          td="No queries available"

package/src/http/views/statusIndex.pug

@@ -0,0 +1,14 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Status | Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Status"
+  table(class="table is-fullwidth is-hoverable")
+    tbody
+      each description, link in links
+        tr
+          td
+            a(href=link)= link
+          td=description

package/src/http/views/taskIndex.pug

@@ -0,0 +1,17 @@
+extends includes/layout.pug
+
+block vars
+  - var title = "Available tasks | Static Suite Data Server"
+
+block content
+  h1(class="title is-1")="Available tasks"
+  table(class="table is-fullwidth  is-hoverable")
+    tbody
+      if taskIds
+        each taskId in taskIds
+          tr
+            td
+              a(href=taskId)= taskId
+      else
+        tr
+          td="No tasks available"

package/src/lib/config/__tests__/config.test.ts

@@ -0,0 +1,132 @@
+import { RunMode } from '@lib/dataServer.types';
+import fs from 'fs';
+import path from 'path';
+import { setConfig } from '../config';
+import { ConfigOptions, NonSanitizedConfigOptions } from '../config.types';
+import {
+  InvalidRunMode,
+  MissingDirectory,
+  MissingRequiredOption,
+} from '../error';
+
+describe('Config test', () => {
+  describe('setConfig', () => {
+    it('Returns correct config', () => {
+      const testConfig: NonSanitizedConfigOptions = {
+        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',
+      };
+      const expectedConfig = {
+        dataDir: fs.realpathSync(path.resolve(testConfig.dataDir)),
+        workDir: fs.realpathSync(path.resolve(<string>testConfig.workDir)),
+        queryDir: fs.realpathSync(path.resolve(<string>testConfig.queryDir)),
+        hookDir: fs.realpathSync(path.resolve(<string>testConfig.hookDir)),
+        taskDir: fs.realpathSync(path.resolve(<string>testConfig.taskDir)),
+        runMode: 'prod',
+      };
+      expect(setConfig(testConfig)).toEqual(expectedConfig);
+    });
+
+    it('Required option dataDir returns expected error', () => {
+      const config = {
+        runMode: RunMode.DEV,
+      };
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      expect(() => setConfig(config)).toThrowError(MissingRequiredOption);
+    });
+
+    it('wrong option runMode returns expected error', () => {
+      const config = {
+        dataDir: 'src/__tests__/fixtures/data/',
+        runMode: 'xx',
+      };
+      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+      // @ts-ignore
+      expect(() => setConfig(config)).toThrowError(InvalidRunMode);
+    });
+
+    it('Wrong dataDir returns expected error', () => {
+      const config: ConfigOptions = {
+        dataDir: 'non-existent-dir',
+        runMode: RunMode.DEV,
+      };
+
+      expect.assertions(2);
+
+      try {
+        setConfig(config);
+      } catch (error) {
+        expect(error).toBeInstanceOf(MissingDirectory);
+        expect(error).toHaveProperty('directoryId', 'dataDir');
+      }
+    });
+
+    it('Wrong workDir returns expected error', () => {
+      const config: ConfigOptions = {
+        dataDir: 'src/__tests__/fixtures/data/',
+        workDir: 'non-existent-dir',
+        runMode: RunMode.DEV,
+      };
+      expect.assertions(2);
+
+      try {
+        setConfig(config);
+      } catch (error) {
+        expect(error).toBeInstanceOf(MissingDirectory);
+        expect(error).toHaveProperty('directoryId', 'workDir');
+      }
+    });
+
+    it('Wrong queryDir returns expected error', () => {
+      const config: ConfigOptions = {
+        dataDir: 'src/__tests__/fixtures/data/',
+        queryDir: 'non-existent-dir',
+        runMode: RunMode.DEV,
+      };
+      expect.assertions(2);
+
+      try {
+        setConfig(config);
+      } catch (error) {
+        expect(error).toBeInstanceOf(MissingDirectory);
+        expect(error).toHaveProperty('directoryId', 'queryDir');
+      }
+    });
+
+    it('Wrong hookDir returns expected error', () => {
+      const config = {
+        dataDir: 'src/__tests__/fixtures/data/',
+        hookDir: 'non-existent-dir',
+        runMode: RunMode.DEV,
+      };
+      expect.assertions(2);
+
+      try {
+        setConfig(config);
+      } catch (error) {
+        expect(error).toBeInstanceOf(MissingDirectory);
+        expect(error).toHaveProperty('directoryId', 'hookDir');
+      }
+    });
+
+    it('Wrong taskDir returns expected error', () => {
+      const config = {
+        dataDir: 'src/__tests__/fixtures/data/',
+        taskDir: 'non-existent-dir',
+        runMode: RunMode.DEV,
+      };
+      expect.assertions(2);
+
+      try {
+        setConfig(config);
+      } catch (error) {
+        expect(error).toBeInstanceOf(MissingDirectory);
+        expect(error).toHaveProperty('directoryId', 'taskDir');
+      }
+    });
+  });
+});