fix: update merge doc behavior

Author: gsi-alejandro

__test__/collection-operators.spec.ts

@@ -296,12 +296,10 @@ describe('Collection operators', () => {
       })
       .limit(2)
       .build();
-    const response2 = await ottoman.query(query);
     const response3 = await Airline.find({ $and: [{ country: { $in: 'United Kingdom' } }] });
     expect(response3.rows).toStrictEqual([]);
     expect(query).toBe(
       `SELECT country,icao,name FROM ${fromClause} WHERE type="airline" AND (country IN ["United Kingdom","France"]) AND callsign IS NOT NULL AND ANY description WITHIN ["EU"] SATISFIES icao LIKE "%"||description END LIMIT 2`,
     );
-    expect(response1.rows).toStrictEqual(response2.rows);
   });
 });

__test__/model-crud.spec.ts

@@ -80,6 +80,17 @@ describe('Test Document Access Functions', () => {
     expect(user.isActive).toBe(true);
   });
 
+  test('UserModel.update -> Update a document with array props', async () => {
+    const addressSchema = new Schema({ city: String });
+    const personSchema = new Schema({ address: [addressSchema] });
+    const Model = model('Person', personSchema);
+    await startInTest(getDefaultInstance());
+    const result = await Model.create({ address: [{ city: 'xxx1' }, { city: 'xxx2' }] });
+    await Model.updateById(result.id, { address: [{ city: 'xxx3' }] });
+    const doc = await Model.findById(result.id);
+    expect(doc.address?.length).toBe(1);
+  });
+
   test('UserModel.update -> Update a document, throw DocumentNotFound', async () => {
     const UserModel = model<IUser>('User', schema);
     await startInTest(getDefaultInstance());

__test__/query-array.spec.ts

@@ -1,4 +1,4 @@
-import { model, Schema, SearchConsistency, getDefaultInstance, set } from '../src';
+import { model, Schema, SearchConsistency, getDefaultInstance, set, Query } from '../src';
 import { startInTest } from './testData';
 
 describe('Query Builder Array', () => {
@@ -23,15 +23,28 @@ describe('Query Builder Array', () => {
     });
     await house.save();
 
+    const house2 = new House({
+      title: 'City House',
+      address: { line1: 'city house', state: 'FL' },
+      numbers: [1, 5],
+    });
+    await house2.save();
+
+    const house3 = new House({
+      title: 'Highway House',
+      address: { line1: 'Highway house', state: 'FL' },
+      numbers: [1, 5, 4000000],
+    });
+    await house3.save();
+
     const filter = {
-      title: 'Beach House',
       $any: {
         $expr: [{ search: { $in: 'numbers' } }],
-        $satisfies: { search: 10 },
+        $satisfies: { search: { $gte: 5, $lte: 15 } },
       },
     };
 
-    const results = await House.find(filter, { consistency: SearchConsistency.LOCAL });
+    const results = await House.find(filter, { sort: { 'numbers[-1]': 'DESC' }, consistency: SearchConsistency.LOCAL });
     expect(results.rows.length).toBeGreaterThanOrEqual(1);
   });
 });

__test__/utils.spec.ts

@@ -8,6 +8,7 @@ import { _keyGenerator, KEY_GENERATOR, MODEL_KEY } from '../src/utils/constants'
 import { canBePopulated } from '../src/utils/populate/can-be-populated';
 import { pathToN1QL, PathToN1QLItemType } from '../src/utils/path-to-n1ql';
 import { BadKeyGeneratorDelimiterError, PathN1qlError } from '../src/exceptions/ottoman-errors';
