Use built-in Jest types

Refs #388, https://dev.to/kengotoda/how-to-replace-types-jest-with-jest-globals-and-jest-mock-52mb

.eslintrc.json

@@ -50,5 +50,8 @@
       { "allow": ["fp-ts/*", "fp-ts-contrib/*", "io-ts/*", "hyper-ts/lib/*", "nanohtml/*"] }
     ],
     "quotes": ["error", "single", { "avoidEscape": true }]
+  },
+  "settings": {
+    "import/core-modules": ["@jest/globals"]
   }
 }

jest.config.js

@@ -5,6 +5,7 @@ module.exports = {
       isolatedModules: true,
     },
   },
+  injectGlobals: false,
   preset: 'ts-jest',
   testEnvironment: 'node',
   roots: ['./src/', './test/'],

package.json

@@ -56,7 +56,6 @@
     "@types/express": "^4.17.14",
     "@types/html-escaper": "^3.0.0",
     "@types/http-errors": "^1.8.2",
-    "@types/jest": "^28.1.7",
     "@types/make-fetch-happen": "^10.0.0",
     "@types/markdown-it": "^12.2.3",
     "@types/node": "^16.11.68",

test/home.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import * as E from 'fp-ts/Either'
 import { MediaType, Status } from 'hyper-ts'
 import * as _ from '../src/home'

