feat(search): adds human-readable elapsed time config (#264)

src/methods/create.ts

@@ -41,6 +41,7 @@ export async function create<S extends PropertiesSchema>(properties: Configurati
     avgFieldLength: {},
     fieldLengths: {},
     components: {
+      elapsed: properties.components?.elapsed ?? {},
       tokenizer,
       algorithms: {
         intersectTokenScores: properties.components?.algorithms?.intersectTokenScores ?? intersectTokenScores,

src/methods/search.ts

@@ -1,7 +1,7 @@
 import type { Lyra, PropertiesSchema, ResolveSchema, SearchProperties, TokenMap, TokenScore, BM25Params, BM25OptionalParams, PropertiesBoost, FacetsSearch } from "../types.js";
 import { defaultTokenizerConfig, Language } from "../tokenizer/index.js";
 import { find as radixFind } from "../radix-tree/radix.js";
-import { getNanosecondsTime, sortTokenScorePredicate } from "../utils.js";
+import { formatNanoseconds, getNanosecondsTime, sortTokenScorePredicate } from "../utils.js";
 import { getIndices } from "./common.js";
 import { prioritizeTokenScores, BM25 } from "../algorithms.js";
 import { FacetReturningValue, getFacets } from "../facets.js";
@@ -118,7 +118,7 @@ export type SearchResult<S extends PropertiesSchema> = {
   /**
    * The time taken to search.
    */
-  elapsed: bigint;
+  elapsed: bigint | string;
   /**
    * The facets results.
    */
@@ -297,8 +297,14 @@ export async function search<S extends PropertiesSchema>(
     }
   }
 
+  let elapsed: bigint | string = getNanosecondsTime() - timeStart;
+
+  if (lyra.components.elapsed?.format === "human") {
+    elapsed = formatNanoseconds(elapsed);
+  }
+
   const searchResult: SearchResult<S> = {
-    elapsed: getNanosecondsTime() - timeStart,
+    elapsed,
     hits: results.filter(Boolean),
     count: Object.keys(uniqueDocsIDs).length,
   };

src/types.ts

@@ -59,6 +59,10 @@ export type PropertiesBoost<S extends PropertiesSchema> = {
   [P in keyof S]?: number;
 };
 
+export type ElaspedConfig = {
+  format?: "human" | "raw",
+}
+
 export type Configuration<S extends PropertiesSchema> = {
   /**
    * The structure of the document to be inserted into the database.
@@ -85,6 +89,7 @@ export type Data<S extends PropertiesSchema> = {
 };
 
 export type Components = {
+  elapsed?: ElaspedConfig;
   tokenizer?: TokenizerConfig;
   algorithms?: AlgorithmsConfig;
 };

tests/elapsed.test.ts

@@ -0,0 +1,58 @@
+import t from "tap";
+import { create, insert, search } from "../src/index.js";
+
+t.test("elapsed", t => {
+  t.plan(2);
+
+  t.test("should correctly set elapsed time to a human-readable form", async t => {
+    t.plan(1);
+    const db = await create({
+      schema: {
+        title: "string",
+        body: "string",
+      },
+      components: {
+        elapsed: {
+          format: "human"
+        }
+      }
+    });
+
+    await insert(db, {
+      title: "Hello world",
+      body: "This is a test",
+    });
+
+    const results = await search(db, {
+      term: "test"
+    });
+
+    t.same(typeof results.elapsed, "string");
+  });
+
+  t.test("should correctly set elapsed time to a raw, bigInt", async t => {
+    t.plan(1);
+    const db = await create({
+      schema: {
+        title: "string",
+        body: "string",
+      },
+      components: {
+        elapsed: {
+          format: "raw"
+        }
+      }
+    });
+
+    await insert(db, {
+      title: "Hello world",
+      body: "This is a test",
+    });
+
+    const results = await search(db, {
+      term: "test"
+    });
+
+    t.same(typeof results.elapsed, "bigint");
+  });
+});