egg-sequelize-autotrx - npm Package Compare versions

Comparing version 0.0.20 to 0.0.21

package.json

 {
   "name": "egg-sequelize-autotrx",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "Auto transaction based on cls-hooked for egg-sequelize plugin",
@@ -5,0 +5,0 @@ "eggPlugin": {

README.md

@@ -27,4 +27,34 @@ # egg-sequelize-autotrx
 
-TODO desc the case with code ...
+After CLS enabled, nested transaction will have unexpected result:
 
+```js
+async nestedTrx () {
+  await this.ctx.model.transaction(async () => {
+    await this.ctx.model.M1.create()
+    await this.ctx.model.transaction(async () => {
+      await this.ctx.model.M2.create()
+      await this.ctx.model.M3.create()
+    })
+    await this.ctx.model.M4.create()
+  })
+}
+```
+
+If error throw out from M4 creation, transaction will rollback creation for M1 and M4. M2 and M3 will be committed. To make all the operations commit and rollback together through out all the transactions, you need help from this plugin.
+
+Internally, this plugin solves the problem by passing parent transaction down to the child transaction:
+
+```js
+async nestedTrx () {
+  await this.ctx.model.transaction(async parentTrx => {
+    await this.ctx.model.M1.create()
+    await this.ctx.model.transaction({ transaction: parentTrx }, async () => {
+      await this.ctx.model.M2.create()
+      await this.ctx.model.M3.create()
+    })
+    await this.ctx.model.M4.create()
+  })
+}
+```
+
 ## Install
@@ -38,4 +68,6 @@
 
-enable CLS of sequelize:
+You need to use egg-sequelize plugin first, and have it CLS enabled with cls-hooked:
 
+### single datasource
+
 ```js
@@ -50,11 +82,41 @@ // config.xx.js
 
-  // single datasource case
+  // use customized sequelize. https://github.com/eggjs/egg-sequelize#customize-sequelize
   config.sequelize = {
-    Sequelize: mySequelize, // use customized sequelize. https://github.com/eggjs/egg-sequelize#customize-sequelize
-    dialect: '',
+    Sequelize: mySequelize, 
+    dialect: 'mysql',
     // ...
   }
+}
+```
 
+### multiple datasource
+
+```js
+// config.xx.js
+const mySequelize1 = require('sequelize')
+const mySequelize2 = require('sequelize')
+const clsNamespace1 = require('cls-hooked').createNamespace('your-namespace1')
+const clsNamespace2 = require('cls-hooked').createNamespace('your-namespace2')
+
+// create multiple namespaces for multiple customized sequelize
+mySequelize1.useCLS(clsNamespace1)
+mySequelize2.useCLS(clsNamespace2)
+
+module.exports = appInfo => {
+  const config = exports = {}
+
   // for multiple datasource, you need setup CLS of each your specific sequelize with different namespaces. https://github.com/eggjs/egg-sequelize#multiple-datasources
-}
+  config.sequelize = {
+    datasources: [{
+      Sequelize: mySequelize1,
+      delegate: 'model1',
+      dialect: 'mysql'
+      // ...
+    }, {
+      Sequelize: mySequelize2,
+      delegate: 'model2',
+      dialect: 'mysql'
+      // ...
+    }]
+  }
 ```
@@ -74,7 +136,6 @@
 
-No configuration required:
-
 ```js
 // {app_root}/config/config.default.js
 exports.sequelizeAutotrx = {
+  // no config required here
 }
@@ -87,3 +148,3 @@ ```
 
-### single datasource
+Let's see a real case:
 
@@ -94,22 +155,14 @@ ```js
   await this.ctx.model.transaction(async () => {
-    // if any of below operations failed, will rollback all
-    await this.createProject()
-    await this.nestedTrx()
-    await this.createUser()
+    await this.ctx.model.Project.create()
+    await this.innerTrx()
+    await this.ctx.model.User.create()
   })
 }
 
-async nestedTrxCanBeExecAlone () {
+async innerTrxCanBeExecAlone () {
   await this.nestedTrx()
 }
 
-async createProject () {
-  await this.ctx.model.Project.create()
-}
-
-async createUser () {
-  await this.ctx.model.User.create()
-}
-
-async nestedTrx () {
+// this transaction can be execute alone, and also can be nested into another transaction
+async innerTrx () {
   await this.ctx.model.transaction(async () => {
@@ -121,4 +174,2 @@ // other model operations
 
-### multiple datasource
-
 ## Questions & Suggestions
@@ -125,0 +176,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11875

increased by16.79%

Number of lines in readme file

175

increased by41.13%

No dependency changes