knex 3.2.3 → 3.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/CHANGELOG.md +2447 -2441
  2. package/CONTRIBUTING.md +190 -190
  3. package/LICENSE +22 -22
  4. package/README.md +177 -156
  5. package/UPGRADING.md +245 -245
  6. package/bin/cli.js +516 -516
  7. package/bin/knexfile-runtime-error.js +27 -27
  8. package/bin/utils/cli-config-utils.js +217 -217
  9. package/bin/utils/constants.js +7 -7
  10. package/bin/utils/migrationsLister.js +37 -37
  11. package/knex.js +23 -23
  12. package/knex.mjs +11 -11
  13. package/lib/builder-interface-augmenter.js +120 -120
  14. package/lib/client.js +585 -585
  15. package/lib/constants.js +61 -61
  16. package/lib/dialects/better-sqlite3/index.js +101 -101
  17. package/lib/dialects/cockroachdb/crdb-columncompiler.js +14 -14
  18. package/lib/dialects/cockroachdb/crdb-querybuilder.js +11 -11
  19. package/lib/dialects/cockroachdb/crdb-querycompiler.js +122 -122
  20. package/lib/dialects/cockroachdb/crdb-tablecompiler.js +46 -46
  21. package/lib/dialects/cockroachdb/crdb-viewcompiler.js +15 -15
  22. package/lib/dialects/cockroachdb/index.js +86 -86
  23. package/lib/dialects/index.js +34 -34
  24. package/lib/dialects/mssql/index.js +498 -498
  25. package/lib/dialects/mssql/mssql-formatter.js +34 -34
  26. package/lib/dialects/mssql/query/mssql-querycompiler.js +601 -601
  27. package/lib/dialects/mssql/schema/mssql-columncompiler.js +185 -185
  28. package/lib/dialects/mssql/schema/mssql-compiler.js +91 -91
  29. package/lib/dialects/mssql/schema/mssql-tablecompiler.js +393 -393
  30. package/lib/dialects/mssql/schema/mssql-viewcompiler.js +55 -55
  31. package/lib/dialects/mssql/transaction.js +176 -176
  32. package/lib/dialects/mysql/index.js +317 -317
  33. package/lib/dialects/mysql/query/mysql-querybuilder.js +14 -14
  34. package/lib/dialects/mysql/query/mysql-querycompiler.js +292 -292
  35. package/lib/dialects/mysql/schema/mysql-columncompiler.js +193 -193
  36. package/lib/dialects/mysql/schema/mysql-compiler.js +60 -60
  37. package/lib/dialects/mysql/schema/mysql-tablecompiler.js +426 -426
  38. package/lib/dialects/mysql/schema/mysql-viewbuilder.js +21 -21
  39. package/lib/dialects/mysql/schema/mysql-viewcompiler.js +15 -15
  40. package/lib/dialects/mysql/transaction.js +46 -46
  41. package/lib/dialects/mysql2/index.js +53 -53
  42. package/lib/dialects/mysql2/transaction.js +44 -44
  43. package/lib/dialects/oracle/DEAD_CODE.md +5 -5
  44. package/lib/dialects/oracle/index.js +92 -92
  45. package/lib/dialects/oracle/query/oracle-querycompiler.js +343 -343
  46. package/lib/dialects/oracle/schema/internal/incrementUtils.js +22 -22
  47. package/lib/dialects/oracle/schema/internal/trigger.js +155 -155
  48. package/lib/dialects/oracle/schema/oracle-columnbuilder.js +17 -17
  49. package/lib/dialects/oracle/schema/oracle-columncompiler.js +126 -126
  50. package/lib/dialects/oracle/schema/oracle-compiler.js +124 -124
  51. package/lib/dialects/oracle/schema/oracle-tablecompiler.js +210 -210
  52. package/lib/dialects/oracle/utils.js +107 -107
  53. package/lib/dialects/oracledb/index.js +381 -381
  54. package/lib/dialects/oracledb/query/oracledb-querycompiler.js +481 -481
  55. package/lib/dialects/oracledb/schema/oracledb-columncompiler.js +61 -61
  56. package/lib/dialects/oracledb/schema/oracledb-tablecompiler.js +19 -19
  57. package/lib/dialects/oracledb/schema/oracledb-viewbuilder.js +13 -13
  58. package/lib/dialects/oracledb/schema/oracledb-viewcompiler.js +19 -19
  59. package/lib/dialects/oracledb/transaction.js +98 -98
  60. package/lib/dialects/oracledb/utils.js +208 -208
  61. package/lib/dialects/pgnative/index.js +60 -60
  62. package/lib/dialects/postgres/execution/pg-transaction.js +19 -19
  63. package/lib/dialects/postgres/index.js +373 -373
  64. package/lib/dialects/postgres/query/pg-querybuilder.js +43 -43
  65. package/lib/dialects/postgres/query/pg-querycompiler.js +400 -400
  66. package/lib/dialects/postgres/schema/pg-columncompiler.js +162 -162
  67. package/lib/dialects/postgres/schema/pg-compiler.js +138 -138
  68. package/lib/dialects/postgres/schema/pg-tablecompiler.js +331 -331
  69. package/lib/dialects/postgres/schema/pg-viewbuilder.js +21 -21
  70. package/lib/dialects/postgres/schema/pg-viewcompiler.js +35 -35
  71. package/lib/dialects/redshift/index.js +86 -86
  72. package/lib/dialects/redshift/query/redshift-querycompiler.js +163 -163
  73. package/lib/dialects/redshift/schema/redshift-columnbuilder.js +22 -22
  74. package/lib/dialects/redshift/schema/redshift-columncompiler.js +67 -67
  75. package/lib/dialects/redshift/schema/redshift-compiler.js +14 -14
  76. package/lib/dialects/redshift/schema/redshift-tablecompiler.js +134 -134
  77. package/lib/dialects/redshift/schema/redshift-viewcompiler.js +11 -11
  78. package/lib/dialects/redshift/transaction.js +32 -32
  79. package/lib/dialects/sqlite3/execution/sqlite-transaction.js +172 -172
  80. package/lib/dialects/sqlite3/index.js +263 -263
  81. package/lib/dialects/sqlite3/query/sqlite-querybuilder.js +33 -33
  82. package/lib/dialects/sqlite3/query/sqlite-querycompiler.js +341 -341
  83. package/lib/dialects/sqlite3/schema/ddl.js +380 -380
  84. package/lib/dialects/sqlite3/schema/internal/compiler.js +327 -327
  85. package/lib/dialects/sqlite3/schema/internal/parser-combinator.js +161 -161
  86. package/lib/dialects/sqlite3/schema/internal/parser.js +638 -638
  87. package/lib/dialects/sqlite3/schema/internal/sqlite-ddl-operations.js +41 -41
  88. package/lib/dialects/sqlite3/schema/internal/tokenizer.js +38 -38
  89. package/lib/dialects/sqlite3/schema/internal/utils.js +12 -12
  90. package/lib/dialects/sqlite3/schema/sqlite-columncompiler.js +50 -50
  91. package/lib/dialects/sqlite3/schema/sqlite-compiler.js +80 -80
  92. package/lib/dialects/sqlite3/schema/sqlite-tablecompiler.js +364 -364
  93. package/lib/dialects/sqlite3/schema/sqlite-viewcompiler.js +40 -40
  94. package/lib/execution/batch-insert.js +51 -51
  95. package/lib/execution/internal/delay.js +6 -6
  96. package/lib/execution/internal/ensure-connection-callback.js +41 -41
  97. package/lib/execution/internal/query-executioner.js +62 -62
  98. package/lib/execution/runner.js +325 -325
  99. package/lib/execution/transaction.js +417 -417
  100. package/lib/formatter/formatterUtils.js +42 -42
  101. package/lib/formatter/rawFormatter.js +84 -84
  102. package/lib/formatter/wrappingFormatter.js +253 -253
  103. package/lib/formatter.js +25 -25
  104. package/lib/index.js +3 -3
  105. package/lib/knex-builder/FunctionHelper.js +80 -80
  106. package/lib/knex-builder/Knex.js +59 -59
  107. package/lib/knex-builder/internal/config-resolver.js +57 -57
  108. package/lib/knex-builder/internal/parse-connection.js +87 -87
  109. package/lib/knex-builder/make-knex.js +345 -345
  110. package/lib/logger.js +76 -76
  111. package/lib/migrations/common/MigrationsLoader.js +36 -36
  112. package/lib/migrations/migrate/MigrationGenerator.js +84 -84
  113. package/lib/migrations/migrate/Migrator.js +632 -632
  114. package/lib/migrations/migrate/migrate-stub.js +17 -17
  115. package/lib/migrations/migrate/migration-list-resolver.js +33 -33
  116. package/lib/migrations/migrate/migrator-configuration-merger.js +58 -58
  117. package/lib/migrations/migrate/sources/fs-migrations.js +74 -74
  118. package/lib/migrations/migrate/stub/cjs.stub +15 -15
  119. package/lib/migrations/migrate/stub/coffee.stub +13 -13
  120. package/lib/migrations/migrate/stub/eg.stub +14 -14
  121. package/lib/migrations/migrate/stub/js-schema.stub +22 -22
  122. package/lib/migrations/migrate/stub/js.stub +22 -22
  123. package/lib/migrations/migrate/stub/knexfile-coffee.stub +34 -34
  124. package/lib/migrations/migrate/stub/knexfile-eg.stub +43 -43
  125. package/lib/migrations/migrate/stub/knexfile-js.stub +47 -47
  126. package/lib/migrations/migrate/stub/knexfile-ls.stub +35 -35
  127. package/lib/migrations/migrate/stub/knexfile-ts.stub +47 -47
  128. package/lib/migrations/migrate/stub/ls.stub +14 -14
  129. package/lib/migrations/migrate/stub/mjs.stub +23 -23
  130. package/lib/migrations/migrate/stub/ts-schema.stub +21 -21
  131. package/lib/migrations/migrate/stub/ts.stub +21 -21
  132. package/lib/migrations/migrate/table-creator.js +77 -77
  133. package/lib/migrations/migrate/table-resolver.js +27 -27
  134. package/lib/migrations/seed/Seeder.js +137 -137
  135. package/lib/migrations/seed/seed-stub.js +13 -13
  136. package/lib/migrations/seed/seeder-configuration-merger.js +60 -60
  137. package/lib/migrations/seed/sources/fs-seeds.js +65 -65
  138. package/lib/migrations/seed/stub/coffee.stub +9 -9
  139. package/lib/migrations/seed/stub/eg.stub +11 -11
  140. package/lib/migrations/seed/stub/js.stub +13 -13
  141. package/lib/migrations/seed/stub/ls.stub +11 -11
  142. package/lib/migrations/seed/stub/mjs.stub +12 -12
  143. package/lib/migrations/seed/stub/ts.stub +13 -13
  144. package/lib/migrations/util/fs.js +86 -86
  145. package/lib/migrations/util/import-file.js +12 -12
  146. package/lib/migrations/util/is-module-type.js +9 -9
  147. package/lib/migrations/util/template.js +52 -52
  148. package/lib/migrations/util/timestamp.js +14 -14
  149. package/lib/query/analytic.js +52 -52
  150. package/lib/query/constants.js +15 -15
  151. package/lib/query/joinclause.js +270 -270
  152. package/lib/query/method-constants.js +136 -136
  153. package/lib/query/querybuilder.js +1793 -1793
  154. package/lib/query/querycompiler.js +1634 -1634
  155. package/lib/raw.js +139 -139
  156. package/lib/ref.js +39 -39
  157. package/lib/schema/builder.js +115 -115
  158. package/lib/schema/columnbuilder.js +146 -146
  159. package/lib/schema/columncompiler.js +307 -307
  160. package/lib/schema/compiler.js +187 -187
  161. package/lib/schema/internal/helpers.js +55 -55
  162. package/lib/schema/tablebuilder.js +379 -379
  163. package/lib/schema/tablecompiler.js +450 -450
  164. package/lib/schema/viewbuilder.js +92 -92
  165. package/lib/schema/viewcompiler.js +138 -138
  166. package/lib/util/finally-mixin.js +13 -13
  167. package/lib/util/helpers.js +95 -95
  168. package/lib/util/is.js +32 -32
  169. package/lib/util/nanoid.js +40 -40
  170. package/lib/util/noop.js +1 -1
  171. package/lib/util/save-async-stack.js +14 -14
  172. package/lib/util/security.js +32 -32
  173. package/lib/util/string.js +190 -190
  174. package/lib/util/timeout.js +29 -29
  175. package/package.json +295 -293
  176. package/scripts/act-testing/act.sh +19 -19
  177. package/scripts/act-testing/merged-no-label.json +11 -11
  178. package/scripts/act-testing/merged-patch-labeled.json +12 -12
  179. package/scripts/act-testing/merged-skip-labeled.json +12 -12
  180. package/scripts/act-testing/not-merged-patch-labeled.json +12 -12
  181. package/scripts/build-for-release.sh +121 -121
  182. package/scripts/build.js +125 -125
  183. package/scripts/clean.js +31 -31
  184. package/scripts/docker-compose.yml +150 -150
  185. package/scripts/format-changelog.js +55 -55
  186. package/scripts/next-release-howto.md +24 -24
  187. package/scripts/oracledb-install-driver-libs.sh +82 -82
  188. package/scripts/release.sh +36 -36
  189. package/scripts/runkit-example.js +35 -35
  190. package/scripts/stress-test/README.txt +18 -18
  191. package/scripts/stress-test/docker-compose.yml +55 -55
  192. package/scripts/stress-test/knex-stress-test.js +212 -212
  193. package/scripts/stress-test/mysql2-random-hanging-every-now-and-then.js +149 -149
  194. package/scripts/stress-test/mysql2-sudden-exit-without-error.js +101 -101
  195. package/scripts/stress-test/reconnect-test-mysql-based-drivers.js +188 -188
  196. package/types/index.d.mts +14 -0
  197. package/types/index.d.ts +3321 -3321
  198. package/types/result.d.ts +27 -27
  199. package/types/tables.d.ts +4 -4
