contensis-cli 1.1.2-beta.1 → 1.1.2-beta.3

package/dist/version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/version.ts"],
-  "sourcesContent": ["export const LIB_VERSION = \"1.1.2-beta.1\";\n"],
+  "sourcesContent": ["export const LIB_VERSION = \"1.1.2-beta.3\";\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAO,MAAM,cAAc;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contensis-cli",
-  "version": "1.1.2-beta.1",
+  "version": "1.1.2-beta.3",
   "description": "A fully featured Contensis command line interface with a shell UI provides simple and intuitive ways to manage or profile your content in any NodeJS terminal.",
   "repository": "https://github.com/contensis/cli",
   "homepage": "https://github.com/contensis/cli/tree/main/packages/contensis-cli#readme",

package/src/commands/dev.ts

@@ -49,20 +49,28 @@ Example call:
   dev
     .command('requests')
     .description('launch request handler for local development')
-    .argument('[block-ids...]', 'ids of any blocks to develop locally')
+    .argument(
+      '[block-id...]',
+      'id of block to develop locally and the local uri to pass requests for this block onto'
+    )
     .option('--args <args...>', 'override or add additional args')
-    .usage('[block-ids...]')
+    .option(
+      '--release <release>',
+      'launch a specific release version of the request handler'
+    )
+    .usage('[block-id] [local-uri]')
     .addHelpText(
       'after',
       `
 Example call:
-  > dev requests test-block-one\n`
+  > dev requests test-block-one
+  > dev requests my-website http://localhost:8080\n`
     )
-    .action(async (blockIds: string[] = [], opts) => {
+    .action(async (blockId: string[] = [], opts) => {
       await devCommand(
-        ['dev', 'requests', blockIds.join(' ')],
+        ['dev', 'requests', blockId.join(' ')],
         opts
-      ).ExecRequestHandler(blockIds, opts?.args);
+      ).ExecRequestHandler(blockId, opts?.args, opts.release);
     });
 
   return dev;

package/src/commands/get.ts

@@ -298,6 +298,7 @@ Example call:
 Example call:
   > get block contensis-website
   > get block contensis-website develop latest
+  > get block contensis-website feature-branch 3
 `
     )
     .action(async (blockId: string, branch: string, version: string, opts) => {

package/src/factories/RequestHandlerFactory.ts

@@ -6,7 +6,7 @@ import { LogMessages } from '~/localisation/en-GB';
 import GitHubCliModuleProvider from '~/providers/GitHubCliModuleProvider';
 
 import ManifestProvider from '~/providers/ManifestProvider';
-import { appRootDir, joinPath } from '~/providers/file-provider';
+import { appRootDir, checkDir, joinPath } from '~/providers/file-provider';
 import { isDebug } from '~/util/debug';
 import { Logger } from '~/util/logger';
 
@@ -21,6 +21,7 @@ export class RequestHandlerFactory {
   cmd = 'Zengenti.Contensis.RequestHandler.LocalDevelopment';
 
   prerelease;
+  version; // pass in a specific release version to run
 
   get exePath() {
     return path.join(this.basePath, `${this.name}-${this.moduleInfo.version}`);
@@ -35,29 +36,31 @@ export class RequestHandlerFactory {
     );
   }
 
-  constructor(prerelease = false) {
+  constructor(version?: string, prerelease = false) {
     this.prerelease = prerelease;
+    this.version = version;
   }
 
   // Use the factory to create a request handler instance
   // handling the download and updating of the external binary
   async Create() {
-    const { moduleInfo } = this;
-    const firstUse = !moduleInfo?.version || moduleInfo?.version === '*';
+    const { moduleInfo, version } = this;
+    const downloadImmediately =
+      !moduleInfo?.version || moduleInfo?.version === '*' || this.version;
 
-    if (firstUse) {
+    if (downloadImmediately) {
       // Create cli-manifest.json
       this.manifest.writeModule(this.name, this.moduleInfo);
 
       // Download for first time use (await)
-      await this.CheckUpdate({ verbose: true });
+      await this.CheckUpdate({ verbose: true, version });
     }
 
     // Apply any downloaded/pending update so we launch that version
     await this.ApplyUpdate();
 
     // Fire an async update check and continue working in the background (do not await)
-    if (!firstUse) this.CheckUpdate();
+    if (!downloadImmediately) this.CheckUpdate();
 
     // Return a RequestHandler ready to invoke
     return this.CreateInvoke(this);
@@ -121,11 +124,17 @@ export class RequestHandlerFactory {
     };
   }
 
-  async CheckUpdate({ verbose = false }: { verbose?: boolean } = {}) {
-    const { debug, log, manifest, messages, moduleInfo } = this;
+  async CheckUpdate({
+    verbose = false,
+    version,
+  }: { verbose?: boolean; version?: string } = {}) {
+    const { cmd, debug, log, manifest, messages, moduleInfo } = this;
+
     const github = new GitHubCliModuleProvider(moduleInfo.github);
+
     // Find latest version
-    const release = await github.FindLatestRelease();
+    const release = await github.FindLatestRelease(version);
+
     if (verbose || debug)
       if (release)
         log.info(
@@ -137,10 +146,14 @@ export class RequestHandlerFactory {
       else
         log.warning(messages.devrequests.install.notFound(moduleInfo.github));
 
+    const downloadSpecificRelease =
+      version && !checkDir('c') && release?.tag_name;
+
     // Should we download an update?
     if (
-      release?.tag_name &&
-      ![moduleInfo.version, moduleInfo.install].includes(release.tag_name)
+      (release?.tag_name &&
+        ![moduleInfo.version, moduleInfo.install].includes(release.tag_name)) ||
+      downloadSpecificRelease
     ) {
       // Download platform-specific release asset
       const downloadPath = path.join(
@@ -160,6 +173,7 @@ export class RequestHandlerFactory {
       }
       try {
         await github.DownloadRelease(release, {
+          cmd,
           path: downloadPath,
           // Map NodeJS os platform to release asset name
           platforms: [
@@ -186,10 +200,16 @@ export class RequestHandlerFactory {
             ),
           });
 
-        // Update module info with downloaded release
-        this.moduleInfo.install = release.tag_name;
-        // Write module info update to manifest so it installs on next invoke
-        manifest.writeModule(this.name, this.moduleInfo);
+        if (!version) {
+          // Update module info with downloaded release
+          this.moduleInfo.install = release.tag_name;
+          // Write module info update to manifest so it installs on next invoke
+          manifest.writeModule(this.name, this.moduleInfo);
+        } else {
+          // Set module version in memory so the request handler
+          // will be invoked with this version this time only
+          this.moduleInfo.version = release.tag_name;
+        }
       }
     }
   }
@@ -222,4 +242,5 @@ export class RequestHandlerFactory {
   }
 }
 
-export const createRequestHandler = () => new RequestHandlerFactory().Create();
+export const createRequestHandler = (version?: string) =>
+  new RequestHandlerFactory(version).Create();

package/src/localisation/en-GB.ts

@@ -607,8 +607,7 @@ export const LogMessages = {
     install: {
       notFound: (repo: string) =>
         `Could not find a release in ${repo} repo - please check github`,
-      download: (repo: string, version: string) =>
-        `Found release ${repo} ${version}`,
+      download: (repo: string, version: string) => `Found release ${version}`,
       downloading: (repo: string, version: string) =>
         `Downloading ${repo} ${version}`,
       downloadFail: (repo: string, version: string) =>
@@ -621,6 +620,8 @@ export const LogMessages = {
         )}?`,
     },
     launch: () => `Launching request handler for local development`,
+    overrideBlock: () => `Which block will you be running?`,
+    overrideUri: () => `How to access your development site`,
     spawn: () =>
       `If you see a firewall popup requesting network access, it is safe to approve`,
     exited: (code: number | null) =>

package/src/mappers/DevRequests-to-RequestHanderCliArgs.ts

@@ -32,114 +32,148 @@ type RendererRuleJson = {
 interface ISiteConfigYaml {
   alias: string;
   projectId: string;
-  accessToken: string;
+  accessToken: string; // needed?
   clientId: string;
   sharedSecret: string;
   blocks: BlockJson[];
   renderers: RendererJson[];
 }
 
-export const buildSiteConfig = async (cli: ContensisCli) => {
-  const { currentEnv, env, log, messages } = cli;
-  const siteConfig: ISiteConfigYaml = {
-    alias: cli.currentEnv,
-    projectId: cli.currentProject,
-    accessToken: '',
-    clientId: '',
-    sharedSecret: '',
-    blocks: [],
-    renderers: [],
+class RequestHandlerArgs {
+  private cli;
+  args?: string[];
+  siteConfig?: ISiteConfigYaml;
+
+  constructor(cli: ContensisCli) {
+    this.cli = cli;
+  }
+
+  Create = async () => {
+    this.siteConfig = await this.buildSiteConfig();
+    await this.cli.Login(this.cli.env.lastUserId, { silent: true }); // to hydrate the auth service
+    this.args = this.getArgs();
   };
 
-  const getBlocks = async (contensis: ContensisMigrationService) => {
-    const [err, blocksRaw] = await contensis.blocks.GetBlocks();
-    if (err) log.error(messages.blocks.noList(currentEnv, env.currentProject));
+  buildSiteConfig = async () => {
+    const { currentEnv, currentProject, env, log, messages } = this.cli;
+    const siteConfig: ISiteConfigYaml = {
+      alias: currentEnv,
+      projectId: currentProject,
+      accessToken: '',
+      clientId: '',
+      sharedSecret: '',
+      blocks: [],
+      renderers: [],
+    };
 
-    // const blocksRaw = await cli.PrintBlocks();
+    const getBlocks = async (contensis: ContensisMigrationService) => {
+      const [err, blocksRaw] = await contensis.blocks.GetBlocks();
+      if (err)
+        log.error(messages.blocks.noList(currentEnv, env.currentProject));
 
-    const blocks: BlockJson[] = [];
-    for (const block of blocksRaw || []) {
-      // Retrieve block version
-      const [err, versions] = await contensis.blocks.GetBlockVersions(
-        block.id,
-        'default',
-        'latest'
-      );
-      if (err || versions?.length === 0)
-        log.warning(
-          messages.blocks.noGet(
-            block.id,
-            'default',
-            'latest',
-            currentEnv,
-            env.currentProject
-          )
+      // const blocksRaw = await cli.PrintBlocks();
+
+      const blocks: BlockJson[] = [];
+      for (const block of blocksRaw || []) {
+        // Retrieve block version
+        const [err, versions] = await contensis.blocks.GetBlockVersions(
+          block.id,
+          'default',
+          'latest'
         );
-      if (versions?.[0]) {
-        const v = versions[0];
-        blocks.push({
-          id: v.id,
-          baseUri: v.previewUrl,
-          staticPaths: v.staticPaths,
-          endpoints: v.endpoints,
-          versionNo: v.version.versionNo,
-          branch: v.source.branch,
-        });
+        if (err || versions?.length === 0)
+          log.warning(
+            messages.blocks.noGet(
+              block.id,
+              'default',
+              'latest',
+              currentEnv,
+              env.currentProject
+            )
+          );
+        if (versions?.[0]) {
+          const v = versions[0];
+          blocks.push({
+            id: v.id,
+            baseUri: v.previewUrl,
+            staticPaths: v.staticPaths,
+            endpoints: v.endpoints,
+            versionNo: v.version.versionNo,
+            branch: v.source.branch,
+          });
+        }
       }
+      return blocks;
+    };
+
+    const contensis = await this.cli.ConnectContensis();
+    if (contensis) {
+      const [blocks, renderers] = await Promise.all([
+        getBlocks(contensis),
+        contensis.renderers.GetRenderers(),
+      ]);
+
+      siteConfig.blocks = blocks;
+      siteConfig.renderers = renderers?.[1]?.map(r => ({
+        id: r.id,
+        name: r.name,
+        assignedContentTypes: r.assignedContentTypes,
+        rules: r.rules,
+      }));
     }
-    return blocks;
+    return siteConfig;
   };
 
-  const contensis = await cli.ConnectContensis();
-  if (contensis) {
-    const [blocks, renderers] = await Promise.all([
-      getBlocks(contensis),
-      contensis.renderers.GetRenderers(),
-    ]);
-
-    siteConfig.blocks = blocks;
-    siteConfig.renderers = renderers?.[1]?.map(r => ({
-      id: r.id,
-      name: r.name,
-      assignedContentTypes: r.assignedContentTypes,
-      rules: r.rules,
-    }));
-  }
-  return siteConfig;
-};
+  getArgs = (overrideArgs: string[] = []) => {
+    const args = overrideArgs
+      ? typeof overrideArgs?.[0] === 'string' &&
+        overrideArgs[0].includes(' ', 2)
+        ? overrideArgs[0].split(' ')
+        : overrideArgs
+      : []; // args could be [ '-c .\\site_config.yaml' ] or [ '-c', '.\\site_config.yaml' ]
 
-export const requestHandlerCliArgs = async (
-  cli: ContensisCli,
-  overrideArgs: string[] = []
-) => {
-  const args = overrideArgs
-    ? typeof overrideArgs?.[0] === 'string' && overrideArgs[0].includes(' ', 2)
-      ? overrideArgs[0].split(' ')
-      : overrideArgs
-    : []; // args could be [ '-c .\\site_config.yaml' ] or [ '-c', '.\\site_config.yaml' ]
-
-  const siteConfig = await buildSiteConfig(cli);
-  // Add required args
-  if (!args.find(a => a === '--alias')) args.push('--alias', cli.currentEnv);
-  if (!args.find(a => a === '--project-api-id'))
-    args.push('--project-api-id', cli.currentProject);
-  if (!args.find(a => a === '--blocks-json'))
-    args.push('--blocks-json', JSON.stringify(siteConfig.blocks));
-  if (!args.find(a => a === '--renderers-json'))
-    args.push('--renderers-json', JSON.stringify(siteConfig.renderers));
-
-  await cli.Login(cli.env.lastUserId, { silent: true }); // to hydrate the auth service
-  const client = cli.auth?.clientDetails;
-  if (client) {
-    if (!args.find(a => a === '--client-id') && 'clientId' in client)
-      args.push('--client-id', client.clientId);
-    if (!args.find(a => a === '--client-secret') && 'clientSecret' in client)
-      args.push('--client-secret', client.clientSecret);
-    if (!args.find(a => a === '--username') && 'username' in client)
-      args.push('--username', client.username);
-    if (!args.find(a => a === '--password') && 'password' in client)
-      args.push('--password', client.password);
-  }
+    const { cli, siteConfig } = this;
+    if (siteConfig) {
+      // Add required args
+      if (!args.find(a => a === '--alias'))
+        args.push('--alias', cli.currentEnv);
+      if (!args.find(a => a === '--project-api-id'))
+        args.push('--project-api-id', cli.currentProject);
+      if (!args.find(a => a === '--blocks-json'))
+        args.push('--blocks-json', JSON.stringify(siteConfig.blocks));
+      if (!args.find(a => a === '--renderers-json'))
+        args.push('--renderers-json', JSON.stringify(siteConfig.renderers));
+    }
 
-  return args;
-};
+    const client = cli.auth?.clientDetails;
+    if (client) {
+      if (!args.find(a => a === '--client-id') && 'clientId' in client)
+        args.push('--client-id', client.clientId);
+      if (!args.find(a => a === '--client-secret') && 'clientSecret' in client)
+        args.push('--client-secret', client.clientSecret);
+      if (!args.find(a => a === '--username') && 'username' in client)
+        args.push('--username', client.username);
+      if (!args.find(a => a === '--password') && 'password' in client)
+        args.push('--password', client.password);
+    }
+
+    return args;
+  };
+
+  overrideBlock = (blockId: string, overrideUri: string) => {
+    if (blockId && blockId !== 'none') {
+      const blockIndex = this.siteConfig?.blocks.findIndex(
+        b => b.id.toLowerCase() === blockId.toLowerCase()
+      );
+      if (
+        typeof blockIndex === 'number' &&
+        !isNaN(blockIndex) &&
+        this.siteConfig?.blocks[blockIndex]
+      ) {
+        this.siteConfig.blocks[blockIndex].baseUri = overrideUri;
+      }
+    }
+  };
+}
+
+export default RequestHandlerArgs;

package/src/providers/GitHubCliModuleProvider.ts

@@ -3,6 +3,7 @@ import Zip from 'adm-zip';
 import type { Endpoints } from '@octokit/types';
 import HttpProvider from '~/providers/HttpProvider';
 import {
+  addExecutePermission,
   checkDir,
   joinPath,
   removeDirectory,
@@ -37,7 +38,7 @@ class GitHubCliModuleProvider {
     this.repo = repo;
   }
 
-  async FindLatestRelease() {
+  async FindLatestRelease(version?: string) {
     const { http, latest_release_url, releases_url } = this;
     // return latest tag version is:
 
@@ -55,14 +56,18 @@ class GitHubCliModuleProvider {
       throw new Error(`Unable to get releases`, { cause: releasesErr });
     } else if (!releases || releases.length === 0)
       throw new Error(`No releases available`);
-    else if (latestErr && !latest) {
+    else if (version) {
+      const release = releases.find(
+        r => r.tag_name.toLowerCase() === version.toLowerCase()
+      );
+      if (release) return release;
+      else throw new Error(`No release for ${version} found`);
+    } else if (latestErr && !latest) {
       if (latestResponse?.status === 404 && releases?.length) {
         // No latest release, check releases for prerelease version, fallback to last release
         const release = releases.find(r => r.prerelease) || releases[0];
 
-        if (release) {
-          return release;
-        }
+        if (release) return release;
       }
     } else {
       return latest;
@@ -72,10 +77,16 @@ class GitHubCliModuleProvider {
   async DownloadRelease(
     release: GitHubApiRelease,
     {
+      cmd,
       path,
       platforms,
       unzip = true,
-    }: { path: string; unzip?: boolean; platforms: [NodeJS.Platform, string][] }
+    }: {
+      cmd: string;
+      path: string;
+      unzip?: boolean;
+      platforms: [NodeJS.Platform, string][];
+    }
   ) {
     // find os-specific asset
     const platform = platforms.find(p => p[0] === os.platform()) || [
@@ -102,6 +113,8 @@ class GitHubCliModuleProvider {
         // delete the downloaded zip file
         removeFile(filePath);
       }
+
+      if (os.platform() !== 'win32') addExecutePermission(joinPath(path, cmd));
     } else
       throw new Error(
         `no asset found in release ${

package/src/providers/file-provider.ts

@@ -93,6 +93,10 @@ export const cwdPath = (filePath: string) =>
 
 export const joinPath = path.join;
 
+export const addExecutePermission = (filePath: string) =>
+  // Fails in windows with `TypeError [ERR_INVALID_ARG_TYPE]: The "mode" argument must be of type number. Received undefined`
+  fs.chmodSync(filePath, fs.constants.S_IRWXU);
+
 type DetectedFileType =
   | { type: 'json'; contents: any }
   | { type: 'xml' | 'csv'; contents: string };

package/src/services/ContensisDevService.ts

@@ -11,7 +11,7 @@ import { createRequestHandler } from '~/factories/RequestHandlerFactory';
 import { OutputOptionsConstructorArg } from '~/models/CliService';
 import { EnvContentsToAdd } from '~/models/DevService';
 import { mapCIWorkflowContent } from '~/mappers/DevInit-to-CIWorkflow';
-import { requestHandlerCliArgs } from '~/mappers/DevRequests-to-RequestHanderCliArgs';
+import RequestHandlerArgs from '~/mappers/DevRequests-to-RequestHanderCliArgs';
 import { deployKeyRole } from '~/mappers/DevInit-to-RolePermissions';
 import { readFile, writeFile } from '~/providers/file-provider';
 import { diffFileContent } from '~/util/diff';
@@ -412,8 +412,9 @@ class ContensisDev extends ContensisRole {
   };
 
   ExecRequestHandler = async (
-    blockIds: string[],
-    overrideArgs: string[] = []
+    blockId: string[],
+    overrideArgs: string[] = [],
+    version?: string
   ) => {
     const { debug, log, messages } = this;
 
@@ -422,15 +423,45 @@ class ContensisDev extends ContensisRole {
       : log.info(messages.devrequests.launch());
 
     // Ensure request handler is available to use
-    const requestHandler = await createRequestHandler();
+    const requestHandler = await createRequestHandler(version);
 
     // Generate args for request handler using CLI methods
+    const args = new RequestHandlerArgs(this);
     spinner?.start();
-    const args = await requestHandlerCliArgs(this, overrideArgs);
+    await args.Create();
     spinner?.success();
 
+    // Prompt block id and dev uri to run locally (if not supplied)
+    const blockIdChoices = args.siteConfig?.blocks.map(block => block.id) || [];
+    blockIdChoices.push('none');
+    const defaultDeveloperUri = 'http://localhost:3000';
+
+    const { overrideBlockId, overrideUri } = blockId.length
+      ? {
+          overrideBlockId: blockId[0],
+          overrideUri: blockId?.[1] || defaultDeveloperUri,
+        }
+      : await inquirer.prompt([
+          {
+            type: 'list',
+            prefix: '🧱',
+            message: messages.devrequests.overrideBlock(),
+            name: 'overrideBlockId',
+            choices: blockIdChoices,
+          },
+          {
+            type: 'input',
+            prefix: '🔗',
+            message: messages.devrequests.overrideUri(),
+            name: 'overrideUri',
+            default: defaultDeveloperUri,
+          },
+        ]);
+
+    args.overrideBlock(overrideBlockId, overrideUri);
+
     // Launch request handler
-    await requestHandler(args);
+    await requestHandler(args.getArgs(overrideArgs));
   };
 }
 export const devCommand = (

package/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = "1.1.2-beta.1";
+export const LIB_VERSION = "1.1.2-beta.3";