@commercetools-frontend/mc-scripts 21.7.0 → 21.9.0

package/build/utils/get-config-diff.js

@@ -1,308 +0,0 @@
-"use strict";
-
-const chalk = require('chalk'); // Since not all terminal supports colors, to make things more consistent for testing purposes,
-// during tests the color used is appended before the string instead of coloring it.
-
-
-const isTest = process.env.NODE_ENV === 'test';
-
-const red = str => {
-  if (isTest) return `<color-red>${str}</color-red>`;
-  return chalk.red(str);
-};
-
-const green = str => {
-  if (isTest) return `<color-green>${str}</color-green>`;
-  return chalk.green(str);
-}; // Two spaces are used for indentation.
-
-
-const indent = indentLevel => '  '.repeat(indentLevel);
-
-const getStringDiff = ({
-  previousValue,
-  nextValue,
-  label,
-  indentLevel = 0
-}) => {
-  if (!previousValue && nextValue) {
-    return `${indent(indentLevel)}${label} added: ${green(nextValue)}`;
-  }
-
-  if (previousValue && !nextValue) {
-    return `${indent(indentLevel)}${label} removed: ${red(previousValue)}`;
-  }
-
-  if (previousValue && nextValue && previousValue !== nextValue) {
-    return `${indent(indentLevel)}${label} changed: ${red(previousValue)} => ${green(nextValue)}`;
-  }
-
-  return null;
-}; // NOTE: this assumes that the array values are scalar values (not objects).
-
-
-const getArrayDiff = ({
-  previousValue,
-  nextValue,
-  label,
-  indentLevel = 0
-}) => {
-  const oldArraySet = new Set(previousValue);
-  const arrayDiff = [];
-  nextValue === null || nextValue === void 0 ? void 0 : nextValue.forEach(item => {
-    if (oldArraySet.has(item)) {
-      oldArraySet.delete(item);
-    } else {
-      arrayDiff.push(getStringDiff({
-        nextValue: item,
-        label,
-        indentLevel
-      }));
-    }
-  });
-  oldArraySet.forEach(item => {
-    arrayDiff.push(getStringDiff({
-      previousValue: item,
-      label,
-      indentLevel
-    }));
-  });
-  return arrayDiff.join('\n');
-};
-
-const getPermissionsDiff = ({
-  previousValue,
-  nextValue
-}) => {
-  const permissionDiff = ['permissions changed'];
-  const mappedOldPermissions = previousValue.reduce((previousPermission, {
-    name,
-    oAuthScopes
-  }) => ({ ...previousPermission,
-    [name]: oAuthScopes
-  }), {});
-  const indentLevel = 1;
-  nextValue.forEach(newPermission => {
-    const currentDiff = [`${indent(indentLevel)}"${newPermission.name}" changed`]; // if the permission name is not in the old config, it means it is a new addition.
-
-    if (!mappedOldPermissions[newPermission.name]) {
-      permissionDiff.push(`${indent(indentLevel)}"${green(newPermission.name)}" was added`);
-    } // if permission name is in the old config, now we check if there was a change
-    else {
-      currentDiff.push(getArrayDiff({
-        previousValue: mappedOldPermissions[newPermission.name],
-        nextValue: newPermission.oAuthScopes,
-        label: 'oauth scope',
-        indentLevel: 2
-      }));
-      delete mappedOldPermissions[newPermission.name];
-    }
-
-    currentDiff.filter(Boolean).length > 1 && permissionDiff.push(currentDiff.join('\n'));
-  }); // if there are old permissions left, it means they were deleted in the new Permissions.
-
-  Object.keys(mappedOldPermissions).forEach(oldPermissionName => {
-    permissionDiff.push(`${indent(indentLevel)}"${red(oldPermissionName)}" was removed`);
-  });
-  if (permissionDiff.length > 1) return permissionDiff.join('\n');
-};
-
-const getLabelAllLocalesDiff = ({
-  previousValue,
-  nextValue,
-  indentLevel = 0
-}) => {
-  const labelAllLocalesDiff = [`${indent(indentLevel - 1)}labelAllLocales changed`];
-  const mappedOldLabelAllLocales = (previousValue === null || previousValue === void 0 ? void 0 : previousValue.reduce((previousLabelAllLocale, {
-    locale,
-    value
-  }) => ({ ...previousLabelAllLocale,
-    [locale]: value
-  }), {})) ?? {};
-  nextValue === null || nextValue === void 0 ? void 0 : nextValue.forEach(newLabelAllLocale => {
-    if (newLabelAllLocale.locale in mappedOldLabelAllLocales) {
-      const oldLocaleValue = mappedOldLabelAllLocales[newLabelAllLocale.locale];
-
-      if (oldLocaleValue !== newLabelAllLocale.value) {
-        labelAllLocalesDiff.push(`${indent(indentLevel)}locale "${newLabelAllLocale.locale}" changed: ${red(oldLocaleValue)} => ${green(newLabelAllLocale.value)}`);
-      }
-
-      delete mappedOldLabelAllLocales[newLabelAllLocale.locale];
-    } else {
-      labelAllLocalesDiff.push(getStringDiff({
-        nextValue: newLabelAllLocale.locale,
-        label: 'locale',
-        indentLevel
-      }));
-    }
-  });
-  Object.keys(mappedOldLabelAllLocales).forEach(key => {
-    labelAllLocalesDiff.push(getStringDiff({
-      previousValue: key,
-      label: 'locale',
-      indentLevel
-    }));
-  });
-  if (labelAllLocalesDiff.length > 1) return labelAllLocalesDiff.join('\n');
-};
-
-const getMainMenuLinkDiff = ({
-  previousValue,
-  nextValue
-}) => {
-  const mainMenuLinkDiff = ['mainMenuLink changed'];
-  mainMenuLinkDiff.push(getStringDiff({
-    previousValue: previousValue.defaultLabel,
-    nextValue: nextValue.defaultLabel,
-    label: 'defaultLabel',
-    indentLevel: 1
-  }));
-  const mainMenuLinkPermissionsDiff = getArrayDiff({
-    previousValue: previousValue.permissions,
-    nextValue: nextValue.permissions,
-    label: 'applied permission',
-    indentLevel: 2
-  });
-
-  if (mainMenuLinkPermissionsDiff.length > 0) {
-    mainMenuLinkDiff.push(`${indent(1)}permissions changed`);
-    mainMenuLinkDiff.push(mainMenuLinkPermissionsDiff);
-  }
-
-  mainMenuLinkDiff.push(getLabelAllLocalesDiff({
-    previousValue: previousValue.labelAllLocales,
-    nextValue: nextValue.labelAllLocales,
-    indentLevel: 2
-  }));
-  const filteredMainMenuLinkDiff = mainMenuLinkDiff.filter(Boolean);
-  if (filteredMainMenuLinkDiff.length > 1) return filteredMainMenuLinkDiff.join('\n');
-};
-
-const getSubmenuLinksDiff = ({
-  previousValue,
-  nextValue
-}) => {
-  const submenuLinksDiff = ['submenuLink changed'];
-  const mappedSubmenuLinks = previousValue.reduce((previousSubmenuLink, currentSubmenuLink) => ({ ...previousSubmenuLink,
-    [currentSubmenuLink.uriPath]: currentSubmenuLink
-  }), {});
-  nextValue.forEach(newSubmenuLink => {
-    const oldSubMenuLink = mappedSubmenuLinks[newSubmenuLink.uriPath];
-
-    if (newSubmenuLink.uriPath in mappedSubmenuLinks) {
-      const submenuLinkDiff = [`${indent(1)}menu link "${newSubmenuLink.uriPath}" changed`];
-      Object.keys(mappedSubmenuLinks[newSubmenuLink.uriPath]).forEach(key => {
-        switch (key) {
-          case 'defaultLabel':
-            {
-              submenuLinkDiff.push(getStringDiff({
-                previousValue: oldSubMenuLink.defaultLabel,
-                nextValue: newSubmenuLink.defaultLabel,
-                label: 'defaultLabel',
-                indentLevel: 2
-              }));
-              break;
-            }
-
-          case 'permissions':
-            {
-              const submenuLinkPermissionsDiff = getArrayDiff({
-                previousValue: oldSubMenuLink.permissions,
-                nextValue: newSubmenuLink.permissions,
-                label: 'applied permission',
-                indentLevel: 3
-              });
-
-              if (submenuLinkPermissionsDiff.length > 0) {
-                submenuLinkDiff.push(`${indent(2)}permissions changed`);
-                submenuLinkDiff.push(submenuLinkPermissionsDiff);
-              }
-
-              break;
-            }
-
-          case 'labelAllLocales':
-            {
-              submenuLinkDiff.push(getLabelAllLocalesDiff({
-                previousValue: oldSubMenuLink.labelAllLocales,
-                nextValue: newSubmenuLink.labelAllLocales,
-                indentLevel: 3
-              }));
-              break;
-            }
-
-          default:
-            break;
-        }
-      });
-      delete mappedSubmenuLinks[newSubmenuLink.uriPath];
-      const filteredSubmenuLinksDiff = submenuLinkDiff.filter(Boolean);
-
-      if (filteredSubmenuLinksDiff.length > 1) {
-        submenuLinksDiff.push(filteredSubmenuLinksDiff.join('\n'));
-      }
-    } else {
-      submenuLinksDiff.push(getStringDiff({
-        nextValue: newSubmenuLink.uriPath,
-        label: 'menu link',
-        indentLevel: 1
-      }));
-    }
-  });
-  Object.keys(mappedSubmenuLinks).forEach(key => {
-    submenuLinksDiff.push(getStringDiff({
-      previousValue: key,
-      label: 'menu link',
-      indentLevel: 1
-    }));
-  });
-  if (submenuLinksDiff.length > 1) return submenuLinksDiff.join('\n');
-}; // Compute diff changes of the Custom Application config.
-// NOTE: Only known keys are evaluated.
-
-
-const getConfigDiff = (oldConfig, newConfig) => {
-  const diff = []; // Name
-
-  diff.push(getStringDiff({
-    previousValue: oldConfig.name,
-    nextValue: newConfig.name,
-    label: 'name'
-  })); // Description
-
-  diff.push(getStringDiff({
-    previousValue: oldConfig.description,
-    nextValue: newConfig.description,
-    label: 'description'
-  })); // URL
-
-  diff.push(getStringDiff({
-    previousValue: oldConfig.url,
-    nextValue: newConfig.url,
-    label: 'url'
-  })); // Icon
-
-  diff.push(getStringDiff({
-    previousValue: oldConfig.icon,
-    nextValue: newConfig.icon,
-    label: 'icon'
-  })); // Permissions
-
-  diff.push(getPermissionsDiff({
-    previousValue: oldConfig.permissions,
-    nextValue: newConfig.permissions
-  })); // Main menu link
-
-  diff.push(getMainMenuLinkDiff({
-    previousValue: oldConfig.mainMenuLink,
-    nextValue: newConfig.mainMenuLink
-  })); // Submenu links
-
-  diff.push(getSubmenuLinksDiff({
-    previousValue: oldConfig.submenuLinks,
-    nextValue: newConfig.submenuLinks
-  }));
-  return diff.filter(Boolean).join('\n');
-};
-
-module.exports = getConfigDiff;

