@contentful/app-scripts 1.12.0 → 1.13.0

package/bin/app-scripts

@@ -1,78 +0,0 @@
-#!/usr/bin/env node
-
-const { program } = require('commander');
-const { version } = require('../package.json');
-
-const { createAppDefinition, upload, activate, cleanup, open, track } = require('../');
-
-async function runCommand(command, options) {
-  const { ci } = program.opts();
-  return ci ? await command.nonInteractive(options) : await command.interactive(options);
-}
-
-(async function main() {
-  program.version(version).option('--ci', 'Execute in non-interactive mode', false);
-
-  program
-    .command('create-app-definition')
-    .description('Create a new AppDefinition for an App')
-    .action(async (options) => {
-      await runCommand(createAppDefinition, options);
-    });
-
-  program
-    .command('upload')
-    .description('Upload your build folder and create an AppBundle')
-    .option('--bundle-dir [directory]', 'The directory of your build folder')
-    .option('--organization-id [orgId]', 'The id of your organization')
-    .option('--definition-id [defId]', 'The id of your apps definition')
-    .option('--token [accessToken]', 'Your content management access token')
-    .option('--comment [comment]', 'Optional comment for the created bundle')
-    .option('--skip-activation', 'A Boolean flag to skip automatic activation')
-    .option('--host [host]', 'Contentful domain to use')
-    .action(async (options) => {
-      await runCommand(upload, options);
-    });
-
-  program
-    .command('activate')
-    .description('Mark an AppBundle as "active" for a given AppDefinition')
-    .option('--bundle-id [bundleId]', 'The id of your bundle')
-    .option('--organization-id [orgId]', 'The id of your organization')
-    .option('--definition-id  [defId]', 'The id of your apps definition')
-    .option('--token [accessToken]', 'Your content management access token')
-    .option('--host [host]', 'Contentful domain to use')
-    .action(async (options) => {
-      await runCommand(activate, options);
-    });
-
-  program
-    .command('open-settings')
-    .description('Opens the app editor for a given AppDefinition')
-    .option('--definition-id  [defId]', 'The id of your apps definition')
-    .action(async (options) => {
-      await runCommand(open, options);
-    });
-
-  program
-    .command('bundle-cleanup')
-    .description('Removes old, non-active bundles, only keeps the 50 most recent ones')
-    .option('--organization-id [orgId]', 'The id of your organization')
-    .option('--definition-id  [defId]', 'The id of your apps definition')
-    .option('--token [accessToken]', 'Your content management access token')
-    .option('--keep [keepAmount]', 'The amount of bundles that should remain')
-    .option('--host [host]', 'Contentful domain to use')
-    .action(async (options) => {
-      await runCommand(cleanup, options);
-    });
-
-  program.hook('preAction', (thisCommand) => {
-    track({ command: thisCommand.args[0], ci: `${thisCommand._optionValues.ci}` });
-  });
-
-  await program.parseAsync(process.argv);
-})().catch((e) => {
-  console.error(e);
-  // eslint-disable-next-line no-process-exit
-  process.exit(1);
-});

package/lib/activate/activate-bundle.test.js

@@ -1,69 +0,0 @@
-const { stub, match } = require('sinon');
-const assert = require('assert');
-const proxyquire = require('proxyquire');
-
-const mockedSettings = {
-  accessToken: 'token',
-  organization: { value: 'id' },
-  definition: { value: 'id' },
-  bundleId: 'bundle-id',
-};
-
-describe('activate-bundle', () => {
-  // eslint-disable-next-line no-unused-vars
-  let activateBundle, clientMock, updateStub, createClientArgs;
-  beforeEach(() => {
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    console.log.restore();
-  });
-
-  const throwErrorStub = stub();
-  const definitionMock = {
-    src: 'src',
-    bundle: undefined,
-    locations: [],
-  };
-
-  beforeEach(() => {
-    updateStub = stub();
-    clientMock = {
-      appDefinition: {
-        get: () => definitionMock,
-        update: () => updateStub(),
-      },
-    };
-
-    ({ activateBundle } = proxyquire('./activate-bundle', {
-      'contentful-management': {
-        createClient: (...args) => {
-          createClientArgs = args;
-          return clientMock;
-        },
-      },
-      '../utils': {
-        throwError: throwErrorStub,
-      },
-    }));
-  });
-
-  it('updates definition with bundle, sets default location, and sets src to undefined', async () => {
-    await activateBundle(mockedSettings);
-    assert.strictEqual(definitionMock.bundle.sys.id, mockedSettings.bundleId);
-    assert.strictEqual(definitionMock.locations.length, 1);
-    assert.strictEqual(definitionMock.src, undefined);
-    assert.strictEqual(updateStub.called, true);
-    assert(console.log.calledWith(match(/Your app bundle was activated/)));
-  });
-  it('shows error when update went wrong', async () => {
-    updateStub = stub().rejects(new Error());
-    await activateBundle(mockedSettings);
-    assert.strictEqual(throwErrorStub.called, true);
-  });
-  it('supports custom defined host domain', async () => {
-    await activateBundle({ ...mockedSettings, host: 'jane.doe.com' });
-    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
-  });
-});

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

