@itentialopensource/adapter-sendgrid 0.1.2 → 0.2.0

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 (44) hide show
  1. package/.eslintrc.js +1 -0
  2. package/AUTH.md +4 -4
  3. package/BROKER.md +4 -4
  4. package/CALLS.md +9 -9
  5. package/ENHANCE.md +3 -3
  6. package/PROPERTIES.md +24 -9
  7. package/README.md +24 -23
  8. package/SUMMARY.md +2 -2
  9. package/SYSTEMINFO.md +1 -1
  10. package/TAB1.md +2 -2
  11. package/TAB2.md +9 -5
  12. package/TROUBLESHOOT.md +10 -1
  13. package/UTILITIES.md +473 -0
  14. package/adapter.js +12 -12
  15. package/adapterBase.js +52 -16
  16. package/package.json +25 -29
  17. package/pronghorn.json +349 -347
  18. package/propertiesSchema.json +196 -43
  19. package/report/adapterInfo.json +7 -7
  20. package/report/updateReport1748553308645.json +120 -0
  21. package/sampleProperties.json +4 -0
  22. package/test/integration/adapterTestBasicGet.js +88 -54
  23. package/test/integration/adapterTestConnectivity.js +15 -16
  24. package/test/integration/adapterTestIntegration.js +1 -38
  25. package/test/unit/adapterBaseTestUnit.js +641 -39
  26. package/test/unit/adapterTestUnit.js +23 -54
  27. package/utils/adapterInfo.js +114 -164
  28. package/utils/argParser.js +44 -0
  29. package/utils/checkMigrate.js +77 -38
  30. package/utils/entitiesToDB.js +53 -42
  31. package/utils/logger.js +26 -0
  32. package/utils/modify.js +56 -55
  33. package/utils/mongoDbConnection.js +79 -0
  34. package/utils/mongoUtils.js +162 -0
  35. package/utils/taskMover.js +31 -32
  36. package/utils/tbScript.js +36 -172
  37. package/utils/tbUtils.js +84 -226
  38. package/utils/troubleshootingAdapter.js +68 -84
  39. package/utils/updateAdapterConfig.js +158 -0
  40. package/utils/addAuth.js +0 -94
  41. package/utils/artifactize.js +0 -146
  42. package/utils/basicGet.js +0 -50
  43. package/utils/packModificationScript.js +0 -35
  44. package/utils/patches2bundledDeps.js +0 -90
package/adapterBase.js CHANGED
@@ -32,6 +32,7 @@ const entitiesToDB = require(path.join(__dirname, 'utils/entitiesToDB'));
32
32
  const troubleshootingAdapter = require(path.join(__dirname, 'utils/troubleshootingAdapter'));
33
33
  const tbUtils = require(path.join(__dirname, 'utils/tbUtils'));
34
34
  const taskMover = require(path.join(__dirname, 'utils/taskMover'));
35
+ const { updateMongoDBConfig } = require(path.join(__dirname, 'utils/updateAdapterConfig'));
35
36
 
36
37
  let propUtil = null;
37
38
  let choosepath = null;
