dcp-worker 3.2.33 → 3.2.35

package/.eslintrc.js

@@ -1,117 +1,31 @@
+/**
+ * @file    .eslintrc.js - ESLint configuration file, following the Core Team's JS Style Guide.
+ *
+ * @author  Wes Garland <wes@distributive.network>
+ * @author  Bryan Hoang <bryan@distributive.network>
+ * @date    Mar. 2022, Sep. 2023
+ */
+
+'use strict';
+
+/**
+ * @see {@link https://eslint.org/docs/latest/use/configure/}
+ * @type {import('eslint').Linter.Config}
+ */
 module.exports = {
-  'env': {
-    'browser': true,
-    'commonjs': true,
-    'es2021': true,
-    'node': true
-  },
-  'extends': 'eslint:recommended',
-  'parserOptions': {
-    'ecmaVersion': 13
+  root: true,
+  reportUnusedDisableDirectives: true,
+  extends: ['eslint:recommended', '@distributive'],
+  env: {
+    node: true,
+    es2022: true,
   },
   globals: {
-    dcpConfig: true
+    dcpConfig: true,
+  },
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'script',
   },
-  'rules': {
-    'indent': [
-      'warn',
-      2,
-      {
-        'SwitchCase': 1,
-        'ignoredNodes': ['CallExpression', 'ForStatement'],
-      }
-    ],
-    'linebreak-style': [
-      'error',
-      'unix'
-    ],
-    'quotes': [
-      'warn',
-      'single'
-    ],
-    'func-call-spacing': [
-      'off', 'never'
-    ],
-    'no-prototype-builtins': 'off',
-    'quotes': ['warn', 'single', 'avoid-escape'],
-    'no-unused-vars': ['warn', { 'vars': 'all', 'args': 'none', 'ignoreRestSiblings': false }],
-    'no-empty': [ 'warn' ],
-    'no-trailing-spaces': [
-      'off', {
-        skipBlankLines: true,
-        ignoreComments: true
-      }
-    ],
-    'no-multi-spaces': [
-      'off',
-    ],
-    'prettier/prettier': [
-      'off',
-    ],
-    'vars-on-top': [
-      'error',
-    ],
-    'no-var': [
-      'off',
-    ],
-    'spaced-comment': [
-      'warn',
-    ],
-    'brace-style': [
-      /* 'warn', 'allman', { 'allowSingleLine': true } */
-      'off'
-    ],
-    'no-eval': [
-      'error',
-    ],
-    'object-curly-spacing': [
-      'warn',
-      'always'
-    ],
-    'no-dupe-keys':             [ 'warn' ],
-    'no-constant-condition':    [ 'warn' ],
-    'no-extra-boolean-cast':    [ 'warn' ],
-    'no-sparse-arrays':         [ 'off' ],
-    'no-inner-declarations':    [ 'off' ],
-    'no-loss-of-precision':     [ 'warn' ],
-    'require-atomic-updates':   [ 'warn' ], /* watch for false positives, remove if (m)any */
-    'eqeqeq':                   [ 'warn', 'always' ],
-    'no-dupe-keys':             [ 'warn' ],
-    'no-dupe-class-members':    [ 'warn' ],
-    'no-fallthrough':           [ 'warn', { commentPattern: 'fall[ -]*through' }],
-    'no-invalid-this':          [ 'error' ],
-    'no-return-assign':         [ 'error' ],
-    'no-return-await':          [ 'warn' ],
-    'no-unused-expressions':    [ 'warn', { allowShortCircuit: true, allowTernary: true } ],
-    'prefer-promise-reject-errors': [ 'error' ],
-    'no-throw-literal':         [ 'error' ],
-    'semi':                     [ 'off', { omitLastInOneLineBlock: true }], /* does not work right with exports.X = function allmanStyle */
-    'semi-style':               [ 'warn', 'last' ],
-    'semi-spacing':             [ 'error', {'before': false, 'after': true}],
-    'no-extra-semi':            [ 'warn' ],
-    'no-tabs':                  [ 'error' ],
-    'symbol-description':       [ 'error' ],
-    'operator-linebreak':       [ 'warn', 'before' ],
-    'new-cap':                  [ 'warn' ],
-    'consistent-this':          [ 'error', 'that' ],
-    'no-use-before-define':     [ 'error', { functions: false, classes: false } ],
-    'no-shadow':                [ 'error' ],
-    'no-label-var':             [ 'error' ],
-    'radix':                    [ 'error' ],
-    'no-self-compare':          [ 'error' ],
-    'require-await':            [ 'error' ],
-    'require-yield':            [ 'error' ],
-    'no-promise-executor-return':       [ 'off' ],
-    'no-template-curly-in-string':      [ 'warn' ],
-    'no-unmodified-loop-condition':     [ 'warn' ],
-    'no-unused-private-class-members':  [ 'warn' ],
-    'no-use-before-define':             ['error', { functions: false, classes: true, variables: true }],
-    "no-implicit-coercion": [1, {
-      disallowTemplateShorthand: false,
-      boolean: true,
-      number: true,
-      string: true,
-      allow: ['!!'] /* really only want to allow if(x) and if(!x) but not if(!!x) */
-    }],
-  }
+  rules: {},
 };

