chore: added automatic url opening

[ci skip]

Author: aryanjassal

npmDepsHash

@@ -1 +1 @@
-sha256-23Yx1RJcaNEL1YmNz/LRFYL+5g++B+aoT0CSSbreAx8=
+sha256-44tI1RhQERi0VnHlcRaYWnvTUd3r+cJ4JTQPSTZ2hXk=

package-lock.json

@@ -126,21 +126,21 @@
   },
   "optionalDependencies": {
     "@matrixai/db": "*",
+    "@matrixai/exec-darwin-universal": "*",
+    "@matrixai/exec-linux-x64": "*",
     "@matrixai/mdns-linux-x64": "*",
     "@matrixai/quic-darwin-universal": "*",
     "@matrixai/quic-linux-x64": "*",
     "@matrixai/quic-win32-x64": "*",
-    "@matrixai/exec-darwin-universal": "*",
-    "@matrixai/exec-linux-x64": "*",
     "fd-lock": "*",
     "sodium-native": "*"
   },
   "devDependencies": {
-    "@matrixai/lint": "^0.2.11",
+    "@fast-check/jest": "^2.1.1",
     "@matrixai/errors": "^2.1.3",
-    "@matrixai/logger": "^4.0.3",
     "@matrixai/exec": "^1.0.3",
-    "@fast-check/jest": "^2.1.1",
+    "@matrixai/lint": "^0.2.11",
+    "@matrixai/logger": "^4.0.3",
     "@swc/core": "1.3.82",
     "@swc/jest": "^0.2.29",
     "@types/jest": "^29.5.14",
@@ -161,6 +161,7 @@
     "mocked-env": "^1.3.5",
     "nexpect": "^0.6.0",
     "node-gyp-build": "^4.8.4",
+    "open": "^10.1.2",
     "polykey": "^2.4.0",
     "shelljs": "^0.8.5",
     "shx": "^0.3.4",

package.json

@@ -1,10 +1,8 @@
 import type PolykeyClient from 'polykey/PolykeyClient.js';
 import CommandPolykey from '../CommandPolykey.js';
 import * as binProcessors from '../utils/processors.js';
-import * as binParsers from '../utils/parsers.js';
 import * as binUtils from '../utils/index.js';
 import * as binOptions from '../utils/options.js';
-import * as errors from '../errors.js';
 
 class CommandLogin extends CommandPolykey {
   constructor(...args: ConstructorParameters<typeof CommandPolykey>) {
@@ -20,6 +18,7 @@ class CommandLogin extends CommandPolykey {
       const { default: PolykeyClient } = await import(
         'polykey/PolykeyClient.js'
       );
+      const { default: open } = await import('open');
       const clientOptions = await binProcessors.processClientOptions(
         options.nodePath,
         options.nodeId,
@@ -51,19 +50,31 @@ class CommandLogin extends CommandPolykey {
         // Get a signed token by the agent
         const response = await binUtils.retryAuthentication(
           (auth) =>
-            pkClient.rpcClient.methods.authSignToken({ metadata: auth }),
+            pkClient.rpcClient.methods.authIdentityToken({ metadata: auth }),
           meta,
         );
 
         // Send the returned JWT to the returnURL provided by the initial token
         const compactHeader = binUtils.jsonToCompactJWT(response);
-        const targetURL = new URL(url.endsWith('/') ? url.slice(0, url.length) : url);
-        const subPath: string = options.returnURLPath ?? '/api/oauth2/oidc'
+        const targetURL = new URL(
+          url.endsWith('/') ? url.slice(0, url.length) : url,
+        );
+        const subPath: string = options.returnURLPath ?? '/api/oauth2/oidc';
         targetURL.pathname = subPath.startsWith('/') ? subPath : `/${subPath}`;
         targetURL.searchParams.append('token', compactHeader);
 
-        // TEMPORARY: Print out the resulting URL
-        process.stdout.write(`Open the following URL in your browser:\n\t${targetURL}`)
+        // Print out the URL to stderr
+        process.stderr.write(
+          `Open the following URL in your browser:\n\t${targetURL}\n`,
+        );
+
+        // Try to open the URL in the browser
+        try {
+          process.stderr.write('Opening URL in browser...\n');
+          await open(targetURL.toString());
+        } catch (e) {
+          process.stderr.write(`Failed to open browser: ${e.message}\n`);
+        }
       } finally {
         if (pkClient! != null) await pkClient.stop();
       }

src/auth/CommandLogin.ts

@@ -201,11 +201,6 @@ class ErrorPolykeyCLIInvalidJWT<T> extends ErrorPolykeyCLI<T> {
   exitCode = sysexits.USAGE;
 }
 
-class ErrorPolykeyCLILoginFailed<T> extends ErrorPolykeyCLI<T> {
-  static description = 'Failed to login using Polykey';
-  exitCode = sysexits.SOFTWARE;
-}
-
 export {
   ErrorPolykeyCLI,
   ErrorPolykeyCLIUncaughtException,
@@ -235,5 +230,4 @@ export {
   ErrorPolykeyCLIEditSecret,
   ErrorPolykeyCLITouchSecret,
   ErrorPolykeyCLIInvalidJWT,
-  ErrorPolykeyCLILoginFailed,
 };

src/errors.ts

@@ -193,30 +193,6 @@ const parsePort: (data: string) => Port = validateParserToArgParser(
 const parseSeedNodes: (data: string) => [SeedNodes, boolean] =
   validateParserToArgParser(nodesUtils.parseSeedNodes);
 
-// Compact JWTs are in xxxx.yyyy.zzzz format where x is the protected
-// header, y is the payload, and z is the binary signature.
-const parseCompactJWT = (token: string): [string, string, string] => {
-  // Clean up whitespaces
-  token = token.trim();
-
-  // Confirm part amount
-  const parts = token.split('.');
-  if (parts.length !== 3) {
-    throw new InvalidArgumentError(
-      'JWT must contain three dot-separated parts',
-    );
-  }
-
-  // Validate base64 encoding
-  for (const part of parts) {
-    if (!part || !base64UrlRegex.test(part)) {
-      throw new InvalidArgumentError('JWT is not correctly encoded');
-    }
-  }
-
-  return [parts[0], parts[1], parts[2]];
-};
-
 export {
   vaultNameRegex,
   secretPathRegex,
@@ -245,5 +221,4 @@ export {
   parseProviderId,
   parseIdentityId,
   parseProviderIdList,
-  parseCompactJWT,
 };