@@ -1,417 +1,417 @@
1
- // Transaction
2
- // -------
3
- const { EventEmitter } = require('events');
4
- const Debug = require('debug');
5
- const uniqueId = require('lodash/uniqueId');
6
- const { callbackify } = require('util');
7
-
8
- const makeKnex = require('../knex-builder/make-knex');
9
- const { timeout, KnexTimeoutError } = require('../util/timeout');
10
- const finallyMixin = require('../util/finally-mixin');
11
-
12
- const debug = Debug('knex:tx');
13
-
14
- // FYI: This is defined as a function instead of a constant so that
15
- // each Transactor can have its own copy of the default config.
16
- // This will minimize the impact of bugs that might be introduced
17
- // if a Transactor ever mutates its config.
18
- function DEFAULT_CONFIG() {
19
- return {
20
- userParams: {},
21
- doNotRejectOnRollback: true,
22
- };
23
- }
24
- // These aren't supported in sqlite3 which is serialized already so it's as
25
- // safe as reasonable, except for a special read_uncommitted pragma
26
- const validIsolationLevels = [
27
- // Doesn't really work in postgres, it treats it as read committed
28
- 'read uncommitted',
29
- 'read committed',
30
- 'snapshot',
31
- // snapshot and repeatable read are basically the same, most "repeatable
32
- // read" implementations are actually "snapshot" also known as Multi Version
33
- // Concurrency Control (MVCC). Mssql's repeatable read doesn't stop
34
- // repeated reads for inserts as it uses a pessimistic locking system so
35
- // you should probably use 'snapshot' to stop read skew.
36
- 'repeatable read',
37
- // mysql pretends to have serializable, but it is not
38
- 'serializable',
39
- ];
40
-
41
- // Acts as a facade for a Promise, keeping the internal state
42
- // and managing any child transactions.
43
- class Transaction extends EventEmitter {
44
- constructor(client, container, config = DEFAULT_CONFIG(), outerTx = null) {
45
- super();
46
- this.userParams = config.userParams;
47
- this.doNotRejectOnRollback = config.doNotRejectOnRollback;
48
-
49
- const txid = (this.txid = uniqueId('trx'));
50
-
51
- this.client = client;
52
- this.logger = client.logger;
53
- this.outerTx = outerTx;
54
- this.trxClient = undefined;
55
- this._completed = false;
56
- this._debug = client.config && client.config.debug;
57
-
58
- this.readOnly = config.readOnly;
59
- if (config.isolationLevel) {
60
- this.setIsolationLevel(config.isolationLevel);
61
- }
62
-
63
- debug(
64
- '%s: Starting %s transaction',
65
- txid,
66
- outerTx ? 'nested' : 'top level'
67
- );
68
-
69
- // `this` can potentially serve as an `outerTx` for another
70
- // Transaction. So, go ahead and establish `_lastChild` now.
71
- this._lastChild = Promise.resolve();
72
-
73
- const _previousSibling = outerTx ? outerTx._lastChild : Promise.resolve();
74
-
75
- // FYI: As you will see in a moment, this Promise will be used to construct
76
- // 2 separate Promise Chains. This ensures that each Promise Chain
77
- // can establish its error-handling semantics without interfering
78
- // with the other Promise Chain.
79
- const basePromise = _previousSibling.then(() =>
80
- this._evaluateContainer(config, container)
81
- );
82
-
83
- // FYI: This is the Promise Chain for EXTERNAL use. It ensures that the
84
- // caller must handle any exceptions that result from `basePromise`.
85
- this._promise = basePromise.then((x) => x);
86
-
87
- if (outerTx) {
88
- // FYI: This is the Promise Chain for INTERNAL use. It serves as a signal
89
- // for when the next sibling should begin its execution. Therefore,
90
- // exceptions are caught and ignored.
91
- outerTx._lastChild = basePromise.catch(() => {});
92
- }
93
- }
94
-
95
- isCompleted() {
96
- return (
97
- this._completed || (this.outerTx && this.outerTx.isCompleted()) || false
98
- );
99
- }
100
-
101
- begin(conn) {
102
- const trxMode = [
103
- this.isolationLevel ? `ISOLATION LEVEL ${this.isolationLevel}` : '',
104
- this.readOnly ? 'READ ONLY' : '',
105
- ]
106
- .join(' ')
107
- .trim();
108
-
109
- if (trxMode.length === 0) {
110
- return this.query(conn, 'BEGIN;');
111
- }
112
-
113
- return this.query(conn, `SET TRANSACTION ${trxMode};`).then(() =>
114
- this.query(conn, 'BEGIN;')
115
- );
116
- }
117
-
118
- savepoint(conn) {
119
- return this.query(conn, `SAVEPOINT ${this.txid};`);
120
- }
121
-
122
- commit(conn, value) {
123
- return this.query(conn, 'COMMIT;', 1, value);
124
- }
125
-
126
- release(conn, value) {
127
- return this.query(conn, `RELEASE SAVEPOINT ${this.txid};`, 1, value);
128
- }
129
-
130
- setIsolationLevel(isolationLevel) {
131
- if (!validIsolationLevels.includes(isolationLevel)) {
132
- throw new Error(
133
- `Invalid isolationLevel, supported isolation levels are: ${JSON.stringify(
134
- validIsolationLevels
135
- )}`
136
- );
137
- }
138
- this.isolationLevel = isolationLevel;
139
- return this;
140
- }
141
-
142
- rollback(conn, error) {
143
- return timeout(this.query(conn, 'ROLLBACK', 2, error), 5000).catch(
144
- (err) => {
145
- if (!(err instanceof KnexTimeoutError)) {
146
- return Promise.reject(err);
147
- }
148
- this._rejecter(error);
149
- }
150
- );
151
- }
152
-
153
- rollbackTo(conn, error) {
154
- return timeout(
155
- this.query(conn, `ROLLBACK TO SAVEPOINT ${this.txid}`, 2, error),
156
- 5000
157
- ).catch((err) => {
158
- if (!(err instanceof KnexTimeoutError)) {
159
- return Promise.reject(err);
160
- }
161
- this._rejecter(error);
162
- });
163
- }
164
-
165
- query(conn, sql, status, value) {
166
- const q = this.trxClient
167
- .query(conn, sql)
168
- .catch((err) => {
169
- status = 2;
170
- value = err;
171
- this._completed = true;
172
- debug('%s error running transaction query', this.txid);
173
- })
174
- .then((res) => {
175
- if (status === 1) {
176
- this._resolver(value);
177
- }
178
- if (status === 2) {
179
- if (value === undefined) {
180
- if (this.doNotRejectOnRollback && /^ROLLBACK\b/i.test(sql)) {
181
- this._resolver();
182
- return;
183
- }
184
-
185
- value = new Error(`Transaction rejected with non-error: ${value}`);
186
- }
187
- this._rejecter(value);
188
- }
189
- return res;
190
- });
191
- if (status === 1 || status === 2) {
192
- this._completed = true;
193
- }
194
- return q;
195
- }
196
-
197
- debug(enabled) {
198
- this._debug = arguments.length ? enabled : true;
199
- return this;
200
- }
201
-
202
- async _onAcquire(container, connection) {
203
- const trxClient = (this.trxClient = makeTxClient(
204
- this,
205
- this.client,
206
- connection
207
- ));
208
- const init = this.client.transacting
209
- ? this.savepoint(connection)
210
- : this.begin(connection);
211
- const executionPromise = new Promise((resolver, rejecter) => {
212
- this._resolver = resolver;
213
- this._rejecter = rejecter;
214
- });
215
-
216
- init
217
- .then(() => {
218
- return makeTransactor(this, connection, trxClient);
219
- })
220
- .then((transactor) => {
221
- this.transactor = transactor;
222
- if (this.outerTx) {
223
- transactor.parentTransaction = this.outerTx.transactor;
224
- }
225
- transactor.executionPromise = executionPromise;
226
-
227
- // If we've returned a "thenable" from the transaction container, assume
228
- // the rollback and commit are chained to this object's success / failure.
229
- // Directly thrown errors are treated as automatic rollbacks.
230
- let result;
231
- try {
232
- result = container(transactor);
233
- } catch (err) {
234
- result = Promise.reject(err);
235
- }
236
- if (result && result.then && typeof result.then === 'function') {
237
- result
238
- .then((val) => {
239
- return transactor.commit(val);
240
- })
241
- .catch((err) => {
242
- return transactor.rollback(err);
243
- });
244
- }
245
- return null;
246
- })
247
- .catch((e) => {
248
- return this._rejecter(e);
249
- });
250
-
251
- return executionPromise;
252
- }
253
-
254
- _evaluateContainer(config, container) {
255
- return this.acquireConnection(config, (connection) =>
256
- this._onAcquire(container, connection)
257
- );
258
- }
259
-
260
- // Acquire a connection and create a disposer - either using the one passed
261
- // via config or getting one off the client. The disposer will be called once
262
- // the original promise is marked completed.
263
- async acquireConnection(config, cb) {
264
- const configConnection = config && config.connection;
265
- const connection =
266
- configConnection || (await this.client.acquireConnection());
267
-
268
- try {
269
- connection.__knexTxId = this.txid;
270
- return await cb(connection);
271
- } finally {
272
- if (!configConnection) {
273
- debug('%s: releasing connection', this.txid);
274
- this.client.releaseConnection(connection);
275
- } else {
276
- debug('%s: not releasing external connection', this.txid);
277
- }
278
- }
279
- }
280
-
281
- then(onResolve, onReject) {
282
- return this._promise.then(onResolve, onReject);
283
- }
284
-
285
- catch(...args) {
286
- return this._promise.catch(...args);
287
- }
288
-
289
- asCallback(cb) {
290
- callbackify(() => this._promise)(cb);
291
- return this._promise;
292
- }
293
- }
294
- finallyMixin(Transaction.prototype);
295
-
296
- // The transactor is a full featured knex object, with a "commit", a "rollback"
297
- // and a "savepoint" function. The "savepoint" is just sugar for creating a new
298
- // transaction. If the rollback is run inside a savepoint, it rolls back to the
299
- // last savepoint - otherwise it rolls back the transaction.
300
- function makeTransactor(trx, connection, trxClient) {
301
- const transactor = makeKnex(trxClient);
302
-
303
- transactor.context.withUserParams = () => {
304
- throw new Error(
305
- 'Cannot set user params on a transaction - it can only inherit params from main knex instance'
306
- );
307
- };
308
-
309
- transactor.isTransaction = true;
310
- transactor.userParams = trx.userParams || {};
311
-
312
- transactor.context.transaction = function (container, options) {
313
- if (!options) {
314
- options = { doNotRejectOnRollback: true };
315
- } else if (options.doNotRejectOnRollback === undefined) {
316
- options.doNotRejectOnRollback = true;
317
- }
318
-
319
- return this._transaction(container, options, trx);
320
- };
321
-
322
- transactor.savepoint = function (container, options) {
323
- return transactor.transaction(container, options);
324
- };
325
-
326
- if (trx.client.transacting) {
327
- transactor.commit = (value) => trx.release(connection, value);
328
- transactor.rollback = (error) => trx.rollbackTo(connection, error);
329
- } else {
330
- transactor.commit = (value) => trx.commit(connection, value);
331
- transactor.rollback = (error) => trx.rollback(connection, error);
332
- }
333
-
334
- transactor.isCompleted = () => trx.isCompleted();
335
-
336
- return transactor;
337
- }
338
-
339
- // We need to make a client object which always acquires the same
340
- // connection and does not release back into the pool.
341
- function makeTxClient(trx, client, connection) {
342
- const trxClient = Object.create(client.constructor.prototype);
343
- trxClient.version = client.version;
344
- trxClient.config = client.config;
345
- trxClient.driver = client.driver;
346
- trxClient.connectionSettings = client.connectionSettings;
347
- trxClient.transacting = true;
348
- trxClient.valueForUndefined = client.valueForUndefined;
349
- trxClient.logger = client.logger;
350
-
351
- trxClient.on('start', function (arg) {
352
- trx.emit('start', arg);
353
- client.emit('start', arg);
354
- });
355
-
356
- trxClient.on('query', function (arg) {
357
- trx.emit('query', arg);
358
- client.emit('query', arg);
359
- });
360
-
361
- trxClient.on('query-error', function (err, obj) {
362
- trx.emit('query-error', err, obj);
363
- client.emit('query-error', err, obj);
364
- });
365
-
366
- trxClient.on('query-response', function (response, obj, builder) {
367
- trx.emit('query-response', response, obj, builder);
368
- client.emit('query-response', response, obj, builder);
369
- });
370
-
371
- const _query = trxClient.query;
372
- trxClient.query = function (conn, obj) {
373
- const completed = trx.isCompleted();
374
- return new Promise(function (resolve, reject) {
375
- try {
376
- if (conn !== connection)
377
- throw new Error('Invalid connection for transaction query.');
378
- if (completed) completedError(trx, obj);
379
- resolve(_query.call(trxClient, conn, obj));
380
- } catch (e) {
381
- reject(e);
382
- }
383
- });
384
- };
385
- const _stream = trxClient.stream;
386
- trxClient.stream = function (conn, obj, stream, options) {
387
- const completed = trx.isCompleted();
388
- return new Promise(function (resolve, reject) {
389
- try {
390
- if (conn !== connection)
391
- throw new Error('Invalid connection for transaction query.');
392
- if (completed) completedError(trx, obj);
393
- resolve(_stream.call(trxClient, conn, obj, stream, options));
394
- } catch (e) {
395
- reject(e);
396
- }
397
- });
398
- };
399
- trxClient.acquireConnection = function () {
400
- return Promise.resolve(connection);
401
- };
402
- trxClient.releaseConnection = function () {
403
- return Promise.resolve();
404
- };
405
-
406
- return trxClient;
407
- }
408
-
409
- function completedError(trx, obj) {
410
- const sql = typeof obj === 'string' ? obj : obj && obj.sql;
411
- debug('%s: Transaction completed: %s', trx.txid, sql);
412
- throw new Error(
413
- 'Transaction query already complete, run with DEBUG=knex:tx for more info'
414
- );
415
- }
416
-
417
- module.exports = Transaction;
1
+ // Transaction
2
+ // -------
3
+ const { EventEmitter } = require('events');
4
+ const Debug = require('debug');
5
+ const uniqueId = require('lodash/uniqueId');
6
+ const { callbackify } = require('util');
7
+
8
+ const makeKnex = require('../knex-builder/make-knex');
9
+ const { timeout, KnexTimeoutError } = require('../util/timeout');
10
+ const finallyMixin = require('../util/finally-mixin');
11
+
12
+ const debug = Debug('knex:tx');
13
+
14
+ // FYI: This is defined as a function instead of a constant so that
15
+ // each Transactor can have its own copy of the default config.
16
+ // This will minimize the impact of bugs that might be introduced
17
+ // if a Transactor ever mutates its config.
18
+ function DEFAULT_CONFIG() {
19
+ return {
20
+ userParams: {},
21
+ doNotRejectOnRollback: true,
22
+ };
23
+ }
24
+ // These aren't supported in sqlite3 which is serialized already so it's as
25
+ // safe as reasonable, except for a special read_uncommitted pragma
26
+ const validIsolationLevels = [
27
+ // Doesn't really work in postgres, it treats it as read committed
28
+ 'read uncommitted',
29
+ 'read committed',
30
+ 'snapshot',
31
+ // snapshot and repeatable read are basically the same, most "repeatable
32
+ // read" implementations are actually "snapshot" also known as Multi Version
33
+ // Concurrency Control (MVCC). Mssql's repeatable read doesn't stop
34
+ // repeated reads for inserts as it uses a pessimistic locking system so
35
+ // you should probably use 'snapshot' to stop read skew.
36
+ 'repeatable read',
37
+ // mysql pretends to have serializable, but it is not
38
+ 'serializable',
39
+ ];
40
+
41
+ // Acts as a facade for a Promise, keeping the internal state
42
+ // and managing any child transactions.
43
+ class Transaction extends EventEmitter {
44
+ constructor(client, container, config = DEFAULT_CONFIG(), outerTx = null) {
45
+ super();
46
+ this.userParams = config.userParams;
47
+ this.doNotRejectOnRollback = config.doNotRejectOnRollback;
48
+
49
+ const txid = (this.txid = uniqueId('trx'));
50
+
51
+ this.client = client;
52
+ this.logger = client.logger;
53
+ this.outerTx = outerTx;
54
+ this.trxClient = undefined;
55
+ this._completed = false;
56
+ this._debug = client.config && client.config.debug;
57
+
58
+ this.readOnly = config.readOnly;
59
+ if (config.isolationLevel) {
60
+ this.setIsolationLevel(config.isolationLevel);
61
+ }
62
+
63
+ debug(
64
+ '%s: Starting %s transaction',
65
+ txid,
66
+ outerTx ? 'nested' : 'top level'
67
+ );
68
+
69
+ // `this` can potentially serve as an `outerTx` for another
70
+ // Transaction. So, go ahead and establish `_lastChild` now.
71
+ this._lastChild = Promise.resolve();
72
+
73
+ const _previousSibling = outerTx ? outerTx._lastChild : Promise.resolve();
74
+
75
+ // FYI: As you will see in a moment, this Promise will be used to construct
76
+ // 2 separate Promise Chains. This ensures that each Promise Chain
77
+ // can establish its error-handling semantics without interfering
78
+ // with the other Promise Chain.
79
+ const basePromise = _previousSibling.then(() =>
80
+ this._evaluateContainer(config, container)
81
+ );
82
+
83
+ // FYI: This is the Promise Chain for EXTERNAL use. It ensures that the
84
+ // caller must handle any exceptions that result from `basePromise`.
85
+ this._promise = basePromise.then((x) => x);
86
+
87
+ if (outerTx) {
88
+ // FYI: This is the Promise Chain for INTERNAL use. It serves as a signal
89
+ // for when the next sibling should begin its execution. Therefore,
90
+ // exceptions are caught and ignored.
91
+ outerTx._lastChild = basePromise.catch(() => {});
92
+ }
93
+ }
94
+
95
+ isCompleted() {
96
+ return (
97
+ this._completed || (this.outerTx && this.outerTx.isCompleted()) || false
98
+ );
99
+ }
100
+
101
+ begin(conn) {
102
+ const trxMode = [
103
+ this.isolationLevel ? `ISOLATION LEVEL ${this.isolationLevel}` : '',
104
+ this.readOnly ? 'READ ONLY' : '',
105
+ ]
106
+ .join(' ')
107
+ .trim();
108
+
109
+ if (trxMode.length === 0) {
110
+ return this.query(conn, 'BEGIN;');
111
+ }
112
+
113
+ return this.query(conn, `SET TRANSACTION ${trxMode};`).then(() =>
114
+ this.query(conn, 'BEGIN;')
115
+ );
116
+ }
117
+
118
+ savepoint(conn) {
119
+ return this.query(conn, `SAVEPOINT ${this.txid};`);
120
+ }
121
+
122
+ commit(conn, value) {
123
+ return this.query(conn, 'COMMIT;', 1, value);
124
+ }
125
+
126
+ release(conn, value) {
127
+ return this.query(conn, `RELEASE SAVEPOINT ${this.txid};`, 1, value);
128
+ }
129
+
130
+ setIsolationLevel(isolationLevel) {
131
+ if (!validIsolationLevels.includes(isolationLevel)) {
132
+ throw new Error(
133
+ `Invalid isolationLevel, supported isolation levels are: ${JSON.stringify(
134
+ validIsolationLevels
135
+ )}`
136
+ );
137
+ }
138
+ this.isolationLevel = isolationLevel;
139
+ return this;
140
+ }
141
+
142
+ rollback(conn, error) {
143
+ return timeout(this.query(conn, 'ROLLBACK', 2, error), 5000).catch(
144
+ (err) => {
145
+ if (!(err instanceof KnexTimeoutError)) {
146
+ return Promise.reject(err);
147
+ }
148
+ this._rejecter(error);
149
+ }
150
+ );
151
+ }
152
+
153
+ rollbackTo(conn, error) {
154
+ return timeout(
155
+ this.query(conn, `ROLLBACK TO SAVEPOINT ${this.txid}`, 2, error),
156
+ 5000
157
+ ).catch((err) => {
158
+ if (!(err instanceof KnexTimeoutError)) {
159
+ return Promise.reject(err);
160
+ }
161
+ this._rejecter(error);
162
+ });
163
+ }
164
+
165
+ query(conn, sql, status, value) {
166
+ const q = this.trxClient
167
+ .query(conn, sql)
168
+ .catch((err) => {
169
+ status = 2;
170
+ value = err;
171
+ this._completed = true;
172
+ debug('%s error running transaction query', this.txid);
173
+ })
174
+ .then((res) => {
175
+ if (status === 1) {
176
+ this._resolver(value);
177
+ }
178
+ if (status === 2) {
179
+ if (value === undefined) {
180
+ if (this.doNotRejectOnRollback && /^ROLLBACK\b/i.test(sql)) {
181
+ this._resolver();
182
+ return;
183
+ }
184
+
185
+ value = new Error(`Transaction rejected with non-error: ${value}`);
186
+ }
187
+ this._rejecter(value);
188
+ }
189
+ return res;
190
+ });
191
+ if (status === 1 || status === 2) {
192
+ this._completed = true;
193
+ }
194
+ return q;
195
+ }
196
+
197
+ debug(enabled) {
198
+ this._debug = arguments.length ? enabled : true;
199
+ return this;
200
+ }
201
+
202
+ async _onAcquire(container, connection) {
203
+ const trxClient = (this.trxClient = makeTxClient(
204
+ this,
205
+ this.client,
206
+ connection
207
+ ));
208
+ const init = this.client.transacting
209
+ ? this.savepoint(connection)
210
+ : this.begin(connection);
211
+ const executionPromise = new Promise((resolver, rejecter) => {
212
+ this._resolver = resolver;
213
+ this._rejecter = rejecter;
214
+ });
215
+
216
+ init
217
+ .then(() => {
218
+ return makeTransactor(this, connection, trxClient);
219
+ })
220
+ .then((transactor) => {
221
+ this.transactor = transactor;
222
+ if (this.outerTx) {
223
+ transactor.parentTransaction = this.outerTx.transactor;
224
+ }
225
+ transactor.executionPromise = executionPromise;
226
+
227
+ // If we've returned a "thenable" from the transaction container, assume
228
+ // the rollback and commit are chained to this object's success / failure.
229
+ // Directly thrown errors are treated as automatic rollbacks.
230
+ let result;
231
+ try {
232
+ result = container(transactor);
233
+ } catch (err) {
234
+ result = Promise.reject(err);
235
+ }
236
+ if (result && result.then && typeof result.then === 'function') {
237
+ result
238
+ .then((val) => {
239
+ return transactor.commit(val);
240
+ })
241
+ .catch((err) => {
242
+ return transactor.rollback(err);
243
+ });
244
+ }
245
+ return null;
246
+ })
247
+ .catch((e) => {
248
+ return this._rejecter(e);
249
+ });
250
+
251
+ return executionPromise;
252
+ }
253
+
254
+ _evaluateContainer(config, container) {
255
+ return this.acquireConnection(config, (connection) =>
256
+ this._onAcquire(container, connection)
257
+ );
258
+ }
259
+
260
+ // Acquire a connection and create a disposer - either using the one passed
261
+ // via config or getting one off the client. The disposer will be called once
262
+ // the original promise is marked completed.
263
+ async acquireConnection(config, cb) {
264
+ const configConnection = config && config.connection;
265
+ const connection =
266
+ configConnection || (await this.client.acquireConnection());
267
+
268
+ try {
269
+ connection.__knexTxId = this.txid;
270
+ return await cb(connection);
271
+ } finally {
272
+ if (!configConnection) {
273
+ debug('%s: releasing connection', this.txid);
274
+ this.client.releaseConnection(connection);
275
+ } else {
276
+ debug('%s: not releasing external connection', this.txid);
277
+ }
278
+ }
279
+ }
280
+
281
+ then(onResolve, onReject) {
282
+ return this._promise.then(onResolve, onReject);
283
+ }
284
+
285
+ catch(...args) {
286
+ return this._promise.catch(...args);
287
+ }
288
+
289
+ asCallback(cb) {
290
+ callbackify(() => this._promise)(cb);
291
+ return this._promise;
292
+ }
293
+ }
294
+ finallyMixin(Transaction.prototype);
295
+
296
+ // The transactor is a full featured knex object, with a "commit", a "rollback"
297
+ // and a "savepoint" function. The "savepoint" is just sugar for creating a new
298
+ // transaction. If the rollback is run inside a savepoint, it rolls back to the
299
+ // last savepoint - otherwise it rolls back the transaction.
300
+ function makeTransactor(trx, connection, trxClient) {
301
+ const transactor = makeKnex(trxClient);
302
+
303
+ transactor.context.withUserParams = () => {
304
+ throw new Error(
305
+ 'Cannot set user params on a transaction - it can only inherit params from main knex instance'
306
+ );
307
+ };
308
+
309
+ transactor.isTransaction = true;
310
+ transactor.userParams = trx.userParams || {};
311
+
312
+ transactor.context.transaction = function (container, options) {
313
+ if (!options) {
314
+ options = { doNotRejectOnRollback: true };
315
+ } else if (options.doNotRejectOnRollback === undefined) {
316
+ options.doNotRejectOnRollback = true;
317
+ }
318
+
319
+ return this._transaction(container, options, trx);
320
+ };
321
+
322
+ transactor.savepoint = function (container, options) {
323
+ return transactor.transaction(container, options);
324
+ };
325
+
326
+ if (trx.client.transacting) {
327
+ transactor.commit = (value) => trx.release(connection, value);
328
+ transactor.rollback = (error) => trx.rollbackTo(connection, error);
329
+ } else {
330
+ transactor.commit = (value) => trx.commit(connection, value);
331
+ transactor.rollback = (error) => trx.rollback(connection, error);
332
+ }
333
+
334
+ transactor.isCompleted = () => trx.isCompleted();
335
+
336
+ return transactor;
337
+ }
338
+
339
+ // We need to make a client object which always acquires the same
340
+ // connection and does not release back into the pool.
341
+ function makeTxClient(trx, client, connection) {
342
+ const trxClient = Object.create(client.constructor.prototype);
343
+ trxClient.version = client.version;
344
+ trxClient.config = client.config;
345
+ trxClient.driver = client.driver;
346
+ trxClient.connectionSettings = client.connectionSettings;
347
+ trxClient.transacting = true;
348
+ trxClient.valueForUndefined = client.valueForUndefined;
349
+ trxClient.logger = client.logger;
350
+
351
+ trxClient.on('start', function (arg) {
352
+ trx.emit('start', arg);
353
+ client.emit('start', arg);
354
+ });
355
+
356
+ trxClient.on('query', function (arg) {
357
+ trx.emit('query', arg);
358
+ client.emit('query', arg);
359
+ });
360
+
361
+ trxClient.on('query-error', function (err, obj) {
362
+ trx.emit('query-error', err, obj);
363
+ client.emit('query-error', err, obj);
364
+ });
365
+
366
+ trxClient.on('query-response', function (response, obj, builder) {
367
+ trx.emit('query-response', response, obj, builder);
368
+ client.emit('query-response', response, obj, builder);
369
+ });
370
+
371
+ const _query = trxClient.query;
372
+ trxClient.query = function (conn, obj) {
373
+ const completed = trx.isCompleted();
374
+ return new Promise(function (resolve, reject) {
375
+ try {
376
+ if (conn !== connection)
377
+ throw new Error('Invalid connection for transaction query.');
378
+ if (completed) completedError(trx, obj);
379
+ resolve(_query.call(trxClient, conn, obj));
380
+ } catch (e) {
381
+ reject(e);
382
+ }
383
+ });
384
+ };
385
+ const _stream = trxClient.stream;
386
+ trxClient.stream = function (conn, obj, stream, options) {
387
+ const completed = trx.isCompleted();
388
+ return new Promise(function (resolve, reject) {
389
+ try {
390
+ if (conn !== connection)
391
+ throw new Error('Invalid connection for transaction query.');
392
+ if (completed) completedError(trx, obj);
393
+ resolve(_stream.call(trxClient, conn, obj, stream, options));
394
+ } catch (e) {
395
+ reject(e);
396
+ }
397
+ });
398
+ };
399
+ trxClient.acquireConnection = function () {
400
+ return Promise.resolve(connection);
401
+ };
402
+ trxClient.releaseConnection = function () {
403
+ return Promise.resolve();
404
+ };
405
+
406
+ return trxClient;
407
+ }
408
+
409
+ function completedError(trx, obj) {
410
+ const sql = typeof obj === 'string' ? obj : obj && obj.sql;
411
+ debug('%s: Transaction completed: %s', trx.txid, sql);
412
+ throw new Error(
413
+ 'Transaction query already complete, run with DEBUG=knex:tx for more info'
414
+ );
415
+ }
416
+
417
+ module.exports = Transaction;