runner.js
6.64 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
import { assign, isArray, noop } from 'lodash'
import Promise from 'bluebird';
import * as helpers from './helpers';
let PassThrough;
// The "Runner" constructor takes a "builder" (query, schema, or raw)
// and runs through each of the query statements, calling any additional
// "output" method provided alongside the query and bindings.
function Runner(client, builder) {
this.client = client
this.builder = builder
this.queries = []
// The "connection" object is set on the runner when
// "run" is called.
this.connection = void 0
}
assign(Runner.prototype, {
// "Run" the target, calling "toSQL" on the builder, returning
// an object or array of queries to run, each of which are run on
// a single connection.
run() {
const runner = this
return Promise.using(this.ensureConnection(), function(connection) {
runner.connection = connection;
runner.client.emit('start', runner.builder)
runner.builder.emit('start', runner.builder)
const sql = runner.builder.toSQL();
if (runner.builder._debug) {
helpers.debugLog(sql)
}
if (isArray(sql)) {
return runner.queryArray(sql);
}
return runner.query(sql);
})
// If there are any "error" listeners, we fire an error event
// and then re-throw the error to be eventually handled by
// the promise chain. Useful if you're wrapping in a custom `Promise`.
.catch(function(err) {
if (runner.builder._events && runner.builder._events.error) {
runner.builder.emit('error', err);
}
throw err;
})
// Fire a single "end" event on the builder when
// all queries have successfully completed.
.tap(function() {
runner.builder.emit('end');
})
},
// Stream the result set, by passing through to the dialect's streaming
// capabilities. If the options are
stream(options, handler) {
// If we specify stream(handler).then(...
if (arguments.length === 1) {
if (typeof options === 'function') {
handler = options;
options = {};
}
}
// Determines whether we emit an error or throw here.
const hasHandler = typeof handler === 'function';
// Lazy-load the "PassThrough" dependency.
PassThrough = PassThrough || require('readable-stream').PassThrough;
const runner = this;
const stream = new PassThrough({objectMode: true});
const promise = Promise.using(this.ensureConnection(), function(connection) {
runner.connection = connection;
const sql = runner.builder.toSQL()
const err = new Error('The stream may only be used with a single query statement.');
if (isArray(sql)) {
if (hasHandler) throw err;
stream.emit('error', err);
}
return runner.client.stream(runner.connection, sql, stream, options);
})
// If a function is passed to handle the stream, send the stream
// there and return the promise, otherwise just return the stream
// and the promise will take care of itsself.
if (hasHandler) {
handler(stream);
return promise;
}
// This promise is unreachable since no handler was given, so noop any
// exceptions. Errors should be handled in the stream's 'error' event.
promise.catch(noop);
return stream;
},
// Allow you to pipe the stream to a writable stream.
pipe(writable, options) {
return this.stream(options).pipe(writable);
},
// "Runs" a query, returning a promise. All queries specified by the builder are guaranteed
// to run in sequence, and on the same connection, especially helpful when schema building
// and dealing with foreign key constraints, etc.
query: Promise.method(function(obj) {
this.builder.emit('query', assign({__knexUid: this.connection.__knexUid}, obj))
const runner = this
let queryPromise = this.client.query(this.connection, obj)
if(obj.timeout) {
queryPromise = queryPromise.timeout(obj.timeout)
}
return queryPromise
.then((resp) => {
const processedResponse = this.client.processResponse(resp, runner);
this.builder.emit(
'query-response',
processedResponse,
assign({__knexUid: this.connection.__knexUid}, obj),
this.builder
);
this.client.emit(
'query-response',
processedResponse,
assign({__knexUid: this.connection.__knexUid}, obj),
this.builder
);
return processedResponse;
}).catch(Promise.TimeoutError, error => {
const { timeout, sql, bindings } = obj;
let cancelQuery;
if (obj.cancelOnTimeout) {
cancelQuery = this.client.cancelQuery(this.connection);
} else {
cancelQuery = Promise.resolve();
}
return cancelQuery
.catch((cancelError) => {
// cancellation failed
throw assign(cancelError, {
message: `After query timeout of ${timeout}ms exceeded, cancelling of query failed.`,
sql, bindings, timeout
});
})
.then(() => {
// cancellation succeeded, rethrow timeout error
throw assign(error, {
message: `Defined query timeout of ${timeout}ms exceeded when running query.`,
sql, bindings, timeout
});
});
})
.catch((error) => {
this.builder.emit('query-error', error, assign({__knexUid: this.connection.__knexUid}, obj))
throw error;
});
}),
// In the case of the "schema builder" we call `queryArray`, which runs each
// of the queries in sequence.
queryArray(queries) {
return queries.length === 1 ? this.query(queries[0]) : Promise.bind(this)
.return(queries)
.reduce(function(memo, query) {
return this.query(query).then(function(resp) {
memo.push(resp)
return memo;
});
}, [])
},
// Check whether there's a transaction flag, and that it has a connection.
ensureConnection() {
return Promise.try(() => {
return this.connection || new Promise((resolver, rejecter) => {
// need to return promise or null from handler to prevent warning from bluebird
return this.client.acquireConnection()
.then(resolver)
.catch(Promise.TimeoutError, (error) => {
if (this.builder) {
error.sql = this.builder.sql;
error.bindings = this.builder.bindings;
}
throw error
})
.catch(rejecter)
})
}).disposer(() => {
// need to return promise or null from handler to prevent warning from bluebird
return this.client.releaseConnection(this.connection)
})
}
})
export default Runner;