contensis-cli 1.0.12-beta.1 → 1.0.12-beta.11

package/src/services/ContensisDevService.ts

@@ -29,6 +29,11 @@ class ContensisDev extends ContensisRole {
   git!: GitHelper;
   blockId!: string;
 
+  deployCredentials = {
+    clientId: '',
+    clientSecret: '',
+  };
+
   constructor(
     args: string[],
     outputOpts?: OutputOptionsConstructorArg,
@@ -49,8 +54,6 @@ class ContensisDev extends ContensisRole {
     const contensis = await this.ConnectContensis();
 
     if (contensis) {
-      this.devinit = { ...this.devinit, invokedBy: this.invokedBy };
-
       // First we need to get the block id from the user
       const validateBlockId = (blockId: string) => {
         const pattern = /^[0-9a-z](-?[0-9a-z])*$/;
@@ -64,6 +67,7 @@ class ContensisDev extends ContensisRole {
         prefix: '🧱',
         message: messages.devinit.blockIdQuestion,
         validate: validateBlockId,
+        default: git.name,
       });
       // make sure block id is lowercase
       this.blockId = blockId.toLowerCase();
@@ -93,65 +97,17 @@ class ContensisDev extends ContensisRole {
       const devKeyDescription = `Created by Contensis to allow API access from the running block`;
       let existingDevKey = apiKeyExists(devKeyName);
 
-      // if dev api key doesn't exisit go and create it (we need this for local development, we will store these details in the .env file).
-      if (!existingDevKey) {
-        existingDevKey = await this.CreateOrUpdateApiKey(
-          existingDevKey,
-          devKeyName,
-          devKeyDescription
-        );
-        log.success('Successfully created development key');
-      }
-
       const deployKeyName = `${apiKeyName}-ci`;
       const deployKeyDescription = `Created by the Contensis CLI for use in continuous integration`;
 
       let existingDeployKey = apiKeyExists(deployKeyName);
 
-      // if deploy api key doesn't exisit go and create it (we need this for yml file).
-      if (!existingDeployKey) {
-        existingDeployKey = await this.CreateOrUpdateApiKey(
-          existingDeployKey,
-          deployKeyName,
-          deployKeyDescription
-        );
-        log.success('Successfully created deploy key');
-      }
-
-      // check we have the deply key so we can assign them to this values
-      if (existingDeployKey) {
-        // Add client id and secret to global 'this'
-        this.devinit = {
-          ...this.devinit,
-          credentials: {
-            clientId: existingDeployKey?.id,
-            clientSecret: existingDeployKey?.sharedSecret,
-          },
-        };
-      }
-
-      // we need to credentials of the user so that we can create a auth service
-      const credentials = await this.GetCredentials(this.devinit.invokedBy);
-
-      // create new auth service using creds
-      let classicToken: string | undefined | null;
-      const auth = new ContensisAuthService({
-        username: credentials?.current?.account,
-        password: credentials?.current?.password,
-        projectId: currentProject,
-        rootUrl: `https://cms-${currentEnv}.cloud.contensis.com`,
-      });
-
-      // once we have auth service, we can go and fetch out classic token
-      classicToken = await auth.ClassicToken();
-
       // const blockId = git.name;
       const errors = [] as AppError[];
 
       // Start render console output
       log.raw('');
       log.success(messages.devinit.intro());
-      log.raw('');
       log.raw(
         log.infoText(
           messages.devinit.projectDetails(
@@ -193,7 +149,6 @@ class ContensisDev extends ContensisRole {
 
       log.raw(log.infoText(messages.devinit.ciDetails(ciFileName)));
 
-      let mappedWorkflow;
       // Location for Client ID / Secret.
       const { loc } = await inquirer.prompt({
         name: 'loc',
@@ -213,9 +168,8 @@ class ContensisDev extends ContensisRole {
         ],
       });
 
+      log.raw('');
       log.help(messages.devinit.ciIntro(git, loc));
-      // Update CI Workflow
-      mappedWorkflow = await mapCIWorkflowContent(this, loc);
 
       if (!dryRun) {
         // Confirm prompt
@@ -233,7 +187,6 @@ class ContensisDev extends ContensisRole {
 
       // Fetching access token
       let accessToken: string | undefined = undefined;
-      log.raw('');
 
       const spinner = createSpinner(messages.devinit.accessTokenFetch());
       spinner.start();
@@ -241,9 +194,9 @@ class ContensisDev extends ContensisRole {
       const token = await this.GetDeliveryApiKey();
 
       if (token) {
-        spinner.success();
-        this.log.success(messages.devinit.accessTokenSuccess(token));
         accessToken = token;
+        spinner.success({ text: messages.devinit.accessTokenSuccess(token) });
+        log.raw('');
       } else {
         spinner.error();
         this.log.error(messages.devinit.accessTokenFailed());
@@ -261,9 +214,48 @@ class ContensisDev extends ContensisRole {
       const [getRolesErr, roles] = await to(contensis.roles.GetRoles());
       if (!roles && getRolesErr) errors.push(getRolesErr);
       checkpoint(`fetched ${roles?.length} roles`);
+
       if (dryRun) {
         checkpoint(`skip api key creation (dry-run)`);
       } else {
+        // if dev api key doesn't exist go and create it (we need this for local development, we will store these details in the .env file).
+        const devKeyExisted = !!existingDevKey;
+        if (!existingDevKey) {
+          existingDevKey = await this.CreateOrUpdateApiKey(
+            existingDevKey,
+            devKeyName,
+            devKeyDescription
+          );
+          log.success(messages.devinit.createDevKey(devKeyName, devKeyExisted));
+        }
+        // NF 24/11/23 Added this commented code back in as we are not assigning the dev key to any role here
+        // // Ensure dev API key is assigned to a role
+        // let existingDevRole = findByIdOrName(roles || [], devKeyName, true) as
+        //   | Role
+        //   | undefined;
+        // existingDevRole = await this.CreateOrUpdateRole(
+        //   existingDevRole,
+        //   devKeyRole(devKeyName, devKeyDescription)
+        // );
+        // checkpoint('dev key role assigned');
+
+        // if deploy api key doesn't exist go and create it (we need this for yml file).
+        const deployKeyExisted = !!existingDeployKey;
+        if (!existingDeployKey) {
+          existingDeployKey = await this.CreateOrUpdateApiKey(
+            existingDeployKey,
+            deployKeyName,
+            deployKeyDescription
+          );
+        }
+
+        // check we have the deploy key so we can assign them to this values
+        if (existingDeployKey) {
+          // Add client id and secret to credentials
+          this.deployCredentials.clientId = existingDeployKey?.id;
+          this.deployCredentials.clientSecret = existingDeployKey?.sharedSecret;
+        }
+
         // Ensure deploy API key is assigned to a role with the right permissions
         const deployRoleName = `Role for CI push of block '${blockId}'`;
         const deplyRoleDescription = `Created by the Contensis CLI for use in continuous integration`;
@@ -274,11 +266,13 @@ class ContensisDev extends ContensisRole {
         ) as Role | undefined;
         existingDeployRole = await this.CreateOrUpdateRole(
           existingDeployRole,
-          deployKeyRole(deployKeyName, deplyRoleDescription)
+          deployKeyRole(deployRoleName, deplyRoleDescription)
         );
 
         checkpoint('deploy key role assigned');
-        log.success(messages.devinit.createDeployKey(deployRoleName, true));
+        log.success(
+          messages.devinit.createDeployKey(deployRoleName, deployKeyExisted)
+        );
         checkpoint('api keys done');
       }
 
@@ -339,7 +333,7 @@ class ContensisDev extends ContensisRole {
         }
         checkpoint('skip .env file update (dry-run)');
       } else {
-        if (envDiff) log.info(`updating .env file ${winSlash(envFilePath)}`);
+        if (envDiff) log.info(`Updating .env file ${winSlash(envFilePath)}`);
         writeFile(envFilePath, envFileLines.join('\n'));
         checkpoint('.env file updated');
         log.success(messages.devinit.writeEnvFile());
@@ -347,16 +341,21 @@ class ContensisDev extends ContensisRole {
       }
 
       // Update git ignore
-      const gitIgnorePath = `${projectHome}/.gitignore`;
-      const gitIgnoreContentsToAdd = ['.env'];
-      mergeContentsToAddWithGitignore(gitIgnorePath, gitIgnoreContentsToAdd);
+      if (dryRun) {
+        checkpoint('skip .gitignore file update (dry-run)');
+      } else {
+        mergeContentsToAddWithGitignore(`${projectHome}/.gitignore`, ['.env']);
+        log.raw('');
+      }
+
+      // Update CI Workflow
+      const mappedWorkflow = await mapCIWorkflowContent(this, loc);
 
       // Update CI file -- different for GH/GL
       if (mappedWorkflow?.diff) {
         log.info(
           `Updating ${winSlash(ciFileName)} file:\n${mappedWorkflow.diff}`
         );
-        log.raw('');
       }
       if (dryRun) {
         checkpoint('skip CI file update (dry-run)');
@@ -372,18 +371,20 @@ class ContensisDev extends ContensisRole {
           } else {
             log.info(messages.devinit.ciFileNoChanges(`./${ciFileName}`));
           }
+          log.raw('');
           checkpoint('CI file updated');
         }
       }
 
       if (loc === 'git') {
         // Echo Deployment API key to console, ask user to add secrets to repo
+        const dryRunKeyMessage = dryRun ? 'not created in dry-run' : undefined;
         log.warning(messages.devinit.addGitSecretsIntro());
         log.help(
           messages.devinit.addGitSecretsHelp(
             git,
-            existingDeployKey?.id,
-            existingDeployKey?.sharedSecret
+            existingDeployKey?.id || dryRunKeyMessage,
+            existingDeployKey?.sharedSecret || dryRunKeyMessage
           )
         );
       }
@@ -395,10 +396,13 @@ class ContensisDev extends ContensisRole {
         log.success(messages.devinit.success());
         log.help(messages.devinit.startProjectTip());
         // open the cms link -- if no classic token just return the cms url
+
+        // go and fetch the classic token from auth service
+        const classicToken = await this.auth?.ClassicToken();
         log.help(
           ansiEscapes.link(
             `Open Contensis`,
-            `https://cms-${currentEnv}.cloud.contensis.com${
+            `${this.urls?.cms}${
               classicToken ? `?SecurityToken=${classicToken}` : ''
             }`
           )

package/src/shell.ts

@@ -143,6 +143,7 @@ class ContensisShell {
         'execute block action makelive',
         'execute block action rollback',
         'execute block action markasbroken',
+        'get assets',
         'get block',
         'get block logs',
         'get contenttype',
@@ -155,10 +156,12 @@ class ContensisShell {
         'get token',
         'get version',
         'get webhook',
+        'get workflow',
         'import contenttypes',
         'import components',
         'import entries',
         'import models',
+        'import nodes',
         'list blocks',
         'list contenttypes',
         'list components',
@@ -168,11 +171,13 @@ class ContensisShell {
         'list renderers',
         'list roles',
         'list webhooks',
+        'list workflows',
         'push block',
         'remove components',
         'remove contenttypes',
         'remove key',
         'remove entries',
+        'remove nodes',
         'remove role',
         'set project name',
         'set project description',

package/src/util/console.printer.ts

@@ -1,7 +1,17 @@
+import { Node } from 'contensis-delivery-api/lib/models';
 import dayjs from 'dayjs';
-import { BlockVersion, MigrateModelsResult, MigrateStatus } from 'migratortron';
+import { deconstructApiError } from './error';
+import { Logger, addNewLines } from './logger';
+import {
+  BlockVersion,
+  EntriesResult,
+  MigrateModelsResult,
+  MigrateNodesTree,
+  MigrateStatus,
+  NodesResult,
+  ProjectNodesToMigrate,
+} from 'migratortron';
 import ContensisCli from '~/services/ContensisCliService';
-import { Logger } from './logger';
 
 const formatDate = (date: Date | string, format = 'DD/MM/YYYY HH:mm') =>
   dayjs(date).format(format);
@@ -104,19 +114,19 @@ export const printBlockVersion = (
   console.log('');
 };
 
-export const printMigrateResult = (
+export const printEntriesMigrateResult = (
   { log, messages, currentProject }: ContensisCli,
-  migrateResult: any,
+  migrateResult: EntriesResult,
   {
     action = 'import',
     showDiff = false,
-    showAllEntries = false,
-    showChangedEntries = false,
+    showAll = false,
+    showChanged = false,
   }: {
     action?: 'import' | 'delete';
     showDiff?: boolean;
-    showAllEntries?: boolean;
-    showChangedEntries?: boolean;
+    showAll?: boolean;
+    showChanged?: boolean;
   } = {}
 ) => {
   console.log(``);
@@ -129,8 +139,8 @@ export const printMigrateResult = (
       any
     ][]) {
       if (
-        showAllEntries ||
-        (showChangedEntries &&
+        showAll ||
+        (showChanged &&
           (
             Object.entries(
               Object.entries(entryStatus[currentProject])[0]
@@ -173,7 +183,7 @@ export const printMigrateResult = (
       }
     }
   }
-  if (showAllEntries || showChangedEntries) console.log(``);
+  if (showAll || showChanged) console.log(``);
 
   for (const [projectId, contentTypeCounts] of Object.entries(
     migrateResult.entries || {}
@@ -250,7 +260,98 @@ export const printMigrateResult = (
       `  - ${log.errorText(`errors: ${migrateResult.errors.length}`)}\n`
     );
     for (const error of migrateResult.errors)
-      log.error(error.message || error, null, '');
+      log.error(error.message, null, '');
+  }
+};
+
+export const printNodesMigrateResult = (
+  { log, currentProject }: ContensisCli,
+  migrateResult: NodesResult,
+  {
+    action = 'import',
+    logLimit = 50,
+    showDiff = false,
+    showAll = false,
+    showChanged = false,
+  }: {
+    action?: 'import' | 'delete';
+    logLimit?: number;
+    showDiff?: boolean;
+    showAll?: boolean;
+    showChanged?: boolean;
+  } = {}
+) => {
+  log.raw(``);
+  for (const [projectId, counts] of Object.entries(migrateResult.nodes || {})) {
+    const importTitle =
+      action === 'delete'
+        ? `Delete from project ${log.warningText(currentProject)}`
+        : `Import ${
+            projectId && projectId !== 'null'
+              ? `from project ${log.highlightText(projectId)} `
+              : ''
+          }to ${log.boldText(log.warningText(currentProject))}`;
+    log.help(importTitle);
+
+    const migrateStatusAndCount = migrateResult.nodesToMigrate[
+      currentProject
+    ] as ProjectNodesToMigrate;
+
+    const existingCount =
+      migrateResult.existing?.[currentProject]?.totalCount || 0;
+
+    const totalCount = Object.keys(migrateResult.nodesToMigrate.nodeIds).length;
+    const existingPercent = counts.totalCount
+      ? ((existingCount / totalCount) * 100).toFixed(0)
+      : '0';
+
+    const noChangeCount = migrateStatusAndCount?.['no change'] || 0;
+
+    const changedPercentage = counts.totalCount
+      ? ((noChangeCount / totalCount) * 100).toFixed(0)
+      : '0';
+
+    const existingColor =
+      existingPercent === '0' || action === 'delete'
+        ? log.warningText
+        : log.infoText;
+
+    const changedColor =
+      changedPercentage === '100' ? log.successText : log.warningText;
+
+    console.log(
+      `  - ${log.highlightText(
+        `totalCount: ${migrateStatusAndCount.totalCount}`
+      )}${
+        changedPercentage === '100'
+          ? ''
+          : existingColor(` [existing: ${`${existingPercent}%`}]`)
+      }${
+        existingPercent === '0'
+          ? ''
+          : changedColor(
+              ` ${
+                changedPercentage === '100'
+                  ? 'up to date'
+                  : `[needs update: ${100 - Number(changedPercentage)}%]`
+              }`
+            )
+      }`
+    );
+  }
+  if (migrateResult.errors?.length) {
+    console.log(
+      `  - ${log.errorText(`errors: ${migrateResult.errors.length}`)}\n`
+    );
+
+    log.limits(
+      migrateResult.errors
+        .map(error => {
+          return log.errorText(deconstructApiError(error));
+        })
+        .join('\n'),
+      logLimit
+    );
   }
 };
 
@@ -363,3 +464,128 @@ export const printModelMigrationResult = (
     }
   }
 };
+
+export const printNodeTreeOutput = (
+  { log, messages }: ContensisCli,
+  root: Node | MigrateNodesTree | undefined,
+  logDetail = 'errors',
+  logLimit = 1000
+) => {
+  log.raw('');
+  const statusColour = messages.migrate.status;
+
+  if (root && 'status' in root)
+    log.info(
+      `Migrate status: ${statusColour('no change')(
+        'N'
+      )} [no change]; ${statusColour('create')('C')} [create]; ${statusColour(
+        'update'
+      )('U')} [update]; ${statusColour('delete')('D')} [delete]; ${statusColour(
+        'error'
+      )('E')} [error];`
+    );
+  log.info(
+    `Node properties: ${log.highlightText(
+      'e'
+    )} = has entry; ${log.highlightText('c')} = canonical; ${log.highlightText(
+      'm'
+    )} = include in menu`
+  );
+
+  log.line();
+
+  const outputNode = (
+    node: Node | MigrateNodesTree,
+    spaces: string,
+    isRoot = false
+  ) => {
+    const errorOutput =
+      'error' in node && node.error && deconstructApiError(node.error);
+    const fullOutput = logDetail === 'all';
+    const changesOutput =
+      logDetail === 'changes' &&
+      'status' in node &&
+      ['create', 'update'].includes(node.status);
+
+    const diffOutput =
+      (fullOutput || changesOutput || errorOutput) &&
+      'diff' in node &&
+      node.diff?.replaceAll('\n', '');
+
+    return `${
+      'status' in node
+        ? `${statusColour(node.status)(
+            node.status.substring(0, 1).toUpperCase()
+          )} `
+        : ''
+    }${node.entry ? log.highlightText('e') : log.infoText('-')}${
+      'isCanonical' in node && node.isCanonical
+        ? log.highlightText('c')
+        : log.infoText('-')
+    }${
+      node.includeInMenu ? log.highlightText('m') : log.infoText('-')
+    }${spaces}${log[
+      'status' in node && node.status === 'no change'
+        ? 'infoText'
+        : 'standardText'
+    ](
+      'isCanonical' in node && node.isCanonical
+        ? log.boldText(fullOutput || isRoot ? node.path : `/${node.slug}`)
+        : fullOutput || isRoot
+        ? node.path
+        : `/${node.slug}`
+    )}${node.entry ? ` ${log.helpText(node.entry.sys.contentTypeId)}` : ''}${
+      node.childCount ? ` +${node.childCount}` : ``
+    } ${'displayName' in node ? log.infoText(node.displayName) : ''}${
+      fullOutput || (changesOutput && node.id !== node.originalId)
+        ? `~n  ${log.infoText(`id:`)} ${
+            node.id === node.originalId
+              ? node.id
+              : `${node.id} ${log.infoText(`<= ${node.originalId}`)}`
+          }`
+        : ''
+    }${
+      (fullOutput ||
+        (changesOutput && node.parentId !== node.originalParentId)) &&
+      node.parentId
+        ? `~n  ${log.infoText(
+            `parentId: ${
+              node.parentId === node.originalParentId
+                ? node.parentId
+                : `${node.parentId} <= ${node.originalParentId}`
+            }`
+          )}`
+        : ''
+    }${
+      fullOutput && node.entry?.sys.id
+        ? `~n  ${log.infoText(`entryId: ${node.entry.sys.id}`)}`
+        : ''
+    }${
+      errorOutput
+        ? `~n${addNewLines(`  ${log.errorText(errorOutput)}`, '~n')}`
+        : ''
+    }${
+      diffOutput
+        ? `~n${addNewLines(
+            `  ${log.infoText(`diff: ${highlightDiffText(diffOutput)}`)}`,
+            '~n'
+          )}`
+        : ''
+    }`;
+  };
+
+  const outputChildren = (node: Node | undefined, depth = 2) => {
+    let str = '';
+    for (const child of ((node as any)?.children || []) as Node[]) {
+      str += `${outputNode(child, Array(depth + 1).join('  '))}\n`;
+      if ('children' in child) str += outputChildren(child, depth + 1);
+    }
+    return str;
+  };
+
+  const children = outputChildren(root);
+  log.limits(
+    `${outputNode(root || {}, ' ', true)}${children ? `\n${children}` : ''}`,
+    logLimit
+  );
+};

package/src/util/error.ts

@@ -0,0 +1,7 @@
+export const deconstructApiError = (error: MappedError) => {
+  let inner = '';
+  if (error.data?.[0]) {
+    inner = `${error.data?.[0].Field}: ${error.data?.[0].Message}`;
+  }
+  return `${error.message} ${inner}`;
+};

package/src/util/find.ts

@@ -2,7 +2,18 @@ export const findByIdOrName = (arr: any[], idOrName: string, exact = false) =>
   arr.find(
     r =>
       r.id === idOrName ||
-      r.name.toLowerCase() === idOrName.toLowerCase()
+      (typeof r.name === 'string' &&
+        r.name.toLowerCase() === idOrName.toLowerCase()) ||
+      (typeof r.name === 'object' &&
+        Object.values<string>(r.name || {})?.[0].toLowerCase() ===
+          idOrName.toLowerCase())
   ) ||
   (!exact &&
-    arr.find(r => r.name.toLowerCase().includes(idOrName.toLowerCase())));
+    arr.find(
+      r =>
+        (typeof r.name === 'string' &&
+          r.name.toLowerCase().includes(idOrName.toLowerCase())) ||
+        (typeof r.name === 'object' &&
+          Object.values<string>(r.name || {})?.[0].toLowerCase() ===
+            idOrName.toLowerCase())
+    ));

package/src/util/git.ts

@@ -75,7 +75,7 @@ export class GitHelper {
   }
   gitcwd = () => path.join(this.gitRepoPath);
   gitInfo = (url: string = this.originUrl) => hostedGitInfo.fromUrl(url);
-  hostType = (url: string = this.originUrl): GitTypes => {
+  hostType = (url: string = this.originUrl): GitTypes | undefined => {
     if (url) {
       if (url.includes('github.com')) return 'github';
       else return 'gitlab';
@@ -87,6 +87,7 @@ export class GitHelper {
   gitConfig = (cwd = this.gitRepoPath) => {
     // Find .git/config in project cwd
     const config = parseGitConfig.sync({
+      cwd,
       path: '.git/config',
       expandKeys: true,
     });