package/.gitlab-ci.yml

@@ -1,17 +1,59 @@
 # @file    .gitlab-ci.yml - GitLab CI configuration file.
 # @author  Eddie Roosenmallen <eddie@distributive.network>
+# @author  Bryan Hoang <bryan@distributive.network>
 # @date    September 2022
 
+variables:
+  # Can't cache `~/.npm/`.
+  npm_config_cache: '.cache/npm/'
+  npm_config_prefer_offline: 'true'
+  npm_config_fund: 'false'
+
 default:
   # Use in-house GitLab runners.
   tags:
     - dcp-core
     - linux
+  image: node:lts
+  before_script:
+    - npm add --global npm@latest
+    # Access private deps. e.g., `dcp-client` from GitLab.
+    - git config --global
+      url."${CI_SERVER_PROTOCOL}://gitlab-ci-token:${CI_JOB_TOKEN}@${CI_SERVER_HOST}:${CI_SERVER_PORT}".insteadOf
+      "${CI_SERVER_URL}"
+
+workflow:
+  rules:
+    # Only run branch pipelines for `develop`, or merge request pipelines.
+    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
 
 stages:
   - build
+  - test
   - deploy
 
+# Installs npm dependencies to be cached for subsequent jobs. Also checks that
+# the lock file is synced with the manifest file.
+build:
+  stage: build
+  script:
+    - npm clean-install
+  cache:
+    - key:
+        prefix: $CI_JOB_NAME_SLUG
+        files:
+          - package-lock.json
+      paths:
+        - $npm_config_cache
+    - key:
+        prefix: node-modules
+        files:
+          - package-lock.json
+      paths:
+        - node_modules/
+      policy: push
+
 tidelift:
   stage: build
   rules:
@@ -20,6 +62,9 @@ tidelift:
     # This should be kept in a GitLab Variable. Read more:
     # https://docs.gitlab.com/ee/ci/variables/#create-a-custom-variable-in-the-ui
     TIDELIFT_API_KEY: $TIDELIFT_API_KEY
+  inherit:
+    default:
+      - tags
   # The CLI only requires `glibc`.
   image: frolvlad/alpine-glibc
   before_script:
@@ -32,9 +77,39 @@ tidelift:
     - echo "Running alignment and saving to Tidelift"
     - ./tidelift alignment save --wait
   allow_failure: true