package/build/utils/get-config-diff.spec.js

@@ -1,285 +0,0 @@
-"use strict";
-
-const getConfigDiff = require('./get-config-diff');
-
-const createTestConfig = customConfig => ({
-  entryPointUriPath: 'my-test-app',
-  name: 'test name',
-  description: 'test description',
-  url: 'https://test.com',
-  icon: '<svg><path fill="#000000"></path></svg>',
-  permissions: [],
-  mainMenuLink: {},
-  submenuLinks: [],
-  ...customConfig
-});
-
-describe('when there are no changes', () => {
-  it('should display no diff', () => {
-    expect(getConfigDiff(createTestConfig(), createTestConfig())).toBe('');
-  });
-});
-describe('when there are changes', () => {
-  it('should display diff if "name", "description", "icon", "url" changed', () => {
-    const newConfig = createTestConfig({
-      name: 'updated test name',
-      description: 'updated description',
-      url: 'https://updated-test.com',
-      icon: '<svg><path fill="#ffffff"></path></svg>'
-    });
-    expect(getConfigDiff(createTestConfig(), newConfig)).toMatchInlineSnapshot(`
-      "name changed: <color-red>test name</color-red> => <color-green>updated test name</color-green>
-      description changed: <color-red>test description</color-red> => <color-green>updated description</color-green>
-      url changed: <color-red>https://test.com</color-red> => <color-green>https://updated-test.com</color-green>
-      icon changed: <color-red><svg><path fill=\\"#000000\\"></path></svg></color-red> => <color-green><svg><path fill=\\"#ffffff\\"></path></svg></color-green>"
-    `);
-  });
-  it('should display diff if "description" is removed', () => {
-    const newConfig = createTestConfig({
-      description: undefined
-    });
-    expect(getConfigDiff(createTestConfig(), newConfig)).toMatchInlineSnapshot(`"description removed: <color-red>test description</color-red>"`);
-  });
-  it('should display diff for "permissions"', () => {
-    const oldConfig = createTestConfig({
-      permissions: [{
-        oAuthScopes: ['manage_product'],
-        name: 'manageMyTestApp'
-      }, {
-        oAuthScopes: ['view_products', 'view_customers'],
-        name: 'viewMyTestApp'
-      }]
-    });
-    const newConfig = createTestConfig({
-      permissions: [{
-        oAuthScopes: ['manage_customer'],
-        name: 'manageMyTestApp'
-      }, {
-        oAuthScopes: ['view_products', 'view_customers', 'view_orders'],
-        name: 'viewMyTestApp'
-      }]
-    });
-    expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-      "permissions changed
-        \\"manageMyTestApp\\" changed
-          oauth scope added: <color-green>manage_customer</color-green>
-          oauth scope removed: <color-red>manage_product</color-red>
-        \\"viewMyTestApp\\" changed
-          oauth scope added: <color-green>view_orders</color-green>"
-    `);
-  });
-  describe('for "mainMenuLink"', () => {
-    it('should display diff for "mainMenuLink" when assigning new permissions', () => {
-      const oldConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: []
-        }
-      });
-      const newConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: ['ViewMyTestApp'],
-          labelAllLocales: []
-        }
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "mainMenuLink changed
-          permissions changed
-            applied permission added: <color-green>ViewMyTestApp</color-green>"
-      `);
-    });
-    it('should display diff for "mainMenuLink" when removing permissions', () => {
-      const oldConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: ['ViewMyTestApp'],
-          labelAllLocales: []
-        }
-      });
-      const newConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: []
-        }
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "mainMenuLink changed
-          permissions changed
-            applied permission removed: <color-red>ViewMyTestApp</color-red>"
-      `);
-    });
-    it('should display diff for "mainMenuLink" when assigning new labels', () => {
-      const oldConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: []
-        }
-      });
-      const newConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Die Avengers'
-          }]
-        }
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "mainMenuLink changed
-          labelAllLocales changed
-            locale added: <color-green>de</color-green>"
-      `);
-    });
-    it('should display diff for "mainMenuLink" when removing labels', () => {
-      const oldConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Die Avengers'
-          }]
-        }
-      });
-      const newConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: [],
-          labelAllLocales: []
-        }
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "mainMenuLink changed
-          labelAllLocales changed
-            locale removed: <color-red>de</color-red>"
-      `);
-    });
-    it('should display multiple diff for changes of existing "mainMenuLink"', () => {
-      const oldConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Avengers',
-          permissions: ['ViewMyTestApp'],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Die Avengers'
-          }, {
-            locale: 'en',
-            value: 'The Avengers'
-          }]
-        }
-      });
-      const newConfig = createTestConfig({
-        mainMenuLink: {
-          defaultLabel: 'Justice League',
-          permissions: ['ManageMyTestApp'],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Die Justice League'
-          }, {
-            locale: 'it',
-            value: 'La Justice League'
-          }]
-        }
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "mainMenuLink changed
-          defaultLabel changed: <color-red>Avengers</color-red> => <color-green>Justice League</color-green>
-          permissions changed
-            applied permission added: <color-green>ManageMyTestApp</color-green>
-            applied permission removed: <color-red>ViewMyTestApp</color-red>
-          labelAllLocales changed
-            locale \\"de\\" changed: <color-red>Die Avengers</color-red> => <color-green>Die Justice League</color-green>
-            locale added: <color-green>it</color-green>
-            locale removed: <color-red>en</color-red>"
-      `);
-    });
-  });
-  describe('for "submenuLinks"', () => {
-    it('should display diff for "submenuLinks" when adding a new menu link', () => {
-      const oldConfig = createTestConfig({
-        submenuLinks: []
-      });
-      const newConfig = createTestConfig({
-        submenuLinks: [{
-          uriPath: 'my-test-app/new',
-          defaultLabel: 'New Avenger',
-          permissions: ['ManageMyTestApp'],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Neu Avenger'
-          }]
-        }]
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "submenuLink changed
-          menu link added: <color-green>my-test-app/new</color-green>"
-      `);
-    });
-    it('should display diff for "submenuLinks" when removing a menu link', () => {
-      const oldConfig = createTestConfig({
-        submenuLinks: [{
-          uriPath: 'my-test-app/new',
-          defaultLabel: 'New Avenger',
-          permissions: ['ManageMyTestApp'],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Neu Avenger'
-          }]
-        }]
-      });
-      const newConfig = createTestConfig({
-        submenuLinks: []
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "submenuLink changed
-          menu link removed: <color-red>my-test-app/new</color-red>"
-      `);
-    });
-    it('should display multiple diff for changes of existing "submenuLinks"', () => {
-      const oldConfig = createTestConfig({
-        submenuLinks: [{
-          uriPath: 'my-test-app/new',
-          defaultLabel: 'New Avenger',
-          permissions: ['ManageMyTestApp'],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Neu Avenger'
-          }, {
-            locale: 'en',
-            value: 'Add Avenger'
-          }]
-        }]
-      });
-      const newConfig = createTestConfig({
-        submenuLinks: [{
-          uriPath: 'my-test-app/new',
-          defaultLabel: 'Add Avenger',
-          permissions: [],
-          labelAllLocales: [{
-            locale: 'de',
-            value: 'Avenger hinzufügen'
-          }, {
-            locale: 'it',
-            value: 'Nuovo Avenger'
-          }]
-        }]
-      });
-      expect(getConfigDiff(oldConfig, newConfig)).toMatchInlineSnapshot(`
-        "submenuLink changed
-          menu link \\"my-test-app/new\\" changed
-            defaultLabel changed: <color-red>New Avenger</color-red> => <color-green>Add Avenger</color-green>
-            permissions changed
-              applied permission removed: <color-red>ManageMyTestApp</color-red>
-            labelAllLocales changed
-              locale \\"de\\" changed: <color-red>Neu Avenger</color-red> => <color-green>Avenger hinzufügen</color-green>
-              locale added: <color-green>it</color-green>
-              locale removed: <color-red>en</color-red>"
-      `);
-    });
-  });
-});

