fix: expiresAt can be a numericFilter (#664)

src/@types/pkg.ts

@@ -75,7 +75,7 @@ export interface RawPkg {
   moduleTypes: ModuleType[];
   lastCrawl: string;
   _searchInternal: {
-    expiresAt: string;
+    expiresAt: number;
     alternativeNames: string[];
   };
 }

src/__tests__/__snapshots__/formatPkg.test.ts.snap

@@ -8,7 +8,7 @@ Object {
       "0.js",
       "0js",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -721,7 +721,7 @@ Object {
       "@atlaskit/inputjs",
       "@atlaskit/input",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -921,7 +921,7 @@ Object {
       "@atomic-package/tabjs",
       "@atomic-package/tab",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1043,7 +1043,7 @@ Object {
       "create-instantsearch-appjs",
       "create-instantsearch-app",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {
     "create-instantsearch-app": "src/cli/index.js",
@@ -1169,7 +1169,7 @@ Object {
       "indexof.js",
       "indexofjs",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1255,7 +1255,7 @@ Object {
       "prismjs",
       "prism",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1459,7 +1459,7 @@ Object {
       "long-boyjs",
       "long-boy",
     ],
-    "expiresAt": Any<String>,
+    "expiresAt": Any<Number>,
   },
   "bin": Object {},
   "computedKeywords": Array [],

src/__tests__/formatPkg.test.ts

@@ -63,7 +63,7 @@ it('transforms correctly', () => {
         {
           lastCrawl: expect.any(String),
           _searchInternal: {
-            expiresAt: expect.any(String),
+            expiresAt: expect.any(Number),
           },
         },
         formattedPackage.objectID
@@ -104,7 +104,7 @@ it('truncates long readmes', () => {
     readme: expect.any(String),
     lastCrawl: expect.any(String),
     _searchInternal: {
-      expiresAt: expect.any(String),
+      expiresAt: expect.any(Number),
     },
   });
 });
@@ -692,7 +692,7 @@ describe('deprecated', () => {
       isDeprecated: true,
       deprecatedReason: 'Yes this is deprecated',
       _searchInternal: {
-        expiresAt: expect.any(String),
+        expiresAt: expect.any(Number),
       },
     });
   });

src/__tests__/saveDocs.test.ts

@@ -207,7 +207,7 @@ it('should be similar batch vs one', async () => {
     modified: expect.any(Number),
     _searchInternal: expect.objectContaining({
       downloadsMagnitude: expect.any(Number),
-      expiresAt: expect.any(String),
+      expiresAt: expect.any(Number),
     }),
   });
 
@@ -220,5 +220,8 @@ it('should be similar batch vs one', async () => {
   expect(single).toMatchObject({
     ...batch,
     lastCrawl: expect.any(String),
+    _searchInternal: {
+      expiresAt: expect.any(Number),
+    },
   });
 });

src/config.ts

@@ -20,7 +20,6 @@ const indexSettings: Settings = {
     'types.ts',
     'moduleTypes',
     'popular',
-    '_searchInternal.expiresAt',
   ],
   customRanking: [
     'desc(_searchInternal.downloadsMagnitude)',

src/formatPkg.ts

@@ -177,9 +177,7 @@ export default function formatPkg(pkg: GetPackage): RawPkg | undefined {
     lastCrawl: new Date().toISOString(),
     _searchInternal: {
       alternativeNames,
-      expiresAt: new Date(Date.now() + config.expiresAt)
-        .toISOString()
-        .split('T')[0],
+      expiresAt: new Date(Date.now() + config.expiresAt).getTime(),
     },
   };
 

src/jsDelivr/__test__/index.test.ts

@@ -11,6 +11,8 @@ jest.mock('../../utils/log', () => {
   };
 });
 
+jest.setTimeout(10000);
+
 beforeEach(() => {
   jest.resetAllMocks();
 });

src/npm/__tests__/index.test.ts

@@ -1,5 +1,7 @@
 import * as api from '../index';
 
+jest.setTimeout(10000);
+
 describe('findAll()', () => {
   it('contains the correct keys', async () => {
     const all = await api.findAll({ limit: 2, startkey: '0' });
@@ -152,7 +154,7 @@ describe('getDownloads()', () => {
         _searchInternal: {
           popularName: 'jest',
           downloadsMagnitude: expect.any(Number),
-          expiresAt: expect.any(String),
+          expiresAt: expect.any(Number),
         },
       }),
       expect.objectContaining({
@@ -163,7 +165,7 @@ describe('getDownloads()', () => {
         _searchInternal: {
           popularName: '@angular/core',
           downloadsMagnitude: expect.any(Number),
-          expiresAt: expect.any(String),
+          expiresAt: expect.any(Number),
         },
       }),
       expect.objectContaining({
@@ -173,6 +175,7 @@ describe('getDownloads()', () => {
         popular: false,
         _searchInternal: {
           downloadsMagnitude: expect.any(Number),
+          expiresAt: expect.any(Number),
         },
       }),
     ]);

src/npm/index.ts

@@ -11,7 +11,7 @@ import type {
 import nano from 'nano';
 import numeral from 'numeral';
 
-import type { RawPkg } from '../@types/pkg';
+import type { FinalPkg, RawPkg } from '../@types/pkg';
 import { config } from '../config';
 import { datadog } from '../utils/datadog';
 import { log } from '../utils/log';
@@ -25,11 +25,10 @@ type GetDownload = {
   humanDownloadsLast30Days: string;
   downloadsRatio: number;
   popular: boolean;
-  _searchInternal: {
-    expiresAt?: string;
-    popularName?: string;
-    downloadsMagnitude: number;
-  };
+  _searchInternal: Pick<
+    FinalPkg['_searchInternal'],
+    'expiresAt' | 'popularName' | 'downloadsMagnitude'
+  >;
 };
 let cacheTotalDownloads: { total: number; date: number } | undefined;
 
@@ -311,22 +310,28 @@ function computeDownload(
     ? downloadsLast30Days.toString().length
     : 0;
 
+  // Rand -48h to +48h, to spread refresh
+  const randHours = Math.floor(Math.random() * (-48 - 48 + 1)) + 48;
+  const expiresAt =
+    new Date(
+      Date.now() + (popular ? config.popularExpiresAt : config.expiresAt)
+    ).getTime() +
+    randHours * 3600 * 1000;
+
   return {
     downloadsLast30Days,
     humanDownloadsLast30Days: numeral(downloadsLast30Days).format('0.[0]a'),
     downloadsRatio,
     popular,
     _searchInternal: {
+      expiresAt,
+      downloadsMagnitude,
       // if the package is popular, we copy its name to a dedicated attribute
       // which will make popular records' `name` matches to be ranked higher than other matches
       // see the `searchableAttributes` index setting
       ...(popular && {
         popularName: pkg.name,
-        expiresAt: new Date(Date.now() + config.popularExpiresAt)
-          .toISOString()
-          .split('T')[0],
       }),
-      downloadsMagnitude,
     },
   };
 }