@@ -1,118 +0,0 @@
-const { stub, spy, match, useFakeTimers } = require('sinon');
-const assert = require('assert');
-const proxyquire = require('proxyquire');
-
-const mockedSettings = { definition: { value: 'test' }, organization: { value: 'test' } };
-const bundlesFixture = [
-  { sys: { id: 'test-1' } },
-  { sys: { id: 'test-2' } },
-  { sys: { id: 'test-3' } },
-  { sys: { id: 'test-4' } },
-  { sys: { id: 'test-5' } },
-  { sys: { id: 'test-6' } },
-  { sys: { id: 'test-7' } },
-  { sys: { id: 'test-8' } },
-];
-
-describe('cleanUpBundles', () => {
-  let subject, clientMock, deleteMock, createClientArgs;
-  let mockedBundles = bundlesFixture;
-
-  beforeEach(() => {
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    mockedBundles = bundlesFixture;
-    console.log.restore();
-  });
-
-  beforeEach(() => {
-    deleteMock = stub();
-    clientMock = {
-      appBundle: {
-        getMany: () => ({
-          total: mockedBundles.length,
-          items: mockedBundles,
-        }),
-        delete: deleteMock,
-      },
-      appDefinition: {
-        get: () => ({ bundle: { sys: { id: 'active-bundle' } } }),
-        delete: deleteMock,
-      },
-    };
-    ({ cleanUpBundles: subject } = proxyquire('./clean-up-bundles', {
-      'contentful-management': {
-        createClient: (...args) => {
-          createClientArgs = args;
-          return clientMock;
-        },
-      },
-      '../../utils/constants': {
-        MAX_CONCURRENT_DELETION_CALLS: 2,
-      },
-    }));
-  });
-
-  it('deletes the correct amount when keep is defined with number', async () => {
-    const keep = 1;
-    await subject({ ...mockedSettings, keep });
-    assert.strictEqual(deleteMock.callCount, mockedBundles.length - keep);
-  });
-  it('deletes all when 0 to keep on a list of 4', async () => {
-    await subject({ ...mockedSettings, keep: 0 });
-    assert.strictEqual(deleteMock.callCount, mockedBundles.length);
-  });
-  it('does not delete the active one', async () => {
-    mockedBundles = [{ sys: { id: 'test-1' } }, { sys: { id: 'active-bundle' } }];
-    await subject({ ...mockedSettings, keep: 0 });
-    assert.strictEqual(deleteMock.callCount, 1);
-  });
-  it('shows a warning when nothing will be deleted and delete is not called', async () => {
-    await subject({ ...mockedSettings, keep: 100 });
-    assert.strictEqual(deleteMock.called, false);
-    assert(console.log.calledWith(match(/There is nothing to delete/)));
-  });
-  it('only runs specific deletion calls at a time ', async () => {
-    const clock = useFakeTimers();
-    clientMock.appBundle.delete = stub().callsFake(() => new Promise((r) => setTimeout(r, 100)));
-    subject({ ...mockedSettings, keep: 0 });
-    await clock.tickAsync(50);
-    // Here we expect only the first ones to be called
-    assert.strictEqual(clientMock.appBundle.delete.callCount, 2); // 2 is batch size
-    await clock.tickAsync(150);
-    // Here the next ones also have called
-    assert.strictEqual(clientMock.appBundle.delete.callCount, 4); // 2 before + 2 new
-
-    clock.restore();
-  });
-  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)),
-    );
-    subject({ ...mockedSettings, keep: 0 });
-    await clock.tickAsync(50);
-    // Here we expect only the first ones to be called
-    assert.strictEqual(clientMock.appBundle.delete.callCount, 2); // 2 is batch size
-    await clock.tickAsync(100);
-    // Here there are still only two called
-    assert.strictEqual(clientMock.appBundle.delete.callCount, 3); // 2 before + 1 new  (1 still in flight and occupies slot)
-    await clock.tickAsync(100);
-    assert.strictEqual(clientMock.appBundle.delete.callCount, 5); // 3 before + 2 new  (slot is free again)
-
-    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/create-app-definition/create-app-definition.test.js

