@contentful/app-scripts 1.2.6 → 1.4.2

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

@@ -1,7 +1,10 @@
 const chalk = require('chalk');
 const ora = require('ora');
 const Bottleneck = require('bottleneck');
-const { MAX_CONCURRENT_DELETION_CALLS } = require('../../utils/constants');
+const {
+  MAX_CONCURRENT_DELETION_CALLS,
+  DEFAULT_BUNDLES_TO_FETCH,
+} = require('../../utils/constants');
 const { throwError } = require('../utils');
 const { createClient } = require('contentful-management');
 
@@ -29,7 +32,8 @@ const scheduleBundleDeletion = async (bundlesToDelete, client, settings) => {
 };
 
 async function cleanUpBundles(settings) {
-  let bundles, definition;
+  let bundlesToDelete, definition;
+
   const client = createClient(
     {
       host: settings.host,
@@ -37,12 +41,51 @@ async function cleanUpBundles(settings) {
     },
     { type: 'plain' }
   );
-  const bundlesSpinner = ora(`Fetching all bundles...`).start();
-  try {
-    bundles = await client.appBundle.getMany({
+
+  const fetchAppBundles = async (limit = DEFAULT_BUNDLES_TO_FETCH, skip = 0) => {
+    return await client.appBundle.getMany({
       appDefinitionId: settings.definition.value,
       organizationId: settings.organization.value,
+      query: {
+        limit,
+        skip,
+      },
     });
+  };
+
+  const getAppBundles = async (requestedAmount = DEFAULT_BUNDLES_TO_FETCH) => {
+    if (requestedAmount < 1) {
+      throw new Error('Requested amount of bundles to fetch must be greater than 0');
+    }
+    const getBundles = async (limit, skip) => {
+      const result = await fetchAppBundles(limit, skip);
+      const currLength = skip + result.items.length;
+
+      if (result.total > currLength) {
+        return [...result.items, ...(await getBundles(result.items.length, currLength))];
+      } else {
+        return result.items;
+      }
+    };
+
+    const all = await getBundles(DEFAULT_BUNDLES_TO_FETCH, 0);
+    return all.reverse().slice(0, requestedAmount);
+  };
+
+  const getAppBundleCount = async () => {
+    return await fetchAppBundles(1, 0);
+  };
+
+  const bundlesSpinner = ora(`Fetching all bundles...`).start();
+  try {
+    const { total } = await getAppBundleCount();
+    const amountToDelete = total - settings.keep;
+    if (amountToDelete < 1) {
+      console.log(`${chalk.yellow('Warning:')} There is nothing to delete`);
+      bundlesSpinner.stop();
+      return;
+    }
+    bundlesToDelete = await getAppBundles(amountToDelete);
     definition = await client.appDefinition.get({
       appDefinitionId: settings.definition.value,
       organizationId: settings.organization.value,
@@ -53,8 +96,6 @@ async function cleanUpBundles(settings) {
 
   bundlesSpinner.stop();
 
-  let bundlesToDelete = bundles.items.slice(settings.keep);
-
   if (definition.bundle) {
     bundlesToDelete = bundlesToDelete.filter(
       (bundle) => bundle.sys.id !== definition.bundle.sys.id

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

@@ -1,4 +1,4 @@
-const { stub, match, useFakeTimers } = require('sinon');
+const { stub, spy, match, useFakeTimers } = require('sinon');
 const assert = require('assert');
 const proxyquire = require('proxyquire');
 
@@ -14,8 +14,8 @@ const bundlesFixture = [
   { sys: { id: 'test-8' } },
 ];
 
-describe('cleanUpBundles', () => {
-  let subject, clientMock, deleteMock;
+describe.only('cleanUpBundles', () => {
+  let subject, clientMock, deleteMock, createClientArgs;
   let mockedBundles = bundlesFixture;
 
   beforeEach(() => {
@@ -31,7 +31,10 @@ describe('cleanUpBundles', () => {
     deleteMock = stub();
     clientMock = {
       appBundle: {
-        getMany: () => ({ items: mockedBundles }),
+        getMany: () => ({
+          total: mockedBundles.length,
+          items: mockedBundles,
+        }),
         delete: deleteMock,
       },
       appDefinition: {
@@ -41,7 +44,10 @@ describe('cleanUpBundles', () => {
     };
     ({ cleanUpBundles: subject } = proxyquire('./clean-up-bundles', {
       'contentful-management': {
-        createClient: () => clientMock,
+        createClient: (...args) => {
+          createClientArgs = args;
+          return clientMock;
+        },
       },
       '../../utils/constants': {
         MAX_CONCURRENT_DELETION_CALLS: 2,
@@ -84,6 +90,7 @@ describe('cleanUpBundles', () => {
   it('slow call will occupy slot until finished', async () => {
     const clock = useFakeTimers();
     mockedBundles.unshift({ sys: { id: 'slow' } });
+    mockedBundles = mockedBundles.reverse();
     clientMock.appBundle.delete = stub().callsFake(
       ({ appBundleId }) => new Promise((r) => setTimeout(r, appBundleId === 'slow' ? 200 : 100))
     );
@@ -99,4 +106,13 @@ describe('cleanUpBundles', () => {
 
     clock.restore();
   });
+  it('supports custom defined host domain', async () => {
+    await subject({ ...mockedSettings, host: 'jane.doe.com' });
+    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
+  });
+  it('queries more than 100 bundles', async () => {
+    spy(clientMock.appBundle, 'getMany');
+    await subject(mockedSettings);
+    assert(clientMock.appBundle.getMany.calledWith(match({ query: { limit: 1000 } })));
+  });
 });

package/lib/clean-up/get-clean-up-settings.js

@@ -19,6 +19,7 @@ async function getCleanUpSettingsArgs(options) {
     return {
       ...appInfo,
       keep: options.keep !== undefined ? +options.keep : DEFAULT_BUNDLES_TO_KEEP,
+      host: options.host,
     };
   } catch (err) {
     console.log(`

package/lib/create-app-definition/build-app-definition-settings.js

@@ -26,6 +26,7 @@ NOTE: This will create an app definition in your Contentful organization.
         { name: 'Entry editor (entry-editor)', value: 'entry-editor' },
         { name: 'Entry sidebar (entry-sidebar) ', value: 'entry-sidebar' },
         { name: 'Page (page) ', value: 'page' },
+        { name: 'Home (home) ', value: 'home' },
       ],
     },
     {

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

@@ -7,7 +7,12 @@ const { createAppUpload } = require('./create-app-upload');
 
 async function createAppBundleFromUpload(settings, appUploadId) {
   const clientSpinner = ora('Verifying your upload...').start();
-  const client = createClient({ accessToken: settings.accessToken });
+  const client = createClient({
+    accessToken: settings.accessToken,
+    application: settings.userAgentApplication
+      ? settings.userAgentApplication
+      : 'contentful.app-scripts',
+  });
   const organization = await client.getOrganization(settings.organization.value);
   const appDefinition = await organization.getAppDefinition(settings.definition.value);
   clientSpinner.stop();
@@ -31,18 +36,16 @@ async function createAppBundleFromSettings(settings) {
   try {
     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.`);
+  ${chalk.yellow('Done!')} Your files were successfully uploaded and a new AppUpload (${chalk.dim(
+      appUpload.sys.id
+    )}) has been created.`);
   } catch (err) {
     showCreationError('app upload', err.message);
   }
 
   if (!appUpload) return;
 
-  console.log("")
+  console.log('');
   console.log(`  ----------------------------`);
   const appBundle = await createAppBundleFromUpload(settings, appUpload.sys.id);
 

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

@@ -21,6 +21,7 @@ async function getUploadSettingsArgs(options) {
       bundleDirectory: options.bundleDir,
       skipActivation: options.skipActivation,
       comment: options.comment,
+      userAgentApplication: options.userAgentApplication,
     };
   } catch (err) {
     console.log(`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/app-scripts",
-  "version": "1.2.6",
+  "version": "1.4.2",
   "description": "A collection of scripts for building Contentful Apps",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -52,7 +52,7 @@
     "bottleneck": "2.19.5",
     "chalk": "4.1.2",
     "commander": "9.4.1",
-    "contentful-management": "10.21.4",
+    "contentful-management": "10.23.0",
     "dotenv": "16.0.3",
     "ignore": "5.2.1",
     "inquirer": "8.2.5",
@@ -60,5 +60,5 @@
     "open": "8.4.0",
     "ora": "5.4.1"
   },
-  "gitHead": "106280b4757286f49f7622f3ed3aca5c1fd93fec"
+  "gitHead": "4c3506be3f52c7a8aae17deaa75acefc9a805b42"
 }

package/utils/constants.js

@@ -4,6 +4,7 @@ const ORG_ID_ENV_KEY = 'CONTENTFUL_ORG_ID';
 const APP_DEF_ENV_KEY = 'CONTENTFUL_APP_DEF_ID';
 
 const DEFAULT_BUNDLES_TO_KEEP = 50;
+const DEFAULT_BUNDLES_TO_FETCH = 1000;
 const MAX_CONCURRENT_DELETION_CALLS = 5;
 
 module.exports = {
@@ -13,4 +14,5 @@ module.exports = {
   ORG_ID_ENV_KEY,
   APP_DEF_ENV_KEY,
   MAX_CONCURRENT_DELETION_CALLS,
+  DEFAULT_BUNDLES_TO_FETCH,
 };

package/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Contentful
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.