enable strictNullChecks and strictPropertyInitialization

Fix ~652 null-safety errors across source and test files.

Author: JamieMagee

test/business/definitionServiceTest.ts

@@ -54,7 +54,7 @@ describe('Definition Service', () => {
   })
 
   it('stores new definitions', async () => {
-    const { service, coordinates } = setup(createDefinition(null, null, ['foo']))
+    const { service, coordinates } = setup(createDefinition(undefined, undefined, ['foo']))
     await service.get(coordinates)
     expect(service.definitionStore.store.calledOnce).to.be.true
     expect(service.search.store.notCalled).to.be.true
@@ -79,7 +79,7 @@ describe('Definition Service', () => {
   })
 
   it('logs and harvest new definitions with empty tools', async () => {
-    const { service, coordinates } = setup(createDefinition(null, null, []))
+    const { service, coordinates } = setup(createDefinition(undefined, undefined, []))
     await service.get(coordinates)
     // expect(service.logger.info.calledOnce).to.be.true
     // expect(service.logger.info.getCall(0).args[0]).to.eq('definition not available')
@@ -88,7 +88,7 @@ describe('Definition Service', () => {
   })
 
   it('logs and harvests new definitions with undefined tools', async () => {
-    const { service, coordinates } = setup(createDefinition(null, null, undefined))
+    const { service, coordinates } = setup(createDefinition(undefined, undefined, undefined))
     await service.get(coordinates)
     // expect(service.logger.info.calledOnce).to.be.true
     // expect(service.logger.info.getCall(0).args[0]).to.eq('definition not available')
@@ -104,7 +104,7 @@ describe('Definition Service', () => {
       files: [{ path: 'bar.txt', attributions: ['Copyright Bob'] }],
       described: { releaseDate: '2018-08-09' }
     }
-    const { service, coordinates } = setup(raw, null, curation)
+    const { service, coordinates } = setup(raw, undefined, curation)
     const definition = await service.compute(coordinates)
     expect(definition.described.score.total).to.eq(30)
     expect(definition.described.toolScore.total).to.eq(0)
@@ -229,7 +229,7 @@ describe('Definition Service', () => {
 
     data.forEach((expected, coordinatesString) => {
       it(`should have source location for ${coordinatesString} package`, async () => {
-        const { service, coordinates } = setup(createDefinition(null, null, []), coordinatesString)
+        const { service, coordinates } = setup(createDefinition(undefined, undefined, []), coordinatesString)
         const definition = await service.compute(coordinates)
         expect(definition.described.sourceLocation).to.be.deep.equal(expected)
       })
@@ -332,7 +332,7 @@ describe('Definition Service', () => {
 
     beforeEach(() => {
       autoCurate = sinon.stub().resolves()
-      ;({ service, coordinates } = setup(createDefinition(null, null, ['scancode/3.2.2'])))
+      ;({ service, coordinates } = setup(createDefinition(undefined, undefined, ['scancode/3.2.2'])))
       service.curationService = {
         apply: (_coordinates, _curationSpec, definition) => Promise.resolve(definition),
         autoCurate
@@ -409,7 +409,7 @@ describe('Definition Service', () => {
         const firstCompute = new Promise(resolve => {
           resolveFirstCompute = resolve
         })
-        deferredDefinition = createDefinition(null, null, ['scancode/3.2.2'])
+        deferredDefinition = createDefinition(undefined, undefined, ['scancode/3.2.2'])
         sinon
           .stub(service, '_computeAndStore')
           .onFirstCall()
@@ -649,7 +649,11 @@ describe('Integration test', () => {
 
       context('with stale definitions', () => {
         it('recomputes a definition with the updated schema version', async () => {
-          const staleDef = { ...createDefinition(null, null, ['foo']), _meta: { schemaVersion: '1.0.0' }, coordinates }
+          const staleDef = {
+            ...createDefinition(undefined, undefined, ['foo']),
+            _meta: { schemaVersion: '1.0.0' },
+            coordinates
+          }
           const { service, store } = setupServiceForUpgrade(staleDef, recomputeHandler)
           const result = await service.get(coordinates)
           expect(result._meta.schemaVersion).to.eq('1.7.0')
@@ -666,7 +670,11 @@ describe('Integration test', () => {
         queue = memoryQueue.upgrade()
         recomputeHandler = delayedFactory({ logger, queue: { upgrade: () => queue, compute: memoryQueue.compute } })
         await recomputeHandler.initialize()
-        staleDef = { ...createDefinition(null, null, ['foo']), _meta: { schemaVersion: '1.0.0' }, coordinates }
+        staleDef = {
+          ...createDefinition(undefined, undefined, ['foo']),
+          _meta: { schemaVersion: '1.0.0' },
+          coordinates
+        }
       })
 
       handleVersionedDefinition()
@@ -781,7 +789,7 @@ describe('Integration test', () => {
     })
 
     it('returns placeholder when no definition exists, then returns real definition after queue processed', async () => {
-      const computedDef = { ...createDefinition(null, null, ['clearlydefined']), coordinates }
+      const computedDef = { ...createDefinition(undefined, undefined, ['clearlydefined']), coordinates }
       const { service, store } = setupServiceForUpgrade(computedDef, recomputeHandler)
       store.get.resolves(null) // no stored definition initially — triggers delayed compute path
 
@@ -811,7 +819,7 @@ describe('Integration test', () => {
     let harvestService
 
     it('deletes the tracked in progress harvest after definition is computed', async () => {
-      ;({ service, coordinates, harvestService } = setup(createDefinition(null, null, ['foo'])))
+      ;({ service, coordinates, harvestService } = setup(createDefinition(undefined, undefined, ['foo'])))
       harvestService.done = sinon.stub().resolves(true)
       await service.computeAndStore(coordinates)
       expect(harvestService.done.calledOnce).to.be.true
@@ -938,7 +946,7 @@ function setup(
   const curator = {
     get: () => Promise.resolve(curation),
     apply: (_coordinates: unknown, _curationSpec: unknown, definition: unknown) =>
-      Promise.resolve(Curation.apply(definition, curation)),
+      Promise.resolve(Curation.apply(definition as any, curation as any)),
     autoCurate: () => {
       return
     }
@@ -962,7 +970,7 @@ function setup(
   )
   service.logger = { info: sinon.stub(), debug: sinon.stub() }
   service._harvest = sinon.stub()
-  const coordinates = EntityCoordinates.fromString(coordinateSpec || 'npm/npmjs/-/test/1.0')
+  const coordinates = EntityCoordinates.fromString(coordinateSpec || 'npm/npmjs/-/test/1.0')!
   return { coordinates, service, harvestService }
 }
 

test/business/suggestionServiceTest.mts

@@ -20,7 +20,7 @@ const expect = chai.expect
 
 const testDir = dirname(fileURLToPath(import.meta.url))
 
-const testCoordinates = EntityCoordinates.fromString('npm/npmjs/-/test/10.0')
+const testCoordinates = EntityCoordinates.fromString('npm/npmjs/-/test/10.0')!
 
 describe('Suggestion Service', () => {
   it('gets suggestion for missing declared license', async () => {
@@ -99,7 +99,7 @@ describe('Suggestion Service', () => {
 
   it('queries related definitions with namespace', async () => {
     const now = DateTime.now()
-    const coordinates = EntityCoordinates.fromString('npm/npmjs/@scope/scope-test/1.0.0')
+    const coordinates = EntityCoordinates.fromString('npm/npmjs/@scope/scope-test/1.0.0')!
     const definition = createDefinition(coordinates, now, null, files)
     const service = setup(definition, [])
     await service.get(coordinates)
@@ -135,8 +135,8 @@ function createModifiedDefinition(
 ) {
   const newCoordinates = EntityCoordinates.fromObject({
     ...coordinates,
-    revision: `${coordinates.revision.split('.')[0] + amount}.0`
-  })
+    revision: `${coordinates.revision!.split('.')[0] + amount}.0`
+  })!
   const newFiles = files.map(file => {
     return { ...file, license, attributions }
   })

test/business/summarizerTest.mts

@@ -21,7 +21,7 @@ describe('Summary Service', () => {
     const raw = loadEvidence(coordSpec)
 
     const summaryService = SummaryService({})
-    const summaries = summaryService.summarizeAll(coords, raw as any)
+    const summaries = summaryService.summarizeAll(coords!, raw as any)
     const scancodeSummary = summaries['scancode']['32.3.0']
     expect(scancodeSummary.licensed.declared).to.equal('Apache-2.0')
     const licenseeSummary = summaries['licensee']['9.14.0']

test/providers/curation/github.ts

@@ -155,7 +155,7 @@ describe('Github Curation Service', () => {
 
   it('fails if definition exists', async () => {
     const { service } = setup()
-    const gitHubService = createService(service)
+    const gitHubService = createService(service as any)
     const contributionPatch = {
       contributionInfo: {
         summary: 'test',
@@ -184,9 +184,9 @@ describe('Github Curation Service', () => {
     sinon
       .stub(service, 'listAll')
       .callsFake(async () => [
-        EntityCoordinates.fromObject({ type: 'npm', provider: 'npmjs', name: 'test', revision: '1.0' })
+        EntityCoordinates.fromObject({ type: 'npm', provider: 'npmjs', name: 'test', revision: '1.0' })!
       ])
-    const gitHubService = createService(service)
+    const gitHubService = createService(service as any)
     sinon.stub(gitHubService, '_writePatch').callsFake(() => Promise.resolve())
 
     const contributionPatch = {
@@ -267,7 +267,7 @@ describe('Github Curation Service', () => {
       sinon
         .stub(service, 'listAll')
         .callsFake(async () => [
-          EntityCoordinates.fromObject({ type: 'npm', provider: 'npmjs', name: 'test', revision: '1.0' })
+          EntityCoordinates.fromObject({ type: 'npm', provider: 'npmjs', name: 'test', revision: '1.0' })!
         ])
       sinon.stub(service, 'list').callsFake(async () => [
         'npm/npmjs/-/test/1.0', // curated revision
@@ -278,7 +278,7 @@ describe('Github Curation Service', () => {
       ])
       sinon.stub(service, 'getStored').callsFake(async () => undefined as any)
 
-      const gitHubService = createService(service, licenseMatcher, harvestStore)
+      const gitHubService = createService(service as any, licenseMatcher as any, harvestStore as any)
       sinon.stub(gitHubService, '_getPatchesFromMergedPullRequest').resolves([component])
       sinon.stub(gitHubService, '_writePatch').callsFake(() => Promise.resolve())
       sinon.stub(gitHubService, 'list').callsFake(async () => {
@@ -350,7 +350,7 @@ describe('Github Curation Service', () => {
     beforeEach(() => {
       const { service } = setup()
       sinon.stub(service, 'getStored').resolves({
-        coordinates: EntityCoordinates.fromString('npm/npmjs/-/express/5.0.0')
+        coordinates: EntityCoordinates.fromString('npm/npmjs/-/express/5.0.0')!
       })
       const licenseMatcher = {
         process: sinon.stub().callsFake(() => matcherResult)
@@ -361,7 +361,7 @@ describe('Github Curation Service', () => {
       const harvestStore = {
         getAll: sinon.stub().resolves({})
       }
-      gitHubService = createService(service, licenseMatcher, harvestStore, {} as any, store as any)
+      gitHubService = createService(service as any, licenseMatcher as any, harvestStore as any, {} as any, store as any)
       // TODO: Should not stub private functions and private properties
       sinon.stub(gitHubService, 'github').value({
         rest: { users: { get: sinon.stub() } }
@@ -426,7 +426,7 @@ describe('Github Curation Service', () => {
       const store = {
         list: sinon.stub().callsFake(() => curationsAndContributions)
       }
-      gitHubService = createService(definitionService, licenseMatcher, harvestStore, {} as any, store as any)
+      gitHubService = createService(definitionService as any, licenseMatcher as any, harvestStore as any, {} as any, store as any)
       gitHubService.github = {
         rest: {
           users: { get: () => ({ name: 'clearlydefined-bot' }) },

test/providers/curation/githubPRs.ts

@@ -200,15 +200,15 @@ describe('Curation service pr events', () => {
 
   it('gets null curation if blob does not exist', async () => {
     const service = await createService({
-      geitStubOverride: () => {
+      geitStubOverride: (() => {
         return {
           tree: ref => {
             expect(ref).to.eq('branch')
             return Promise.resolve()
           },
           blob: () => Promise.resolve(Buffer.alloc(0))
         }
-      }
+      }) as any
     })
     const coordinates = EntityCoordinates.fromString('npm/npmjs/-/test/1.0.0')
     const content = await service._getCurations(coordinates)
@@ -226,7 +226,7 @@ revisions:
       declared: MIT
 `
     const service = await createService({
-      geitStubOverride: () => {
+      geitStubOverride: (() => {
         return {
           tree: ref => {
             expect(ref).to.eq('branch')
@@ -245,7 +245,7 @@ revisions:
             return Promise.resolve(Buffer.from(theYaml))
           }
         }
-      }
+      }) as any
     })
     const coordinates = EntityCoordinates.fromString('npm/npmjs/-/test/1.0.0')
     const content = await service._getCurations(coordinates)
@@ -266,15 +266,15 @@ revisions:
 
   it('getCurations should use pr ref', async () => {
     const service = await createService({
-      geitStubOverride: () => {
+      geitStubOverride: (() => {
         return {
           tree: ref => {
             expect(ref).to.eq('refs/pull/123/head')
             return Promise.resolve()
           },
           blob: () => Promise.resolve(Buffer.alloc(0))
         }
-      }
+      }) as any
     })
     const coordinates = EntityCoordinates.fromString('npm/npmjs/-/test/1.0.0')
     const content = await service._getCurations(coordinates, 123)

test/providers/harvest/throttling/listBasedFilterTest.ts

@@ -9,8 +9,8 @@ import { createSilentLogger } from '../../../helpers/mockLogger.ts'
 describe('ListBasedFilter', () => {
   const logger = createSilentLogger()
 
-  function createCoord(coordString) {
-    return EntityCoordinates.fromString(coordString)
+  function createCoord(coordString): EntityCoordinates {
+    return EntityCoordinates.fromString(coordString)!
   }
 
   describe('isBlocked', () => {
@@ -96,8 +96,8 @@ describe('ListBasedFilter', () => {
       it('should return false for null or undefined coordinates', () => {
         const filter = new ListBasedFilter({ blacklist: ['npm/npmjs/-/test'], logger })
 
-        expect(filter.isBlocked(null)).to.be.false
-        expect(filter.isBlocked(undefined)).to.be.false
+        expect(filter.isBlocked(null as any)).to.be.false
+        expect(filter.isBlocked(undefined as any)).to.be.false
       })
     })
   })
@@ -111,7 +111,7 @@ describe('ListBasedFilter', () => {
       })
 
       it('should log warnings for invalid coordinates', () => {
-        const warnings = []
+        const warnings: string[] = []
         const mockLogger = {
           ...createSilentLogger(),
           warn: (msg: string) => warnings.push(msg)

test/providers/store/azblobDefinition.ts

@@ -14,7 +14,7 @@ describe('azblob Definition store', () => {
     }
     const store = createStore(data)
     try {
-      await store.list(EntityCoordinates.fromString('npm/npmjs/-/error/4.6.0'))
+      await store.list(EntityCoordinates.fromString('npm/npmjs/-/error/4.6.0')!)
       throw new Error('should have thrown error')
     } catch (error) {
       expect((error as Error).message).to.eq('test error')
@@ -27,7 +27,7 @@ describe('azblob Definition store', () => {
       'npm/npmjs/-/co/revision/4.6.1.json': { metadata: { id: 'npm/npmjs/-/co/4.6.1' } }
     }
     const store = createStore(data)
-    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/bogus/4.6.0'))
+    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/bogus/4.6.0')!)
     expect(result.length).to.eq(0)
   })
 
@@ -37,7 +37,7 @@ describe('azblob Definition store', () => {
       'npm/npmjs/-/co/revision/4.6.1.json': { metadata: { id: 'npm/npmjs/-/co/4.6.1' } }
     }
     const store = createStore(data)
-    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.0'))
+    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.0')!)
     expect(result).to.deep.equalInAnyOrder(['npm/npmjs/-/co/4.6.0'])
   })
 
@@ -47,7 +47,7 @@ describe('azblob Definition store', () => {
       'npm/npmjs/-/co/revision/4.6.1.json': { metadata: { id: 'npm/npmjs/-/Co/4.6.1' } }
     }
     const store = createStore(data)
-    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1'))
+    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1')!)
     expect(result).to.deep.equalInAnyOrder(['npm/npmjs/-/Co/4.6.1'])
   })
 
@@ -57,7 +57,7 @@ describe('azblob Definition store', () => {
       'npm/npmjs/-/co/revision/4.6.1.json': { metadata: { id: 'npm/npmjs/-/Co/4.6.1' } }
     }
     const store = createStore(data)
-    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co'))
+    const result = await store.list(EntityCoordinates.fromString('npm/npmjs/-/co')!)
     expect(result).to.deep.equalInAnyOrder(['npm/npmjs/-/Co/4.6.0', 'npm/npmjs/-/Co/4.6.1'])
   })
 
@@ -71,14 +71,14 @@ describe('azblob Definition store', () => {
 
   it('deletes a definition', async () => {
     const store = createStore()
-    await store.delete(EntityCoordinates.fromString('npm/npmjs/-/foo/1.0'))
+    await store.delete(EntityCoordinates.fromString('npm/npmjs/-/foo/1.0')!)
     expect((store as any).blobService.deleteBlob.callCount).to.eq(1)
     expect((store as any).blobService.deleteBlob.args[0][1]).to.eq('npm/npmjs/-/foo/revision/1.0.json')
   })
 
   it('does not throw deleting missing definition', async () => {
     const store = createStore()
-    await store.delete(EntityCoordinates.fromString('npm/npmjs/-/missing/1.0'))
+    await store.delete(EntityCoordinates.fromString('npm/npmjs/-/missing/1.0')!)
     expect((store as any).blobService.deleteBlob.callCount).to.eq(1)
     expect((store as any).blobService.deleteBlob.args[0][1]).to.eq('npm/npmjs/-/missing/revision/1.0.json')
   })
@@ -90,13 +90,13 @@ describe('azblob Definition store', () => {
       'npm/npmjs/-/co/revision/4.6.2.json': createDefinitionJson('npm/npmjs/-/co/4.6.2')
     }
     const store = createStore(data)
-    const result = await store.get(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1'))
-    expect(result.coordinates).to.deep.eq(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1'))
+    const result = await store.get(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1')!)
+    expect(result.coordinates).to.deep.eq(EntityCoordinates.fromString('npm/npmjs/-/co/4.6.1')!)
   })
 })
 
 function createDefinition(coordinates) {
-  return { coordinates: EntityCoordinates.fromString(coordinates) }
+  return { coordinates: EntityCoordinates.fromString(coordinates)! }
 }
 
 function createDefinitionJson(coordinates) {