@@ -1,87 +0,0 @@
-const proxyquire = require('proxyquire');
-const { stub, match } = require('sinon');
-const assert = require('assert');
-const {
-  APP_DEF_ENV_KEY,
-} = require('../../utils/constants');
-
-const organizationId = 'orgId';
-const token = 'token';
-
-describe('createAppDefinition', () => {
-  let subject, clientMock, selectFromListMock, cachedEnvVarsMock;
-
-  beforeEach(() => {
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    console.log.restore();
-  });
-
-  beforeEach(() => {
-    clientMock = {
-      getOrganization: stub(),
-      getOrganizations: stub()
-    };
-
-    cachedEnvVarsMock = stub().resolves(undefined);
-
-    selectFromListMock = stub();
-
-    ({ createAppDefinition: subject } = proxyquire('./create-app-definition', {
-      'contentful-management': {
-        createClient: () => {
-          return clientMock;
-        }
-      },
-      '../../utils/cache-credential': {
-        cacheEnvVars: cachedEnvVarsMock
-      },
-      '../utils': {
-        selectFromList: selectFromListMock
-      }
-    }));
-  });
-
-  it('throws with invalid options', () => assert.rejects(() => subject(), /TypeError/));
-
-  it('throws if unable to fetch organizations', async () => {
-    clientMock.getOrganizations = stub().rejects(new Error());
-
-    await assert.rejects(() => subject(token, { locations: [] }));
-    assert(console.log.calledWith(match(/Could not fetch your organizations/)));
-  });
-
-  it('throws if unable to create definition', async () => {
-    clientMock.getOrganization = stub().resolves({ createAppDefinition: stub().rejects(new Error()) });
-    clientMock.getOrganizations = stub().resolves({ items: [{ name: 'name', sys: { id: organizationId } }] });
-    selectFromListMock.returns({ name: 'name', value: organizationId });
-
-    await assert.rejects(() => subject(token, { locations: [] }));
-    assert(console.log.calledWith(match(/Something went wrong while creating the app definition/)));
-  });
-
-  it('logs success message', async () => {
-    const appId = 'appId';
-    const orgSettingsLink = 'https://app.contentful.com/deeplink?link=org';
-    const appLink = `https://app.contentful.com/deeplink?link=apps&id=${appId}`;
-    const tutorialLink = 'https://ctfl.io/app-tutorial';
-
-    clientMock.getOrganization = stub().resolves({
-      createAppDefinition: stub().resolves({ sys: { id: 'appId' } })
-    });
-    clientMock.getOrganizations = stub().resolves({ items: [{ name: 'name', sys: { id: organizationId } }] });
-    selectFromListMock.returns({ name: 'name', value: organizationId });
-
-    await assert.doesNotReject(() => subject(token, { locations: [] }));
-
-    const loggedMessage = console.log.getCall(0).args[0];
-
-    assert(loggedMessage.includes('Success'));
-    assert(loggedMessage.includes(orgSettingsLink));
-    assert(loggedMessage.includes(appLink));
-    assert(loggedMessage.includes(tutorialLink));
-    assert.deepStrictEqual(cachedEnvVarsMock.args[0][0], {[APP_DEF_ENV_KEY]: 'appId'});
-  });
-});

package/lib/get-app-info.test.js

