fix: extract and apply error properties

Author: JounQin

.changeset/tiny-starfishes-trade.md

@@ -0,0 +1,5 @@
+---
+'synckit': patch
+---
+
+fix: extract and apply error properties

.github/workflows/ci.yml

@@ -16,10 +16,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
 
       - name: Setup Node.js ${{ matrix.node }}
-        uses: actions/setup-node@master
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           cache: yarn
@@ -28,7 +28,7 @@ jobs:
         run: echo "$(yarn global bin)" >> $GITHUB_PATH
 
       - name: Install Dependencies
-        run: yarn --frozen-lockfile
+        run: yarn --frozen-lockfile --ignore-engines
 
       - name: Build, Lint and test
         run: |

.github/workflows/release.yml

@@ -11,15 +11,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
 
-      - name: Setup Node.js 14.x
-        uses: actions/setup-node@v2
+      - name: Setup Node.js 16.x
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
           cache: yarn
 
       - name: Install Dependencies

.remarkrc

@@ -1,5 +1,5 @@
 {
   "plugins": [
-    "@1stg/remark-config"
+    "@1stg/config"
   ]
 }

benchmarks/benchmark.cjs

@@ -42,7 +42,7 @@ const kebabCase = text =>
 
 class Benchmark {
   /**
-   * @param { Object.<string, PerfResult> } perfResults
+   * @param { Record<string, PerfResult> } perfResults
    */
   constructor(perfResults) {
     const keys = Object.keys(perfResults)

benchmarks/benchmark.js

@@ -5,7 +5,6 @@ import { fileURLToPath } from 'url'
 
 const RUN_TIMES = +process.env.RUN_TIMES || 1000
 
-// @ts-expect-error -- no idea
 const __filename = fileURLToPath(import.meta.url)
 
 /**
@@ -16,9 +15,9 @@ const __filename = fileURLToPath(import.meta.url)
 const perfCase = async name => {
   const loadStartTime = performance.now()
 
-  const syncFn = (
-    await import(`./${name}.${name === 'synckit' ? 'js' : 'cjs'}`)
-  ).default
+  const syncFn =
+    // eslint-disable-next-line unicorn/no-await-expression-member
+    (await import(`./${name}.${name === 'synckit' ? 'js' : 'cjs'}`)).default
 
   const loadTime = performance.now() - loadStartTime
 
@@ -48,7 +47,7 @@ const kebabCase = text =>
 
 class Benchmark {
   /**
-   * @param { Object.<string, PerfResult> } perfResults
+   * @param { Record.<string, PerfResult> } perfResults
    */
   constructor(perfResults) {
     const keys = Object.keys(perfResults)

package.json

@@ -7,15 +7,16 @@
   "author": "JounQin <admin@1stg.me>",
   "license": "MIT",
   "engines": {
-    "node": ">=12.3"
+    "node": ">=12.20"
   },
   "main": "./lib/index.cjs",
   "module": "./lib/index.js",
   "exports": {
     "import": "./lib/index.js",
-    "require": "./lib/index.cjs"
+    "require": "./lib/index.cjs",
+    "types": "./lib/index.d.ts"
   },
-  "types": "lib",
+  "types": "./lib/index.d.ts",
   "files": [
     "lib",
     "!*.tsbuildinfo"
@@ -55,23 +56,23 @@
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@1stg/lib-config": "^4.1.2",
-    "@changesets/changelog-github": "^0.4.1",
-    "@changesets/cli": "^2.17.0",
-    "@types/jest": "^27.0.2",
-    "@types/node": "^16.11.0",
-    "@types/uuid": "^8.3.1",
-    "clean-publish": "^3.4.1",
-    "deasync": "^0.1.23",
+    "@1stg/lib-config": "^5.3.0",
+    "@changesets/changelog-github": "^0.4.4",
+    "@changesets/cli": "^2.22.0",
+    "@types/jest": "^27.4.1",
+    "@types/node": "^17.0.23",
+    "@types/uuid": "^8.3.4",
+    "clean-publish": "^4.0.0",
+    "deasync": "^0.1.26",
     "sync-threads": "^1.0.1",
     "ts-expect": "^1.3.0",
-    "ts-jest": "^27.0.6",
-    "ts-node": "^10.3.0",
-    "type-coverage": "^2.18.2",
-    "typescript": "^4.4.4"
+    "ts-jest": "^27.1.4",
+    "ts-node": "^10.7.0",
+    "type-coverage": "^2.21.1",
+    "typescript": "^4.6.3"
   },
   "resolutions": {
-    "prettier": "^2.4.1",
+    "prettier": "^2.6.1",
     "tslib": "^2.3.1"
   },
   "commitlint": {
@@ -104,7 +105,7 @@
     ]
   },
   "typeCoverage": {
-    "atLeast": 99.46,
+    "atLeast": 99.5,
     "cache": true,
     "detail": true,
     "ignoreAsAssertion": true,

src/index.ts

@@ -45,6 +45,36 @@ export interface SynckitOptions {
   execArgv?: string[]
 }
 
+// MessagePort doesn't copy the properties of Error objects. We still want
+// error objects to have extra properties such as "warnings" so implement the
+// property copying manually.
+const extractProperties = (object: unknown): Record<string, unknown> => {
+  const properties: Record<string, unknown> = {}
+  if (object && typeof object === 'object') {
+    for (const key in object) {
+      properties[key] = (object as Record<string, unknown>)[key]
+    }
+  }
+  return properties
+}
+
+// MessagePort doesn't copy the properties of Error objects. We still want
+// error objects to have extra properties such as "warnings" so implement the
+// property copying manually.
+const applyProperties = <T>(
+  object: T,
+  properties?: Record<string, unknown>,
+): T => {
+  if (!properties) {
+    return object
+  }
+  // eslint-disable-next-line sonar/for-in
+  for (const key in properties) {
+    ;(object as Record<string, unknown>)[key] = properties[key]
+  }
+  return object
+}
+
 export function createSyncFn<T extends AnyAsyncFn>(
   workerPath: string,
   bufferSize?: number,
@@ -135,6 +165,7 @@ function startWorkerThread<R, T extends AnyAsyncFn<R>>(
       id: id2,
       result,
       error,
+      properties,
     } = receiveMessageOnPort(mainPort)!.message as WorkerToMainMessage<R>
 
     /* istanbul ignore if */
@@ -143,7 +174,7 @@ function startWorkerThread<R, T extends AnyAsyncFn<R>>(
     }
 
     if (error) {
-      throw error
+      throw applyProperties(error, properties)
     }
 
     return result!
@@ -177,6 +208,7 @@ export function runAsWorker<
           msg = {
             id,
             error,
+            properties: extractProperties(error),
           }
         }
         workerPort.postMessage(msg)

src/types.ts

@@ -32,6 +32,7 @@ export interface WorkerData {
 export interface DataMessage<T> {
   result?: T
   error?: unknown
+  properties?: Record<string, unknown>
 }
 
 export interface WorkerToMainMessage<T = unknown> extends DataMessage<T> {