@bluedot-innovation/models 7.0.0 → 7.0.1

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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,8 @@
1
+ ## 7.0.1
2
+ - Added tempo webhooks array back for migration
3
+ - Added tempo destinationId back for migration
4
+ - Added no duplicate webhooks of same type validation
5
+
1
6
  ## 7.0.0
2
7
  - BREAKING CHANGE - Moved tempo webhooks to within main project webhooks array
3
8
  - BREAKING CHANGE - Moved zone destinationId to object root and removed tempo object from zone
@@ -26,6 +26,13 @@
26
26
  "headers" : {
27
27
  "securityToken" : "value"
28
28
  }
29
+ },
30
+ {
31
+ "type": "trigger",
32
+ "url": "https://webhooklistener.bluedotinnovation.com",
33
+ "headers" : {
34
+ "securityToken" : "value"
35
+ }
29
36
  }
30
37
  ],
31
38
  "shouldSync": true,
@@ -40,6 +47,16 @@
40
47
  }
41
48
  },
42
49
  "tempo": {
43
- "isochroneBracketInterval": [60, 120, 300]
50
+ "isochroneBracketInterval": [60, 120, 300],
51
+ "webhooks": [
52
+ {
53
+ "type": "tempo",
54
+ "url": "https://webhooklistener.bluedotinnovation.com",
55
+ "headers" : {
56
+ "securityToken" : "value"
57
+ }
58
+ }
59
+ ]
60
+
44
61
  }
45
62
  }
@@ -90,7 +90,9 @@ testCase('Project', () => {
90
90
  done()
91
91
  })
92
92
  })