@@ -1,57 +0,0 @@
-const { stub } = require('sinon');
-const proxyquire = require('proxyquire');
-const assert = require('assert');
-
-describe('get-app-info', () => {
-  let getAppInfo, stubs;
-  const mockedSettings = {
-    token: 'token',
-    organizationId: 'test-id',
-    definitionId: 'test-id',
-  };
-
-  beforeEach(() => {
-    stubs = {
-      getDefinitionByIdStub: stub().returns({ value: 'id' }),
-      selectDefinitionStub: stub().returns({ value: 'id' }),
-      getOrganizationByIdStub: stub().returns({ value: 'id' }),
-      selectOrganizationStub: stub().returns({ value: 'id' }),
-    };
-    ({ getAppInfo } = proxyquire('./get-app-info', {
-      './definition-api': {
-        getDefinitionById: stubs.getDefinitionByIdStub,
-        selectDefinition: stubs.selectDefinitionStub,
-      },
-      './organization-api': {
-        getOrganizationById: stubs.getOrganizationByIdStub,
-        selectOrganization: stubs.selectOrganizationStub,
-      },
-      inquirer: {
-        prompt: stub(),
-      },
-      './get-management-token': {
-        getManagementToken: stub(),
-      },
-    }));
-  });
-  it('calls select Organization when id not provided', async () => {
-    await getAppInfo({ ...mockedSettings, organizationId: undefined });
-    assert.strictEqual(stubs.selectOrganizationStub.called, true);
-    assert.strictEqual(stubs.getOrganizationByIdStub.called, false);
-  });
-  it('calls getOrganizationById when id provided', async () => {
-    await getAppInfo(mockedSettings);
-    assert.strictEqual(stubs.selectDefinitionStub.called, false);
-    assert.strictEqual(stubs.getDefinitionByIdStub.called, true);
-  });
-  it('calls select Definition when id not provided', async () => {
-    await getAppInfo({ ...mockedSettings, definitionId: undefined });
-    assert.strictEqual(stubs.selectDefinitionStub.called, true);
-    assert.strictEqual(stubs.getDefinitionByIdStub.called, false);
-  });
-  it('calls getDefinitionById when id provided', async () => {
-    await getAppInfo(mockedSettings);
-    assert.strictEqual(stubs.selectDefinitionStub.called, false);
-    assert.strictEqual(stubs.getDefinitionByIdStub.called, true);
-  });
-});

package/lib/get-management-token.test.js

@@ -1,82 +0,0 @@
-const proxyquire = require('proxyquire');
-const { stub, spy } = require('sinon');
-const assert = require('assert');
-
-describe('getManagementToken-js', () => {
-  context('getManagementToken', () => {
-    let subject, promptMock, openMock;
-
-    beforeEach(() => {
-      stub(console, 'log');
-    });
-
-    afterEach(() => {
-      console.log.restore();
-    });
-
-    beforeEach(() => {
-      promptMock = stub();
-      openMock = stub();
-
-      ({ getManagementToken: subject } = proxyquire('./get-management-token', {
-        inquirer: { prompt: promptMock },
-        open: openMock,
-        'contentful-management': {
-          createClient() {
-            return {
-              async getOrganizations() {
-                throw new Error();
-              },
-            };
-          },
-        },
-      }));
-    });
-
-    it('throws when unable to open the browser', async () => {
-      openMock.throws(new Error());
-      await assert.rejects(() => subject());
-    });
-
-    it('throws when unable to get input', async () => {
-      promptMock.throws(new Error());
-      await assert.rejects(() => subject());
-    });
-
-    it('returns management token', async () => {
-      const mgmtToken = 'token';
-      promptMock.returns({ mgmtToken });
-      assert.strictEqual(await subject(), mgmtToken);
-    });
-  });
-
-  context('checkTokenValidity', () => {
-    let subject, createClientSpy, promptMock, openMock;
-    const mgmtToken = 'token';
-    const host = 'host';
-    const mockedSettings = {
-      host,
-      accessToken: mgmtToken,
-    };
-
-    beforeEach(() => {
-      promptMock = stub();
-      openMock = stub();
-      createClientSpy = spy();
-
-      ({ getManagementToken: subject } = proxyquire('./get-management-token', {
-        inquirer: { prompt: promptMock },
-        open: openMock,
-        'contentful-management': {
-          createClient: createClientSpy,
-        },
-      }));
-    });
-
-    it('Call CMA with a host argument', async () => {
-      promptMock.returns({ mgmtToken });
-      assert.strictEqual(await subject(host), mgmtToken);
-      assert.strictEqual(createClientSpy.args[0][0].host, mockedSettings.host);
-    });
-  });
-});

package/lib/open/open-settings.test.js

