refactor: convert tests to typescript

Author: sushantdhiman

.eslintrc.js

@@ -1,28 +1,17 @@
 module.exports = {
-  extends: ['plugin:prettier/recommended'],
   env: {
     node: true,
     es6: true,
   },
-  overrides: [
-    {
-      files: ['**/*.ts'],
-      extends: [
-        'plugin:prettier/recommended',
-        'plugin:@typescript-eslint/eslint-recommended',
-        'plugin:@typescript-eslint/recommended',
-      ],
-      globals: { Atomics: 'readonly', SharedArrayBuffer: 'readonly' },
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        ecmaVersion: 2020,
-        sourceType: 'module',
-        project: './tsconfig.json',
-      },
-      plugins: ['@typescript-eslint'],
-      rules: {
-        '@typescript-eslint/ban-types': 'off',
-      },
-    },
+  extends: [
+    'plugin:prettier/recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
   ],
+  globals: { Atomics: 'readonly', SharedArrayBuffer: 'readonly' },
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/ban-types': 'off',
+  },
 };

package-lock.json

@@ -19,9 +19,9 @@
     "types"
   ],
   "types": "types",
-  "dependencies": {},
   "devDependencies": {
     "@types/node": "^10.17.60",
+    "@types/tap": "^15.0.7",
     "@typescript-eslint/eslint-plugin": "^5.30.7",
     "@typescript-eslint/parser": "^5.30.7",
     "eslint": "^8.20.0",
@@ -37,12 +37,13 @@
     "node": ">= 10.0.0"
   },
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -b tsconfig-build.json",
+    "types": "tsc",
     "test": "npm run lint && npm run test:raw",
-    "lint": "eslint --ext .js,.ts src/**/* test/**/*",
+    "lint": "eslint --ext .ts src/**/* test/**/*",
     "pretty": "prettier src test --write",
     "docs": "typedoc",