93
- assertions(`should not validate if one of webhooks have a type other than 'geoTrigger', 'tempo' or 'doorbell'`, (done) => {
93
+
94
+ // TODO: Remove trigger type after migration
95
+ assertions(`should not validate if one of webhooks have a type other than 'geoTrigger', 'tempo', 'doorbell' or 'trigger'`, (done) => {
94
96
  project.webhooks.push({
95
97
  "type": "sandwich",
96
98
  "url": "https://webhooklistener.bluedotinnovation.com",
@@ -277,6 +279,48 @@ testCase('Project', () => {
277
279
  })
278
280
  })
279
281
 
282
+ testCase('should not validate if webhooks contains two webhooks of the same type', () => {
283
+ // TODO: Remove trigger type after migration
284
+ const webhookTypes = ['geoTrigger', 'tempo', 'doorbell', 'trigger']
285
+
286
+ webhookTypes.map(webhookType => {
287
+ assertions(`should not validate if there are duplicate ${webhookType} webhooks`, (done) => {
288
+ project.webhooks.push({
289
+ "type": webhookType,
290
+ "url": "https://webhooklistener.bluedotinnovation.com",
291
+ "headers" : {
292
+ "securityToken" : "value"
293
+ }
294
+ })
295
+
296
+ let Project = new ProjectModel(project)
297
+ Project.validate((err, res) => {
298
+ assert.exists(err)
299
+ assert.match(err.message, /Duplicate webhooks found. Only have one webhook of each type is allowed/)
300
+ done()
301
+ })
302
+ })
303
+ })
304
+ })
305
+
306
+ // TODO: Remove this test after migration
307
+ assertions(`should not validate if one of tempo webhooks have a type other than 'tempo'`, (done) => {
308
+ project.tempo.webhooks.push({
309
+ "type": "trigger",
310
+ "url": "https://webhooklistener.bluedotinnovation.com",
311
+ "headers" : {
312
+ "securityToken" : "value"
313
+ }
314
+ })
315
+ let Project = new ProjectModel(project)
316
+ Project.validate((err, res) => {
317
+ assert.exists(err)
318
+ assert.match(err.message, /tempo.webhooks should contain tempo webhooks only/)
319
+ done()
320
+ })
321
+ })
322
+
323
+
280
324
  describe('should throw an error when any of the values of the array contains a falsy value', () => {
281
325
  let arrayTypeFields = rules.arrayTypeFields
282
326
 
@@ -450,4 +450,77 @@ describe('Zone', () => {
450
450
  })
451
451
  })
452
452
  })
453
+
454
+ // TODO: Remove all tests in below describe block after migration
455
+ describe("tempo.destinationId tests", () => {
456
+ it('should save without errors when tempo.destinationId is null', (done) => {
457
+ zone.tempo = {
458
+ destinationId: null
459
+ }
460
+ let Zone = new ZoneModel(zone)
461
+ Zone.validate((err, res) => {
462
+ assert.notExists(res)
463
+ assert.notExists(err)
464
+ done()
465
+ })
466
+ })
467
+
468
+ const validTempoGeofeatureTypes = ['boundingBox', 'circle', 'polygon']
469
+
470
+ validTempoGeofeatureTypes.map(type => {
471
+ it(`should save without errors when tempo.destinationId is set and there is a single ${type} geofeature`, (done) => {
472
+ zone.tempo = {
473
+ "destinationId": "test-destination-id"
474
+ }
475
+ zone.geofeatures = zone.geofeatures.filter(gf => gf.type.match(new RegExp(type)))
476
+ let Zone = new ZoneModel(zone)
477
+ Zone.validate((err, res) => {
478
+ assert.notExists(res)
479
+ assert.notExists(err)
480
+ done()
481
+ })
482
+ })
483
+ })
484
+
485
+ it('should throw an error when tempo.destinationId is longer than 128 characters', (done) => {
486
+ zone.tempo = {
487
+ "destinationId": 'Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry standard dummy text ever since the 1500s'
488
+ }
489
+ let Zone = new ZoneModel(zone)
490
+ Zone.validate((err, res) => {
491
+ assert.exists(err, 'err object should exist')
492
+ assert.match(err.message, /(destinationId must be less than 129 characters long)/i)
493
+ done()
494
+ })
495
+ })
496
+
497
+ const invalidTempoGeofeatures = ['geoline', 'beacon']
498
+
499
+ invalidTempoGeofeatures.map(type => {
500
+ it(`should throw an error when tempo.destinationId is set and there is a single ${type} geofeature`, (done) => {
501
+ zone.tempo = {
502
+ "destinationId": "test-destination-id"
503
+ }
504
+ zone.geofeatures = zone.geofeatures.filter(gf => gf.type.match(new RegExp(type)))
505
+ let Zone = new ZoneModel(zone)
506
+ Zone.validate((err, res) => {
507
+ assert.exists(err, 'err object should exist')
508
+ assert.match(err.message, /(destinationId cannot be set on zones with a geoline or beacon)/i)
509
+ done()
510
+ })
511
+ })
512
+ })
513
+
514
+ it('should throw an error when tempo.destinationId is set and there is more than one geofeature', (done) => {
515
+ zone.tempo = {
516
+ "destinationId": "test-destination-id"
517
+ }
518
+ let Zone = new ZoneModel(zone)
519
+ Zone.validate((err, res) => {
520
+ assert.exists(err, 'err object should exist')
521
+ assert.match(err.message, /(destinationId can only be set on zones with a single geofeature)/i)
522
+ done()
523
+ })
524
+ })
525
+ })
453
526
  })
package/helpers.js CHANGED
@@ -266,4 +266,47 @@ helpers.validateDestinationIdGeofeatureType = function(destinationId) {
266
266
  return true
267
267
  }
268
268
 