package/build/utils/graphql-requests.js

@@ -1,105 +0,0 @@
-"use strict";
-
-const {
-  GraphQLClient
-} = require('graphql-request');
-
-const {
-  GRAPHQL_TARGETS
-} = require('@commercetools-frontend/constants');
-
-const userAgent = require('./user-agent');
-
-const requireGraphqlHelper = require('./require-graphql');
-
-const requireGraphql = requireGraphqlHelper(__dirname);
-const FetchCustomApplicationFromCli = requireGraphql('./fetch-custom-application.settings.graphql');
-const UpdateCustomApplicationFromCli = requireGraphql('./update-custom-application.settings.graphql');
-const CreateCustomApplicationFromCli = requireGraphql('./create-custom-application.settings.graphql');
-const FetchMyOrganizationsFromCli = requireGraphql('./fetch-user-organizations.core.graphql');
-
-const graphQLClient = (uri, token, target = GRAPHQL_TARGETS.SETTINGS_SERVICE) => new GraphQLClient(`${uri}/graphql`, {
-  headers: {
-    Accept: 'application/json',
-    'Content-Type': 'application/json',
-    'x-graphql-target': target,
-    'x-mc-cli-access-token': token,
-    'x-user-agent': userAgent
-  }
-});
-
-const fetchCustomApplication = async ({
-  mcApiUrl,
-  token,
-  entryPointUriPath
-}) => {
-  const variables = {
-    entryPointUriPath
-  };
-
-  try {
-    const customAppData = await graphQLClient(mcApiUrl, token).request(FetchCustomApplicationFromCli, variables);
-    return customAppData.organizationExtensionForCustomApplication;
-  } catch (error) {
-    throw new Error(error.response.message);
-  }
-};
-
-const updateCustomApplication = async ({
-  mcApiUrl,
-  token,
-  applicationId,
-  organizationId,
-  data
-}) => {
-  const variables = {
-    organizationId,
-    applicationId,
-    data
-  };
-
-  try {
-    const updatedCustomAppsData = await graphQLClient(mcApiUrl, token).request(UpdateCustomApplicationFromCli, variables);
-    return updatedCustomAppsData.updateCustomApplication;
-  } catch (error) {
-    throw new Error(error.response.message);
-  }
-};
-
-const createCustomApplication = async ({
-  mcApiUrl,
-  token,
-  organizationId,
-  data
-}) => {
-  const variables = {
-    organizationId,
-    data
-  };
-
-  try {
-    const createdCustomAppData = await graphQLClient(mcApiUrl, token).request(CreateCustomApplicationFromCli, variables);
-    return createdCustomAppData.createCustomApplication;
-  } catch (error) {
-    throw new Error(error.response.message);
-  }
-};
-
-const fetchUserOrganizations = async ({
-  mcApiUrl,
-  token
-}) => {
-  try {
-    const userOrganizations = await graphQLClient(mcApiUrl, token, GRAPHQL_TARGETS.ADMINISTRATION_SERVICE).request(FetchMyOrganizationsFromCli);
-    return userOrganizations.myOrganizations;
-  } catch (error) {
-    throw new Error(error.response.message);
-  }
-};
-
-module.exports = {
-  fetchCustomApplication,
-  updateCustomApplication,
-  createCustomApplication,
-  fetchUserOrganizations
-};