@verdaccio/search 6.0.0-6-next.2 → 7.0.0-next.1

package/build/indexer.d.ts

@@ -1,8 +1,9 @@
-import { Version } from '@verdaccio/types';
+import { Logger, Version } from '@verdaccio/types';
 type Results = any;
 declare class SearchMemoryIndexer {
     private database;
     private storage;
+    private logger;
     /**
      * Set up the {Storage}
      * @param {*} storage An storage reference.
@@ -16,6 +17,7 @@ declare class SearchMemoryIndexer {
      * @return {Array} list of results.
      */
     query(term: string): Promise<Results | void>;
+    private prepareKeywords;
     /**
      * Add a new element to index
      * @param {*} pkg the package
@@ -29,8 +31,8 @@ declare class SearchMemoryIndexer {
     /**
      * Force a re-index.
      */
-    reindex(): void;
-    init(): Promise<void>;
+    reindex(): Promise<void>;
+    init(logger: Logger): Promise<void>;
 }
 declare const _default: SearchMemoryIndexer;
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/search",
-  "version": "6.0.0-6-next.2",
+  "version": "7.0.0-next.1",
   "description": "verdaccio search utitlity tools",
   "main": "./build/dist.js",
   "types": "build/index.d.ts",
@@ -30,9 +30,8 @@
     "npm": ">=6"
   },
   "devDependencies": {
-    "@types/node": "16.18.10",
-    "@verdaccio/types": "11.0.0-6-next.25",
-    "@orama/orama": "1.0.0-beta.16",
+    "@verdaccio/types": "12.0.0-next.0",
+    "@orama/orama": "1.2.1",
     "debug": "4.3.4",
     "esbuild": "0.14.10"
   },
@@ -42,7 +41,7 @@
   },
   "scripts": {
     "clean": "rimraf ./build",
-    "test": "echo 1",
+    "test": "vitest run",
     "type-check": "tsc --noEmit -p tsconfig.build.json",
     "build:types": "tsc --emitDeclarationOnly -p tsconfig.build.json",
     "build:js": "babel src/ --out-dir build/ --copy-files --extensions \".ts,.tsx\" --source-maps",

package/src/indexer.ts

@@ -1,7 +1,7 @@
 import { create, insert, remove, search } from '@orama/orama';
 import buildDebug from 'debug';
 
-import { Version } from '@verdaccio/types';
+import { Logger, Version } from '@verdaccio/types';
 
 const debug = buildDebug('verdaccio:search:indexer');
 
@@ -10,6 +10,7 @@ type Results = any;
 class SearchMemoryIndexer {
   private database: any | undefined;
   private storage: any;
+  private logger: Logger | undefined;
 
   /**
    * Set up the {Storage}
@@ -31,13 +32,21 @@ class SearchMemoryIndexer {
       debug('searching %s at indexer', term);
       const searchResult = await search(this.database, {
         term,
-        properties: '*',
       });
 
       return searchResult;
     }
   }
 
+  private prepareKeywords(keywords?: string[] | string): string {
+    if (typeof keywords === 'undefined') {
+      return '';
+    } else if (typeof keywords === 'string') {
+      return keywords;
+    }
+    return keywords.join(',');
+  }
+
   /**
    * Add a new element to index
    * @param {*} pkg the package
@@ -46,14 +55,15 @@ class SearchMemoryIndexer {
     if (this.database) {
       const name = pkg.name;
       debug('adding item %s to the indexer', name);
-      insert(this.database, {
+      const item = {
         id: name,
         name: name,
         description: pkg.description,
-        version: `v${pkg.version}`,
-        keywords: pkg.keywords,
-        author: pkg._npmUser ? pkg._npmUser.name : '???',
-      });
+        version: pkg.version,
+        keywords: this.prepareKeywords(pkg.keywords),
+        author: pkg._npmUser ? pkg._npmUser.name : '',
+      };
+      await insert(this.database, item);
     }
   }
 
@@ -71,9 +81,9 @@ class SearchMemoryIndexer {
   /**
    * Force a re-index.
    */
-  public reindex(): void {
+  public async reindex(): Promise<void> {
     debug('reindexing search indexer');
-    this.storage?.getLocalDatabase((error, packages): void => {
+    this.storage?.getLocalDatabase(async (error, packages): Promise<void> => {
       if (error) {
         // that function shouldn't produce any
         throw error;
@@ -86,13 +96,18 @@ class SearchMemoryIndexer {
       while (i--) {
         const pkg = packages[i];
         debug('indexing package %s', pkg?.name);
-        this.add(pkg);
+        try {
+          await this.add(pkg);
+        } catch (err: any) {
+          this.logger?.error({ err: err.message }, 'error @{err} indexing package');
+        }
       }
       debug('reindexed search indexer');
     });
   }
 
-  public async init() {
+  public async init(logger: Logger) {
+    this.logger = logger;
     this.database = await create({
       schema: {
         id: 'string',

package/test/index.spec.ts

@@ -0,0 +1,47 @@
+import { expect, test } from 'vitest';
+
+import { Logger } from '@verdaccio/types';
+
+import { SearchMemoryIndexer } from '../src';
+
+class MockStore {
+  getLocalDatabase(cb) {
+    return cb(null, [
+      {
+        name: 'verdaccio-search',
+        version: '1.0.0',
+        readme: 'foo',
+        description: 'foo',
+        keywords: ['foo', 'bar'],
+      },
+      {
+        name: 'verdaccio-utils',
+        version: '2.0.0',
+        readme: 'foo',
+        description: 'foo',
+        keywords: 'some',
+      },
+    ]);
+  }
+}
+
+const logger = {
+  // eslint-disable-next-line no-console
+  error: (...arg) => console.error(...arg),
+} as Logger;
+
+test('should search', async () => {
+  const store = new MockStore();
+
+  SearchMemoryIndexer.configureStorage(store);
+  await SearchMemoryIndexer.init(logger);
+  // @ts-expect-error
+  await SearchMemoryIndexer.add({
+    name: 'verdaccio',
+    version: '2.0.0',
+    readme: 'foo',
+    description: '',
+  });
+  const query = await SearchMemoryIndexer.query('verdaccio');
+  expect(query.hits.map((item) => item.id)).toEqual(['verdaccio', 'verdaccio-utils']);
+});