269
+ helpers.validateNoDuplicateWebhookTypes = function(webhookArray) {
270
+ // TODO: Remove trigger type after migration
271
+ const webhookTypes = ['geoTrigger', 'tempo', 'doorbell', 'trigger']
272
+ const webhookCounts = {};
273
+ webhookTypes.forEach(webhookType => webhookCounts[webhookType] = 0);
274
+ let duplicateFound = false
275
+ webhookArray.forEach(webhook => {
276
+ if(webhookCounts[webhook.type] > 0){
277
+ duplicateFound = true
278
+ }
279
+ webhookCounts[webhook.type]++
280
+ })
281
+ return !duplicateFound;
282
+ }
283
+
284
+ // TODO: Remove below three methods after migration
285
+ helpers.validateTempoWebhooks = function(webhooks) {
286
+ const notTempo = webhooks.some(webhook => {
287
+ return webhook.type && webhook.type != 'tempo'
288
+ })
289
+ return !notTempo
290
+ }
291
+
292
+ helpers.validateTempoDestinationSingleGeofeature = function(destinationId) {
293
+ if(destinationId){
294
+ const geofeatures = this.ownerDocument().geofeatures
295
+ if(!geofeatures.length){
296
+ return false
297
+ }
298
+ return geofeatures.length === 1
299
+ }
300
+ return true
301
+ }
302
+
303
+ helpers.validateTempoDestinationIdGeofeatureType = function(destinationId) {
304
+ const geofeatures = this.ownerDocument().geofeatures
305
+ if(destinationId && geofeatures.length){
306
+ return !(geofeatures[0].type === 'geoline' || geofeatures[0].type === 'beacon')
307
+ }
308
+ return true
309
+ }
310
+
311
+
269
312
  module.exports = helpers
package/models/Project.js CHANGED
@@ -18,7 +18,8 @@ let androidConfig = require('../schemas/AndroidConfig')
18
18
  let projectTempoSchema = require('../schemas/ProjectTempo')
19
19
 
20
20
  let webhooksValidators = [
21
- {validator: helpers.validateNotNull}
21
+ {validator: helpers.validateNotNull},
22
+ {validator: helpers.validateNoDuplicateWebhookTypes, msg: "Duplicate webhooks found. Only have one webhook of each type is allowed"}
22
23
  ];
23
24
 
24
25
  let ProjectSchema = new mongoose.Schema({
package/models/Zone.js CHANGED
@@ -124,7 +124,9 @@ let zoneSchema = new Schema({
124
124
  { validator: helpers.validateDestinationIdLength, msg: 'destinationId must be less than 129 characters long' },
125
125
  { validator: helpers.validateDestinationSingleGeofeature, msg: 'destinationId can only be set on zones with a single geofeature' },
126
126
  { validator: helpers.validateDestinationIdGeofeatureType, msg: 'destinationId cannot be set on zones with a geoline or beacon' }
127
- ]}
127
+ ]},
128
+ // TODO: Remove tempo object after migration
129
+ tempo: zoneTempoSchema
128
130
  }, {collection: 'zone', autoIndex: false})
129
131
 
130
132
  zoneSchema.index(
@@ -138,6 +140,18 @@ zoneSchema.index(
138
140
  name: "destinationUniqueWithinProject"
139
141
  })
140
142
 
143
+ // TODO: Remove below index after migration
144
+ zoneSchema.index(
145
+ {
146
+ projectId: 1,
147
+ 'tempo.destinationId': 1
148
+ },
149
+ {
150
+ unique: true,
151
+ partialFilterExpression: { 'tempo.destinationId': { $exists:true, $type:"string" } },
152
+ name: "tempoDestinationUniqueWithinProject"
153
+ })
154
+
141
155
  // Mongoose-json-patch
142
156
  // https://www.npmjs.com/package/mongoose-json-patch
143
157
  // plugin for PATCH operations
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bluedot-innovation/models",
3
- "version": "7.0.0",
3
+ "version": "7.0.1",
4
4
  "main": "Models.js",
