#161 Allow baseSHA to be undefined (#162)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@del-systems/swatcher",
-  "version": "1.2.17",
+  "version": "1.3.0",
   "description": "Screenshot Watcher",
   "main": "src/index.js",
   "scripts": {

src/__tests__/ci.js

@@ -34,6 +34,18 @@ describe('ci should read all available env variables', () => {
       { GITHUB_EVENT_NAME: 'push' },
       { after: '12345', before: 'first_parent' },
       'first_parent'
+    ],
+    [
+      'headSha',
+      { GITHUB_EVENT_NAME: 'workflow_dispatch', GITHUB_SHA: 'work sha' },
+      { },
+      'work sha'
+    ],
+    [
+      'baseSha',
+      { GITHUB_EVENT_NAME: 'workflow_dispatch', GITHUB_SHA: 'work sha' },
+      { },
+      undefined
     ]
   ])('`(await CI()).%s` from %p should return %p', async (property, env, payload, expected) => {
     const resetFakedEnvVariables = fakeEnv(env)

src/__tests__/generate_diff_command.js

@@ -1,13 +1,21 @@
 import generateDiffCommand from '../generate_diff_command'
 import reportChanges from '../report_changes'
 
-jest.mock('../ci', () => ({
-  __esModule: true,
-  default: async () => ({
-    baseSha: 'parent-sha',
-    headSha: 'pull-request-sha'
+const ci = require('../ci')
+jest.mock('../ci', () => {
+  const module = {
+    __esModule: true,
+    __baseSha: '',
+    __headSha: ''
+  }
+
+  module.default = async () => ({
+    baseSha: module.__baseSha,
+    headSha: module.__headSha
   })
-}))
+
+  return module
+})
 
 jest.mock('../report_changes')
 
@@ -58,8 +66,21 @@ jest.mock('../compare_pngs', () => ({
   }))
 }))
 
+beforeEach(jest.clearAllMocks)
+
 it('should properly detect only updated screenshots and check for equalness', async () => {
+  ci.__baseSha = 'parent-sha'
+  ci.__headSha = 'pull-request-sha'
   await generateDiffCommand()
 
   expect(reportChanges).toHaveBeenCalledTimes(1)
 })
+
+it('should abort if base SHA cannot be detected', async () => {
+  ci.__baseSha = null
+  ci.__headSha = 'pull-request-sha'
+
+  await generateDiffCommand()
+
+  expect(reportChanges).not.toHaveBeenCalled()
+})

src/ci.js

@@ -13,9 +13,11 @@ class GithubActionsEnvironment {
         this.baseSha = githubPayload.before
         this.headSha = githubPayload.after
         break
+      case 'workflow_dispatch':
+        this.headSha = process.env.GITHUB_SHA
     }
 
-    if (!this.baseSha || !this.headSha) throw new Error('Base sha and head sha couldn\'t be resolved')
+    if (!this.baseSha && !this.headSha) throw new Error('Base sha and head sha couldn\'t be resolved')
   }
 }
 

src/generate_diff_command.js

@@ -9,6 +9,11 @@ export default async function () {
   const s3 = new S3()
   const ci = await CI()
 
+  if (!ci.baseSha) {
+    console.warn('Cannot generate diffs when base SHA isn\'t available')
+    return
+  }
+
   const headPaths = await listFiles(s3, ci.headSha)
   const basePaths = await listFiles(s3, ci.baseSha)
   const addedPaths = headPaths.filter(item => !basePaths.find(i => i.fsPath === item.fsPath))

version.js

@@ -1 +1 @@
-export default '1.2.17'
+export default '1.3.0'