@@ -1,45 +0,0 @@
-const { stub } = require('sinon');
-const assert = require('assert');
-const { APP_DEF_ENV_KEY } = require('../../utils/constants');
-const proxyquire = require('proxyquire');
-const { REDIRECT_URL } = require('./open-settings');
-
-const TEST_DEF_ID = 'test-def-id';
-
-describe('openSettings', () => {
-  let subject, openMock, inquirerMock;
-  beforeEach(() => {
-    delete process.env[APP_DEF_ENV_KEY];
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    console.log.restore();
-    delete process.env[APP_DEF_ENV_KEY];
-  });
-
-  beforeEach(() => {
-    openMock = stub();
-    inquirerMock = stub();
-    ({ openSettings: subject } = proxyquire('./open-settings', {
-      open: openMock,
-      inquirer: { prompt: inquirerMock },
-    }));
-  });
-
-  it('works with option passed', () => {
-    subject({ definitionId: TEST_DEF_ID });
-    assert(openMock.calledWith(`${REDIRECT_URL}&id=${TEST_DEF_ID}`));
-  });
-
-  it('shows prompt when no definition is provided', () => {
-    subject({});
-    assert.strictEqual(inquirerMock.called, true);
-  });
-
-  it('works with env variable set', () => {
-    process.env[APP_DEF_ENV_KEY] = TEST_DEF_ID;
-    subject({});
-    assert(openMock.calledWith(`${REDIRECT_URL}&id=${TEST_DEF_ID}`));
-  });
-});

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

@@ -1,110 +0,0 @@
-const { stub, match } = require('sinon');
-const assert = require('assert');
-const proxyquire = require('proxyquire');
-
-const bundleMock = { sys: { id: 'mocked_bundle' } };
-const mockedSettings = {
-  accessToken: 'token',
-  organization: { value: 'id' },
-  definition: { value: 'id' },
-};
-
-describe('createAppBundleFromUpload', () => {
-  // eslint-disable-next-line no-unused-vars
-  let createAppBundleFromUpload, clientMock, createClientArgs;
-
-  beforeEach(() => {
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    console.log.restore();
-  });
-
-  beforeEach(() => {
-    clientMock = {
-      getOrganization: () => ({
-        getAppDefinition: () => ({
-          createAppBundle: () => bundleMock,
-        }),
-      }),
-      getOrganizations: stub(),
-    };
-
-    ({ createAppBundleFromUpload } = proxyquire('./create-app-bundle', {
-      'contentful-management': {
-        createClient: (...args) => {
-          createClientArgs = args;
-          return clientMock;
-        },
-      },
-    }));
-  });
-  it('creates app bundle', async () => {
-    const bundle = await createAppBundleFromUpload(mockedSettings, 'upload-id');
-    assert.strictEqual(bundle, bundleMock);
-  });
-  it('shows creation error when createAppBundle throws', async () => {
-    clientMock.getOrganization = () => ({
-      getAppDefinition: () => ({
-        createAppBundle: stub().rejects(new Error()),
-      }),
-    });
-    await createAppBundleFromUpload(mockedSettings, 'upload-id');
-
-    assert(console.log.calledWith(match(/Creation error:/)));
-  });
-  it('supports custom defined host domain creating appbundle from upload', async () => {
-    await createAppBundleFromUpload({ ...mockedSettings, host: 'jane.doe.com' });
-    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
-  });
-});
-
-describe('createAppBundleFromSettings', () => {
-  let createAppBundleFromSettings, clientMock, uploadMock, createClientArgs;
-
-  beforeEach(() => {
-    stub(console, 'log');
-  });
-
-  afterEach(() => {
-    console.log.restore();
-  });
-
-  beforeEach(() => {
-    clientMock = {
-      getOrganization: () => ({
-        getAppDefinition: () => ({
-          createAppBundle: () => bundleMock,
-        }),
-      }),
-      getOrganizations: stub(),
-    };
-
-    uploadMock = { sys: { id: 'test-id' } };
-
-    ({ createAppBundleFromSettings } = proxyquire('./create-app-bundle', {
-      'contentful-management': {
-        createClient: (...args) => {
-          createClientArgs = args;
-          return clientMock;
-        },
-      },
-      './create-app-upload': { createAppUpload: () => uploadMock },
-    }));
-  });
-  it('creates app bundle', async () => {
-    await createAppBundleFromSettings(mockedSettings);
-    assert(console.log.calledWith(match(/Your files were successfully uploaded/)));
-    assert(console.log.calledWith(match(/Created a new app bundle/)));
-  });
-  it('shows creation error when app upload did not succeed', async () => {
-    uploadMock = stub().rejects(new Error())();
-    await createAppBundleFromSettings(mockedSettings);
-    assert(console.log.calledWith(match(/Creation error:/)));
-  });
-  it('supports custom defined host domain creating appbundle from settings', async () => {
-    await createAppBundleFromSettings({ ...mockedSettings, host: 'jane.doe.com' });
-    assert.strictEqual(createClientArgs[0].host, 'jane.doe.com');
-  });
-});