@toptal/davinci-cli-shared 2.2.2-alpha-chore-build-packages-via-bunchee-1d48b3aa.9 → 2.2.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 2.2.2
+
+### Patch Changes
+
+- [#1887](https://github.com/toptal/davinci/pull/1887) [`b3b691f4`](https://github.com/toptal/davinci/commit/b3b691f4bdfcd2c4d05133bb61c69c45bc3c06a6) Thanks [@augustobmoura](https://github.com/augustobmoura)! - ---
+
+  - guard agains NPE on empty metrics config file
+
 ## 2.2.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-cli-shared",
-  "version": "2.2.2-alpha-chore-build-packages-via-bunchee-1d48b3aa.9+1d48b3aa",
+  "version": "2.2.2",
   "description": "Shared CLI code and CLI engine for davinci",
   "publishConfig": {
     "access": "public"
@@ -23,21 +23,20 @@
   "dependencies": {
     "analytics-node": "^6.2.0",
     "chalk": "^4.1.2",
-    "commander": "^10.0.0",
     "execa": "^5.1.1",
     "find-yarn-workspace-root": "^2.0.0",
-    "gradient-string": "^2.0.0",
     "inquirer": "^8.2.0",
     "isomorphic-git": "^1.21.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
-    "ora": "^5.4.1",
+    "proper-lockfile": "^4.1.2",
     "read-pkg-up": "7.0.1",
     "semver": "^7.3.7",
-    "uuid": "^9.0.0"
+    "commander": "^10.0.0",
+    "gradient-string": "^2.0.0",
+    "ora": "^5.4.1"
   },
   "devDependencies": {
     "@jest/globals": "^29.4.2"
-  },
-  "gitHead": "1d48b3aa9f567d1b4427048d1f0d694f1b9df468"
+  }
 }

package/src/utils/metrics/id-config.js

@@ -1,63 +1,93 @@
-import os from 'os'
-import path from 'path'
-import fs from 'fs'
+import os from 'node:os'
+import path from 'node:path'
+import fs from 'node:fs/promises'
+import crypto from 'node:crypto'
 import yaml from 'js-yaml'
-import { v1 as uuid } from 'uuid'
+import properLockfile from 'proper-lockfile'
+import noop from 'lodash/noop.js'
 
-const homeDir = os.homedir()
-const configDir = path.join(homeDir, '.davinci-metrics')
-const configFile = path.join(configDir, 'auth.yml')
-const DEFAULT_FILE_CONTENT = 'allow_tracking: "yes"'
-
-const readConfig = () => {
-  let configFileContent = DEFAULT_FILE_CONTENT
+const CONFIG_DIR = path.join(os.homedir(), '.davinci-metrics')
+const CONFIG_FILE_PATH = path.join(CONFIG_DIR, 'auth.yml')
 
+const fileExists = async filePath => {
   try {
-    configFileContent = fs.readFileSync(configFile)
-  } catch (error) {
-    if (error.code === 'ENOENT') {
-      // File doesn't exist, lets create a new one automatically
-      fs.mkdirSync(configDir, { recursive: true })
-      fs.writeFileSync(configFile, configFileContent)
+    await fs.stat(filePath)
+
+    return true
+  } catch (err) {
+    if (err.code === 'ENOENT') {
+      return false
     }
+
+    throw err
   }
+}
 
-  return yaml.load(configFileContent)
+const createFileIfMissing = async filePath => {
+  await fs.mkdir(path.dirname(filePath), { recursive: true })
+  await fs.open(filePath, 'a').then(fh => fh.close())
 }
 
-const updateConfig = config => {
-  const originalConfig = readConfig()
-  const newConfig = {
-    ...originalConfig,
-    ...config,
-  }
+const resolveConfig = async () => {
+  let release = noop
 
-  fs.writeFileSync(configFile, yaml.dump(newConfig))
-}
+  try {
+    if (!(await fileExists(CONFIG_FILE_PATH))) {
+      await createFileIfMissing(CONFIG_FILE_PATH)
+    }
 
-export const isTrackingEnabled = () => {
-  const config = readConfig()
+    release = await properLockfile.lock(CONFIG_FILE_PATH, {
+      retries: {
+        forever: true,
+        maxRetryTime: 10 * 1000, // try locking the file for 10s
+      },
+    })
 
-  return config.allow_tracking !== 'no'
-}
+    const config = {
+      allow_tracking: true,
+    }
+
+    try {
+      Object.assign(
+        config,
+        yaml.load(await fs.readFile(CONFIG_FILE_PATH, 'utf8'))
+      )
+    } catch (err) {
+      if (err.code !== 'ENOENT') {
+        throw err
+      }
+    }
 
-export const getDeviceId = () => {
-  const config = readConfig()
+    if (!config.uuid) {
+      config.uuid = crypto.randomUUID()
+
+      await fs.writeFile(CONFIG_FILE_PATH, yaml.dump(config))
+    }
 
-  if (config && typeof config.uuid === 'string') {
-    return config.uuid
+    return config
+  } finally {
+    release()
   }
+}
 
-  const id = uuid()
+let loadedConfig = undefined
 
-  updateConfig({
-    uuid: id,
-  })
+export const getConfig = async () => {
+  if (!loadedConfig) {
+    try {
+      const yamlConfig = await resolveConfig()
 
-  return id
-}
+      loadedConfig = {
+        anonymousId: yamlConfig.uuid,
+        allowTracking: yamlConfig.allow_tracking,
+      }
+    } catch (err) {
+      loadedConfig = {
+        anonymousId: 'no-uuid',
+        allowTracking: false,
+      }
+    }
+  }
 
-export default {
-  getDeviceId,
-  isTrackingEnabled,
+  return loadedConfig
 }

package/src/utils/metrics/metrics.js

@@ -1,13 +1,16 @@
 import Analytics from 'analytics-node'
 
 import { isCi } from '../ci.js'
-import { getDeviceId, isTrackingEnabled } from './id-config.js'
+import { getConfig } from './id-config.js'
 
 const SEGMENT_WRITE_KEY = 'cwNYguEVVqdxFj5NyTKOhlrvaNQjlsXV'
-const anonymousId = getDeviceId()
+
+const { anonymousId, allowTracking } = await getConfig()
+
+const analyticsEnabled = !process.env.DAVINCI_SKIP_ANALYTICS && allowTracking
 
 const analytics = new Analytics(SEGMENT_WRITE_KEY, {
-  enable: process.env.DAVINCI_SKIP_ANALYTICS !== 'true' && isTrackingEnabled(),
+  enable: analyticsEnabled,
   flushAt: 1,
 })