Merge pull request #595 from ZIMkaRU/feature/rework-config-keeper-to-validate-and-keep-strict-data-structure

Rework config keeper to validate and keep strict data structure

Author: btrdnch

package-lock.json

@@ -10,12 +10,15 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
+    "ajv": "8.17.1",
+    "ajv-formats": "3.0.1",
     "archiver": "7.0.1",
     "bfx-svc-test-helper": "git+https://github.com/bitfinexcom/bfx-svc-test-helper.git",
     "bittorrent-dht": "10.0.2",
     "changelog-parser": "3.0.1",
     "clean-stack": "6.0.0",
-    "cron-validate": "1.4.3",
+    "compare-versions": "6.1.1",
+    "cron-validate": "1.5.3",
     "electron-alert": "0.1.20",
     "electron-log": "4.4.8",
     "electron-updater": "6.7.0",

package.json

@@ -26,7 +26,7 @@ process.send = process.send || (() => {})
 process.env.NODE_CONFIG_DIR = pathToExpressConfDir
 
 const env = { ...process.env }
-const serializeError = require('./src/helpers/utils')
+const { serializeError } = require('./src/helpers/utils')
 
 const {
   WrongPathToUserDataError,

server.js

@@ -55,7 +55,7 @@ module.exports = ({ pathToUserDocuments }) => {
       }
 
       await pauseApp()
-      const isSaved = await getConfigsKeeperByName('main')
+      const isSaved = await getConfigsKeeperByName()
         .saveConfigs({
           reportFilesPathVersion: REPORT_FILES_PATH_VERSION,
           pathToUserReportFiles: filePaths[0]

src/change-reports-folder.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const cronValidate = require('cron-validate')
+const cron = cronValidate.default ?? cronValidate
 const i18next = require('i18next')
 
 const { createModalWindow } = require('./window-creators')
@@ -39,7 +40,7 @@ const _getTime = (timeFormat, time) => {
 }
 
 const _getTimeDataFromRule = (rule) => {
-  const cronResult = cronValidate(rule)
+  const cronResult = cron(rule)
 
   if (!cronResult.isValid()) {
     return { timeFormat: 'hours', timeValue: 2 }
@@ -95,7 +96,7 @@ const _fireAlert = async (params) => {
 }
 
 module.exports = () => {
-  const configsKeeper = getConfigsKeeperByName('main')
+  const configsKeeper = getConfigsKeeperByName()
 
   const getAlertOpts = (timeFormat, timeData) => {
     const timeFormatMap = {

src/change-sync-frequency.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const SCHEMA_DOMAIN = require('../schema.domain')
+
+const getSchemaIds = (schemaNames, schemaDomain) => {
+  const domain = schemaDomain ?? SCHEMA_DOMAIN
+  const names = Object.entries(schemaNames ?? {})
+
+  const schemaIds = {}
+
+  for (const [key, name] of names) {
+    schemaIds[key] = `${domain}/${name}`
+  }
+
+  return schemaIds
+}
+
+module.exports = {
+  getSchemaIds
+}

src/configs-keeper.js

@@ -0,0 +1,77 @@
+'use strict'
+
+const path = require('node:path')
+const Ajv = require('ajv')
+const addFormats = require('ajv-formats')
+const cronValidate = require('cron-validate')
+const cron = cronValidate.default ?? cronValidate
+const { validateStrict } = require('compare-versions')
+
+const isDevEnv = process.env.NODE_ENV === 'development'
+
+const SCHEMA_IDS = require('./schema.ids')
+const schemas = require('./schemas')
+const {
+  DataValidationSchemaDefError,
+  DataValidationError
+} = require('../../errors')
+
+const ajv = new Ajv({
+  // Compile schema on initialization
+  schemas,
+
+  // Strict mode
+  strict: true,
+  strictRequired: true,
+  allowMatchingProperties: true,
+  allowUnionTypes: true,
+
+  coerceTypes: true,
+  useDefaults: 'empty',
+  removeAdditional: true,
+  $data: true,
+  ownProperties: true,
+  allErrors: true,
+  messages: true,
+  formats: { reserved: true },
+  verbose: isDevEnv
+})
+addFormats(ajv)
+ajv.addFormat('abs-path', {
+  type: 'string',
+  validate: (val) => path.isAbsolute(val)
+})
+ajv.addFormat('cron-expression', {
+  type: 'string',
+  validate: (val) => cron(val).isValid()
+})
+ajv.addFormat('semver', {
+  type: 'string',
+  validate: (val) => validateStrict(val)
+})
+
+const validate = (configs, schemaId) => {
+  const validate = ajv.getSchema(schemaId)
+
+  if (typeof validate !== 'function') {
+    console.error(new DataValidationSchemaDefError())
+
+    return false
+  }
+
+  const res = validate(configs)
+
+  if (validate.errors) {
+    console.debug(new DataValidationError({
+      message: `ERR_DATA_IS_INVALID_WITH_ID: ${schemaId}`,
+      data: validate.errors
+    }))
+  }
+
+  return res
+}
+
+module.exports = {
+  SCHEMA_IDS,
+  validate
+}

src/configs-keeper/configs-validation/helpers/index.js

@@ -0,0 +1,3 @@
+'use strict'
+
+module.exports = 'report.bitfinex.com'

src/configs-keeper/configs-validation/index.js

@@ -0,0 +1,6 @@
+'use strict'
+
+const SCHEMA_NAMES = require('./schema.names')
+const { getSchemaIds } = require('./helpers')
+
+module.exports = getSchemaIds(SCHEMA_NAMES)