fix: add expiresAt field (#643)

algolia · Jul 5, 2021 · dba5d2a · dba5d2a
1 parent 8ef8425
commit dba5d2a
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 1 deletion.
diff --git a/src/@types/pkg.ts b/src/@types/pkg.ts
@@ -75,6 +75,7 @@ export interface RawPkg {
   moduleTypes: ModuleType[];
   lastCrawl: string;
   _searchInternal: {
+    expiresAt: string;
     alternativeNames: string[];
   };
 }

diff --git a/src/__tests__/__snapshots__/formatPkg.test.ts.snap b/src/__tests__/__snapshots__/formatPkg.test.ts.snap
@@ -8,6 +8,7 @@ Object {
       "0.js",
       "0js",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -721,6 +722,7 @@ Object {
       "@atlaskit/inputjs",
       "@atlaskit/input",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -921,6 +923,7 @@ Object {
       "@atomic-package/tabjs",
       "@atomic-package/tab",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1043,6 +1046,7 @@ Object {
       "create-instantsearch-appjs",
       "create-instantsearch-app",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {
     "create-instantsearch-app": "src/cli/index.js",
@@ -1169,6 +1173,7 @@ Object {
       "indexof.js",
       "indexofjs",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1255,6 +1260,7 @@ Object {
       "prismjs",
       "prism",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],
@@ -1459,6 +1465,7 @@ Object {
       "long-boyjs",
       "long-boy",
     ],
+    "expiresAt": Any<String>,
   },
   "bin": Object {},
   "computedKeywords": Array [],

diff --git a/src/__tests__/formatPkg.test.ts b/src/__tests__/formatPkg.test.ts
@@ -62,6 +62,9 @@ it('transforms correctly', () => {
       expect(formattedPackage).toMatchSnapshot(
         {
           lastCrawl: expect.any(String),
+          _searchInternal: {
+            expiresAt: expect.any(String),
+          },
         },
         formattedPackage.objectID
       )
@@ -100,6 +103,9 @@ it('truncates long readmes', () => {
   expect(formatted).toMatchSnapshot({
     readme: expect.any(String),
     lastCrawl: expect.any(String),
+    _searchInternal: {
+      expiresAt: expect.any(String),
+    },
   });
 });
 
@@ -720,6 +726,9 @@ describe('deprecated', () => {
       deprecated: 'Yes this is deprecated',
       isDeprecated: true,
       deprecatedReason: 'Yes this is deprecated',
+      _searchInternal: {
+        expiresAt: expect.any(String),
+      },
     });
   });
 });
diff --git a/src/config.ts b/src/config.ts
@@ -19,6 +19,8 @@ const indexSettings: Settings = {
     'isDeprecated',
     'types.ts',
     'moduleTypes',
+    'popular',
+    '_searchInternal.expiresAt',
   ],
   customRanking: [
     'desc(_searchInternal.downloadsMagnitude)',
@@ -168,6 +170,8 @@ export const config = {
   indexSettings,
   indexSynonyms,
   indexRules,
+  expiresAt: ms('30 days'),
+  popularExpiresAt: ms('7 days'),
 };
 
 export type Config = typeof config;

diff --git a/src/formatPkg.ts b/src/formatPkg.ts
@@ -177,6 +177,9 @@ 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],
     },
   };
 

diff --git a/src/npm/__tests__/index.test.ts b/src/npm/__tests__/index.test.ts
@@ -152,6 +152,7 @@ describe('getDownloads()', () => {
         _searchInternal: {
           popularName: 'jest',
           downloadsMagnitude: expect.any(Number),
+          expiresAt: expect.any(String),
         },
       }),
       expect.objectContaining({
@@ -162,6 +163,7 @@ describe('getDownloads()', () => {
         _searchInternal: {
           popularName: '@angular/core',
           downloadsMagnitude: expect.any(Number),
+          expiresAt: expect.any(String),
         },
       }),
       expect.objectContaining({

diff --git a/src/npm/index.ts b/src/npm/index.ts
@@ -224,6 +224,7 @@ async function getDownloads(pkgs: Array<Pick<RawPkg, 'name'>>): Promise<
     downloadsRatio: number;
     popular: boolean;
     _searchInternal: {
+      expiresAt?: string;
       popularName?: string;
       downloadsMagnitude: number;
     };
@@ -289,7 +290,12 @@ async function getDownloads(pkgs: Array<Pick<RawPkg, 'name'>>): Promise<
         // 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: name }),
+        ...(popular && {
+          popularName: name,
+          expiresAt: new Date(Date.now() + config.popularExpiresAt)
+            .toISOString()
+            .split('T')[0],
+        }),
         downloadsMagnitude,
       },
     };