@toptal/davinci-cli-shared 1.10.2-alpha-fix-wrong-data-structure-in-analytics-e998b099.7 → 1.10.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 1.10.2
+
+### Patch Changes
+
+- [#1843](https://github.com/toptal/davinci/pull/1843) [`1457314e`](https://github.com/toptal/davinci/commit/1457314e7f449146077753dcc467565e6ce4d3d2) Thanks [@dmaklygin](https://github.com/dmaklygin)! - ---
+
+  - fix storybook analytics to send necessary data properly
+
 ## 1.10.1
 
 ### Patch Changes

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@toptal/davinci-cli-shared",
-  "version": "1.10.2-alpha-fix-wrong-data-structure-in-analytics-e998b099.7+e998b099",
+  "version": "1.10.2",
   "description": "Shared CLI code and CLI engine for davinci",
   "publishConfig": {
     "access": "public"
   },
   "main": "src/index.js",
+  "files": [
+    "src",
+    "CHANGELOG.md"
+  ],
   "scripts": {
-    "build:package": "../../bin/build-package.js",
-    "prepublishOnly": "../../bin/prepublish.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "Toptal",
@@ -24,6 +26,5 @@
     "semver": "^7.3.7",
     "uuid": "^9.0.0",
     "vorpal": "^1.12.0"
-  },
-  "gitHead": "e998b09949b7b22fd1305544729bb6665fcfe092"
+  }
 }

package/src/index.js

@@ -1,13 +1,11 @@
 const vorpal = require('vorpal')
 
-const { identify, track } = require('../src/utils/metrics/metrics')
-const { gatherUsageData } = require('../src/utils/metrics/usage-data')
-const print = require('../src/utils/print')
-const { run, runSync } = require('../src/utils/run')
-const prompt = require('../src/utils/prompt')
-const {
-  convertToCLIParameters,
-} = require('../src/utils/convert-to-cli-parameters')
+const { identify, track } = require('./utils/metrics/metrics')
+const { gatherUsageData } = require('./utils/metrics/usage-data')
+const print = require('./utils/print')
+const { run, runSync } = require('./utils/run')
+const prompt = require('./utils/prompt')
+const { convertToCLIParameters } = require('./utils/convert-to-cli-parameters')
 const davinciProjectConfig = require('./utils/davinci-project-config')
 const files = require('./utils/files')
 const packageUtils = require('./utils/package')

package/src/utils/davinci-project-config.test.js

