Merge pull request #69 from gchq/release/v1.0.0-beta

Release/v1.0.0 beta

Author: jl98741

.eslintrc.json

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v2

.github/workflows/publish.yaml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x]
+        node-version: [18.x, 20.x]
 
     steps:
     - uses: actions/checkout@v1

.github/workflows/test.yaml

@@ -0,0 +1,21 @@
+# Changelog
+
+## Versioning
+
+CyberChef Server uses the [semver](https://semver.org/) system to manage versioning: `<MAJOR>.<MINOR>.<PATCH>`.
+
+- MAJOR version changes represent a significant change to the fundamental architecture of CyberChef and may (but don't always) make breaking changes that are not backwards compatible.
+- MINOR version changes usually mean the addition of new operations or reasonably significant new features.
+- PATCH versions are used for bug fixes and any other small tweaks that modify or improve existing capabilities.
+
+All major and minor version changes will be documented in this file. Details of patch-level version changes can be found in [commit messages](https://github.com/gchq/CyberChef-server/commits/master).
+
+
+## Details
+
+### [1.0.0-beta] - 2024-10-04
+- CyberChef functionality brought in line with the mainline release
+- Upgraded to use ESM modules throughout
+- Works with recent versions of NodeJS
+- Re-orged the codebase slightly and slimmed down/updated some dependencies
+- Upgraded the base Docker image to Node 18

CHANGELOG.md

@@ -1,4 +1,4 @@
-FROM node:alpine3.10
+FROM node:18.20.4-alpine
 LABEL author "Wes Lambert, [email protected]"
 LABEL description="Dockerised version of Cyberchef server (https://github.com/gchq/CyberChef-server)"
 LABEL copyright "Crown Copyright 2020"

Dockerfile

@@ -30,6 +30,10 @@ After using [CyberChef](https://gchq.github.io/CyberChef/) to experiment and fin
 
 
 ## Installing
+While the instructions below are straightforward, it's worth understanding what happens under the hood as quirks in the installation process can cause issues with upgrades etc. The upstream CyberChef library uses a postinstall script to manipulate some dependenciesafter installation. That postinstal script doesn't work when install CC as a dependency into another project, so we now have our own postinstall process to install the CyberChef library (hence it does not appear in the package.json dependency list).
+
+This process can cause problems when updating libs, so the recommended approach is to remove node_modules and package-lock.json and install from scratch.
+
 - Clone the repository
 - `cd` into the project and run `npm install`
 - Run `npm run`

README.md

@@ -0,0 +1,116 @@
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [...compat.extends("eslint:recommended"), {
+    languageOptions: {
+        globals: {
+            ...globals.node,
+            it: false,
+            describe: false,
+        },
+
+        ecmaVersion: 2020,
+        sourceType: "module",
+
+        parserOptions: {
+            ecmaFeatures: {
+                impliedStrict: true,
+            },
+
+            allowImportExportEverywhere: true,
+        },
+    },
+
+    rules: {
+        "no-eval": "error",
+        "no-implied-eval": "error",
+        "dot-notation": "error",
+        eqeqeq: ["error", "smart"],
+        "no-caller": "error",
+        "no-extra-bind": "error",
+        "no-unused-expressions": "error",
+        "no-useless-call": "error",
+        "no-useless-return": "error",
+        radix: "warn",
+
+        "no-unused-vars": ["error", {
+            args: "none",
+            vars: "all",
+        }],
+
+        "no-empty": ["error", {
+            allowEmptyCatch: true,
+        }],
+
+        "no-control-regex": "off",
+        "require-atomic-updates": "off",
+        "no-async-promise-executor": "off",
+        "brace-style": ["error", "1tbs"],
+        "block-spacing": "error",
+        "array-bracket-spacing": "error",
+        "comma-spacing": "error",
+        "comma-style": "error",
+        "computed-property-spacing": "error",
+        "no-trailing-spaces": "warn",
+        "eol-last": "error",
+        "func-call-spacing": "error",
+
+        "key-spacing": ["warn", {
+            mode: "minimum",
+        }],
+
+        indent: ["error", 4, {
+            ignoreComments: true,
+            ArrayExpression: "first",
+            SwitchCase: 1,
+        }],
+
+        "linebreak-style": ["error", "unix"],
+
+        quotes: ["error", "double", {
+            avoidEscape: true,
+        }],
+
+        camelcase: ["error", {
+            properties: "always",
+        }],
+
+        semi: ["error", "always"],
+        "unicode-bom": "error",
+
+        "keyword-spacing": ["error", {
+            before: true,
+            after: true,
+        }],
+
+        "no-multiple-empty-lines": ["warn", {
+            max: 2,
+            maxEOF: 1,
+            maxBOF: 0,
+        }],
+
+        "no-whitespace-before-property": "error",
+        "operator-linebreak": ["error", "after"],
+        "space-in-parens": "error",
+        "no-var": "error",
+        "prefer-const": "error",
+    },
+}, {
+    files: ["test/**/*"],
+
+    rules: {
+        "no-unused-expressions": "off",
+        "no-console": "off",
+    },
+}];

bin/www

@@ -0,0 +1,8 @@
+import app from "./src/app.mjs";
+
+
+const port = process.env.PORT || 3000;
+
+app.listen(port, function () {
+    console.log(`CyberChef Server listening on port ${port}!`);
+});