test: remove @ts-expect-errors for this being mocha (#4250)

If we specify the return type of the `getIt` util, tsc will know what type `this` is in the test context so we can remove the error overrides.
ipfs · Nov 17, 2022 · 419aae1 · 419aae1
1 parent 6ae5eb7
commit 419aae1
Show file tree

Hide file tree

Showing 27 changed files with 83 additions and 115 deletions.
diff --git a/package.json b/package.json
@@ -73,4 +73,4 @@
   "workspaces": [
     "packages/*"
   ]
-}
+}
diff --git a/packages/interface-ipfs-core/src/add-all.js b/packages/interface-ipfs-core/src/add-all.js
@@ -76,8 +76,7 @@ export function testAddAll (factory, options) {
 
     it('should add a File as array of tuples', async function () {
       if (!supportsFileReader) {
-        // @ts-expect-error this is mocha
-        return this.skip('skip in node')
+        return this.skip()
       }
 
       const tuple = {
@@ -102,8 +101,7 @@ export function testAddAll (factory, options) {
 
     it('should add array of objects with readable stream content', async function () {
       if (!isNode) {
-        // @ts-expect-error this is mocha
-        this.skip('Only node supports readable streams')
+        this.skip()
       }
 
       const expectedCid = 'QmVv4Wz46JaZJeH5PMV4LGbRiiMKEmszPYY3g6fjGnVXBS'
@@ -336,7 +334,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a directory with only-hash=true', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const content = String(Math.random() + Date.now())
 
@@ -358,21 +355,18 @@ export function testAddAll (factory, options) {
     })
 
     it('should add with mode as string', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mode = '0777'
       await testMode(mode, parseInt(mode, 8))
     })
 
     it('should add with mode as number', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mode = parseInt('0777', 8)
       await testMode(mode, mode)
     })
 
     it('should add with mtime as Date', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = new Date(5000)
       await testMtime(mtime, {
@@ -382,7 +376,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add with mtime as { nsecs, secs }', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = {
         secs: 5,
@@ -392,7 +385,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add with mtime as timespec', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       await testMtime({
         Seconds: 5,
@@ -404,7 +396,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add with mtime as hrtime', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = process.hrtime()
       await testMtime(mtime, {
@@ -414,7 +405,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a directory from the file system', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
       const filesPath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')
 
@@ -423,7 +413,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a directory from the file system with an odd name', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
 
       const filesPath = resolve('test/fixtures/weird name folder [v0]', 'interface-ipfs-core')
@@ -433,7 +422,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should ignore a directory from the file system', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
 
       const filesPath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')
@@ -443,7 +431,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a file from the file system', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
 
       const filePath = resolve('test/fixtures/test-folder', 'interface-ipfs-core')
@@ -454,7 +441,6 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a hidden file in a directory from the file system', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
 
       const filesPath = resolve('test/fixtures', 'interface-ipfs-core')
@@ -465,10 +451,8 @@ export function testAddAll (factory, options) {
     })
 
     it('should add a file with only-hash=true', async function () {
-      // @ts-expect-error this is mocha
       if (!isNode) this.skip()
 
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
 
       const out = await all(ipfs.addAll([{

diff --git a/packages/interface-ipfs-core/src/add.js b/packages/interface-ipfs-core/src/add.js
@@ -73,8 +73,7 @@ export function testAdd (factory, options) {
 
     it('should add a File', async function () {
       if (!supportsFileReader) {
-        // @ts-expect-error this is mocha
-        return this.skip('skip in node')
+        return this.skip()
       }
 
       const fileAdded = await ipfs.add(new File(['should add a File'], 'filename.txt', { type: 'text/plain' }))
@@ -83,8 +82,7 @@ export function testAdd (factory, options) {
 
     it('should add a File as tuple', async function () {
       if (!supportsFileReader) {
-        // @ts-expect-error this is mocha
-        return this.skip('skip in node')
+        return this.skip()
       }
 
       const tuple = {
@@ -212,7 +210,6 @@ export function testAdd (factory, options) {
 
     it('should add readable stream', async function () {
       if (!isNode) {
-        // @ts-expect-error this is mocha
         this.skip()
       }
       const expectedCid = 'QmVv4Wz46JaZJeH5PMV4LGbRiiMKEmszPYY3g6fjGnVXBS'
@@ -264,7 +261,6 @@ export function testAdd (factory, options) {
     })
 
     it('should add with only-hash=true', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const content = String(Math.random() + Date.now())
 
@@ -292,21 +288,18 @@ export function testAdd (factory, options) {
     })
 
     it('should add with mode as string', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mode = '0777'
       await testMode(mode, parseInt(mode, 8))
     })
 
     it('should add with mode as number', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mode = parseInt('0777', 8)
       await testMode(mode, mode)
     })
 
     it('should add with mtime as Date', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = new Date(5000)
       await testMtime(mtime, {
@@ -316,7 +309,6 @@ export function testAdd (factory, options) {
     })
 
     it('should add with mtime as { nsecs, secs }', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = {
         secs: 5,
@@ -326,7 +318,6 @@ export function testAdd (factory, options) {
     })
 
     it('should add with mtime as timespec', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       await testMtime({
         Seconds: 5,
@@ -338,7 +329,6 @@ export function testAdd (factory, options) {
     })
 
     it('should add with mtime as hrtime', async function () {
-      // @ts-expect-error this is mocha
       this.slow(10 * 1000)
       const mtime = process.hrtime()
       await testMtime(mtime, {

diff --git a/packages/interface-ipfs-core/src/dag/export.js b/packages/interface-ipfs-core/src/dag/export.js
@@ -72,7 +72,6 @@ export function testExport (factory, options) {
     })
 
     it('export of shuffled devnet export identical to canonical original', async function () {
-      // @ts-expect-error this is mocha
       this.timeout(360000)
 
       const input = loadFixture('test/fixtures/car/lotus_devnet_genesis.car', 'interface-ipfs-core')
@@ -83,7 +82,6 @@ export function testExport (factory, options) {
     })
 
     it('export of shuffled testnet export identical to canonical original', async function () {
-      // @ts-expect-error this is mocha
       this.timeout(360000)
 
       const input = loadFixture('test/fixtures/car/lotus_testnet_export_128.car', 'interface-ipfs-core')

diff --git a/packages/interface-ipfs-core/src/files/touch.js b/packages/interface-ipfs-core/src/files/touch.js
@@ -53,7 +53,6 @@ export function testTouch (factory, options) {
     after(() => factory.clean())
 
     it('should have default mtime', async function () {
-      // @ts-expect-error this is mocha
       this.slow(5 * 1000)
       const testPath = `/test-${nanoid()}`
 
@@ -74,7 +73,6 @@ export function testTouch (factory, options) {
     })
 
     it('should update file mtime', async function () {
-      // @ts-expect-error this is mocha
       this.slow(5 * 1000)
       const testPath = `/test-${nanoid()}`
       const mtime = new Date()
@@ -92,7 +90,6 @@ export function testTouch (factory, options) {
     })
 
     it('should update directory mtime', async function () {
-      // @ts-expect-error this is mocha
       this.slow(5 * 1000)
       const testPath = `/test-${nanoid()}`
       const mtime = new Date()

diff --git a/packages/interface-ipfs-core/src/files/write.js b/packages/interface-ipfs-core/src/files/write.js
@@ -188,7 +188,6 @@ export function testWrite (factory, options) {
 
     it('writes a small file using a Node stream (Node only)', async function () {
       if (!isNode) {
-        // @ts-expect-error this is mocha
         this.skip()
       }
       const filePath = `/small-file-${Math.random()}.txt`
@@ -205,7 +204,6 @@ export function testWrite (factory, options) {
 
     it('writes a small file using an HTML5 Blob (Browser only)', async function () {
       if (!global.Blob || !global.FileReader) {
-        // @ts-expect-error this is mocha
         return this.skip()
       }
 

diff --git a/packages/interface-ipfs-core/src/key/gen.js b/packages/interface-ipfs-core/src/key/gen.js
@@ -44,7 +44,6 @@ export function testGen (factory, options) {
 
     keyTypes.forEach((kt) => {
       it(`should generate a new ${kt.opts.type || 'default'} key`, async function () {
-        // @ts-expect-error this is mocha
         this.timeout(20 * 1000)
         const name = nanoid()
         const key = await ipfs.key.gen(name, kt.opts)
@@ -61,8 +60,7 @@ export function testGen (factory, options) {
         } catch (/** @type {any} */ err) {
           if (err.code === 'ERR_NOT_IMPLEMENTED') {
             // key export is not exposed over the HTTP API
-            // @ts-expect-error this is mocha
-            this.skip('Cannot verify key type')
+            this.skip()
           }
 
           throw err

diff --git a/packages/interface-ipfs-core/src/key/list.js b/packages/interface-ipfs-core/src/key/list.js
@@ -27,7 +27,6 @@ export function testList (factory, options) {
     after(() => factory.clean())
 
     it('should list all the keys', async function () {
-      // @ts-expect-error this is mocha
       this.timeout(60 * 1000)
 
       const keys = await Promise.all([1, 2, 3].map(() => ipfs.key.gen(nanoid(), { type: 'rsa', size: 2048 })))

diff --git a/packages/interface-ipfs-core/src/key/rename.js b/packages/interface-ipfs-core/src/key/rename.js
@@ -27,7 +27,6 @@ export function testRename (factory, options) {
     after(() => factory.clean())
 
     it('should rename a key', async function () {
-      // @ts-expect-error this is mocha
       this.timeout(30 * 1000)
 
       const oldName = nanoid()

diff --git a/packages/interface-ipfs-core/src/key/rm.js b/packages/interface-ipfs-core/src/key/rm.js
@@ -27,7 +27,6 @@ export function testRm (factory, options) {
     after(() => factory.clean())
 
     it('should rm a key', async function () {
-      // @ts-expect-error this is mocha
       this.timeout(30 * 1000)
 
       const key = await ipfs.key.gen(nanoid(), { type: 'rsa', size: 2048 })

diff --git a/packages/interface-ipfs-core/src/miscellaneous/dns.js b/packages/interface-ipfs-core/src/miscellaneous/dns.js
@@ -38,13 +38,11 @@ export function testDns (factory, options) {
         expect(res).to.match(/\/ipns\/.+$/)
       } catch (/** @type {any} */ err) {
         if (err.message.includes('could not resolve name')) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 
         // happens when running tests offline
         if (err.message.includes(`ECONNREFUSED ${domain}`)) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 
@@ -62,13 +60,11 @@ export function testDns (factory, options) {
         expect(res).to.match(/\/ipfs\/.+$/)
       } catch (/** @type {any} */ err) {
         if (err.message.includes('could not resolve name')) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 
         // happens when running tests offline
         if (err.message.includes(`ECONNREFUSED ${domain}`)) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 
@@ -86,13 +82,11 @@ export function testDns (factory, options) {
         expect(res).to.match(/\/ipfs\/.+$/)
       } catch (/** @type {any} */ err) {
         if (err.message.includes('could not resolve name')) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 
         // happens when running tests offline
         if (err.message.includes(`ECONNREFUSED ${domain}`)) {
-          // @ts-expect-error this is mocha
           return this.skip()
         }
 

diff --git a/packages/interface-ipfs-core/src/miscellaneous/id.js b/packages/interface-ipfs-core/src/miscellaneous/id.js
@@ -59,7 +59,6 @@ export function testId (factory, options) {
     it('should return swarm ports opened after startup', async function () {
       if (isWebWorker) {
         // TODO: webworkers are not currently dialable
-        // @ts-expect-error this is mocha
         return this.skip()
       }
 
@@ -69,7 +68,6 @@ export function testId (factory, options) {
     it('should get the id of another node in the swarm', async function () {
       if (isWebWorker) {
         // TODO: https://github.com/libp2p/js-libp2p-websockets/issues/129
-        // @ts-expect-error this is mocha
         return this.skip()
       }