@@ -366,7 +367,6 @@ class AdapterBase extends EventEmitterCl {
366
367
  // if we were healthy, toggle health
367
368
  if (this.healthy) {
368
369
  this.emit('OFFLINE', { id: this.id });
369
- this.emit('DEGRADED', { id: this.id });
370
370
  this.healthy = false;
371
371
  if (typeof error === 'object') {
372
372
  log.error(`${origin}: HEALTH CHECK - Error ${JSON.stringify(error)}`);
@@ -385,7 +385,6 @@ class AdapterBase extends EventEmitterCl {
385
385
 
386
386
  // if we were unhealthy, toggle health
387
387
  if (!this.healthy) {
388
- this.emit('FIXED', { id: this.id });
389
388
  this.emit('ONLINE', { id: this.id });
390
389
  this.healthy = true;
391
390
  log.info(`${origin}: HEALTH CHECK SUCCESSFUL`);
@@ -583,21 +582,32 @@ class AdapterBase extends EventEmitterCl {
583
582
 
584
583
  // take action based on type of file being changed
585
584
  if (type === 'action') {
586
- // BACKUP???
587
585
  const ares = updateAction(epath, action, changes);
588
586
  if (ares) {
589
587
  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${ares}`, [], null, null, null);
590
588
  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
591
589
  return callback(null, errorObj);
592
590
  }
593
- // AJV CHECK???
594
- // RESTORE IF NEEDED???
591
+ // Update MongoDB if possible
592
+ updateMongoDBConfig({
593
+ id: this.id,
594
+ mongoProps: this.allProps.mongo,
595
+ entity,
596
+ type,
597
+ configFile,
598
+ changes,
599
+ action,
600
+ replace
601
+ }).catch((error) => {
602
+ log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
603
+ });
595
604
  const result = {
596
605
  response: `Action updates completed to entity: ${entity} - ${action}`
597
606
  };
598
607
  log.info(result.response);
599
608
  return callback(result, null);
600
609
  }
610
+
601
611
  if (type === 'schema') {
602
612
  const sres = updateSchema(epath, configFile, changes);
603
613
  if (sres) {
@@ -605,12 +615,26 @@ class AdapterBase extends EventEmitterCl {
605
615
  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
606
616
  return callback(null, errorObj);
607
617
  }
618
+ // Update MongoDB if possible
619
+ updateMongoDBConfig({
620
+ id: this.id,
621
+ mongoProps: this.allProps.mongo,
622
+ entity,
623
+ type,
624
+ configFile,
625
+ changes,
626
+ action,
627
+ replace
628
+ }).catch((error) => {
629
+ log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
630
+ });
608
631
  const result = {
609
632
  response: `Schema updates completed to entity: ${entity} - ${configFile}`
610
633
  };
611
634
  log.info(result.response);
612
635
  return callback(result, null);
613
636
  }
637
+
614
638
  if (type === 'mock') {
615
639
  // if the mock directory does not exist - error
616
640
  const mpath = `${__dirname}/entities/${entity}/mockdatafiles`;
@@ -624,18 +648,31 @@ class AdapterBase extends EventEmitterCl {
624
648
  return callback(null, errorObj);
625
649
  }
626
650
  const mres = updateMock(mpath, configFile, changes, replace);
627
-
628
651
  if (mres) {
629
652
  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: ${mres}`, [], null, null, null);
630
653
  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
631
654
  return callback(null, errorObj);
632
655
  }
656
+ // Update MongoDB if possible
657
+ updateMongoDBConfig({
658
+ id: this.id,
659
+ mongoProps: this.allProps.mongo,
660
+ entity,
661
+ type,
662
+ configFile,
663
+ changes,
664
+ action,
665
+ replace
666
+ }).catch((error) => {
667
+ log.error(`${origin}: Error updating MongoDB configuration: ${error.message}`);
668
+ });
633
669
  const result = {
634
670
  response: `Mock data updates completed to entity: ${entity} - ${configFile}`
635
671
  };
636
672
  log.info(result.response);
637
673
  return callback(result, null);
638
674
  }
675
+
639
676
  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, `Incomplete Configuration Change: Unsupported Type - ${type}`, [], null, null, null);
640
677
  log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
641
678
  return callback(null, errorObj);
@@ -831,14 +868,13 @@ class AdapterBase extends EventEmitterCl {
831
868
  *
832
869
  * @function iapTroubleshootAdapter
833
870
  * @param {Object} props - the connection, healthcheck and authentication properties
834
- * @param {boolean} persistFlag - whether the adapter properties should be updated
835
871
  * @param {Adapter} adapter - adapter instance to troubleshoot
836
872
  * @param {Callback} callback - callback function to return troubleshoot results
837
873
  */
838
- async iapTroubleshootAdapter(props, persistFlag, adapter, callback) {
874
+ async iapTroubleshootAdapter(props, adapter, callback) {
839
875
  try {
840
- const result = await troubleshootingAdapter.troubleshoot(props, false, persistFlag, adapter);
841
- if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.failCount === 0) {
876
+ const result = await troubleshootingAdapter.troubleshoot(props, false, adapter);
877
+ if (result.healthCheck && result.connectivity.failCount === 0 && result.basicGet.passCount !== 0) {
842
878
  return callback(result);
843
879
  }
844
880
  return callback(null, result);
@@ -875,8 +911,7 @@ class AdapterBase extends EventEmitterCl {
875
911
  */
876
912
  async iapRunAdapterConnectivity(callback) {
877
913
  try {
878
- const { host } = this.allProps;
879
- const result = tbUtils.runConnectivity(host, false);
914
+ const result = tbUtils.runConnectivity(this.allProps.host, false);
880
915
  if (result.failCount > 0) {
881
916
  return callback(null, result);
882
917
  }
@@ -890,12 +925,13 @@ class AdapterBase extends EventEmitterCl {
890
925
  * @summary runs basicGet script for adapter
891
926
  *
892
927
  * @function iapRunAdapterBasicGet
928
+ * @param {number} maxCalls - how many GETs to run (optional)
893
929
  * @param {Callback} callback - callback function to return basicGet result
894
930
  */
895
- iapRunAdapterBasicGet(callback) {
931
+ iapRunAdapterBasicGet(maxCalls, callback) {
896
932
  try {
897
- const result = tbUtils.runBasicGet(false);
898
- if (result.failCount > 0) {
933
+ const result = tbUtils.runBasicGet(this.allProps, false, maxCalls);
934
+ if (result.passCount === 0) {
899
935
  return callback(null, result);
900
936
  }
901
937
  return callback(result);
@@ -917,7 +953,7 @@ class AdapterBase extends EventEmitterCl {
917
953
  log.trace(origin);
918
954
 
919
955
  try {
920
- const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: this.allProps, id: this.id });
956
+ const result = await entitiesToDB.moveEntitiesToDB(__dirname, { pronghornProps: { mongo: this.allProps && this.allProps.mongo }, id: this.id });
921
957
  return callback(result, null);
922
958
  } catch (err) {
923
959
  const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Caught Exception', null, null, null, err);
package/package.json CHANGED
@@ -1,14 +1,13 @@
1
1
  {
2
2
  "name": "@itentialopensource/adapter-sendgrid",
3
- "version": "0.1.2",
3
+ "version": "0.2.0",
4
4
  "description": "This adapter integrates with system described as: SendGrid.",
5
5
  "main": "adapter.js",
6
6
  "systemName": "Sendgrid",
7
- "wizardVersion": "3.3.1",
8
- "engineVersion": "1.68.11",
7
+ "wizardVersion": "2.44.7",
8
+ "engineVersion": "1.69.14",
9
9
  "adapterType": "http",
10
10
  "scripts": {
11
- "artifactize": "npm i && node utils/packModificationScript.js",
12
11
  "preinstall": "node utils/setup.js",
13
12
  "deinstall": "node utils/removeHooks.js",
14
13
  "lint": "node --max_old_space_size=4096 ./node_modules/eslint/bin/eslint.js . --ext .json --ext .js",
@@ -17,7 +16,6 @@
17
16
  "test:unit": "mocha test/unit/adapterTestUnit.js --LOG=error",
18
17
  "test:integration": "mocha test/integration/adapterTestIntegration.js --LOG=error",
19
18
  "test": "npm run test:baseunit && npm run test:unit && npm run test:integration",
20
- "adapter:install": "npm i && node utils/tbScript.js install",
21
19
  "adapter:checkMigrate": "node utils/checkMigrate.js",
22
20
  "adapter:findPath": "node utils/findPath.js",
23
21
  "adapter:migrate": "node utils/modify.js -m",
@@ -32,10 +30,9 @@
32
30
  },
33
31
  "keywords": [
34
32
  "Itential",
35
- "IAP",
33
+ "Itential Platform",
36
34
  "Automation",
37
35
  "Integration",
38
- "App-Artifacts",
39
36
  "Adapter",
40
37
  "sendgrid",
41
38
  "Pre-Release"
@@ -52,30 +49,29 @@
52
49
  "author": "Itential",
53
50
  "homepage": "https://gitlab.com/itentialopensource/adapters/adapter-sendgrid#readme",
54
51
  "dependencies": {
55
- "@itentialopensource/adapter-utils": "^5.10.10",
56
- "acorn": "^8.12.1",
57
- "ajv": "^8.17.1",
58
- "axios": "^1.8.2",
59
- "commander": "^11.0.0",
60
- "dns-lookup-promise": "^1.0.4",
61
- "fs-extra": "^11.2.0",
62
- "json-query": "^2.2.2",
63
- "mocha": "^10.7.3",
64
- "mocha-param": "^2.0.1",
65
- "mongodb": "^4.16.0",
66
- "ping": "^0.4.4",
67
- "prompts": "^2.4.2",
68
- "readline-sync": "^1.4.10",
69
- "semver": "^7.6.3",
70
- "winston": "^3.14.2"
52
+ "@itentialopensource/adapter-utils": "5.10.16",
53
+ "acorn": "8.14.1",
54
+ "ajv": "8.17.1",
55
+ "axios": "1.9.0",
56
+ "commander": "11.1.0",
57
+ "fs-extra": "11.3.0",
58
+ "json-query": "2.2.2",
59
+ "mocha": "10.8.2",
60
+ "mocha-param": "2.0.1",
61
+ "mongodb": "4.17.2",
62
+ "ping": "0.4.4",
63
+ "prompts": "2.4.2",
64
+ "readline-sync": "1.4.10",
65
+ "semver": "7.7.2",
66
+ "winston": "3.17.0"
71
67
  },
72
68
  "devDependencies": {
73
- "chai": "^4.3.7",
74
- "eslint": "^8.44.0",
75
- "eslint-config-airbnb-base": "^15.0.0",
76
- "eslint-plugin-import": "^2.27.5",
77
- "eslint-plugin-json": "^3.1.0",
78
- "testdouble": "^3.18.0"
69
+ "chai": "4.5.0",
70
+ "eslint": "8.57.0",
71
+ "eslint-config-airbnb-base": "15.0.0",
72
+ "eslint-plugin-import": "2.31.0",
73
+ "eslint-plugin-json": "3.1.0",
74
+ "testdouble": "3.18.0"
79
75
  },
80
76
  "private": false
81
77
  }