-  cache: []
+
+# Run `trunk check` on the project to hightlight newly introduced lint issues
+# when compared to the target branch.
+check:
+  variables:
+    # Can't cache `~/.cache/trunk/`.
+    TRUNK_CACHE: ${CI_PROJECT_DIR}/.cache/trunk/
+  stage: test
+  script:
+    - UPSTREAM_BRANCH=${CI_MERGE_REQUEST_TARGET_BRANCH_NAME:-$CI_DEFAULT_BRANCH}
+    # Fetch the branch so that `trunk` has the proper information needed to
+    # determine the upstream changes to compare lint results against.
+    - git fetch origin $UPSTREAM_BRANCH
+    - npm run check -- --ci --upstream origin/$UPSTREAM_BRANCH
+  cache:
+    - key:
+        prefix: $CI_JOB_NAME_SLUG
+        files:
+          - .trunk/trunk.yaml
+      paths:
+        - $TRUNK_CACHE
+    - key:
+        prefix: node-modules
+        files:
+          - package-lock.json
+      paths:
+        - node_modules/
+      policy: pull
 
 publish_docs:
+  stage: deploy
+  needs:
+    - build
   rules:
     - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
       changes:
@@ -53,8 +128,14 @@ publish_docs:
     ENTITY_NAMESPACE: 'default'
   stage: deploy
   needs: []
-  image: registry.gitlab.com/distributed-compute-protocol/docker/dcp-ci:2023-09-13
+  image: registry.gitlab.com/distributed-compute-protocol/backstage-ci-image:latest
   script:
-    - npm clean-install
-    - python3 -m pip install mkdocs mkdocs-techdocs-core==1.* mkdocs-same-dir
     - bin/publish-docs.sh
+  cache:
+    - key:
+        prefix: node-modules
+        files:
+          - package-lock.json
+      paths:
+        - node_modules/
+      policy: pull

package/.trunk/trunk.yaml

@@ -0,0 +1,29 @@
+# @file    trunk.yaml - This file controls the behavior of Trunk:
+#                       https://docs.trunk.io/cli
+#
+#                       To learn more about the format of this file, see
+#                       https://docs.trunk.io/reference/trunk-yaml
+#
+#                       Initially autogenerated by `npm exec -- trunk init --lock`
+#
+# @author  Bryan Hoang <bryan@distributive.network>
+# @date    Oct. 2023
+
+version: 0.1
+cli:
+  version: 1.17.1
+  sha256:
+    darwin_arm64: 707359316ea1f972cbad8a77cb076449155c19d42933cecfe5b70cfefc38d085
+    darwin_x86_64: d5e5928a24a4eb9931eaed1d5899be12ab2556f17ce5cd89ef73fa42b2293c88
+    linux_x86_64: f2bbf8de19e7961390633fe23599b8890f617a6e8b2563ac6741a0514e7d16e6
+plugins:
+  sources:
+    - id: trunk
+      ref: v1.2.6
+      uri: https://github.com/trunk-io/plugins
+runtimes:
+  enabled:
+    - node@18.12.1
+lint:
+  enabled:
+    - eslint@8.52.0

package/bin/dcp-evaluator-start

@@ -55,12 +55,6 @@ function main() {
           alias: ['r'],
           desc: 'Path to evaluator as a module identitifer',
         })