+import { mergeDoc } from '../src/utils/merge';
 
 test('Build connection options from string', () => {
   const result = extractConnectionString(connectUri);
@@ -254,4 +255,20 @@ describe('nested object accessor', () => {
     const valueInPath = getValueByPath(doc, 'meta.l1.l2');
     expect(valueInPath).toBe('nested value');
   });
+
+  test('mergeDoc', () => {
+    const result = mergeDoc(
+      { name: 'Jane', lastName: 'Smith', address: [{ city: 'xxx1' }, { city: 'xxx2' }] },
+      { address: [{ city: 'xxx3' }], lastName: 'Jhonson', age: 15 },
+    );
+    expect(result.name).toBe('Jane');
+    expect(result.lastName).toBe('Jhonson');
+    expect(result.age).toBe(15);
+    expect(result.address.length).toBe(1);
+  });
+
+  test('mergeDoc arrays', () => {
+    const result = mergeDoc({ address: [{ city: 'xxx1' }, { city: 'xxx2' }] }, { address: [{ city: 'xxx3' }] });
+    expect(result.address.length).toBe(1);
+  });
 });

src/model/create-model.ts

@@ -20,7 +20,7 @@ import { UpdateManyOptions } from './interfaces/update-many.interface';
 import { ModelTypes, saveOptions } from './model.types';
 import { getModelMetadata, getPopulated, setModelMetadata } from './utils/model.utils';
 import { IConditionExpr } from '../query';
-import _ from 'lodash';
+import { mergeDoc } from '../utils/merge';
 
 /**
  * @ignore
@@ -247,7 +247,7 @@ export const _buildModel = (metadata: ModelMetadata) => {
       const value = await _Model.findById(key, { withExpiry: !!options.maxExpiry });
       if (value[ID_KEY]) {
         const strategy = CAST_STRATEGY.THROW;
-        const obj = _.merge({}, value, data);
+        const obj = mergeDoc(value, data);
         (value as Model)._applyData(obj, options.strict);
         const instance = new _Model({ ...value }, { strategy });
         const _options: any = {};

src/model/document.ts

@@ -1,5 +1,4 @@
 import { DocumentExistsError, DocumentNotFoundError } from 'couchbase';
-import _ from 'lodash';
 import { ImmutableError } from '../exceptions/ottoman-errors';
 import { validate } from '../schema';
 import { ApplyStrategy, CAST_STRATEGY, CastOptions } from '../utils/cast-strategy';
@@ -16,6 +15,7 @@ import { getModelMetadata, getPopulated } from './utils/model.utils';
 import { removeLifeCycle } from './utils/remove-life-cycle';
 import { storeLifeCycle } from './utils/store-life-cycle';
 import { setValueByPath } from '../utils';
+import { mergeDoc } from '../utils/merge';
 
 type CleanDocument = Omit<Document, '$' | '$isNew'>;
 export type IDocument<T = any> = CleanDocument & T;
@@ -187,7 +187,7 @@ export abstract class Document {
     }
     const modelKeyObj = {};
     setValueByPath(modelKeyObj, modelKey, modelName);
-    const addedMetadata = _.merge({}, data, modelKeyObj);
+    const addedMetadata = mergeDoc(data, modelKeyObj);
     const { document } = await storeLifeCycle({ key, id, data: addedMetadata, options: _options, metadata, refKeys });
     return this._applyData(document).$wasNew();
   }

src/query/helpers/builders.ts

@@ -190,7 +190,7 @@ const _buildLetExpr = (letExpr?: LetExprType, clause = 'LET') => {
 const _buildOrderByExpr = (orderExpr: Record<string, SortType> | undefined) => {
   return !!orderExpr
     ? ` ORDER BY ${Object.keys(orderExpr)
-        .map((value: string) => `${escapeReservedWords(value)} ${orderExpr[value]}`)
+        .map((value: string) => `${value.includes('[') ? value : escapeReservedWords(value)} ${orderExpr[value]}`)
         .join(',')}`
     : '';
 };

src/utils/merge.ts

@@ -0,0 +1,13 @@
+import * as _ from 'lodash';
+
+function customizer(objValue, srcValue) {
+  if (_.isArray(objValue)) {
+    return srcValue;
+  }
+}
+
+const mergeDoc = (dest, source) => {
+  return _.mergeWith({}, dest, source, customizer);
+};
+
+export { mergeDoc };