refactor!: Major rewrite, switching to ECMAScript instead of CJS.

Implements #942
ptarmiganlabs · Jan 28, 2024 · 25f0ab2 · 25f0ab2
1 parent 3f42d02
commit 25f0ab2
Show file tree

Hide file tree

Showing 84 changed files with 971 additions and 1,400 deletions.
diff --git a/.eslintrc.yml b/.eslintrc.yml
@@ -1,17 +1,28 @@
 env:
-    es6: true
-    es2021: true
+    # es6: true
+    es2023: true
     node: true
+    # commonjs: false
 extends:
     - airbnb-base
+    # - eslint:recommended
     - prettier
 parserOptions:
-    ecmaVersion: 12
+    ecmaVersion: 2023
     sourceType: module
+    requireConfigFile: false
+    babelOptions:
+        plugins:
+            - '@babel/plugin-syntax-import-assertions'
+parser: '@babel/eslint-parser'    
 rules:
     prettier/prettier: error
+    import/no-unresolved: 2
+    import/no-commonjs: 2
+    import/extensions: [2, "ignorePackages"]
 plugins:
     - prettier
+    - import
 globals:
     beforeAll: readonly
     afterAll: readonly

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,13 +3,19 @@
     "version": "9.4.0",
     "description": "Superpowers for Qlik Sense. Task scheduling, key-value store, advanced alerting and more.",
     "scripts": {
-        "test": "jest",
+        "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
         "test2": "node_modules/jshint/bin/jshint butler.js",
         "format1": "npm run format",
         "format": "npm run format:prettier",
         "format:prettier": "npx prettier --config .prettierrc \"./**/*.{ts,css,less,js}\" --write",
         "butler": "node src/butler.js",
-        "lint": "npx eslint src/**/*.js"
+        "lint": "npx eslint ./src/**/*.js"
+    },
+    "jest": {
+        "transform": {},
+        "setupFiles": [
+            "./src/test/env.js"
+        ]
     },
     "repository": {
         "type": "git",
@@ -36,7 +42,8 @@
     "files": [
         "butler.js"
     ],
-    "main": "butler.js",
+    "type": "module",
+    "exports": "./butler.js",
     "directories": {
         "lib": "lib",
         "test": "test"
@@ -63,7 +70,6 @@
         "eslint": "^8.55.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-config-prettier": "^9.1.0",
-        "eslint-plugin-import": "^2.29.0",
         "eslint-plugin-prettier": "^5.0.1",
         "express-handlebars": "^7.0.7",
         "fastify": "^4.24.3",
@@ -101,6 +107,9 @@
         "xstate": "^4.38.3"
     },
     "devDependencies": {
+        "@babel/eslint-parser": "^7.23.9",
+        "@babel/plugin-syntax-import-assertions": "^7.23.3",
+        "eslint-plugin-import": "^2.29.1",
         "jest": "^29.7.0",
         "prettier": "^3.1.1",
         "snyk": "^1.1260.0"

diff --git a/src/api/api.js b/src/api/api.js
@@ -16,6 +16,4 @@ const apiGetAPIEndpointsEnabled = {
     },
 };
 
-module.exports = {
-    apiGetAPIEndpointsEnabled,
-};
+export default apiGetAPIEndpointsEnabled;
diff --git a/src/api/base_conversion.js b/src/api/base_conversion.js
@@ -1,4 +1,4 @@
-const apiGetBase62ToBase16 = {
+export const apiGetBase62ToBase16 = {
     schema: {
         description: 'Converts strings from base62 to base16.',
         summary: 'Converts strings from base62 to base16.',
@@ -55,7 +55,7 @@ const apiGetBase62ToBase16 = {
     },
 };
 
-const apiGetBase16ToBase62 = {
+export const apiGetBase16ToBase62 = {
     schema: {
         description: 'Converts strings from base16 to base62.',
         summary: 'Converts strings from base16 to base62.',
@@ -116,8 +116,3 @@ const apiGetBase16ToBase62 = {
         },
     },
 };
-
-module.exports = {
-    apiGetBase62ToBase16,
-    apiGetBase16ToBase62,
-};
diff --git a/src/api/butler_ping.js b/src/api/butler_ping.js
@@ -26,6 +26,4 @@ const apiGetButlerPing = {
     },
 };
 
-module.exports = {
-    apiGetButlerPing,
-};
+export default apiGetButlerPing;
diff --git a/src/api/disk_utils.js b/src/api/disk_utils.js
@@ -1,4 +1,4 @@
-const apiFileCopy = {
+export const apiFileCopy = {
     schema: {
         description:
             "Copying of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be copied too.",
@@ -97,7 +97,7 @@ const apiFileCopy = {
     },
 };
 
-const apiFileMove = {
+export const apiFileMove = {
     schema: {
         description:
             "Moving of files is only posttible between pre-approved directories.\nDefining approved source and destination directories is done in Butler's config file.\n\nIf the source directory contains subdirectories, these will be moved too.",
@@ -181,7 +181,7 @@ const apiFileMove = {
     },
 };
 
-const apiFileDelete = {
+export const apiFileDelete = {
     schema: {
         description:
             "It is only possible to delete files in pre-approved directories, or subdirectories thereof.\nDefining approved directories is done in Butler's config file.",
@@ -239,7 +239,7 @@ const apiFileDelete = {
     },
 };
 
-const apiCreateDir = {
+export const apiCreateDir = {
     schema: {
         description:
             "If the directory already exists nothing will happen.\nIf permissions don't allow a directory to be created, or if the path is invalid, an error will be returned.",
@@ -292,7 +292,7 @@ const apiCreateDir = {
     },
 };
 
-const apiCreateDirQvd = {
+export const apiCreateDirQvd = {
     schema: {
         description: "Creates a directory in QVD directory (which is defined in Butler's config file).",
         summary: 'Creates a directory in designated QVD directory.',
@@ -343,11 +343,3 @@ const apiCreateDirQvd = {
         },
     },
 };
-
-module.exports = {
-    apiFileCopy,
-    apiFileMove,
-    apiFileDelete,
-    apiCreateDir,
-    apiCreateDirQvd,
-};
diff --git a/src/api/key_value_store.js b/src/api/key_value_store.js
@@ -1,4 +1,4 @@
-const apiGetAllNamespaces = {
+export const apiGetAllNamespaces = {
     schema: {
         description: '',
         summary: 'List all currently defined namespaces.',
@@ -26,7 +26,7 @@ const apiGetAllNamespaces = {
     },
 };
 
-const apiGetKVPair = {
+export const apiGetKVPair = {
     schema: {
         description: '',
         summary: 'Get the value associated with a key, in a specific namespace.',
@@ -99,7 +99,7 @@ const apiGetKVPair = {
     },
 };
 
-const apiGetKVExists = {
+export const apiGetKVExists = {
     schema: {
         description: 'Returns true if the specified key exists, otherwise false.',
         summary: 'Checks if a key exists in a namespace.',
@@ -181,7 +181,7 @@ const apiGetKVExists = {
     },
 };
 
-const apiPostKVPair = {
+export const apiPostKVPair = {
     schema: {
         description:
             'If the specified key already exists it will be overwritten.\n\nIf the posted data has a TTL, it will start counting when the post occur.\nI.e. if a previouly posted key also had a TTL, it will be replace with the most recent TTL.',
@@ -270,7 +270,7 @@ const apiPostKVPair = {
     },
 };
 
-const apiDeleteKVPair = {
+export const apiDeleteKVPair = {
     schema: {
         description: '',
         summary: 'Delete a key-value pair in a specific namespace.',
@@ -322,7 +322,7 @@ const apiDeleteKVPair = {
     },
 };
 
-const apiDeleteNamespace = {
+export const apiDeleteNamespace = {
     schema: {
         description: '',
         summary: 'Delete a namespace and all key-value pairs in it.',
@@ -368,7 +368,7 @@ const apiDeleteNamespace = {
     },
 };
 
-const apiGetKeysInNamespace = {
+export const apiGetKeysInNamespace = {
     schema: {
         description: '',
         summary: 'Retrieve a list of all keys present in the specified namespace.',
@@ -438,13 +438,3 @@ const apiGetKeysInNamespace = {
         },
     },
 };
-
-module.exports = {
-    apiGetAllNamespaces,
-    apiGetKVPair,
-    apiGetKVExists,
-    apiPostKVPair,
-    apiDeleteKVPair,
-    apiDeleteNamespace,
-    apiGetKeysInNamespace,
-};
diff --git a/src/api/mqtt_publish_message.js b/src/api/mqtt_publish_message.js
@@ -54,6 +54,4 @@ const apiPutMqttMessage = {
     },
 };
 
-module.exports = {
-    apiPutMqttMessage,
-};
+export default apiPutMqttMessage;
diff --git a/src/api/newrelic_event.js b/src/api/newrelic_event.js
@@ -74,6 +74,4 @@ const apiPostNewRelicEvent = {
     },
 };
 
-module.exports = {
-    apiPostNewRelicEvent,
-};
+export default apiPostNewRelicEvent;
diff --git a/src/api/newrelic_metric.js b/src/api/newrelic_metric.js
@@ -88,6 +88,4 @@ const apiPostNewRelicMetric = {
     },
 };
 
-module.exports = {
-    apiPostNewRelicMetric,
-};
+export default apiPostNewRelicMetric;
diff --git a/src/api/scheduler.js b/src/api/scheduler.js
@@ -1,4 +1,4 @@
-const apiGETSchedules = {
+export const apiGETSchedules = {
     schema: {
         summary: 'Get all information available for existing schedule(s).',
         description:
@@ -101,7 +101,7 @@ const apiGETSchedules = {
     },
 };
 
-const apiPOSTSchedules = {
+export const apiPOSTSchedules = {
     schema: {
         summary: 'Create a new schedule.',
         description: '',
@@ -224,7 +224,7 @@ const apiPOSTSchedules = {
     },
 };
 
-const apiDELETESchedules = {
+export const apiDELETESchedules = {
     schema: {
         summary: 'Delete a schedule.',
         description: '',
@@ -270,7 +270,7 @@ const apiDELETESchedules = {
     },
 };
 
-const apiPUTSchedulesStart = {
+export const apiPUTSchedulesStart = {
     schema: {
         summary: 'Start a schedule.',
         description: "Start a schedule, i.e. have the scheduler run the associated reload task according to the schedule's cron settings.",
@@ -369,7 +369,7 @@ const apiPUTSchedulesStart = {
     },
 };
 
-const apiPUTSchedulesStop = {
+export const apiPUTSchedulesStop = {
     schema: {
         summary: 'Stop a schedule.',
         description: 'Stop a schedule, i.e. tell the scheduler to no longer execute the schedule according to its cron settings.',
@@ -468,7 +468,7 @@ const apiPUTSchedulesStop = {
     },
 };
 
-const apiPUTSchedulesStartAll = {
+export const apiPUTSchedulesStartAll = {
     schema: {
         summary: 'Start all schedules.',
         description:
@@ -544,7 +544,7 @@ const apiPUTSchedulesStartAll = {
     },
 };
 
-const apiPUTSchedulesStopAll = {
+export const apiPUTSchedulesStopAll = {
     schema: {
         summary: 'Stop all schedules.',
         description: 'Stop all schedules, i.e. tell the scheduler to no longer execute any schedule according to its cron settings.',
@@ -619,7 +619,7 @@ const apiPUTSchedulesStopAll = {
     },
 };
 
-const apiGETSchedulerStatus = {
+export const apiGETSchedulerStatus = {
     schema: {
         summary: 'Get scheduler status.',
         description:
@@ -647,14 +647,3 @@ const apiGETSchedulerStatus = {
         },
     },
 };
-
-module.exports = {
-    apiGETSchedules,
-    apiPOSTSchedules,
-    apiDELETESchedules,
-    apiPUTSchedulesStart,
-    apiPUTSchedulesStartAll,
-    apiPUTSchedulesStop,
-    apiPUTSchedulesStopAll,
-    apiGETSchedulerStatus,
-};
diff --git a/src/api/sense_app.js b/src/api/sense_app.js
@@ -80,6 +80,4 @@ const apiPutAppReload = {
     },
 };
 
-module.exports = {
-    apiPutAppReload,
-};
+export default apiPutAppReload;
diff --git a/src/api/sense_app_dump.js b/src/api/sense_app_dump.js
@@ -1,4 +1,4 @@
-const apiGetSenseAppDump = {
+export const apiGetSenseAppDump = {
     schema: {
         summary: 'Dump a Sense app to JSON.',
         description: 'Does the same thing as `/v4/app/:appId/dump`',
@@ -72,7 +72,7 @@ const apiGetSenseAppDump = {
     },
 };
 
-const apiGetAppDump = {
+export const apiGetAppDump = {
     schema: {
         summary: 'Dump a Sense app to JSON.',
         description: 'Does the same thing as `/v4/senseappdump/:appId`',
@@ -145,8 +145,3 @@ const apiGetAppDump = {
         },
     },
 };
-
-module.exports = {
-    apiGetSenseAppDump,
-    apiGetAppDump,
-};