-        .option('evaluator-lib-dir', {
-          alias: ['l'],
-          deprecated: true,
-          desc: 'Location of evaluator libraries',
-          default: dcpConfig.evaluator.libDir || undefined
-        })
         .option('sandbox-libexec-dir', {
           desc: 'Location of sandbox setup files',
           default: path.resolve(dcpClientDir, 'libexec', 'sandbox'),
@@ -128,12 +122,6 @@ function main() {
   if (!options.stdio && options.port)
     args = args.concat(['-p', options.port]);
 
-  if (options.evaluatorLibDir) {
-    console.warn(`Note: --evaluator-lib-dir (-l) is deprecated. Please pass this argument to the evalutor 'dcp-evaluator-start ... -- -l ${options.evaluatorLibDir}'`);
-    options.evaluatorLibDir = path.resolve(options.prefix, 'etc', options.evaluatorLibDir);
-    args = args.concat(['-l', options.evaluatorLibDir]);
-  }
-
   /* Decode log-level parameters and translate as appropriate for the type of evaluator in use */
   if (options.debugLogLevel || options.debugLogLevel === 0)
   {

package/bin/dcp-worker

@@ -155,10 +155,6 @@ function parseCliArgs()
         type: 'number',
         group: 'Output options',
       },
-      eventDebug: {
-        hidden: true,
-        describe: 'If set, dump all sandbox and worker events',
-      },
 
       showConfig: {
         hide: false,
@@ -402,9 +398,6 @@ async function main()
   else
     worker.on('end', () => setTimeout(processExit, getCleanupTimeoutMs()).unref());
 
-  if (cliArgs.eventDebug)
-    worker.enableDebugEvents = true;
-
   if (dcpWorkerOptions.publicGroupFallback)
   {
     if (dcpWorkerOptions.leavePublicGroup)
@@ -460,8 +453,6 @@ async function main()
     introBanner += ` . Target core density: ${JSON.stringify(dcpWorkerOptions.defaultCoreDensity)}\n`;
   if (cliArgs.verbose)
     introBanner += ` + Verbosity level: ${cliArgs.verbose}` + '\n';
-  if (cliArgs.eventDebug)
-    introBanner += ' + Event debug on' + '\n';
   if (telnetd.hasOwnProperty('port'))
     introBanner += ` ! telnetd listening on port ${telnetd.port}\n`;
   

package/bin/publish-docs.sh

@@ -67,8 +67,8 @@ npx techdocs-cli publish \
   --publisher-type awsS3 \
   --storage-name "$TECHDOCS_S3_BUCKET_NAME" \
   --entity "$ENTITY_NAMESPACE"/"$ENTITY_KIND"/"$ENTITY_NAME" \
-  --directory "$ROOT_DIR"/site
+  --directory "$DOCS_DIR"/site
 
-rm -r "$ROOT_DIR"/site
+rm -r "$DOCS_DIR"/site
 
 echo "View generated component: https://backstage.overwatch.distributive.network/docs/default/component/$ENTITY_NAME"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dcp-worker",
-  "version": "3.2.33",
+  "version": "3.2.35",
   "description": "JavaScript portion of DCP Workers for Node.js",
   "main": "bin/dcp-worker",
   "keywords": [
@@ -26,9 +26,11 @@
     "etc": "etc"
   },
   "scripts": {
+    "check": "trunk check",
     "start": "node bin/dcp-worker start",
     "start-evaluator": "node bin/dcp-evaluator-start",
     "hook": "PATH=npm-hooks:$PATH &&",
+    "lint": "eslint --cache --cache-strategy=content --cache-location=.cache/eslint/ --ignore-path=.gitignore --ext=js .",
     "test": "peter tests",
     "prepack": "node npm-hooks/prepack",
     "postpublish": "npm-hooks/postpublish",
@@ -38,7 +40,7 @@
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.11.0",
     "chalk": "^4.1.0",
-    "dcp-client": "4.3.3",
+    "dcp-client": "4.3.5",
     "kvin": "^1.2.7",
     "posix-getopt": "^1.2.1",
     "semver": "^7.3.8",
@@ -49,9 +51,11 @@
     "telnet-console": "^1.0.4"
   },
   "devDependencies": {
+    "@distributive/eslint-plugin": "1.0.2",
     "@kingsds/eslint-config": "^1.0.1",
-    "@techdocs/cli": "1.4.6",
-    "eslint": ">=8"
+    "@trunkio/launcher": "1.2.7",
+    "eslint": ">=8",
+    "eslint-plugin-jsdoc": "46.8.2"
   },
   "peerDependencies": {
     "node-eventlog": "https://gitpkg.now.sh/Distributive-Network/node-eventlog/package?dcp/0.0.1"