feat(js): introduce safe flag to suppress errors

Author: antongolub

packages/core/README.md

@@ -37,6 +37,7 @@ npx buildstamp --output='buildstamp.json' --extra='{"foo": "bar"}'
 | `--git`          | Collect git info            | `true`            |
 | `--ci`           | Capture CI digest           | `true`            |
 | `--date`         | Attach ISO8601 date         | `true`            |
+| `--safe`         | Suppress errors             | `false`           |
 | `--extra`        | JSON mixin to inject        | `{}`              |
 | `--help`         | Print help info             |                   |               
 

packages/core/package.json

@@ -28,7 +28,8 @@
   },
   "devDependencies": {
     "@abstractest/core": "^0.4.4",
-    "@qiwi/buildstamp-infra": "workspace:*"
+    "@qiwi/buildstamp-infra": "workspace:*",
+    "@types/minimist": "^1.2.5"
   },
   "scripts": {
     "build": "concurrently --kill-others-on-fail 'npm:build:*'",

packages/core/src/main/ts/buildstamp.ts

@@ -7,7 +7,8 @@ import {
   IBuildstamp,
   IBuildstampOptions,
   IBuildstampOptionsNormalized,
-  IGitInfo
+  IGitInfo,
+  ICallable
 } from './interface'
 
 export const normalizeOpts = ({
@@ -16,6 +17,7 @@ export const normalizeOpts = ({
   ci = true,
   git = true,
   date = true,
+  safe = false,
   extra = {}
 }: IBuildstampOptions = {}): IBuildstampOptionsNormalized => ({
   ci,
@@ -24,25 +26,27 @@ export const normalizeOpts = ({
   git,
   date,
   extra,
+  safe
 })
 
 export const buildstamp = async (opts?: IBuildstampOptions): Promise<IBuildstamp> => {
-  const {ci, git, date, cwd, output, extra} = normalizeOpts(opts)
+  const {ci, git, date, cwd, output, extra, safe} = normalizeOpts(opts)
   const stamp: IBuildstamp = {...extra}
+  const s = safe ? safify : (v: any) => v
 
   if (date) {
     stamp.date = new Date().toISOString()
   }
   if (git) {
-    Object.assign(stamp, await getGitInfo(cwd, process.env))
+    Object.assign(stamp, await s(getGitInfo)(cwd, process.env))
   }
   if (ci) {
-    Object.assign(stamp, getCIInfo(process.env))
+    Object.assign(stamp, s(getCIInfo)(process.env))
   }
   if (output) {
-    const file = path.resolve(cwd, output)
-    await fs.mkdir(path.dirname(file), { recursive: true })
-    await fs.writeFile(file, JSON.stringify(stamp, null, 2))
+    const file = s(path.resolve)(cwd, output)
+    await s(fs.mkdir)(s(path.dirname)(file), { recursive: true })
+    await s(fs.writeFile)(file, JSON.stringify(stamp, null, 2))
   }
 
   return stamp
@@ -106,3 +110,12 @@ export const spawn = (
       })
     })
 })
+
+export const safify = <T extends ICallable>(fn: T, value: any = {}): T => ((...args: any[]) => {
+  try {
+    const result = fn(...args)
+    return result?.then((v: any) => v, () => value) || result
+  } catch {
+    return value
+  }
+}) as T

packages/core/src/main/ts/cli.ts

@@ -8,7 +8,7 @@ const camelize = (s: string) => s.replace(/-./g, x => x[1].toUpperCase())
 const normalizeFlags = (flags = {}): Record<string, any> => Object.fromEntries(Object.entries(flags).map(([k, v]) =>
   [camelize(k), v === 'false' ? false : v]))
 
-const { cwd, git, date, output, version, help, extra } = normalizeFlags(minimist(process.argv.slice(2), {
+const { cwd, git, date, output, version, help, extra, safe } = normalizeFlags(minimist(process.argv.slice(2), {
   alias: {
     help: ['h'],
     version: ['v'],
@@ -28,6 +28,7 @@ const { cwd, git, date, output, version, help, extra } = normalizeFlags(minimist
     --git           Inject git info. True by default
     --date          Inject date. True by default
     --extra         JSON to mixin
+    --safe          Suppress any errors. Defaults to false
     --help, -h      Print help digest
     --version, -v   Print version
   
@@ -48,6 +49,7 @@ const { cwd, git, date, output, version, help, extra } = normalizeFlags(minimist
     date,
     git,
     output,
+    safe,
     extra: extra ? JSON.parse(extra) : {}
   })
 })()

packages/core/src/main/ts/interface.ts

@@ -4,6 +4,7 @@ export interface IBuildstampOptionsNormalized {
   date:   boolean | string
   git:    boolean
   ci:     boolean
+  safe:   boolean
   extra:  Record<string, string>
 }
 
@@ -25,3 +26,5 @@ export interface IBuildstamp extends Partial<IGitInfo>, Partial<ICIInfo> {
   date?: string
   [e: string]: string | undefined
 }
+
+export interface ICallable { (...args: any[]): any }

packages/core/src/test/ts/buildstamp.test.ts

@@ -12,6 +12,18 @@ describe('buildstamp', () => {
     expect(result.git_repo_name).toEqual('qiwi/buildstamp')
     expect(result.foo).toEqual('bar')
   })
+
+  it('suppresses errors in `safe` mode', async () => {
+    const output = '\0invali::?d_path.json'
+    try {
+      await buildstamp({output})
+    } catch (e) {
+      expect(e.message).toMatch(/The argument 'path' must be a string, Uint8Array, or URL without null bytes/)
+    }
+
+    const result = await buildstamp({output, safe: true})
+    expect(result.git_repo_name).toEqual('qiwi/buildstamp')
+  })
 })
 
 describe('getGitInfo()', () => {

packages/infra/package.json

@@ -30,6 +30,6 @@
     "ts-node": "^10.9.2",
     "typedoc": "^0.26.3",
     "typescript": "^5.5.3",
-    "zx-bulk-release": "^2.15.18"
+    "zx-bulk-release": "^2.15.19"
   }
 }