@naturalcycles/db-lib 8.21.0 → 8.21.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [8.21.1](https://github.com/NaturalCycles/db-lib/compare/v8.21.0...v8.21.1) (2021-10-18)
+
+
+### Bug Fixes
+
+* test for saving/loading undefined values ([e7a8dcf](https://github.com/NaturalCycles/db-lib/commit/e7a8dcff296ba7c8c23c4157510dd79fe7ef1727))
+
 # [8.21.0](https://github.com/NaturalCycles/db-lib/compare/v8.20.1...v8.21.0) (2021-10-18)
 
 

package/dist/adapter/file/file.db.js

@@ -41,7 +41,7 @@ class FileDB extends __1.BaseCommonDB {
     async saveBatch(table, rows, _opt) {
         if (!rows.length)
             return; // save some api calls
-        // 1. Load the whole file from gh
+        // 1. Load the whole file
         const byId = (0, js_lib_1._by)(await this.loadFile(table), r => r.id);
         // 2. Merge with new data (using ids)
         let saved = 0;
@@ -173,6 +173,7 @@ class FileDB extends __1.BaseCommonDB {
      * Mutates
      */
     sortRows(rows) {
+        rows.forEach(r => (0, js_lib_1._filterUndefinedValues)(r, true));
         if (this.cfg.sortOnSave) {
             (0, js_lib_1._sortBy)(rows, r => r[this.cfg.sortOnSave.name], true);
             if (this.cfg.sortOnSave.descending)

package/dist/testing/daoTest.js

@@ -22,7 +22,7 @@ function runCommonDaoTest(db, features = {}, quirks = {}) {
     // tableSchemas = true,
     createTable = true, dbQueryFilter = true, 
     // dbQueryFilterIn = true,
-    dbQueryOrder = true, dbQuerySelectFields = true, streaming = true, strongConsistency = true, } = features;
+    dbQueryOrder = true, dbQuerySelectFields = true, streaming = true, strongConsistency = true, nullValues = true, } = features;
     // const {
     // allowExtraPropertiesInResponse,
     // allowBooleansAsUndefined,
@@ -72,15 +72,28 @@ function runCommonDaoTest(db, features = {}, quirks = {}) {
         expect(await dao.getByIds(['abc', 'abcd'])).toEqual([]);
     });
     // SAVE
-    test('should allow to save and load null values', async () => {
+    if (nullValues) {
+        test('should allow to save and load null values', async () => {
+            const item3 = {
+                ...(0, test_model_1.createTestItemBM)(3),
+                k2: null,
+            };
+            await dao.save(item3);
+            const item3Loaded = await dao.requireById(item3.id);
+            (0, dbTest_1.expectMatch)([item3], [item3Loaded], quirks);
+            expect(item3Loaded.k2).toBe(null);
+        });
+    }
+    test('undefined values should not be saved/loaded', async () => {
         const item3 = {
             ...(0, test_model_1.createTestItemBM)(3),
-            k2: null,
+            k2: undefined,
         };
         await dao.save(item3);
         const item3Loaded = await dao.requireById(item3.id);
         (0, dbTest_1.expectMatch)([item3], [item3Loaded], quirks);
-        expect(item3Loaded.k2).toBe(null);
+        expect(item3Loaded.k2).toBe(undefined);
+        expect(Object.keys(item3Loaded)).not.toContain('k2');
     });
     test('saveBatch test items', async () => {
         const itemsSaved = await dao.saveBatch(items);

package/dist/testing/dbTest.d.ts

@@ -17,6 +17,7 @@ export interface CommonDBImplementationFeatures {
     strongConsistency?: boolean;
     streaming?: boolean;
     bufferSupport?: boolean;
+    nullValues?: boolean;
 }
 /**
  * All options default to `false`.

package/dist/testing/dbTest.js

@@ -12,7 +12,7 @@ const test_util_1 = require("./test.util");
 function runCommonDBTest(db, features = {}, quirks = {}) {
     const { querying = true, tableSchemas = true, createTable = true, dbQueryFilter = true, 
     // dbQueryFilterIn = true,
-    dbQueryOrder = true, dbQuerySelectFields = true, streaming = true, strongConsistency = true, bufferSupport = true, } = features;
+    dbQueryOrder = true, dbQuerySelectFields = true, streaming = true, strongConsistency = true, bufferSupport = true, nullValues = true, } = features;
     // const {
     // allowExtraPropertiesInResponse,
     // allowBooleansAsUndefined,
@@ -58,15 +58,28 @@ function runCommonDBTest(db, features = {}, quirks = {}) {
         expect(await db.getByIds(test_model_1.TEST_TABLE, ['abc', 'abcd'])).toEqual([]);
     });
     // SAVE
-    test('should allow to save and load null values', async () => {
+    if (nullValues) {
+        test('should allow to save and load null values', async () => {
+            const item3 = {
+                ...(0, test_model_1.createTestItemDBM)(3),
+                k2: null,
+            };
+            await db.saveBatch(test_model_1.TEST_TABLE, [item3]);
+            const item3Loaded = (await db.getByIds(test_model_1.TEST_TABLE, [item3.id]))[0];
+            expectMatch([item3], [item3Loaded], quirks);
+            expect(item3Loaded.k2).toBe(null);
+        });
+    }
+    test('undefined values should not be saved/loaded', async () => {
         const item3 = {
             ...(0, test_model_1.createTestItemDBM)(3),
-            k2: null,
+            k2: undefined,
         };
         await db.saveBatch(test_model_1.TEST_TABLE, [item3]);
         const item3Loaded = (await db.getByIds(test_model_1.TEST_TABLE, [item3.id]))[0];
         expectMatch([item3], [item3Loaded], quirks);
-        expect(item3Loaded.k2).toBe(null);
+        expect(item3Loaded.k2).toBe(undefined);
+        expect(Object.keys(item3Loaded)).not.toContain('k2');
     });
     test('saveBatch test items', async () => {
         await db.saveBatch(test_model_1.TEST_TABLE, items);

package/package.json

@@ -42,7 +42,7 @@
   "engines": {
     "node": ">=12.13"
   },
-  "version": "8.21.0",
+  "version": "8.21.1",
   "description": "Lowest Common Denominator API to supported Databases",
   "keywords": [
     "db",

package/src/adapter/file/file.db.ts

@@ -10,6 +10,7 @@ import {
   _stringMapValues,
   _uniq,
   JsonSchemaRootObject,
+  _filterUndefinedValues,
 } from '@naturalcycles/js-lib'
 import { Debug, readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
 import { dimGrey } from '@naturalcycles/nodejs-lib/dist/colors'
@@ -82,7 +83,7 @@ export class FileDB extends BaseCommonDB implements CommonDB {
   ): Promise<void> {
     if (!rows.length) return // save some api calls
 
-    // 1. Load the whole file from gh
+    // 1. Load the whole file
     const byId = _by(await this.loadFile<ROW>(table), r => r.id)
 
     // 2. Merge with new data (using ids)
@@ -261,6 +262,8 @@ export class FileDB extends BaseCommonDB implements CommonDB {
    * Mutates
    */
   sortRows<ROW>(rows: ROW[]): ROW[] {
+    rows.forEach(r => _filterUndefinedValues(r, true))
+
     if (this.cfg.sortOnSave) {
       _sortBy(rows, r => r[this.cfg.sortOnSave!.name], true)
       if (this.cfg.sortOnSave.descending) rows.reverse() // mutates

package/src/testing/daoTest.ts

@@ -39,6 +39,7 @@ export function runCommonDaoTest(
     dbQuerySelectFields = true,
     streaming = true,
     strongConsistency = true,
+    nullValues = true,
   } = features
 
   // const {
@@ -102,15 +103,29 @@ export function runCommonDaoTest(
   })
 
   // SAVE
-  test('should allow to save and load null values', async () => {
+  if (nullValues) {
+    test('should allow to save and load null values', async () => {
+      const item3 = {
+        ...createTestItemBM(3),
+        k2: null,
+      }
+      await dao.save(item3)
+      const item3Loaded = await dao.requireById(item3.id)
+      expectMatch([item3], [item3Loaded], quirks)
+      expect(item3Loaded.k2).toBe(null)
+    })
+  }
+
+  test('undefined values should not be saved/loaded', async () => {
     const item3 = {
       ...createTestItemBM(3),
-      k2: null,
+      k2: undefined,
     }
     await dao.save(item3)
     const item3Loaded = await dao.requireById(item3.id)
     expectMatch([item3], [item3Loaded], quirks)
-    expect(item3Loaded.k2).toBe(null)
+    expect(item3Loaded.k2).toBe(undefined)
+    expect(Object.keys(item3Loaded)).not.toContain('k2')
   })
 
   test('saveBatch test items', async () => {

package/src/testing/dbTest.ts

@@ -34,6 +34,7 @@ export interface CommonDBImplementationFeatures {
   streaming?: boolean
 
   bufferSupport?: boolean
+  nullValues?: boolean
 }
 
 /**
@@ -76,6 +77,7 @@ export function runCommonDBTest(
     streaming = true,
     strongConsistency = true,
     bufferSupport = true,
+    nullValues = true,
   } = features
 
   // const {
@@ -135,15 +137,29 @@ export function runCommonDBTest(
   })
 
   // SAVE
-  test('should allow to save and load null values', async () => {
+  if (nullValues) {
+    test('should allow to save and load null values', async () => {
+      const item3 = {
+        ...createTestItemDBM(3),
+        k2: null,
+      }
+      await db.saveBatch(TEST_TABLE, [item3])
+      const item3Loaded = (await db.getByIds<TestItemDBM>(TEST_TABLE, [item3.id]))[0]!
+      expectMatch([item3], [item3Loaded], quirks)
+      expect(item3Loaded.k2).toBe(null)
+    })
+  }
+
+  test('undefined values should not be saved/loaded', async () => {
     const item3 = {
       ...createTestItemDBM(3),
-      k2: null,
+      k2: undefined,
     }
     await db.saveBatch(TEST_TABLE, [item3])
     const item3Loaded = (await db.getByIds<TestItemDBM>(TEST_TABLE, [item3.id]))[0]!
     expectMatch([item3], [item3Loaded], quirks)
-    expect(item3Loaded.k2).toBe(null)
+    expect(item3Loaded.k2).toBe(undefined)
+    expect(Object.keys(item3Loaded)).not.toContain('k2')
   })
 
   test('saveBatch test items', async () => {