feat: add logger

README.md

@@ -30,12 +30,14 @@ const sql = `
     id INTEGER PRIMARY KEY AUTOINCREMENT,
     name TEXT NOT NULL,
     year INTEGER NOT NULL
+    age REAL NOT NULL
   );
-  INSERT INTO names (name, year) VALUES
-  ('John', 1990),
-  ('Jane', 1985),
-  ('Alice', 2000),
-  ('Bob', 1990);
+
+  INSERT INTO names (name, year, age) VALUES
+    ('John', 1990, 30.1),
+    ('Jane', 1985, 29.7),
+    ('Alice', 2000, 25),
+    ('Bob', 1990, 43);
 `;
 db.exec(sql);
 
@@ -52,6 +54,10 @@ search('year:>1990', db); // [{name: 'Alice', year: 2000}]
 search('year:!=1990,2000', db); // [{name: 'Jane', year: 1985}]
 search('year:<>1990,2000', db); // [{name: 'Jane', year: 1985}]
 
+search('age:30', db); // by default we take into account significative digits and it will search between 29.5 and 30.5
+search('age:=30', db); // must be exactly 30, no hit
+search('age:=25', db); // must be exactly 25, 1 hit
+
 // when searching for a string we can use the following operators: '^' (starts with), '$' (ends with), '~' (contains), '='. Default to contains. When searching for '=' it is case sensitive otherwise it is not.
 search('name:~o', db); // [{name: 'John', year: 1990}, {name: 'Bob', year: 1990}]
 search('name:$e', db); // [{name: 'Alice', year: 2000}]

package.json

@@ -43,9 +43,14 @@
     "better-sqlite3": "^11.1.2",
     "eslint": "^8.57.0",
     "eslint-config-cheminfo-typescript": "^14.0.0",
+    "fifo-logger": "^1.0.0",
+    "jest-matcher-deep-close-to": "^3.0.2",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
     "typescript": "^5.5.3",
     "vitest": "^2.0.3"
+  },
+  "dependencies": {
+    "cheminfo-types": "^1.7.3"
   }
 }

src/__tests__/search.names.test.ts

