mcdev 4.2.1 → 4.3.1

package/test/transactionalEmail.test.js

@@ -32,9 +32,9 @@ describe('transactionalEmail', () => {
                 'returned JSON was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 12,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -68,9 +68,9 @@ describe('transactionalEmail', () => {
             );
             // check number of API calls
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
-                13,
-                'Unexpected number of requests made'
+                testUtils.getAPIHistoryLength(),
+                14,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -110,9 +110,9 @@ describe('transactionalEmail', () => {
                 'returned deployment JSON was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 12,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });

package/test/transactionalPush.test.js

@@ -32,9 +32,9 @@ describe('transactionalPush', () => {
                 'returned JSON was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 3,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -68,9 +68,9 @@ describe('transactionalPush', () => {
             );
             // check number of API calls
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
-                4,
-                'Unexpected number of requests made'
+                testUtils.getAPIHistoryLength(),
+                5,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -110,9 +110,9 @@ describe('transactionalPush', () => {
                 'returned deployment JSON was not equal expected'
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 3,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });

package/test/transactionalSMS.test.js

@@ -39,9 +39,9 @@ describe('transactionalSMS', () => {
                 file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'get', 'amp'))
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 4,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -85,9 +85,9 @@ describe('transactionalSMS', () => {
             );
             // check number of API calls
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
-                5,
-                'Unexpected number of requests made'
+                testUtils.getAPIHistoryLength(),
+                6,
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });
@@ -139,9 +139,9 @@ describe('transactionalSMS', () => {
                 file(testUtils.getExpectedFile('9999999', 'transactionalSMS', 'build', 'amp'))
             );
             assert.equal(
-                Object.values(testUtils.getAPIHistory()).flat().length,
+                testUtils.getAPIHistoryLength(),
                 4,
-                'Unexpected number of requests made'
+                'Unexpected number of requests made. Run testUtils.logAPIHistoryDebug() to see the requests'
             );
             return;
         });

package/test/utils.js

@@ -114,12 +114,29 @@ exports.mockSetup = (isDeploy) => {
         .reply((config) => resourceFactory.handleRESTRequest(config));
     const fsMockConf = {
         '.prettierrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.prettierrc')),
+        '.eslintrc': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintrc')),
+        '.eslintignore': fsmock.load(path.resolve(__dirname, '../boilerplate/files/.eslintignore')),
         '.mcdevrc.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdevrc.json')),
         '.mcdev-auth.json': fsmock.load(path.resolve(__dirname, 'mockRoot/.mcdev-auth.json')),
         'boilerplate/config.json': fsmock.load(
             path.resolve(__dirname, '../boilerplate/config.json')
         ),
         test: fsmock.load(path.resolve(__dirname)),
+        // the following node_modules are required for prettier's SQL parser to work
+        'node_modules/prettier': fsmock.load(path.resolve(__dirname, '../node_modules/prettier')),
+        'node_modules/prettier-plugin-sql': fsmock.load(
+            path.resolve(__dirname, '../node_modules/prettier-plugin-sql')
+        ),
+        'node_modules/node-sql-parser': fsmock.load(
+            path.resolve(__dirname, '../node_modules/node-sql-parser')
+        ),
+        'node_modules/big-integer': fsmock.load(
+            path.resolve(__dirname, '../node_modules/big-integer')
+        ),
+        'node_modules/sql-formatter': fsmock.load(
+            path.resolve(__dirname, '../node_modules/sql-formatter')
+        ),
+        'node_modules/nearley': fsmock.load(path.resolve(__dirname, '../node_modules/nearley')),
     };
     if (isDeploy) {
         // load files we manually prepared for a direct test of `deploy` command
@@ -138,12 +155,45 @@ exports.mockReset = () => {
     fsmock.restore();
     apimock.restore();
 };
+/**
+ * helper to return amount of api callouts
+ *
+ * @param {boolean} [includeToken] if true, will include token calls in count
+ * @returns {object} of API history
+ */
+exports.getAPIHistoryLength = (includeToken) => {
+    const historyArr = Object.values(apimock.history).flat();
+    if (includeToken) {
+        return historyArr.length;
+    }
+    return historyArr.filter((item) => item.url !== '/v2/token').length;
+};
 /**
  * helper to return api history
  *
  * @returns {object} of API history
  */
 exports.getAPIHistory = () => apimock.history;
+/**
+ * helper to return most important fields for each api call
+ *
+ * @returns {object} of API history
+ */
+function getAPIHistoryDebug() {
+    const historyArr = Object.values(apimock.history)
+        .flat()
+        .map((item) => ({ url: item.url, data: item.data }));
+    return historyArr;
+}
+exports.getAPIHistoryDebug = getAPIHistoryDebug;
+/**
+ * helper to return most important fields for each api call
+ *
+ * @returns {void} of API history
+ */
+exports.logAPIHistoryDebug = () => {
+    console.log(getAPIHistoryDebug()); // eslint-disable-line no-console
+};
 
 /**
  * escapes string for regex

package/types/mcdev.d.js

@@ -24,6 +24,7 @@ const SDK = require('sfmc-sdk');
  * @typedef {{metadata:MetadataTypeMap,type:SupportedMetadataTypes}} MetadataTypeMapObj
  * @typedef {{metadata:MetadataTypeItem,type:SupportedMetadataTypes}} MetadataTypeItemObj
  * @typedef {Object.<number, MultiMetadataTypeMap>} Cache key=MID
+ * @typedef {{before: TYPE.MetadataTypeItem, after: TYPE.MetadataTypeItem}} MetadataTypeItemDiff used during update
  */
 
 /**