5
5
  "scripts": {
6
6
  "lint": "./node_modules/.bin/eslint -c .eslintrc.js ./models/*.js ./__tests__/**/*.js ./__tests__/**/**/*.js ./schemas/*.js",
@@ -1,4 +1,7 @@
1
1
  let mongoose = require('mongoose')
2
+ // TODO: Remove below imports after migration
3
+ let WebhookSchema = require('./Webhook')
4
+ let helpers = require('../helpers')
2
5
 
3
6
  function validateIsochroneBracketInterval (brackets) {
4
7
  const isInteger = brackets.every((bracket) => {
@@ -8,8 +11,16 @@ function validateIsochroneBracketInterval (brackets) {
8
11
  return isInteger
9
12
  }
10
13
 
14
+ // TODO: Remove below validators after migration
15
+ let webhooksValidators = [
16
+ {validator: helpers.validateNotNull},
17
+ {validator: helpers.validateTempoWebhooks, msg: 'tempo.webhooks should contain tempo webhooks only'}
18
+ ];
19
+
11
20
  let ProjectTempoSchema = new mongoose.Schema({
12
- isochroneBracketInterval: {type: [Number], validate: { validator: validateIsochroneBracketInterval, msg: 'tempo.isochroneBracketInterval should contain integer numbers only' }}
21
+ isochroneBracketInterval: {type: [Number], validate: { validator: validateIsochroneBracketInterval, msg: 'tempo.isochroneBracketInterval should contain integer numbers only' }},
22
+ // TODO: Remove webhooks after migration
23
+ webhooks: {type:[WebhookSchema], validate: webhooksValidators}
13
24
  }, {
14
25
  _id: false
15
26
  })
@@ -2,7 +2,8 @@ let mongoose = require('mongoose')
2
2
  let validators = require('../utils/validators')
3
3
 
4
4
  let WebhookSchema = new mongoose.Schema({
5
- type: {type: String, enum: ['geoTrigger', 'tempo', 'doorbell'], required: [true, 'webhook type is required']},
5
+ // TODO: Remove trigger type after migration
6
+ type: {type: String, enum: ['geoTrigger', 'tempo', 'doorbell', 'trigger'], required: [true, 'webhook type is required']},
6
7
  url: {type: String, required: [true, 'URL is required'], validate: {validator: validators.validateUrl, msg: 'Please enter a valid URL'}},
7
8
  headers: {type: mongoose.Schema.Types.Mixed, validate: { validator: validateHeaderlength, msg: 'Header object can only have 1 key <-> value pair' }}
8
9
  }, {
@@ -1,8 +1,13 @@
1
+ // TODO: Remove this file after migration
1
2
  let mongoose = require('mongoose')
2
3
  let helpers = require('../helpers')
3
4
 
4
5
  let ZoneTempoSchema = new mongoose.Schema({
5
-
6
+ destinationId: {type: String, validate: [
7
+ { validator: helpers.validateDestinationIdLength, msg: 'destinationId must be less than 129 characters long' },
8
+ { validator: helpers.validateTempoDestinationSingleGeofeature, msg: 'destinationId can only be set on zones with a single geofeature' },
9
+ { validator: helpers.validateTempoDestinationIdGeofeatureType, msg: 'destinationId cannot be set on zones with a geoline or beacon' }
10
+ ]}
6
11
  }, {
7
12
  _id: false
8
13
  })
@@ -17,6 +17,18 @@ const indexes = {
17
17
  partialFilterExpression: { destinationId: { $exists:true, $type:"string" } },
18
18
  name: "destinationUniqueWithinProject"
19
19
  }
20
+ },
21
+ // TODO: Remove below index after migration
22
+ {
23
+ fields: {
24
+ projectId: 1,
25
+ 'tempo.destinationId': 1
26
+ },
27
+ options: {
28
+ unique: true,
29
+ partialFilterExpression: { 'tempo.destinationId': { $exists:true, $type:"string" } },
30
+ name: "tempoDestinationUniqueWithinProject"
31
+ }
20
32
  }
21
33
  ]
22
34
  }