@dr-js/node@0.3.0-dev.3

notable change:
- break: drop `TaskAction` module and `TaskRunner` feature to allow later to add improved version
- ci: run on all 3 platform & test `nodejs@14`
- add: `module/TerminalColor` from `@dr-js/dev`
- add: `module/Software/npm` from `@dr-js/dev`
- use `createCommandWrap` for `module/Software/7z|git|tar` to allow reset command
- package update

Author: dr-js

.github/workflows/ci-test.yml

@@ -5,13 +5,19 @@ on: [ push ]
 jobs:
   build:
     strategy:
+      fail-fast: false # allow all test to run to the end
       matrix:
-        os: [ ubuntu-latest ] # [ ubuntu-latest, windows-latest, macos-latest ]
-        node-version: [ 12.x, 13.x ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        node-version: [ 12.x, 14.x ]
 
     runs-on: ${{ matrix.os }}
 
     steps:
+      - name: Reset Git config # fix win32 CI cause `something to commit` test error: https://github.com/actions/checkout/issues/135#issuecomment-602171132
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
       - name: Setup Git repo
         uses: actions/checkout@v2 # https://github.com/actions/checkout
 
@@ -26,8 +32,10 @@ jobs:
           echo "node: $(node -v)"
           echo "npm: $(npm -v)"
 
-      - name: Install 7zip
-        run: sudo apt-get -y install p7zip-full
+      - name: Patch `7z`
+        run: node -e "process.exitCode = Number(os.platform() === 'darwin')" || brew install p7zip
+        # linux supported: https://github.com/actions/virtual-environments/blob/ubuntu18/20200415.3/images/linux/scripts/installers/7-zip.sh
+        # win32 supported: https://github.com/actions/virtual-environments/blob/win19/20200416.1/images/win/scripts/Installers/Install-7zip.ps1
 
       - run: npm ci
 

SPEC.md

@@ -32,22 +32,24 @@
   - `configureServerPack`
 + 📄 [source/module/ServerStatus.js](source/module/ServerStatus.js)
   - `getCommonServerStatus`
-+ 📄 [source/module/TaskAction.js](source/module/TaskAction.js)
-  - `TASK_ACTION_TYPE`, `createTaskAction`
++ 📄 [source/module/TerminalColor.js](source/module/TerminalColor.js)
+  - `configureTerminalColor`, `shouldSupportColor`
 + 📄 [source/module/TokenCache.js](source/module/TokenCache.js)
   - `DEFAULT_TOKEN_KEY`, `configureTokenCache`
 + 📄 [source/module/PathAction/base.js](source/module/PathAction/base.js)
   - `PATH_ACTION_MAP`, `PATH_ACTION_TYPE`, `createPathActionTask`
 + 📄 [source/module/PathAction/extraCompress.js](source/module/PathAction/extraCompress.js)
   - `PATH_ACTION_MAP`, `PATH_ACTION_TYPE`
 + 📄 [source/module/Software/7z.js](source/module/Software/7z.js)
-  - `compressConfig`, `compressFileConfig`, `detect`, `extractConfig`
+  - `compressConfig`, `compressFileConfig`, `compressTgzAsync`, `detect`, `extractConfig`, `extractTgzAsync`, `getCommand`, `setCommand`
 + 📄 [source/module/Software/function.js](source/module/Software/function.js)
-  - `createDetect`
+  - `createCommandWrap`, `createDetect`
 + 📄 [source/module/Software/git.js](source/module/Software/git.js)
-  - `detect`, `getGitBranch`, `getGitCommitHash`
+  - `detect`, `getCommand`, `getGitBranch`, `getGitCommitHash`, `setCommand`
++ 📄 [source/module/Software/npm.js](source/module/Software/npm.js)
+  - `findUpPackageRoot`, `fromGlobalNodeModules`, `fromNpmNodeModules`, `getPathNpm`, `getPathNpmExecutable`, `getPathNpmGlobalRoot`, `parsePackageNameAndVersion`
 + 📄 [source/module/Software/tar.js](source/module/Software/tar.js)
-  - `compressConfig`, `detect`, `extractConfig`
+  - `compressConfig`, `detect`, `extractConfig`, `getCommand`, `setCommand`
 + 📄 [source/module/Stat/StatCollect.js](source/module/Stat/StatCollect.js)
   - `configureStatCollect`
 + 📄 [source/module/Stat/StatReport.js](source/module/Stat/StatReport.js)
@@ -100,18 +102,6 @@
   - `configureFeaturePack`
 + 📄 [source/server/feature/StatReport/option.js](source/server/feature/StatReport/option.js)
   - `StatReportFormatConfig`, `getStatReportOption`
-+ 📄 [source/server/feature/TaskRunner/configureFeaturePack.js](source/server/feature/TaskRunner/configureFeaturePack.js)
-  - `configureFeaturePack`
-+ 📄 [source/server/feature/TaskRunner/option.js](source/server/feature/TaskRunner/option.js)
-  - `TaskRunnerFormatConfig`, `getTaskRunnerOption`
-+ 📄 [source/server/feature/TaskRunner/permission.js](source/server/feature/TaskRunner/permission.js)
-  - `CREATE_PERMISSION_CHECK_MAP`, `PERMISSION_TASK_RUNNER_TASK_ACTION`, `PERMISSION_TYPE`
-+ 📄 [source/server/feature/TaskRunner/responder.js](source/server/feature/TaskRunner/responder.js)
-  - `createResponderTaskAction`
-+ 📄 [source/server/feature/TaskRunner/HTML/main.js](source/server/feature/TaskRunner/HTML/main.js)
-  - `getHTML`
-+ 📄 [source/server/feature/TaskRunner/HTML/taskList.js](source/server/feature/TaskRunner/HTML/taskList.js)
-  - `initTaskList`, `taskListStyle`
 + 📄 [source/server/feature/TokenCache/option.js](source/server/feature/TokenCache/option.js)
   - `TokenCacheFormatConfig`, `getTokenCacheOption`
 + 📄 [source/server/feature/TokenCache/responder.js](source/server/feature/TokenCache/responder.js)
@@ -228,7 +218,6 @@
 >       --stat-collect-url [ARGUMENT=1]
 >       --stat-collect-interval [ARGUMENT=1]
 >     --stat-report-process-tag [ARGUMENT=1]
->     --task-runner-root-path [ARGUMENT=1]
 > ENV Usage:
 >   "
 >     #!/usr/bin/env bash
@@ -291,7 +280,6 @@
 >     export DR_NODE_STAT_COLLECT_URL="[ARGUMENT=1]"
 >     export DR_NODE_STAT_COLLECT_INTERVAL="[ARGUMENT=1]"
 >     export DR_NODE_STAT_REPORT_PROCESS_TAG="[ARGUMENT=1]"
->     export DR_NODE_TASK_RUNNER_ROOT_PATH="[ARGUMENT=1]"
 >   "
 > CONFIG Usage:
 >   {
@@ -354,6 +342,5 @@
 >     "statCollectUrl": [ "[ARGUMENT=1]" ],
 >     "statCollectInterval": [ "[ARGUMENT=1]" ],
 >     "statReportProcessTag": [ "[ARGUMENT=1]" ],
->     "taskRunnerRootPath": [ "[ARGUMENT=1]" ],
 >   }
 > ```

package-lock.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@dr-js/node",
-  "version": "0.3.0-dev.2",
+  "version": "0.3.0-dev.3",
   "description": "A collection of strange functions, for node",
   "author": "dr-js",
   "license": "MIT",
@@ -23,7 +23,7 @@
     "build-library-dev": "dr-dev --EE BABEL_ENV=dev -E -- npm run build-library -- --watch",
     "build-module": "dr-dev --EE BABEL_ENV=module -E -- babel ./source --out-dir ./output-gitignore/module",
     "// test ========================": "",
-    "test-dev": "dr-dev --EE BABEL_ENV=dev -E -- dr-dev --TR @babel/register --TT 999999 -T source/module/PingRace.test.js",
+    "test-dev": "dr-dev --EE BABEL_ENV=dev -E -- dr-dev --TR @babel/register -T source/module/Software/npm.test.js",
     "test-source": "dr-dev --TR @babel/register -T source/ --TFS .test.js",
     "test-output-library": "dr-dev -T output-gitignore/library/ --TFS .test.js",
     "test-output-module": "dr-dev --TR @babel/register -T output-gitignore/module/ --TFS .test.js",
@@ -38,7 +38,7 @@
     "npm": ">=6.12"
   },
   "dependencies": {
-    "@dr-js/core": "^0.3.0 || ^0.3.0-dev.6"
+    "@dr-js/core": "^0.3.0 || ^0.3.0-dev.8"
   },
   "devDependencies": {
     "@dr-js/dev": "0.3.0-dev.6",

package.json

@@ -41,8 +41,7 @@ const TEXT_SERVER_CONFIG = JSON.stringify({
   permissionFile: './server-permission.config.js',
   authFile: FILE_AUTH_KEY,
   explorerRootPath: './path-upload',
-  explorerUploadMergePath: './path-upload.merge',
-  taskRunnerRootPath: './task-runner'
+  explorerUploadMergePath: './path-upload.merge'
 })
 
 const FILE_CLIENT_PATH_ACTION_CONFIG = fromTemp('client-path-action.config.json')

script/testServer.js

@@ -17,7 +17,6 @@ import { getPermissionOption, PermissionFormatConfig } from '@dr-js/node/module/
 import { getExplorerOption, ExplorerFormatConfig } from '@dr-js/node/module/server/feature/Explorer/option'
 import { getStatCollectOption, StatCollectFormatConfig } from '@dr-js/node/module/server/feature/StatCollect/option'
 import { getStatReportOption, StatReportFormatConfig } from '@dr-js/node/module/server/feature/StatReport/option'
-import { getTaskRunnerOption, TaskRunnerFormatConfig } from '@dr-js/node/module/server/feature/TaskRunner/option'
 
 import { configureSampleServer } from './sampleServer'
 
@@ -36,8 +35,7 @@ const SampleServerFormatConfig = getServerPackFormatConfig([
 
   ExplorerFormatConfig,
   StatCollectFormatConfig,
-  StatReportFormatConfig,
-  TaskRunnerFormatConfig
+  StatReportFormatConfig
 ])
 
 const runSampleServer = async (optionData) => startServer({
@@ -52,8 +50,7 @@ const runSampleServer = async (optionData) => startServer({
   ...getPermissionOption(optionData),
   ...getExplorerOption(optionData),
   ...getStatCollectOption(optionData),
-  ...getStatReportOption(optionData),
-  ...getTaskRunnerOption(optionData)
+  ...getStatReportOption(optionData)
 })
 
 const startServer = async (serverOption, featureOption) => {

source-bin/runServer.js

@@ -8,7 +8,6 @@ import { configureFeaturePack as configureFeaturePackPermission } from '@dr-js/n
 import { configureFeaturePack as configureFeaturePackExplorer } from '@dr-js/node/module/server/feature/Explorer/configureFeaturePack'
 import { configureFeaturePack as configureFeaturePackStatCollect } from '@dr-js/node/module/server/feature/StatCollect/configureFeaturePack'
 import { configureFeaturePack as configureFeaturePackStatReport } from '@dr-js/node/module/server/feature/StatReport/configureFeaturePack'
-import { configureFeaturePack as configureFeaturePackTaskRunner } from '@dr-js/node/module/server/feature/TaskRunner/configureFeaturePack'
 
 const configureSampleServer = async ({
   serverPack: { server, option }, logger, routePrefix = '',
@@ -27,9 +26,7 @@ const configureSampleServer = async ({
   // stat collect
   statCollectPath, statCollectUrl, statCollectInterval,
   // stat report
-  statReportProcessTag,
-  // task-runner
-  taskRunnerRootPath
+  statReportProcessTag
 }) => {
   const URL_AUTH_CHECK = '/auth'
 
@@ -61,16 +58,10 @@ const configureSampleServer = async ({
     statReportProcessTag
   })
 
-  const featureTaskRunner = taskRunnerRootPath && await configureFeaturePackTaskRunner({
-    logger, routePrefix, featureAuth, featurePermission,
-    taskRunnerRootPath
-  })
-
   const redirectUrl = featureExplorer ? featureExplorer.URL_HTML
     : featureStatCollect ? featureStatCollect.URL_HTML
       : featureStatReport ? featureStatReport.URL_HTML
-        : featureTaskRunner ? featureTaskRunner.URL_HTML
-          : ''
+        : ''
 
   const responderLogEnd = createResponderLogEnd({ log: logger.add })
 
@@ -79,7 +70,6 @@ const configureSampleServer = async ({
     ...(featureExplorer ? featureExplorer.routeList : []),
     ...(featureStatCollect ? featureStatCollect.routeList : []),
     ...(featureStatReport ? featureStatReport.routeList : []),
-    ...(featureTaskRunner ? featureTaskRunner.routeList : []),
     [ '/', 'GET', isDebugRoute ? createResponderRouteListHTML({ getRouteMap: () => routeMap })
       : redirectUrl ? (store) => responderEndWithRedirect(store, { redirectUrl })
         : (store) => responderEndWithStatusCode(store, { statusCode: 400 })
@@ -102,8 +92,7 @@ const configureSampleServer = async ({
     featureAuth,
     featureExplorer,
     featureStatCollect,
-    featureStatReport,
-    featureTaskRunner
+    featureStatReport
   }
 }
 

source-bin/sampleServer.js

@@ -6,7 +6,7 @@ const runDetached = async ({ command, argList, option, logFile }) => {
   const logFd = await openAsync(logFile, 'a')
   const subProcess = spawn(command, argList, {
     stdio: [ 'ignore', logFd, logFd ], // TODO: NOTE: should test for https://github.com/joyent/libuv/issues/923
-    detached: true, windowsHide: true, // to allow server restart and find the process again
+    detached: true, // to allow server restart and find the process again
     ...option
   })
   subProcess.on('error', (error) => { __DEV__ && console.warn('[ERROR][runDetached] config:', { command, argList, option, logFile }, 'error:', error) })

source/module/RunDetached.js

@@ -23,7 +23,7 @@ const TEST_DETACHED_PROCESS_FUNC = (TEST_LOG_FILE) => {
     const subProcess = spawn(command, argList, {
       ...option,
       stdio: [ 'ignore', stdoutFd, stdoutFd ], // TODO: NOTE: check: https://github.com/joyent/libuv/issues/923
-      detached: true, windowsHide: true // to allow server restart and find the process again
+      detached: true // to allow server restart and find the process again
     })
     subProcess.on('error', (error) => { console.warn('[ERROR][startDetachedProcess] config:', { command, argList, option }, 'error:', error) })
     subProcess.unref()

source/module/RunDetached.test.js

@@ -1,21 +1,25 @@
 import { resolve } from 'path'
+import { createGzip, createGunzip } from 'zlib'
+import { setupStreamPipe, waitStreamStopAsync } from '@dr-js/core/module/node/data/Stream'
+import { createReadStream, createWriteStream } from '@dr-js/core/module/node/file/function'
+import { run } from '@dr-js/core/module/node/system/Run'
 
-import { createDetect } from './function'
+import { createCommandWrap, createDetect } from './function'
 
 // NOTE: require 7z@>=16.00 for `-bs` switch
 
-const command = '7z'
+const { getCommand, setCommand } = createCommandWrap('7z')
 
 // $ 7z
 //   7-Zip 18.06 (x64) : Copyright (c) 1999-2018 Igor Pavlov : 2018-12-30
 const detect = createDetect( // test for: `-bs{o|e|p}{0|1|2} : set output stream for output/error/progress line`
   '-bs{o|e|p}{0|1|2}',
   'expect "7z" in PATH with "-bs{o|e|p}{0|1|2}" support',
-  command
+  getCommand
 )
 
 const compressConfig = (sourceDirectory, outputFile) => ({
-  command,
+  command: getCommand(),
   argList: [
     'a', resolve(outputFile), // can ends with `.7z` or `.zip`
     resolve(sourceDirectory, '*'),
@@ -24,7 +28,7 @@ const compressConfig = (sourceDirectory, outputFile) => ({
 })
 
 const compressFileConfig = (sourceFile, outputFile) => ({
-  command,
+  command: getCommand(),
   argList: [
     'a', resolve(outputFile), // can ends with `.7z` or `.zip`
     resolve(sourceFile),
@@ -33,18 +37,54 @@ const compressFileConfig = (sourceFile, outputFile) => ({
 })
 
 const extractConfig = (sourceFile, outputPath) => ({
-  command,
+  command: getCommand(),
   argList: [
     'x', resolve(sourceFile),
     `-o${resolve(outputPath)}`,
-    '-y', // for overwrite existing
+    '-aoa', // for overwrite existing
     '-bso0', '-bsp0' // mute extra output
   ]
 })
 
+// require manual setup piping: https://stackoverflow.com/questions/1359793/programmatically-extract-tar-gz-in-a-single-step-on-windows-with-7-zip/14699663#14699663
+const compressTgzAsync = async (sourceDirectory, outputFile) => { // for `.tgz` or `.tar.gz`
+  const outputStream = createWriteStream(resolve(outputFile))
+  const { promise, subProcess } = run({
+    command: getCommand(),
+    argList: [
+      'a', 'placeholder-name',
+      resolve(sourceDirectory, '*'),
+      '-ttar', '-so' // mark archive type and output to stdout
+    ]
+  })
+  await Promise.all([
+    waitStreamStopAsync(setupStreamPipe(subProcess.stdout, createGzip(), outputStream)),
+    promise
+  ])
+}
+
+const extractTgzAsync = async (sourceFile, outputPath) => { // for `.tgz` or `.tar.gz`
+  const inputStream = createReadStream(resolve(sourceFile))
+  const { promise, subProcess } = run({
+    command: getCommand(),
+    argList: [
+      'x',
+      `-o${resolve(outputPath)}`,
+      '-aoa', // for overwrite existing
+      '-ttar', '-si' // mark archive type and input from stdin
+    ]
+  })
+  await Promise.all([
+    waitStreamStopAsync(setupStreamPipe(inputStream, createGunzip(), subProcess.stdin)),
+    promise
+  ])
+}
+
 export {
-  detect,
+  getCommand, setCommand, detect,
 
   compressConfig, compressFileConfig,
-  extractConfig
+  extractConfig,
+
+  compressTgzAsync, extractTgzAsync
 }