Ensure that mocked requests are matched

This change uses fetch-mock's 'done' inspection to ensure that it matches the requests as expected to avoid tests passing for the wrong reason (i.e. we didn't mock a response). I think I've found a bug in fetch-mock where it doesn't recognise that it matched a request when testing a query string independently of the URL. It works as expected when only partially matching the URL. Refs #976, 047d979, https://www.wheresrhys.co.uk/fetch-mock/#api-inspectiondone, wheresrhys/fetch-mock#657
PREreview · Jun 15, 2023 · ceea33f · ceea33f
1 parent 047d979
commit ceea33f
Show file tree

Hide file tree

Showing 15 changed files with 220 additions and 145 deletions.
diff --git a/test/about-us.test.ts b/test/about-us.test.ts
@@ -46,14 +46,17 @@ describe('about-us', () => {
     fc.fetchResponse(),
     fc.either(fc.constant('no-session' as const), fc.user()),
   ])('when the page cannot be loaded', async (connection, key, response, user) => {
+    const fetch = fetchMock.sandbox().getOnce(
+      {
+        url: 'begin:https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb14?',
+        query: { key },
+      },
+      response,
+    )
+
     const actual = await runMiddleware(
       _.aboutUs({
-        fetch: fetchMock
-          .sandbox()
-          .getOnce(
-            { url: 'https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb14', query: { key } },
-            response,
-          ),
+        fetch,
         ghostApi: { key },
         getUser: () => M.fromEither(user),
       }),
@@ -68,5 +71,6 @@ describe('about-us', () => {
         { type: 'setBody', body: expect.anything() },
       ]),
     )
+    expect(fetch.done()).toBeTruthy()
   })
 })
diff --git a/test/code-of-conduct.test.ts b/test/code-of-conduct.test.ts
@@ -46,14 +46,17 @@ describe('codeOfConduct', () => {
     fc.fetchResponse(),
     fc.either(fc.constant('no-session' as const), fc.user()),
   ])('when the page cannot be loaded', async (connection, key, response, user) => {
+    const fetch = fetchMock.sandbox().getOnce(
+      {
+        url: 'begin:https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb00?',
+        query: { key },
+      },
+      response,
+    )
+
     const actual = await runMiddleware(
       _.codeOfConduct({
-        fetch: fetchMock
-          .sandbox()
-          .getOnce(
-            { url: 'https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb00', query: { key } },
-            response,
-          ),
+        fetch,
         ghostApi: { key },
         getUser: () => M.fromEither(user),
       }),
@@ -68,5 +71,6 @@ describe('codeOfConduct', () => {
         { type: 'setBody', body: expect.anything() },
       ]),
     )
+    expect(fetch.done()).toBeTruthy()
   })
 })
diff --git a/test/communities.test.ts b/test/communities.test.ts
@@ -46,14 +46,17 @@ describe('communities', () => {
     fc.fetchResponse(),
     fc.either(fc.constant('no-session' as const), fc.user()),
   ])('when the page cannot be loaded', async (connection, key, response, user) => {
+    const fetch = fetchMock.sandbox().getOnce(
+      {
+        url: 'begin:https://content.prereview.org/ghost/api/content/pages/64637b4c07fb34a92c7f84ec?',
+        query: { key },
+      },
+      response,
+    )
+
     const actual = await runMiddleware(
       _.communities({
-        fetch: fetchMock
-          .sandbox()
-          .getOnce(
-            { url: 'https://content.prereview.org/ghost/api/content/pages/64637b4c07fb34a92c7f84ec', query: { key } },
-            response,
-          ),
+        fetch,
         ghostApi: { key },
         getUser: () => M.fromEither(user),
       }),
@@ -68,5 +71,6 @@ describe('communities', () => {
         { type: 'setBody', body: expect.anything() },
       ]),
     )
+    expect(fetch.done()).toBeTruthy()
   })
 })