test/html.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, test } from '@jest/globals'
 import * as _ from '../src/html'
 
 describe('html', () => {

test/infrastructure.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, jest } from '@jest/globals'
 import { Temporal } from '@js-temporal/polyfill'
 import { Doi } from 'doi-ts'
 import fetchMock from 'fetch-mock'

test/legacy-prereview.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import fetchMock from 'fetch-mock'
 import * as E from 'fp-ts/Either'
 import { Status } from 'hyper-ts'

test/log-in.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import fetchMock from 'fetch-mock'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'

test/middleware.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import * as E from 'fp-ts/Either'
 import { MediaType, Status } from 'hyper-ts'
 import * as _ from '../src/middleware'

test/preprint.test.ts

@@ -1,6 +1,8 @@
+import { describe, expect, jest } from '@jest/globals'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import * as _ from '../src/preprint'
 import * as fc from './fc'
 import { runMiddleware } from './middleware'
@@ -29,10 +31,8 @@ describe('preprint', () => {
         ),
       ],
       async (connection, preprint, prereviews) => {
-        const getPreprint: jest.MockedFunction<_.GetPreprintEnv['getPreprint']> = jest.fn(_ => TE.right(preprint))
-        const getPrereviews: jest.MockedFunction<_.GetPrereviewsEnv['getPrereviews']> = jest.fn(_ =>
-          TE.right(prereviews),
-        )
+        const getPreprint: Mock<_.GetPreprintEnv['getPreprint']> = jest.fn(_ => TE.right(preprint))
+        const getPrereviews: Mock<_.GetPrereviewsEnv['getPrereviews']> = jest.fn(_ => TE.right(prereviews))
 
         const actual = await runMiddleware(_.preprint(preprint.id.doi)({ getPreprint, getPrereviews }), connection)()
 

test/review.test.ts

@@ -1,6 +1,8 @@
+import { describe, expect, jest } from '@jest/globals'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import * as _ from '../src/review'
 import * as fc from './fc'
 import { runMiddleware } from './middleware'
@@ -25,7 +27,7 @@ describe('review', () => {
         }),
       ],
       async (id, connection, prereview) => {
-        const getPrereview: jest.MockedFunction<_.GetPrereviewEnv['getPrereview']> = jest.fn(_ => TE.right(prereview))
+        const getPrereview: Mock<_.GetPrereviewEnv['getPrereview']> = jest.fn(_ => TE.right(prereview))
 
         const actual = await runMiddleware(_.review(id)({ getPrereview }), connection)()
 

test/string.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, test } from '@jest/globals'
 import * as D from 'io-ts/Decoder'
 import * as _ from '../src/string'
 import * as fc from './fc'

test/time.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import * as _ from '../src/time'
 import * as fc from './fc'
 

test/user.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import { pipe } from 'fp-ts/function'

test/write-review/write-review-add-author.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { CanAddAuthorsEnv } from '../../src/feature-flags'
 import { UserC } from '../../src/user'
@@ -54,10 +56,8 @@ describe('writeReviewAddAuthor', () => {
       await sessionStore.set(sessionId, UserC.encode(user))
       const formStore = new Keyv()
       await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-      const canAddAuthors: jest.MockedFunction<CanAddAuthorsEnv['canAddAuthors']> = jest.fn(_ => true)
-      const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-        TE.right(preprintTitle),
-      )
+      const canAddAuthors: Mock<CanAddAuthorsEnv['canAddAuthors']> = jest.fn(_ => true)
+      const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
       const actual = await runMiddleware(
         _.writeReviewAddAuthor(preprintDoi)({
           canAddAuthors,

test/write-review/write-review-add-authors.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { UserC } from '../../src/user'
 import * as _ from '../../src/write-review'
@@ -47,9 +49,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => true,
@@ -112,9 +112,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => true,
@@ -182,9 +180,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => true,
@@ -248,9 +244,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => true,
@@ -326,9 +320,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => false,
@@ -395,9 +387,7 @@ describe('writeReviewAddAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAddAuthors(preprintDoi)({
             canAddAuthors: () => false,

test/write-review/write-review-authors.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { UserC } from '../../src/user'
 import * as _ from '../../src/write-review'
@@ -46,9 +48,7 @@ describe('writeReviewAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAuthors(preprintDoi)({
             canAddAuthors: () => canAddAuthors,
@@ -123,9 +123,7 @@ describe('writeReviewAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAuthors(preprintDoi)({
             canAddAuthors: () => canAddAuthors,
@@ -208,9 +206,7 @@ describe('writeReviewAuthors', () => {
         await sessionStore.set(sessionId, UserC.encode(user))
         const formStore = new Keyv()
         await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-        const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-          TE.right(preprintTitle),
-        )
+        const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
         const actual = await runMiddleware(
           _.writeReviewAuthors(preprintDoi)({
             canAddAuthors: () => canAddAuthors,

test/write-review/write-review-change-author.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { CanAddAuthorsEnv } from '../../src/feature-flags'
 import { UserC } from '../../src/user'
@@ -58,10 +60,8 @@ describe('writeReviewChangeAuthor', () => {
       await sessionStore.set(sessionId, UserC.encode(user))
       const formStore = new Keyv()
       await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-      const canAddAuthors: jest.MockedFunction<CanAddAuthorsEnv['canAddAuthors']> = jest.fn(_ => true)
-      const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-        TE.right(preprintTitle),
-      )
+      const canAddAuthors: Mock<CanAddAuthorsEnv['canAddAuthors']> = jest.fn(_ => true)
+      const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
       const actual = await runMiddleware(
         _.writeReviewChangeAuthor(
           preprintDoi,

test/write-review/write-review-competing-interests.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { UserC } from '../../src/user'
 import * as _ from '../../src/write-review'
@@ -56,9 +58,7 @@ describe('writeReviewCompetingInterests', () => {
       await sessionStore.set(sessionId, UserC.encode(user))
       const formStore = new Keyv()
       await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-      const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-        TE.right(preprintTitle),
-      )
+      const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
 
       const actual = await runMiddleware(
         _.writeReviewCompetingInterests(preprintDoi)({ formStore, getPreprintTitle, secret, sessionStore }),

test/write-review/write-review-conduct.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { UserC } from '../../src/user'
 import * as _ from '../../src/write-review'
@@ -55,9 +57,7 @@ describe('writeReviewConduct', () => {
       await sessionStore.set(sessionId, UserC.encode(user))
       const formStore = new Keyv()
       await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-      const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-        TE.right(preprintTitle),
-      )
+      const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
 
       const actual = await runMiddleware(
         _.writeReviewConduct(preprintDoi)({ formStore, getPreprintTitle, secret, sessionStore }),

test/write-review/write-review-persona.test.ts

@@ -1,7 +1,9 @@
+import { describe, expect, jest } from '@jest/globals'
 import cookieSignature from 'cookie-signature'
 import * as E from 'fp-ts/Either'
 import * as TE from 'fp-ts/TaskEither'
 import { MediaType, Status } from 'hyper-ts'
+import type { Mock } from 'jest-mock'
 import Keyv from 'keyv'
 import { UserC } from '../../src/user'
 import * as _ from '../../src/write-review'
@@ -56,9 +58,7 @@ describe('writeReviewPersona', () => {
       await sessionStore.set(sessionId, UserC.encode(user))
       const formStore = new Keyv()
       await formStore.set(`${user.orcid}_${preprintDoi}`, newReview)
-      const getPreprintTitle: jest.MockedFunction<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ =>
-        TE.right(preprintTitle),
-      )
+      const getPreprintTitle: Mock<_.GetPreprintTitleEnv['getPreprintTitle']> = jest.fn(_ => TE.right(preprintTitle))
       const actual = await runMiddleware(
         _.writeReviewPersona(preprintDoi)({ formStore, getPreprintTitle, secret, sessionStore }),
         connection,