-    "test:raw": "tap test/**/*-test.js"
+    "test:raw": "tap --ts test/**/*-test.ts"
   },
   "prettier": {
     "singleQuote": true

package.json

@@ -2,7 +2,7 @@ import { Deferred } from './Deferred';
 import { AggregateError } from './AggregateError';
 import { defaultTo } from './helpers/defaultTo';
 
-export type LogLevel = 'verbose' | 'info' | 'error';
+export type LogLevel = 'verbose' | 'info' | 'warn' | 'error';
 export type FactoryLogger = (message: string, level: LogLevel) => void;
 
 // Various resources

src/Pool.ts

@@ -1,12 +1,14 @@
-const tap = require('tap');
-const Pool = require('../..').Pool;
+import * as tap from 'tap';
+import { Pool } from '../../src';
 
 tap.test('fail for max < min', (t) => {
   const factory = {
     name: 'test-config',
-    create: () => {},
-    destroy: () => {},
-    validate: () => {},
+    create: async () => Math.random(),
+    destroy: () => {
+      //noop
+    },
+    validate: () => true,
     max: 1,
     min: 12,
   };
@@ -20,13 +22,16 @@ tap.test('fail for max < min', (t) => {
 tap.test('fail without factory.create', (t) => {
   const factory = {
     name: 'test-config',
-    destroy: () => {},
-    validate: () => {},
+    destroy: () => {
+      //noop
+    },
+    validate: () => true,
     max: 1,
     min: 0,
   };
 
   t.throws(() => {
+    // @ts-expect-error validate is required
     new Pool(factory);
   }, 'create function is required');
   t.end();
@@ -35,13 +40,14 @@ tap.test('fail without factory.create', (t) => {
 tap.test('fail without factory.destroy', (t) => {
   const factory = {
     name: 'test-config',
-    create: () => {},
-    validate: () => {},
+    create: async () => Math.random(),
+    validate: () => true,
     max: 1,
     min: 0,
   };
 
   t.throws(() => {
+    // @ts-expect-error destroy is required
     new Pool(factory);
   }, 'destroy function is required');
   t.end();
@@ -50,13 +56,16 @@ tap.test('fail without factory.destroy', (t) => {
 tap.test('fail without factory.validate', (t) => {
   const factory = {
     name: 'test-config',
-    create: () => {},
-    destroy: () => {},
+    create: async () => Math.random(),
+    destroy: () => {
+      //noop
+    },
     max: 1,
     min: 0,
   };
 
   t.throws(() => {
+    // @ts-expect-error validate is required
     new Pool(factory);
   }, 'validate function is required');
   t.end();
@@ -65,20 +74,32 @@ tap.test('fail without factory.validate', (t) => {
 tap.test('correctly defaults', (t) => {
   const factory = {
     name: 'test-config-defaults',
-    create: () => {},
-    destroy: () => {},
+    create: async () => Math.random(),
+    destroy: () => {
+      //noop
+    },
     validate: () => true,
     max: 1,
     min: 0,
     idleTimeoutMillis: 0,
+    // @ts-expect-error need to pass undefined
     acquireTimeoutMillis: undefined,
+    // @ts-expect-error need to pass null
     reapIntervalMillis: null,
   };
 
   const pool = new Pool(factory);
 
+  // eslint-disable-next-line
+  // @ts-ignore
   t.equal(pool.idleTimeoutMillis, 0);
+
+  // eslint-disable-next-line
+  // @ts-ignore
   t.equal(pool.acquireTimeoutMillis, 30000);
+
+  // eslint-disable-next-line
+  // @ts-ignore
   t.equal(pool.reapIntervalMillis, 1000);
 
   t.end();

test/integration/config-test.js test/integration/config-test.tstest/integration/config-test.js renamed to test/integration/config-test.ts

@@ -1,6 +1,6 @@
-const tap = require('tap');
-const Pool = require('../..').Pool;
-const { delay } = require('../utils');
+import * as tap from 'tap';
+import { Pool } from '../../src';
+import { delay } from '../utils';
 
 tap.test('factory.create', (t) => {
   tap.test('handle creation errors', (t) => {
@@ -14,8 +14,10 @@ tap.test('factory.create', (t) => {
           return Promise.resolve({ id: created });
         }
       },
-      destroy: () => {},
-      validate: () => {},
+      destroy: () => {
+        //noop
+      },
+      validate: () => false,
       max: 1,
       min: 0,
       idleTimeoutMillis: 1000,
@@ -51,8 +53,10 @@ tap.test('factory.create', (t) => {
           return delay(10).then(() => Promise.resolve({ id: created }));
         }
       },
-      destroy: () => {},
-      validate: () => {},
+      destroy: () => {
+        //noop
+      },
+      validate: () => false,
       max: 1,
       min: 0,
       idleTimeoutMillis: 1000,

test/integration/create-test.js test/integration/create-test.tstest/integration/create-test.js renamed to test/integration/create-test.ts

@@ -1,12 +1,15 @@
-const tap = require('tap');
-const Pool = require('../..').Pool;
+import * as tap from 'tap';
+import { Pool } from '../../src';
+
 const random = () => Math.floor(Math.random() * 1000);
 
 tap.test('pool.name', (t) => {
   const pool = new Pool({
     name: 'test-pool.name',
     create: () => Promise.resolve({ id: random() }),
-    destroy: () => {},
+    destroy: () => {
+      //noop
+    },
     validate: () => true,
     max: 2,
     min: 0,
@@ -20,7 +23,9 @@ tap.test('pool.size', (t) => {
   const pool = new Pool({
     name: 'test-pool.size',
     create: () => Promise.resolve({ id: random() }),
-    destroy: () => {},
+    destroy: () => {
+      //noop
+    },
     validate: () => true,
     max: 2,
     min: 0,
@@ -55,7 +60,9 @@ tap.test('pool.available', (t) => {
   const pool = new Pool({
     name: 'test-pool.available',
     create: () => Promise.resolve({ id: random() }),
-    destroy: () => {},
+    destroy: () => {
+      //noop
+    },
     validate: () => true,
     max: 2,
     min: 0,