upgrade context finalize process (#201)

* upgrade data context finalize process * 2.18.2
themost-framework · Feb 3, 2025 · 2389e94 · 2389e94
1 parent 919e0f3
commit 2389e94
Show file tree

Hide file tree

Showing 15 changed files with 74 additions and 51 deletions.
diff --git a/data-context.js b/data-context.js
@@ -40,9 +40,9 @@ var { DataModel } = require('./data-model');
 function DefaultDataContext()
 {
     /**
-     * @type {DataAdapter|*}
+     * @type {import('./types').DataAdapter}
      */
-    var db_= null;
+    var _db= null;
     /**
      * @name DataAdapter#hasConfiguration
      * @type {Function}
@@ -51,10 +51,15 @@ function DefaultDataContext()
     /**
      * @private
      */
-    this.finalize_ = function() {
-        if (db_)
-            db_.close();
-        db_=null;
+    this._finalize = function(cb) {
+        if (_db) {
+            return _db.close(function(err) {
+                // destroy db context
+                _db = null;
+                return cb(err);
+            });
+        }
+        return cb();
     };
     var self = this;
     // set data context name with respect to DataContext implementation
@@ -69,8 +74,8 @@ function DefaultDataContext()
 
     self.getDb = function() {
 
-        if (db_)
-            return db_;
+        if (_db)
+            return _db;
         var er;
         //otherwise load database options from configuration
         var strategy = self.getConfiguration().getStrategy(DataConfigurationStrategy);
@@ -96,31 +101,31 @@ function DefaultDataContext()
         var AdapterTypeCtor = adapterType.type;
         // create adapter instance
         if (typeof  AdapterTypeCtor === 'function') {
-            db_ = new AdapterTypeCtor(adapter.options);
+            _db = new AdapterTypeCtor(adapter.options);
         } else if (typeof createInstance === 'function') {
-            db_ = createInstance(adapter.options);
+            _db = createInstance(adapter.options);
         } else {
             // throw error
             var err = new Error('The given adapter type is invalid. Adapter type constructor is undefined.');
             err.code = 'ERR_ADAPTER_TYPE';
             throw err;
         }
-        if (typeof db_.hasConfiguration === 'function') {
-            db_.hasConfiguration(function() {
+        if (typeof _db.hasConfiguration === 'function') {
+            _db.hasConfiguration(function() {
                return self.getConfiguration();
             });
         }
-        return db_;
+        return _db;
     };
 
     self.setDb = function(value) {
         /**
          * @type {DataAdapter|*}
          */
-        db_ = value;
-        if (db_) {
-            if (typeof db_.hasConfiguration === 'function') {
-                db_.hasConfiguration(function() {
+        _db = value;
+        if (_db) {
+            if (typeof _db.hasConfiguration === 'function') {
+                _db.hasConfiguration(function() {
                     return self.getConfiguration();
                 });
             }
@@ -192,8 +197,13 @@ DefaultDataContext.prototype.model = function(name) {
  */
 DefaultDataContext.prototype.finalize = function(cb) {
     cb = cb || function () {};
-    this.finalize_();
-    cb.call(this);
+    void this._finalize(function(err) {
+        if (err) {
+            TraceUtils.error('An error occurred while finalizing the underlying database context.');
+            TraceUtils.error(err);
+        }
+        return cb();
+    });
 };
 
 
@@ -212,27 +222,26 @@ function NamedDataContext(name)
      * @type {DataAdapter}
      * @private
      */
-    var db_;
+    var _db;
     /**
      * @private
      */
-    this.finalize_ = function() {
-        try {
-            if (db_)
-                db_.close();
-        }
-        catch(err) {
-            TraceUtils.debug('An error occurred while closing the underlying database context.');
-            TraceUtils.debug(err);
+    this._finalize = function(cb) {
+        if (_db) {
+            return _db.close(function(err) {
+                // destroy db context
+                _db = null;
+                return cb(err);
+            });
         }
-        db_ = null;
+        return cb();
     };
     var self = this;
     self[nameProperty] = name;
 
     self.getDb = function() {
-        if (db_)
-            return db_;
+        if (_db)
+            return _db;
         var strategy = self.getConfiguration().getStrategy(DataConfigurationStrategy);
         //otherwise load database options from configuration
         var adapter = strategy.adapters.find(function(x) {
@@ -251,31 +260,31 @@ function NamedDataContext(name)
         var AdapterTypeCtor = adapterType.type;
         // create adapter instance
         if (typeof  AdapterTypeCtor === 'function') {
-            db_ = new AdapterTypeCtor(adapter.options);
+            _db = new AdapterTypeCtor(adapter.options);
         } else if (typeof createInstance === 'function') {
-            db_ = createInstance(adapter.options);
+            _db = createInstance(adapter.options);
         } else {
             // throw error
             var err = new Error('The given adapter type is invalid. Adapter type constructor is undefined.');
             err.code = 'ERR_ADAPTER_TYPE';
             throw err;
         }
-        if (typeof db_.hasConfiguration === 'function') {
-            db_.hasConfiguration(function() {
+        if (typeof _db.hasConfiguration === 'function') {
+            _db.hasConfiguration(function() {
                 return self.getConfiguration();
             });
         }
-        return db_;
+        return _db;
     };
 
     /**
      * @param {DataAdapter|*} value
      */
     self.setDb = function(value) {
-        db_ = value;
-        if (db_) {
-            if (typeof db_.hasConfiguration === 'function') {
-                db_.hasConfiguration(function() {
+        _db = value;
+        if (_db) {
+            if (typeof _db.hasConfiguration === 'function') {
+                _db.hasConfiguration(function() {
                     return self.getConfiguration();
                 });
             }
@@ -364,8 +373,13 @@ NamedDataContext.prototype.model = function(name) {
 
 NamedDataContext.prototype.finalize = function(cb) {
     cb = cb || function () {};
-    this.finalize_();
-    cb.call(this);
+    this._finalize(function(err) {
+        if (err) {
+            TraceUtils.error('An error occurred while finalizing the underlying database context.');
+            TraceUtils.error(err);
+        }
+        cb();
+    });
 };
 
 module.exports = {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@themost/data",
-  "version": "2.18.1",
+  "version": "2.18.2",
   "description": "MOST Web Framework Codename Blueshift - Data module",
   "main": "index.js",
   "scripts": {

diff --git a/spec/DataAssociationMapping.spec.ts b/spec/DataAssociationMapping.spec.ts
@@ -10,6 +10,7 @@ describe('DataAssociationMapping', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     })
     it('should get item children (for one-to-many association)', async () => {

diff --git a/spec/DataAttributeResolver.spec.ts b/spec/DataAttributeResolver.spec.ts
@@ -12,6 +12,7 @@ describe('DataAttributeResolver', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     })
     it('should resolve child nested attributes', async () => {

diff --git a/spec/DataNestedObjectListener.spec.ts b/spec/DataNestedObjectListener.spec.ts
@@ -13,7 +13,7 @@ describe('DataNestedObjectListener', () => {
         return done();
     });
     afterAll(async () => {
-        await context.finalize();
+        await context.finalizeAsync();
         await app.finalize();
     });
     it('should use zero-or-one multiplicity', async () => {

diff --git a/spec/DataObjectAssociationListener.spec.ts b/spec/DataObjectAssociationListener.spec.ts
@@ -12,7 +12,7 @@ describe('DataObjectAssociationListener', () => {
         return done();
     });
     afterAll(async () => {
-        await context.finalize();
+        await context.finalizeAsync();
         await app.finalize();
     });
     it('should validate foreign-key association', async ()=> {

diff --git a/spec/DataObjectJunction.spec.ts b/spec/DataObjectJunction.spec.ts
@@ -11,6 +11,7 @@ describe('DataObjectJunction', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     });
 

diff --git a/spec/DataObjectTag.spec.ts b/spec/DataObjectTag.spec.ts
@@ -12,6 +12,7 @@ describe('DataObjectTag', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     });
 

diff --git a/spec/DataValueResolver.spec.ts b/spec/DataValueResolver.spec.ts
@@ -10,6 +10,7 @@ describe('DataValueResolver', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     })
     it('should resolve value from an associated parent object', async () => {

diff --git a/spec/FunctionContext.spec.ts b/spec/FunctionContext.spec.ts
@@ -13,6 +13,7 @@ describe('FunctionContext', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     });
 

diff --git a/spec/HasParentJunction.spec.ts b/spec/HasParentJunction.spec.ts
@@ -11,6 +11,7 @@ describe('HasParentJunction', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     });
 

diff --git a/spec/OnExecuteNestedQueryable.spec.ts b/spec/OnExecuteNestedQueryable.spec.ts
@@ -5,19 +5,22 @@ import { DataConfigurationStrategy } from '../data-configuration';
 import { OnExecuteNestedQueryable } from '../OnExecuteNestedQueryable';
 import { TestUtils } from './adapter/TestUtils';
 import { TestApplication2 } from './TestApplication';
+import { DataContext } from 'types';
 
 describe('OnExecuteNestedQueryable', () => {
     let app: TestApplication2;
+    let context: DataContext;
     beforeAll((done) => {
         app = new TestApplication2();
+        context = app.createContext();
         return done();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     })
     it('should find listener', () => {
         expect(app).toBeTruthy();
-        const context = app.createContext();
         const model = context.model('Product');
         expect(model).toBeTruthy();
         let listeners = model.rawListeners('before.execute');
@@ -35,7 +38,6 @@ describe('OnExecuteNestedQueryable', () => {
     });
 
     it('should use nested query', async () => {
-        const context = app.createContext();
         let Actions = context.model('Action');
         const beforeExecute = OnExecuteNestedQueryable.prototype.beforeExecute;
         Actions.removeListener('before.execute', beforeExecute);
@@ -47,14 +49,12 @@ describe('OnExecuteNestedQueryable', () => {
     });
 
     it('should use nested many-to-one query', async () => {
-        const context = app.createContext();
         let Orders = context.model('Order');
         await expect(Orders.where('customer/gender/alternateName')
         .equal('Female').silent().getItems()).resolves.toBeTruthy();
     });
 
     it('should use nested one-to-many query', async () => {
-        const context = app.createContext();
         let People = context.model('Person');
         await expect(People.where('orders/orderStatus/alternateName')
             .equal('OrderProblem').silent().getItems()).resolves.toBeTruthy();

diff --git a/spec/ParentChildRelationship.spec.ts b/spec/ParentChildRelationship.spec.ts
@@ -11,6 +11,7 @@ describe('ParentChildRelationship', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     });
 

diff --git a/spec/ZeroOneMultiplicity.spec.ts b/spec/ZeroOneMultiplicity.spec.ts
@@ -26,6 +26,7 @@ describe('ZeroOrOneMultiplicity', () => {
         context = app.createContext();
     });
     afterAll(async () => {
+        await context.finalizeAsync();
         await app.finalize();
     })
     it('should use zero or one multiplicity', async () => {