diff --git a/test/crossref.test.ts b/test/crossref.test.ts
@@ -2256,6 +2256,7 @@ describe('getPreprintFromCrossref', () => {
     const actual = await _.getPreprintFromCrossref(id)({ fetch })()
 
     expect(actual).toStrictEqual(E.left('not-found'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([
@@ -2320,6 +2321,7 @@ describe('getPreprintFromCrossref', () => {
     const actual = await _.getPreprintFromCrossref(id)({ fetch })()
 
     expect(actual).toStrictEqual(E.left('not-a-preprint'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.crossrefPreprintId(), fc.record({ status: fc.integer(), body: fc.string() })])(
@@ -2332,6 +2334,7 @@ describe('getPreprintFromCrossref', () => {
       const actual = await _.getPreprintFromCrossref(id)({ fetch })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     },
   )
 })
diff --git a/test/datacite.test.ts b/test/datacite.test.ts
@@ -888,6 +888,7 @@ describe('getPreprintFromDatacite', () => {
     const actual = await _.getPreprintFromDatacite(id)({ fetch })()
 
     expect(actual).toStrictEqual(E.left('not-found'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.arxivPreprintId(), fc.instant(), fc.string()])(
@@ -1065,6 +1066,7 @@ describe('getPreprintFromDatacite', () => {
       const actual = await _.getPreprintFromDatacite(id)({ fetch })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     },
   )
 })
diff --git a/test/funding.test.ts b/test/funding.test.ts
@@ -46,14 +46,17 @@ describe('funding', () => {
     fc.fetchResponse(),
     fc.either(fc.constant('no-session' as const), fc.user()),
   ])('when the page cannot be loaded', async (connection, key, response, user) => {
+    const fetch = fetchMock.sandbox().getOnce(
+      {
+        url: 'begin:https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb12?',
+        query: { key },
+      },
+      response,
+    )
+
     const actual = await runMiddleware(
       _.funding({
-        fetch: fetchMock
-          .sandbox()
-          .getOnce(
-            { url: 'https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb12', query: { key } },
-            response,
-          ),
+        fetch,
         ghostApi: { key },
         getUser: () => M.fromEither(user),
       }),
@@ -68,5 +71,6 @@ describe('funding', () => {
         { type: 'setBody', body: expect.anything() },
       ]),
     )
+    expect(fetch.done()).toBeTruthy()
   })
 })
diff --git a/test/ghost.test.ts b/test/ghost.test.ts
@@ -87,14 +87,15 @@ describe('getPage', () => {
   ])('when the response cannot be decoded', async (id, key, response) => {
     const fetch = fetchMock
       .sandbox()
-      .getOnce({ url: `https://content.prereview.org/ghost/api/content/pages/${id}`, query: { key } }, response)
+      .getOnce({ url: `begin:https://content.prereview.org/ghost/api/content/pages/${id}?`, query: { key } }, response)
 
     const actual = await _.getPage(id)({
       fetch,
       ghostApi: { key },
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.stringOf(fc.alphanumeric(), { minLength: 1 }), fc.stringOf(fc.alphanumeric(), { minLength: 1 })])(
@@ -123,14 +124,15 @@ describe('getPage', () => {
   ])('when the response has a non-200/404 status code', async (id, key, status) => {
     const fetch = fetchMock
       .sandbox()
-      .getOnce({ url: `https://content.prereview.org/ghost/api/content/pages/${id}`, query: { key } }, status)
+      .getOnce({ url: `begin:https://content.prereview.org/ghost/api/content/pages/${id}?`, query: { key } }, status)
 
     const actual = await _.getPage(id)({
       fetch,
       ghostApi: { key },
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([

diff --git a/test/legacy-prereview.test.ts b/test/legacy-prereview.test.ts
@@ -68,6 +68,7 @@ describe('getPreprintDoiFromLegacyPreviewUuid', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.uuid(), fc.string(), fc.string(), fc.origin(), fc.boolean()])(
@@ -100,6 +101,7 @@ describe('getPreprintDoiFromLegacyPreviewUuid', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.uuid(), fc.string(), fc.string(), fc.origin(), fc.boolean(), fc.error()])(
@@ -173,6 +175,7 @@ describe('getProfileIdFromLegacyPreviewUuid', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.uuid(), fc.string(), fc.string(), fc.origin(), fc.boolean()])(
@@ -205,6 +208,7 @@ describe('getProfileIdFromLegacyPreviewUuid', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.uuid(), fc.string(), fc.string(), fc.origin(), fc.boolean(), fc.error()])(
@@ -278,6 +282,7 @@ describe('getPseudonymFromLegacyPrereview', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   describe('when the response has a 404 status code', () => {
@@ -332,6 +337,7 @@ describe('getPseudonymFromLegacyPrereview', () => {
       })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     })
 
     test.prop([
@@ -361,6 +367,7 @@ describe('getPseudonymFromLegacyPrereview', () => {
       })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     })
   })
 
@@ -381,6 +388,7 @@ describe('getPseudonymFromLegacyPrereview', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 
   test.prop([fc.orcid(), fc.string(), fc.string(), fc.string(), fc.origin(), fc.boolean(), fc.error()])(
@@ -603,16 +611,17 @@ describe('getRapidPreviewsFromLegacyPrereview', () => {
     fc.preprintIdWithDoi(),
     fc.integer({ min: 400, max: 599 }).filter(status => status !== Status.NotFound),
   ])('when the Rapid PREreviews cannot be loaded', async (app, key, url, update, preprintId, status) => {
-    const actual = await _.getRapidPreviewsFromLegacyPrereview(preprintId)({
-      fetch: fetchMock
-        .sandbox()
+    const fetch = fetchMock
+      .sandbox()
+      .getOnce(
+        `${url}api/v2/preprints/doi-${encodeURIComponent(
+          preprintId.value.toLowerCase().replaceAll('-', '+').replaceAll('/', '-'),
+        )}/rapid-reviews`,
+        { status },
+      )
 
-        .getOnce(
-          `${url}api/v2/preprints/doi-${encodeURIComponent(
-            preprintId.value.toLowerCase().replaceAll('-', '+').replaceAll('/', '-'),
-          )}/rapid-reviews`,
-          { status },
-        ),
+    const actual = await _.getRapidPreviewsFromLegacyPrereview(preprintId)({
+      fetch,
       legacyPrereviewApi: {
         app,
         key,
@@ -622,6 +631,7 @@ describe('getRapidPreviewsFromLegacyPrereview', () => {
     })()
 
     expect(actual).toStrictEqual(E.left('unavailable'))
+    expect(fetch.done()).toBeTruthy()
   })
 })
 
@@ -746,6 +756,7 @@ describe('createPrereviewOnLegacyPrereview', () => {
         })()
 
         expect(actual).toStrictEqual(E.left(expect.anything()))
+        expect(fetch.done()).toBeTruthy()
       },
     )
 

diff --git a/test/log-in.test.ts b/test/log-in.test.ts
@@ -268,17 +268,18 @@ describe('authenticate', () => {
     'when a pseudonym cannot be retrieved',
     async (code, [referer], oauth, accessToken, secret, sessionCookie, connection) => {
       const sessionStore = new Keyv()
+      const fetch = fetchMock.sandbox().postOnce(oauth.tokenUrl.href, {
+        status: Status.OK,
+        body: accessToken,
+      })
 
       const actual = await runMiddleware(
         _.authenticate(
           code,
           referer.href,
         )({
           clock: SystemClock,
-          fetch: fetchMock.sandbox().postOnce(oauth.tokenUrl.href, {
-            status: Status.OK,
-            body: accessToken,
-          }),
+          fetch,
           getPseudonym: () => TE.left('unavailable'),
           logger: () => IO.of(undefined),
           oauth,
@@ -300,6 +301,7 @@ describe('authenticate', () => {
           { type: 'setBody', body: expect.anything() },
         ]),
       )
+      expect(fetch.done()).toBeTruthy()
     },
   )
 

diff --git a/test/orcid.test.ts b/test/orcid.test.ts
@@ -82,13 +82,16 @@ describe('getNameFromOrcid', () => {
   test.prop([fc.orcid(), fc.integer({ min: 100, max: 599 }).filter(status => status !== Status.OK)])(
     'when the request fails',
     async (orcid, status) => {
+      const fetch = fetchMock.sandbox().get('*', { status })
+
       const actual = await _.getNameFromOrcid(orcid)({
         clock: SystemClock,
-        fetch: fetchMock.sandbox().get('*', { status }),
+        fetch,
         logger: () => IO.of(undefined),
       })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     },
   )
 

diff --git a/test/philsci.test.ts b/test/philsci.test.ts
@@ -321,6 +321,7 @@ describe('getPreprintFromPhilsci', () => {
       const actual = await _.getPreprintFromPhilsci(id)({ fetch })()
 
       expect(actual).toStrictEqual(E.left('unavailable'))
+      expect(fetch.done()).toBeTruthy()
     },
   )
 })
diff --git a/test/preprint-journal-clubs.test.ts b/test/preprint-journal-clubs.test.ts
@@ -46,14 +46,17 @@ describe('preprintJournalClubs', () => {
     fc.fetchResponse(),
     fc.either(fc.constant('no-session' as const), fc.user()),
   ])('when the page cannot be loaded', async (connection, key, response, user) => {
+    const fetch = fetchMock.sandbox().getOnce(
+      {
+        url: 'begin:https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb10?',
+        query: { key },
+      },
+      response,
+    )
+
     const actual = await runMiddleware(
       _.preprintJournalClubs({
-        fetch: fetchMock
-          .sandbox()
-          .getOnce(
-            { url: 'https://content.prereview.org/ghost/api/content/pages/6154aa157741400e8722bb10', query: { key } },
-            response,
-          ),
+        fetch,
         ghostApi: { key },
         getUser: () => M.fromEither(user),
       }),
@@ -68,5 +71,6 @@ describe('preprintJournalClubs', () => {
         { type: 'setBody', body: expect.anything() },
       ]),
     )
+    expect(fetch.done()).toBeTruthy()
   })
 })