@@ -0,0 +1,140 @@
+describe('davinci-project-config', () => {
+  let fs
+
+  beforeEach(() => {
+    jest.resetModules()
+
+    jest.mock('fs')
+    fs = require('fs')
+  })
+
+  it('returns the default config when the file does not exist', () => {
+    fs.existsSync.mockReturnValue(false)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('returns the default config when the file is empty', () => {
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue('')
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('returns specified options merged with the default config', () => {
+    const data = `
+      master:
+        conventional_commits: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.deploy).toBe(false)
+    expect(davinciProjectConfig.master.conventionalCommits).toBe(true)
+    expect(davinciProjectConfig.pr.contractTesting).toBe(false)
+  })
+
+  it('parses correctly is_progressive_web_app root flag', () => {
+    const data = `
+      is_progressive_web_app: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.isProgressiveWebApp).toBe(true)
+  })
+
+  it('parses correctly require_assignee master flag', () => {
+    const data = `
+      master:
+        require_assignee: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.requireAssigneeWhitelist).toEqual([
+      'dependabot-preview[bot]',
+      'dependabot[bot]',
+    ])
+    expect(davinciProjectConfig.master.requireAssignee).toBe(true)
+  })
+
+  it('parses correctly require_assignee_whitelist master flag', () => {
+    const data = `
+      master:
+        require_assignee_whitelist: []
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.master.requireAssigneeWhitelist).toEqual([])
+    expect(davinciProjectConfig.master.requireAssignee).toBe(false)
+  })
+
+  it('parses correctly service_worker_filename root flag', () => {
+    const serviceWorkerFileName = 'service-worker-123.js'
+    const data = `
+      service_worker_filename: ${serviceWorkerFileName}
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBe(
+      serviceWorkerFileName
+    )
+  })
+
+  it('when davinci.yml file exists and service_worker_filename is not specified in config', () => {
+    const data = `
+      master:
+        conventional_commits: true
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBeUndefined()
+  })
+
+  it('when davinci.yml file is empty and service_worker_filename is not specified in config', () => {
+    const data = ''
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.serviceWorkerFileName).toBeUndefined()
+  })
+
+  it('parses correctly safety_workers list', () => {
+    const data = `
+      safety_workers:
+        - service-worker-1.js
+        - service-worker-2.js
+    `
+
+    fs.existsSync.mockReturnValue(true)
+    fs.readFileSync.mockReturnValue(data)
+    const davinciProjectConfig = require('./davinci-project-config')
+
+    expect(davinciProjectConfig.safetyWorkers).toEqual([
+      'service-worker-1.js',
+      'service-worker-2.js',
+    ])
+  })
+})

package/src/utils/package.test.js

@@ -0,0 +1,77 @@
+jest.mock('./yarn-adapter', () => ({
+  list: jest.fn(),
+}))
+
+const packageUtils = require('./package')
+const yarnAdapter = require('./yarn-adapter')
+
+const packageName = '@toptal/davinci-engine'
+const packageValidVersions = [
+  '4.0.0',
+  '4',
+  '4.4',
+  '4.1.13-alpha-FX-1234-my-branch.1',
+  '^3',
+  '~5.6.7',
+]
+const packageInvalidVersions = [
+  '2.0.0',
+  '6',
+  '1.4',
+  '1.1.13-alpha-FX-1234-my-branch.1',
+]
+const validVersionRange = '3 - 5'
+const packageJsonDependencies = {
+  [packageName]: validVersionRange,
+}
+
+describe('package utils', () => {
+  describe('checkPrerequirement', () => {
+    it('should return an error when package is not installed', () => {
+      yarnAdapter.list.mockReturnValueOnce(new Map())
+
+      const result = packageUtils.checkPrerequirement({
+        dependencies: packageJsonDependencies,
+        packageName,
+      })
+
+      expect(result).toBe(`Cannot find module '${packageName}'.`)
+    })
+
+    it.each(packageValidVersions)(
+      `should return no errors for version %s in range ${validVersionRange}`,
+      packageValidVersion => {
+        yarnAdapter.list.mockReturnValueOnce(
+          new Map([[packageName, packageValidVersion]])
+        )
+
+        const result = packageUtils.checkPrerequirement({
+          dependencies: packageJsonDependencies,
+          packageName,
+        })
+
+        expect(result).toBeNull()
+      }
+    )
+
+    it.each(packageInvalidVersions)(
+      `should return an error for version %s in range ${validVersionRange}`,
+      packageInvalidVersion => {
+        yarnAdapter.list.mockReturnValueOnce(
+          new Map([[packageName, packageInvalidVersion]])
+        )
+
+        const result = packageUtils.checkPrerequirement({
+          dependencies: packageJsonDependencies,
+          packageName,
+        })
+
+        expect(result).toBe(
+          `Invalid version of package @toptal/davinci-engine is installed.
+Installed version: ${packageInvalidVersion}
+Should be: ${validVersionRange}`
+        )
+      }
+    )
+  })
+})

package/src/utils/to-vorpal-args.test.js

@@ -0,0 +1,37 @@
+const toVorpalArgs = require('./to-vorpal-args')
+
+describe('toVorpalArgs', () => {
+  it('transforms numbers', () => {
+    const initialArgs = '--foo=1 --bar=2'
+    const expectedArgs = '--foo 1 --bar 2'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms strings', () => {
+    const initialArgs = '--foo="hello" --bar="world"'
+    const expectedArgs = '--foo "hello" --bar "world"'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms booleans', () => {
+    const initialArgs = '--foo=true --bar=false'
+    const expectedArgs = '--foo true --bar false'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('transforms short arguments', () => {
+    const initialArgs = '-f=1 -b="hello"'
+    const expectedArgs = '-f 1 -b "hello"'
+
+    expect(toVorpalArgs(initialArgs)).toEqual(expectedArgs)
+  })
+
+  it('ignores formatted arguments', () => {
+    const formattedArgs = '--foo 1 --bar "hello" -f true'
+
+    expect(toVorpalArgs(formattedArgs)).toEqual(formattedArgs)
+  })
+})

package/src/utils/yarn-adapter.test.js

@@ -0,0 +1,57 @@
+jest.mock('./run', () => ({
+  runSync: jest.fn(),
+}))
+
+const yarnAdapter = require('./yarn-adapter')
+const { runSync } = require('./run')
+
+const packageName = 'find-up'
+const packageVersion = '5.0.0'
+const existingPackageResponseMock = `{"type":"tree","data":{"type":"list","trees":[{"name":"${packageName}@${packageVersion}","children":[],"hint":null,"color":null,"depth":0}]}}`
+const nonExistingPackageResponseMock = `{"type":"tree","data":{"type":"list","trees":[]}}`
+const invalidResponseMock = 'invalid-response'
+
+describe('yarnAdapter', () => {
+  describe('list', () => {
+    it('should return a version for the existing package', () => {
+      runSync.mockReturnValueOnce({
+        stdout: existingPackageResponseMock,
+      })
+
+      const result = yarnAdapter.list(packageName)
+
+      expect(result.size).toBe(1)
+      expect(result.get(packageName)).toBe(packageVersion)
+    })
+
+    it('should return empty map for non-existing package', () => {
+      runSync.mockReturnValueOnce({
+        stdout: nonExistingPackageResponseMock,
+      })
+
+      const result = yarnAdapter.list(packageName)
+
+      expect(result.size).toBe(0)
+    })
+
+    it('should throw an error for invalid response', () => {
+      runSync.mockReturnValueOnce({
+        stdout: invalidResponseMock,
+      })
+
+      expect(() => {
+        yarnAdapter.list(packageName)
+      }).toThrow('Unexpected token i in JSON at position 0')
+    })
+
+    it('should throw an error for empty response', () => {
+      runSync.mockReturnValueOnce({
+        stdout: '',
+      })
+
+      expect(() => {
+        yarnAdapter.list(packageName)
+      }).toThrow('Unexpected end of JSON input')
+    })
+  })
+})