forked from 99x/serverless-dynamodb-local
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
348 lines (318 loc) · 15.3 KB
/
index.js
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
"use strict";
const _ = require("lodash");
const BbPromise = require("bluebird");
const AWS = require("aws-sdk");
const dynamodbLocal = require("dynamodb-localhost");
const seeder = require("./src/seeder");
const path = require('path');
class ServerlessDynamodbLocal {
constructor(serverless, options) {
this.serverless = serverless;
this.service = serverless.service;
this.serverlessLog = serverless.cli.log.bind(serverless.cli);
this.config = this.service.custom && this.service.custom.dynamodb || {};
this.options = _.merge({
localPath: serverless.config && path.join(serverless.config.servicePath, '.dynamodb')
},
options
);
this.provider = "aws";
this.commands = {
dynamodb: {
commands: {
migrate: {
lifecycleEvents: ["migrateHandler"],
usage: "Creates local DynamoDB tables from the current Serverless configuration"
},
seed: {
lifecycleEvents: ["seedHandler"],
usage: "Seeds local DynamoDB tables with data",
options: {
online: {
shortcut: "o",
usage: "Will connect to the tables online to do an online seed run"
}
}
},
start: {
lifecycleEvents: ["startHandler"],
usage: "Starts local DynamoDB",
options: {
port: {
shortcut: "p",
usage: "The port number that DynamoDB will use to communicate with your application. If you do not specify this option, the default port is 8000"
},
cors: {
shortcut: "c",
usage: "Enable CORS support (cross-origin resource sharing) for JavaScript. You must provide a comma-separated \"allow\" list of specific domains. The default setting for -cors is an asterisk (*), which allows public access."
},
inMemory: {
shortcut: "i",
usage: "DynamoDB; will run in memory, instead of using a database file. When you stop DynamoDB;, none of the data will be saved. Note that you cannot specify both -dbPath and -inMemory at once."
},
dbPath: {
shortcut: "d",
usage: "The directory where DynamoDB will write its database file. If you do not specify this option, the file will be written to the current directory. Note that you cannot specify both -dbPath and -inMemory at once. For the path, current working directory is <projectroot>/node_modules/serverless-dynamodb-local/dynamob. For example to create <projectroot>/node_modules/serverless-dynamodb-local/dynamob/<mypath> you should specify -d <mypath>/ or --dbPath <mypath>/ with a forwardslash at the end."
},
sharedDb: {
shortcut: "h",
usage: "DynamoDB will use a single database file, instead of using separate files for each credential and region. If you specify -sharedDb, all DynamoDB clients will interact with the same set of tables regardless of their region and credential configuration."
},
delayTransientStatuses: {
shortcut: "t",
usage: "Causes DynamoDB to introduce delays for certain operations. DynamoDB can perform some tasks almost instantaneously, such as create/update/delete operations on tables and indexes; however, the actual DynamoDB service requires more time for these tasks. Setting this parameter helps DynamoDB simulate the behavior of the Amazon DynamoDB web service more closely. (Currently, this parameter introduces delays only for global secondary indexes that are in either CREATING or DELETING status."
},
optimizeDbBeforeStartup: {
shortcut: "o",
usage: "Optimizes the underlying database tables before starting up DynamoDB on your computer. You must also specify -dbPath when you use this parameter."
},
migrate: {
shortcut: "m",
usage: "After starting dynamodb local, create DynamoDB tables from the current serverless configuration."
},
seed: {
shortcut: "s",
usage: "After starting and migrating dynamodb local, injects seed data into your tables. The --seed option determines which data categories to onload.",
},
migration: {
shortcut: 'm',
usage: 'After starting dynamodb local, run dynamodb migrations'
},
heapInitial: {
usage: 'The initial heap size. Specify megabytes, gigabytes or terabytes using m, b, t. E.g., "2m"'
},
heapMax: {
usage: 'The maximum heap size. Specify megabytes, gigabytes or terabytes using m, b, t. E.g., "2m"'
},
convertEmptyValues: {
shortcut: "e",
usage: "Set to true if you would like the document client to convert empty values (0-length strings, binary buffers, and sets) to be converted to NULL types when persisting to DynamoDB.",
}
}
},
noStart: {
shortcut: "n",
default: false,
usage: "Do not start DynamoDB local (in case it is already running)",
},
remove: {
lifecycleEvents: ["removeHandler"],
usage: "Removes local DynamoDB"
},
install: {
usage: "Installs local DynamoDB",
lifecycleEvents: ["installHandler"],
options: {
localPath: {
shortcut: "x",
usage: "Local dynamodb install path"
}
}
}
}
}
};
const stage = (this.options && this.options.stage) || (this.service.provider && this.service.provider.stage);
if (this.config.stages && !this.config.stages.includes(stage)) {
// don't do anything for this stage
this.hooks = {};
return;
}
this.hooks = {
"dynamodb:migrate:migrateHandler": this.migrateHandler.bind(this),
"dynamodb:seed:seedHandler": this.seedHandler.bind(this),
"dynamodb:remove:removeHandler": this.removeHandler.bind(this),
"dynamodb:install:installHandler": this.installHandler.bind(this),
"dynamodb:start:startHandler": this.startHandler.bind(this),
"before:offline:start:init": this.startHandler.bind(this),
"before:offline:start:end": this.endHandler.bind(this),
};
}
get port() {
const config = this.service.custom && this.service.custom.dynamodb || {};
const port = _.get(config, "start.port", 8000);
return port;
}
get host() {
const config = this.service.custom && this.service.custom.dynamodb || {};
const host = _.get(config, "start.host", "localhost");
return host;
}
dynamodbOptions(options) {
let dynamoOptions = {};
if(options && options.online){
this.serverlessLog("Connecting to online tables...");
if (!options.region) {
throw new Error("please specify the region");
}
dynamoOptions = {
region: options.region,
convertEmptyValues: options && options.convertEmptyValues ? options.convertEmptyValues : false,
};
} else {
dynamoOptions = {
endpoint: `http://${this.host}:${this.port}`,
region: "localhost",
accessKeyId: "MOCK_ACCESS_KEY_ID",
secretAccessKey: "MOCK_SECRET_ACCESS_KEY",
convertEmptyValues: options && options.convertEmptyValues ? options.convertEmptyValues : false,
};
}
return {
raw: new AWS.DynamoDB(dynamoOptions),
doc: new AWS.DynamoDB.DocumentClient(dynamoOptions)
};
}
migrateHandler() {
const dynamodb = this.dynamodbOptions();
const tables = this.tables;
return BbPromise.each(tables, (table) => this.createTable(dynamodb, table));
}
seedHandler() {
const options = this.options;
const dynamodb = this.dynamodbOptions(options);
return BbPromise.each(this.seedSources, (source) => {
if (!source.table) {
throw new Error("seeding source \"table\" property not defined");
}
const seedPromise = seeder.locateSeeds(source.sources || [])
.then((seeds) => seeder.writeSeeds(dynamodb.doc.batchWrite.bind(dynamodb.doc), source.table, seeds));
const rawSeedPromise = seeder.locateSeeds(source.rawsources || [])
.then((seeds) => seeder.writeSeeds(dynamodb.raw.batchWriteItem.bind(dynamodb.raw), source.table, seeds));
return BbPromise.all([seedPromise, rawSeedPromise]);
});
}
removeHandler() {
return new BbPromise((resolve) => dynamodbLocal.remove(resolve));
}
installHandler() {
const options = this.options;
return new BbPromise((resolve) => dynamodbLocal.install(resolve, options.localPath));
}
startHandler() {
const config = this.service.custom && this.service.custom.dynamodb || {};
const options = _.merge({
sharedDb: this.options.sharedDb || true,
install_path: this.options.localPath
},
config && config.start,
this.options
);
// otherwise endHandler will be mis-informed
this.options = options;
let dbPath = options.dbPath;
if (dbPath) {
options.dbPath = path.isAbsolute(dbPath) ? dbPath : path.join(this.serverless.config.servicePath, dbPath);
}
if (!options.noStart) {
dynamodbLocal.start(options);
}
return BbPromise.resolve()
.then(() => options.migrate && this.migrateHandler())
.then(() => options.seed && this.seedHandler());
}
endHandler() {
if (!this.options.noStart) {
this.serverlessLog("DynamoDB - stopping local database");
dynamodbLocal.stop(this.port);
}
}
getDefaultStack() {
return _.get(this.service, "resources");
}
getAdditionalStacks() {
return _.values(_.get(this.service, "custom.additionalStacks", {}));
}
hasAdditionalStacksPlugin() {
return _.get(this.service, "plugins", []).includes("serverless-plugin-additional-stacks");
}
getTableDefinitionsFromStack(stack) {
const resources = _.get(stack, "Resources", []);
return Object.keys(resources).map((key) => {
if (resources[key].Type === "AWS::DynamoDB::Table") {
return resources[key].Properties;
}
}).filter((n) => n);
}
/**
* Gets the table definitions
*/
get tables() {
let stacks = [];
const defaultStack = this.getDefaultStack();
if (defaultStack) {
stacks.push(defaultStack);
}
if (this.hasAdditionalStacksPlugin()) {
stacks = stacks.concat(this.getAdditionalStacks());
}
return stacks.map((stack) => this.getTableDefinitionsFromStack(stack)).reduce((tables, tablesInStack) => tables.concat(tablesInStack), []);
}
/**
* Gets the seeding sources
*/
get seedSources() {
const config = this.service.custom.dynamodb;
const seedConfig = _.get(config, "seed", {});
const seed = this.options.seed || config.start.seed || seedConfig;
let categories;
if (typeof seed === "string") {
categories = seed.split(",");
} else if(seed) {
categories = Object.keys(seedConfig);
} else { // if (!seed)
this.serverlessLog("DynamoDB - No seeding defined. Skipping data seeding.");
return [];
}
const sourcesByCategory = categories.map((category) => seedConfig[category].sources);
return [].concat.apply([], sourcesByCategory);
}
createTable(dynamodb, migration) {
return new BbPromise((resolve, reject) => {
if (migration.StreamSpecification && migration.StreamSpecification.StreamViewType) {
migration.StreamSpecification.StreamEnabled = true;
}
if (migration.TimeToLiveSpecification) {
delete migration.TimeToLiveSpecification;
}
if (migration.SSESpecification) {
migration.SSESpecification.Enabled = migration.SSESpecification.SSEEnabled;
delete migration.SSESpecification.SSEEnabled;
}
if (migration.PointInTimeRecoverySpecification) {
delete migration.PointInTimeRecoverySpecification;
}
if (migration.Tags) {
delete migration.Tags;
}
if (migration.BillingMode === "PAY_PER_REQUEST") {
delete migration.BillingMode;
const defaultProvisioning = {
ReadCapacityUnits: 5,
WriteCapacityUnits: 5
};
migration.ProvisionedThroughput = defaultProvisioning;
if (migration.GlobalSecondaryIndexes) {
migration.GlobalSecondaryIndexes.forEach((gsi) => {
gsi.ProvisionedThroughput = defaultProvisioning;
});
}
}
dynamodb.raw.createTable(migration, (err) => {
if (err) {
if (err.name === 'ResourceInUseException') {
this.serverlessLog(`DynamoDB - Warn - table ${migration.TableName} already exists`);
resolve();
} else {
this.serverlessLog("DynamoDB - Error - ", err);
reject(err);
}
} else {
this.serverlessLog("DynamoDB - created table " + migration.TableName);
resolve(migration);
}
});
});
}
}
module.exports = ServerlessDynamodbLocal;