@@ -7,13 +7,20 @@ import { getDBNames } from './utils/getDBNames';
 test('names', () => {
   const db = getDBNames();
   /*
-    ('John', 1990),
-    ('Jane', 1985),
-    ('Alice', 2000),
-    ('Bob', 1990);
+    ('John', 1990, 30.1),
+    ('Jane', 1985, 29.7),
+    ('Alice', 2000, 25),
+    ('Bob', 1990, 43);
   */
   expect(search('John', db)).toHaveLength(1);
   expect(search('1990', db)).toHaveLength(2);
+  expect(search('male:true', db)).toHaveLength(2);
+  expect(search('1990,2000', db)).toHaveLength(3);
+  expect(search('30', db)).toHaveLength(2);
+  expect(search('age:30', db)).toHaveLength(2);
+  expect(search('age:=30', db)).toHaveLength(0);
+  expect(search('age:=25', db)).toHaveLength(1);
+  expect(search('30.00', db)).toHaveLength(0);
   expect(search('J', db)).toHaveLength(2);
   expect(search('year:>1990', db)).toHaveLength(1);
   expect(search('name:~o', db)).toHaveLength(2);
@@ -25,4 +32,5 @@ test('names', () => {
   expect(search('year:1990,2000 name:$e,n', db)).toHaveLength(2);
   expect(search('year:"1990,2000"', db)).toHaveLength(4);
   expect(search('year:"1990","2000"', db)).toHaveLength(3);
+  expect(search('age:"30","25"', db)).toHaveLength(3);
 });

src/__tests__/utils/getDBNames.ts

@@ -8,14 +8,16 @@ export function getDBNames(): Database {
     CREATE TABLE IF NOT EXISTS names (
       id INTEGER PRIMARY KEY AUTOINCREMENT,
       name TEXT NOT NULL,
-      year INTEGER NOT NULL
+      year INTEGER NOT NULL,
+      age REAL NOT NULL,
+      male BOOLEAN NOT NULL
     );
 
-    INSERT INTO names (name, year) VALUES
-    ('John', 1990),
-    ('Jane', 1985),
-    ('Alice', 2000),
-    ('Bob', 1990);
+    INSERT INTO names (name, year, age, male) VALUES
+    ('John', 1990, 30.1, 1),
+    ('Jane', 1985, 29.7, 1),
+    ('Alice', 2000, 25, 0),
+    ('Bob', 1990, 43, 0);
   `;
 
   db.exec(sql);

src/search.ts

@@ -1,4 +1,5 @@
 import { Database } from 'better-sqlite3';
+import { Logger } from 'cheminfo-types';
 
 import { Schema } from './types/Schema';
 import { TableInfo } from './types/TableInfo';
@@ -29,6 +30,10 @@ export interface SearchOptions {
    * It is possible to specify many fields in which the search will be performed
    */
   fieldsAliases?: Record<string, string[]>;
+  /**
+   * We can log more information about how queries are executed
+   */
+  logger?: Logger;
 }
 
 export type Entry = Record<string, number | string>;

src/utils/appendSQLForCriteria.ts

@@ -1,11 +1,16 @@
+import { Logger } from 'cheminfo-types';
+
 import { QueryCriterium } from '../types/QueryCriterium';
 import { Schema } from '../types/Schema';
 
+import { getNumberRange } from './getNumberRange';
+
 type Values = Record<string, number | string>;
 
 interface AppendSQLForCriteriaOptions {
   defaultFields?: string[];
   fieldsAliases?: Record<string, string[]>;
+  logger?: Logger;
 }
 
 /**
@@ -44,12 +49,17 @@ export function appendSQLForCriteria(
   }
   // build the corresponding sql part
   for (const criterium of criteria) {
-    criterium.sql = buildSQL(criterium, schema, values);
+    criterium.sql = buildSQL(criterium, schema, values, options);
   }
   return values;
 }
 
-function buildSQL(criterium: QueryCriterium, schema: Schema, values: Values) {
+function buildSQL(
+  criterium: QueryCriterium,
+  schema: Schema,
+  values: Values,
+  options: AppendSQLForCriteriaOptions,
+) {
   const sql = [];
   for (const field of criterium.fields) {
     const column = schema[field];
@@ -67,15 +77,15 @@ function buildSQL(criterium: QueryCriterium, schema: Schema, values: Values) {
       case 'INT':
       case 'INTEGER':
         {
-          const newSQL = processNumber(field, criterium, values);
+          const newSQL = processNumber(field, criterium, values, options);
           if (newSQL) {
             sql.push(newSQL);
           }
         }
         break;
       case 'BOOLEAN':
         {
-          const newSQL = processBoolean(field, criterium, values);
+          const newSQL = processBoolean(field, criterium, values, options);
           if (newSQL) {
             sql.push(newSQL);
           }
@@ -133,8 +143,10 @@ function processNumber(
   field: string,
   criterium: QueryCriterium,
   values: Values,
+  options: AppendSQLForCriteriaOptions,
 ) {
-  const operator = criterium.operator || '=';
+  const { logger } = options;
+  const operator = criterium.operator || '~';
   const sqls = [];
   let joinOperator = 'OR';
   for (let valueIndex = 0; valueIndex < criterium.values.length; valueIndex++) {
@@ -146,13 +158,28 @@ function processNumber(
     const valueFieldName = `${field}_${criterium.index}_${valueIndex}`;
 
     switch (operator) {
+      case '~':
+        {
+          // we consider by default that a number is not exact by default
+          const { min, max } = getNumberRange(value);
+          values[`${valueFieldName}_min`] = min;
+          values[`${valueFieldName}_max`] = max;
+          sqls.push(
+            `${field} BETWEEN :${valueFieldName}_min AND :${valueFieldName}_max`,
+          );
+        }
+        break;
       case '=':
         values[valueFieldName] = Number(value);
         sqls.push(`${field} = :${valueFieldName}`);
         break;
       case '..':
         {
           const [min, max] = value.split('..').map(Number);
+          if (Number.isNaN(min) || Number.isNaN(max)) {
+            if (logger) logger.info(`Invalid range for ${field}: ${value}`);
+            continue;
+          }
           values[`${valueFieldName}_min`] = min;
           values[`${valueFieldName}_max`] = max;
           sqls.push(
@@ -192,9 +219,12 @@ function processBoolean(
   field: string,
   criterium: QueryCriterium,
   values: Values,
+  options: AppendSQLForCriteriaOptions,
 ) {
+  const { logger } = options;
   if (criterium.values.length > 1) {
-    throw new Error('Boolean does not support multiple values');
+    if (logger) logger.info('Boolean does not support multiple values');
+    return '';
   }
   const value = getBooleanValue(criterium.values[0]);
   if (value === null) {