@contentful/app-scripts 1.11.0 → 1.12.0

package/lib/clean-up/clean-up-bundles.test.js

@@ -14,7 +14,7 @@ const bundlesFixture = [
   { sys: { id: 'test-8' } },
 ];
 
-describe.only('cleanUpBundles', () => {
+describe('cleanUpBundles', () => {
   let subject, clientMock, deleteMock, createClientArgs;
   let mockedBundles = bundlesFixture;
 
@@ -92,7 +92,7 @@ describe.only('cleanUpBundles', () => {
     mockedBundles.unshift({ sys: { id: 'slow' } });
     mockedBundles = mockedBundles.reverse();
     clientMock.appBundle.delete = stub().callsFake(
-      ({ appBundleId }) => new Promise((r) => setTimeout(r, appBundleId === 'slow' ? 200 : 100))
+      ({ appBundleId }) => new Promise((r) => setTimeout(r, appBundleId === 'slow' ? 200 : 100)),
     );
     subject({ ...mockedSettings, keep: 0 });
     await clock.tickAsync(50);

package/lib/upload/build-upload-settings.js

@@ -2,13 +2,15 @@
 
 const inquirer = require('inquirer');
 const { getAppInfo } = require('../get-app-info');
-const { getActionsManifest } = require('../utils');
+const { getEntityFromManifest } = require('../utils');
 const { CONTENTFUL_API_HOST } = require('../../utils/constants');
 
 async function buildAppUploadSettings(options) {
-  const actionsManifest = getActionsManifest();
+  const actionsManifest = getEntityFromManifest('actions');
+  const deliveryFnManifest = getEntityFromManifest('deliveryFunctions');
   const prompts = [];
   const { bundleDir, comment, skipActivation, host } = options;
+
   if (!bundleDir) {
     prompts.push({
       name: 'bundleDirectory',
@@ -49,6 +51,7 @@ async function buildAppUploadSettings(options) {
     comment,
     host,
     actions: actionsManifest,
+    deliveryFunctions: deliveryFnManifest,
     ...appUploadSettings,
     ...appInfo,
   };

package/lib/upload/create-app-bundle.js

@@ -6,7 +6,7 @@ const { createClient } = require('contentful-management');
 const { createAppUpload } = require('./create-app-upload');
 
 async function createAppBundleFromUpload(settings, appUploadId) {
-  const { accessToken, host, userAgentApplication, comment, actions } = settings;
+  const { accessToken, host, userAgentApplication, comment, actions, deliveryFunctions } = settings;
   const clientSpinner = ora('Verifying your upload...').start();
   const client = createClient({
     accessToken,
@@ -24,6 +24,7 @@ async function createAppBundleFromUpload(settings, appUploadId) {
       appUploadId,
       comment: comment && comment.length > 0 ? comment : undefined,
       actions,
+      deliveryFunctions,
     });
   } catch (err) {
     showCreationError('app upload', err.message);
@@ -38,8 +39,8 @@ async function createAppBundleFromSettings(settings) {
     appUpload = await createAppUpload(settings);
     console.log(`
   ${chalk.yellow('Done!')} Your files were successfully uploaded and a new AppUpload (${chalk.dim(
-      appUpload.sys.id
-    )}) has been created.`);
+    appUpload.sys.id,
+  )}) has been created.`);
   } catch (err) {
     showCreationError('app upload', err.message);
   }
@@ -54,7 +55,7 @@ async function createAppBundleFromSettings(settings) {
 
   console.log(`
   ${chalk.cyan('Success!')} Created a new app bundle for ${chalk.cyan(
-    settings.definition.name
+    settings.definition.name,
   )} in ${chalk.bold(settings.organization.name)}.
 
   Bundle Id: ${chalk.yellow(appBundle.sys.id)}

package/lib/upload/get-upload-settings-args.js

@@ -2,7 +2,7 @@ const chalk = require('chalk');
 const ora = require('ora');
 const { getAppInfo } = require('../get-app-info');
 const { validateArguments } = require('../validate-arguments');
-const { getActionsManifest } = require('../utils');
+const { getEntityFromManifest } = require('../utils');
 
 const requiredOptions = {
   definitionId: '--definition-id',
@@ -13,7 +13,8 @@ const requiredOptions = {
 
 async function getUploadSettingsArgs(options) {
   const validateSpinner = ora('Validating your input...').start();
-  const actionsManifest = getActionsManifest();
+  const actionsManifest = getEntityFromManifest('actions');
+  const deliveryFnManifest = getEntityFromManifest('deliveryFunctions');
   const { bundleDir, comment, skipActivation, host, userAgentApplication } = options;
 
   try {
@@ -27,6 +28,7 @@ async function getUploadSettingsArgs(options) {
       host,
       userAgentApplication,
       actions: actionsManifest,
+      deliveryFunctions: deliveryFnManifest,
     };
   } catch (err) {
     console.log(`

package/lib/utils.js

@@ -35,6 +35,14 @@ const showCreationError = (subject, message) => {
     `);
 };
 
+const logProgress = (message) => {
+  console.log('');
+  console.log(`  ----------------------------
+  ${message}
+  ----------------------------`);
+  console.log('');
+};
+
 const throwError = (err, message) => {
   console.log(`
 ${chalk.red('Error:')} ${message}.
@@ -50,10 +58,8 @@ const selectFromList = async (list, message, cachedOptionEnvVar) => {
   const cachedElement = list.find((item) => item.value === cachedEnvVar);
 
   if (cachedElement) {
-    console.log(`
-  ${message}
-  Using environment variable: ${cachedElement.name} (${chalk.blue(cachedElement.value)})
-    `);
+    logProgress(`${message}
+      Using environment variable: ${cachedElement.name} (${chalk.blue(cachedElement.value)})`);
     return cachedElement;
   } else {
     const { elementId } = await inquirer.prompt([
@@ -73,7 +79,7 @@ const selectFromList = async (list, message, cachedOptionEnvVar) => {
   }
 };
 
-function getActionsManifest() {
+function getEntityFromManifest(type) {
   const isManifestExists = fs.existsSync(DEFAULT_MANIFEST_PATH);
 
   if (!isManifestExists) {
@@ -83,29 +89,29 @@ function getActionsManifest() {
   try {
     const manifest = JSON.parse(fs.readFileSync(DEFAULT_MANIFEST_PATH, { encoding: 'utf8' }));
 
-    if (!Array.isArray(manifest.actions) || manifest.actions.length === 0) {
+    if (!Array.isArray(manifest[type]) || manifest[type].length === 0) {
       return;
     }
 
-    console.log('');
-    console.log(`  ----------------------------
-  App actions manifest found in ${chalk.bold(DEFAULT_MANIFEST_PATH)}.
-  ----------------------------`);
-    console.log('');
+    logProgress(
+      `${type === 'actions' ? 'App Actions' : 'Delivery functions'} found in ${chalk.bold(
+        DEFAULT_MANIFEST_PATH,
+      )}.`,
+    );
 
-    const actions = manifest.actions.map((action) => {
-      const allowNetworks = Array.isArray(action.allowNetworks)
-        ? action.allowNetworks.map(stripProtocol)
+    const items = manifest[type].map((item) => {
+      const allowNetworks = Array.isArray(item.allowNetworks)
+        ? item.allowNetworks.map(stripProtocol)
         : [];
 
       const hasInvalidNetwork = allowNetworks.find((netWork) => !isValidNetwork(netWork));
       if (hasInvalidNetwork) {
         console.log(
           `${chalk.red(
-            'Error:'
-          )} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for action "${
-            action.name
-          }".`
+            'Error:',
+          )} Invalid IP address ${hasInvalidNetwork} found in the allowNetworks array for ${type} "${
+            item.name
+          }".`,
         );
         // eslint-disable-next-line no-process-exit
         process.exit(1);
@@ -113,20 +119,20 @@ function getActionsManifest() {
 
       // EntryFile is not used but we do want to strip it from action
       // eslint-disable-next-line no-unused-vars
-      const { entryFile: _, ...actionWithoutEntryFile } = action;
+      const { entryFile: _, ...itemWithoutEntryFile } = item;
 
       return {
-        ...actionWithoutEntryFile,
+        ...itemWithoutEntryFile,
         allowNetworks,
       };
     });
 
-    return actions;
+    return items;
   } catch {
     console.log(
       `${chalk.red('Error:')} Invalid JSON in manifest file at ${chalk.bold(
-        DEFAULT_MANIFEST_PATH
-      )}.`
+        DEFAULT_MANIFEST_PATH,
+      )}.`,
     );
     // eslint-disable-next-line no-process-exit
     process.exit(1);
@@ -138,7 +144,7 @@ module.exports = {
   throwError,
   selectFromList,
   showCreationError,
-  getActionsManifest,
+  getEntityFromManifest,
   isValidNetwork,
   stripProtocol,
 };

package/lib/utils.test.js

@@ -68,9 +68,8 @@ describe('removeProtocolFromUrl', () => {
   });
 });
 
-describe('getActionsManifest', () => {
+describe('get actions from manifest', () => {
   let fs, exitStub, consoleLog, chalk;
-  let DEFAULT_MANIFEST_PATH = 'path/to/manifest';
 
   const actionMock = {
     name: 'name',
@@ -94,7 +93,7 @@ describe('getActionsManifest', () => {
     red: stub(),
   };
 
-  let { getActionsManifest } = proxyquire('./utils', { fs, chalk });
+  let { getEntityFromManifest } = proxyquire('./utils', { fs, chalk });
 
   beforeEach(() => {
     exitStub = stub(process, 'exit');
@@ -108,7 +107,7 @@ describe('getActionsManifest', () => {
   it('should return undefined if manifest does not exist', () => {
     fs.existsSync.returns(false);
 
-    const result = getActionsManifest(DEFAULT_MANIFEST_PATH);
+    const result = getEntityFromManifest('actions');
 
     assert.equal(result, undefined);
   });
@@ -117,7 +116,7 @@ describe('getActionsManifest', () => {
     fs.existsSync.returns(true);
     fs.readFileSync.returns(JSON.stringify({ actions: [] }));
 
-    const result = getActionsManifest(DEFAULT_MANIFEST_PATH);
+    const result = getEntityFromManifest('actions');
     assert.equal(result, undefined);
   });
 
@@ -126,10 +125,10 @@ describe('getActionsManifest', () => {
     fs.readFileSync.returns(
       JSON.stringify({
         actions: [actionMock],
-      })
+      }),
     );
 
-    const result = getActionsManifest();
+    const result = getEntityFromManifest('actions');
 
     assert.deepEqual(result, [resultMock]);
     assert.ok(consoleLog.called);
@@ -146,10 +145,10 @@ describe('getActionsManifest', () => {
     fs.readFileSync.returns(
       JSON.stringify({
         actions: [mockAction],
-      })
+      }),
     );
 
-    const result = getActionsManifest();
+    const result = getEntityFromManifest('actions');
 
     assert.deepEqual(result, [{ ...resultMock, allowNetworks: ['some.domain.tld'] }]);
     assert.ok(consoleLog.called);
@@ -160,10 +159,10 @@ describe('getActionsManifest', () => {
     fs.readFileSync.returns(
       JSON.stringify({
         actions: [actionMock],
-      })
+      }),
     );
 
-    const result = getActionsManifest();
+    const result = getEntityFromManifest('actions');
 
     assert.notDeepEqual(result, [actionMock]);
   });
@@ -179,10 +178,10 @@ describe('getActionsManifest', () => {
             allowNetworks: ['412.1.1.1'],
           },
         ],
-      })
+      }),
     );
 
-    getActionsManifest();
+    getEntityFromManifest('actions');
 
     assert.ok(exitStub.calledOnceWith(1));
   });
@@ -191,7 +190,133 @@ describe('getActionsManifest', () => {
     fs.existsSync.returns(true);
     fs.readFileSync.throws();
 
-    getActionsManifest();
+    getEntityFromManifest('actions');
+
+    assert.ok(exitStub.calledOnceWith(1));
+  });
+});
+
+describe('get delivery functions from manifest', () => {
+  let fs, exitStub, consoleLog, chalk;
+
+  const deliveryFnMock = {
+    id: 'test',
+    name: 'name',
+    description: 'descriptoin',
+    path: 'delivery-functions/mock.js',
+    entryFile: './delivery-functions/mock.ts',
+    allowNetworks: ['127.0.0.1', 'some.domain.tld'],
+  };
+  // eslint-disable-next-line no-unused-vars
+  const { entryFile: _, ...resultMock } = deliveryFnMock;
+
+  fs = {
+    existsSync: stub(),
+    readFileSync: stub(),
+  };
+  chalk = {
+    bold: stub(),
+    red: stub(),
+  };
+
+  let { getEntityFromManifest } = proxyquire('./utils', { fs, chalk });
+
+  beforeEach(() => {
+    exitStub = stub(process, 'exit');
+    consoleLog = stub(console, 'log');
+  });
+  afterEach(() => {
+    exitStub.restore();
+    consoleLog.restore();
+  });
+
+  it('should return undefined if manifest does not exist', () => {
+    fs.existsSync.returns(false);
+
+    const result = getEntityFromManifest('deliveryFunctions');
+
+    assert.equal(result, undefined);
+  });
+
+  it('should return undefined if manifest has no delivery functions', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(JSON.stringify({ deliveryFunctions: [] }));
+
+    const result = getEntityFromManifest('deliveryFunctions');
+    assert.equal(result, undefined);
+  });
+
+  it('should return an array of delivery functions if manifest is valid', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        deliveryFunctions: [deliveryFnMock],
+      }),
+    );
+
+    const result = getEntityFromManifest('deliveryFunctions');
+
+    assert.deepEqual(result, [resultMock]);
+    assert.ok(consoleLog.called);
+  });
+
+  it('should strip the protocol when a domain has a protocol in allowNetworks', () => {
+    const mockDeliveryFn = {
+      ...deliveryFnMock,
+      allowNetworks: ['http://some.domain.tld'],
+    };
+    // eslint-disable-next-line no-unused-vars
+    const { entryFile: _, ...resultMock } = mockDeliveryFn;
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        deliveryFunctions: [mockDeliveryFn],
+      }),
+    );
+
+    const result = getEntityFromManifest('deliveryFunctions');
+
+    assert.deepEqual(result, [{ ...resultMock, allowNetworks: ['some.domain.tld'] }]);
+    assert.ok(consoleLog.called);
+  });
+
+  it('should return an array of delivery functions without entryFile prop if manifest is valid', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        deliveryFunctions: [deliveryFnMock],
+      }),
+    );
+
+    const result = getEntityFromManifest('deliveryFunctions');
+
+    assert.notDeepEqual(result, [deliveryFnMock]);
+  });
+
+  it('should exit with error if invalid network is found in allowNetworks', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.returns(
+      JSON.stringify({
+        deliveryFunctions: [
+          {
+            name: 'test resolver fn',
+            entryFile: 'entry1',
+            allowNetworks: ['412.1.1.1'],
+          },
+        ],
+      }),
+    );
+
+    getEntityFromManifest('deliveryFunctions');
+
+    assert.ok(exitStub.calledOnceWith(1));
+  });
+
+  it('should exit with error if manifest is invalid JSON', () => {
+    fs.existsSync.returns(true);
+    fs.readFileSync.throws();
+
+    getEntityFromManifest('deliveryFunctions');
 
     assert.ok(exitStub.calledOnceWith(1));
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -27,7 +27,7 @@
     "prettier": "prettier **/*.js --write --ignore-path .gitignore",
     "lint": "eslint ./lib",
     "lint:fix": "npm run lint -- --fix",
-    "test": "mocha ./lib/**/*.test.js ./lib/*.test.js ./utils/**/*.test.js",
+    "test": "mocha \"./{,!(node_modules)/**/}*.test.js\" --exit",
     "test:watch": "npm t -- --watch",
     "pre-commit": "lint-staged"
   },
@@ -53,7 +53,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "11.0.0",
-    "contentful-management": "10.39.2",
+    "contentful-management": "10.40.0",
     "dotenv": "16.3.1",
     "ignore": "5.2.4",
     "inquirer": "8.2.6",
@@ -61,5 +61,5 @@
     "open": "8.4.2",
     "ora": "5.4.1"
   },
-  "gitHead": "5c1470b0d752ec3e8e6cdf412b8ea2d1183a32ab"
+  "gitHead": "e6ee977c9fc8db111bcd36c8caa1550f4829afb6"
 }