Merge pull request #9 from codemagic-ci-cd/ux-login-help

Managed-first CLI login and help cleanup

Author: kmsbernard

README.md

@@ -589,19 +589,35 @@ function link(command: cli.ILinkCommand): Promise<void> {
 }
 
 function login(command: cli.ILoginCommand): Promise<void> {
-  // Check if one of the flags were provided.
   if (command.accessKey) {
-    sdk = getSdk(command.accessKey, CLI_HEADERS, command.serverUrl);
-    return sdk.isAuthenticated().then((isAuthenticated: boolean): void => {
-      if (isAuthenticated) {
-        serializeConnectionInfo(command.accessKey, /*preserveAccessKeyOnLogout*/ true, command.serverUrl);
-      } else {
-        throw new Error("Invalid access key.");
-      }
-    });
-  } else {
-    return loginWithExternalAuthentication("login", command.serverUrl);
+    return loginWithAccessKey(command.accessKey, command.serverUrl, /*preserveAccessKeyOnLogout*/ true);
+  }
+
+  return requestAccessKey().then((accessKey: string): Promise<void> => {
+    if (accessKey === null) {
+      // The user has aborted the synchronous prompt (e.g.:  via [CTRL]+[C]).
+      return;
+    }
+
+    return loginWithAccessKey(accessKey, command.serverUrl, /*preserveAccessKeyOnLogout*/ true);
+  });
+}
+
+function loginWithAccessKey(accessKey: string, serverUrl?: string, preserveAccessKeyOnLogout: boolean = true): Promise<void> {
+  accessKey = accessKey ? accessKey.trim() : "";
+
+  if (!accessKey) {
+    throw new Error("An access key must be specified.");
   }
+
+  sdk = getSdk(accessKey, CLI_HEADERS, serverUrl);
+  return sdk.isAuthenticated().then((isAuthenticated: boolean): void => {
+    if (isAuthenticated) {
+      serializeConnectionInfo(accessKey, preserveAccessKeyOnLogout, serverUrl);
+    } else {
+      throw new Error("Invalid access key.");
+    }
+  });
 }
 
 function loginWithExternalAuthentication(action: string, serverUrl?: string): Promise<void> {
@@ -614,15 +630,7 @@ function loginWithExternalAuthentication(action: string, serverUrl?: string): Pr
       return;
     }
 
-    sdk = getSdk(accessKey, CLI_HEADERS, serverUrl);
-
-    return sdk.isAuthenticated().then((isAuthenticated: boolean): void => {
-      if (isAuthenticated) {
-        serializeConnectionInfo(accessKey, /*preserveAccessKeyOnLogout*/ false, serverUrl);
-      } else {
-        throw new Error("Invalid access key.");
-      }
-    });
+    return loginWithAccessKey(accessKey, serverUrl, /*preserveAccessKeyOnLogout*/ false);
   });
 }
 
@@ -1422,14 +1430,16 @@ function requestAccessKey(): Promise<string> {
         properties: {
           response: {
             description: chalk.cyan("Enter your access key: "),
+            hidden: true,
+            replace: "*",
           },
         },
       },
       (err: any, result: any): void => {
         if (err) {
           resolve(null);
         } else {
-          resolve(result.response.trim());
+          resolve((result.response || "").trim());
         }
       }
     );

script/command-executor.ts

@@ -277,6 +277,7 @@ function deploymentHistory(commandName: string, yargs: yargs.Argv): void {
 }
 
 yargs
+  .scriptName("code-push")
   .usage(USAGE_PREFIX + " <command>")
   .demand(/*count*/ 1, /*max*/ 1) // Require exactly one non-option argument.
   .command("access-key", "View and manage the access keys associated with your account", (yargs: yargs.Argv) => {
@@ -334,7 +335,7 @@ yargs
 
     addCommonConfiguration(yargs);
   })
-  .command("collaborator", "View and manage app collaborators", (yargs: yargs.Argv) => {
+  .command("collaborator", false, (yargs: yargs.Argv) => {
     isValidCommandCategory = true;
     yargs
       .usage(USAGE_PREFIX + " collaborator <command>")
@@ -413,7 +414,7 @@ yargs
 
     addCommonConfiguration(yargs);
   })
-  .command("link", "Link an additional authentication provider (e.g. GitHub) to an existing CodePush account", (yargs: yargs.Argv) => {
+  .command("link", false, (yargs: yargs.Argv) => {
     isValidCommandCategory = true;
     isValidCommand = true;
     yargs
@@ -430,14 +431,13 @@ yargs
     yargs
       .usage(USAGE_PREFIX + " login [options]")
       .demand(/*count*/ 0, /*max*/ 1) //set 'max' to one to allow usage of serverUrl undocument parameter for testing
-      .example("login", "Logs in to the CodePush server")
-      .example("login --accessKey mykey", 'Logs in on behalf of the user who owns and created the access key "mykey"')
-      .option("accessKey", {
+      .example("login", "Prompts for an access key and logs in to the CodePush server")
+      .example("login --access-key mykey", 'Logs in with the access key "mykey"')
+      .option("access-key", {
         alias: "key",
         default: null,
         demand: false,
-        description:
-          "Access key to authenticate against the CodePush server with, instead of providing your username and password credentials",
+        description: "Access key to authenticate against the CodePush server with",
         type: "string",
       })
       .check((argv: any, aliases: { [aliases: string]: string }): any => isValidCommand); // Report unrecognized, non-hyphenated command category.
@@ -585,7 +585,7 @@ yargs
 
     addCommonConfiguration(yargs);
   })
-  .command("register", "Register a new CodePush account", (yargs: yargs.Argv) => {
+  .command("register", false, (yargs: yargs.Argv) => {
     isValidCommandCategory = true;
     isValidCommand = true;
     yargs
@@ -859,7 +859,7 @@ yargs
 
     addCommonConfiguration(yargs);
   })
-  .command("session", "View and manage the current login sessions associated with your account", (yargs: yargs.Argv) => {
+  .command("session", false, (yargs: yargs.Argv) => {
     isValidCommandCategory = true;
     yargs
       .usage(USAGE_PREFIX + " session <command>")
@@ -1137,7 +1137,7 @@ export function createCommand(): cli.ICommand {
         const loginCommand = <cli.ILoginCommand>cmd;
 
         loginCommand.serverUrl = getServerUrl(arg1);
-        loginCommand.accessKey = argv["accessKey"] as any;
+        loginCommand.accessKey = argv["access-key"] as any;
         break;
 
       case "logout":

script/command-parser.ts

@@ -62,7 +62,7 @@ class AccountManager {
     OWNER: "Owner",
     COLLABORATOR: "Collaborator",
   };
-  public static SERVER_URL = "http://localhost:3000";
+  public static SERVER_URL = "https://codepush.pro";
 
   private static API_VERSION: number = 2;
 

script/management-sdk.ts

@@ -0,0 +1,5 @@
+platform :ios, '13.0'
+
+target 'TestApp' do
+  use_react_native!(:hermes_enabled => false)
+end