@metaplay/metaplay-auth 1.7.1 → 1.7.2

package/index.ts

@@ -107,10 +107,7 @@ async function fetchManagedEnvironmentInfoWithSlugs(
   })
 
   // Throw on server errors (eg, forbidden)
-  if (!response.ok) {
-    const errorData = await response.json()
-    throw new Error(`Failed to fetch environment details with error ${response.status}: ${JSON.stringify(errorData)}`)
-  }
+  await checkEnvironmentInfoResponseError(response)
 
   // \todo Validate response?
   const portalEnvInfo = (await response.json()) as PortalEnvironmentInfo
@@ -130,20 +127,30 @@ async function fetchManageEnvironmentInfoWithHumanId(tokens: TokenSet, humanId:
   })
 
   // Throw on server errors (eg, forbidden)
-  if (!response.ok) {
-    const errorData = await response.json()
-    throw new Error(`Failed to fetch environment details with error ${response.status}: ${JSON.stringify(errorData)}`)
-  }
+  await checkEnvironmentInfoResponseError(response)
 
   // Return the result
   const portalEnvInfos = (await response.json()) as PortalEnvironmentInfo[]
   logger.debug(`Portal returned environment infos: ${JSON.stringify(portalEnvInfos, undefined, 2)}`)
   if (portalEnvInfos.length === 0) {
-    throw new Error(`Failed to fetch details from portal for environment ${humanId}: no matching environment found`)
+    throw new Error(`Environment ${humanId} does not exist or your account does not have permissions to access this environment`)
   }
   return portalEnvInfos[0]
 }
 
+async function checkEnvironmentInfoResponseError(response: Response): Promise<void> {
+  // Throw on server errors (eg, forbidden)
+  // Portal returns a helpful error message in 'message' field.
+  if (!response.ok) {
+    const errorData = await response.json()
+    if (typeof(errorData) === 'object' && errorData !== null && 'message' in errorData && typeof(errorData.message) === 'string') {
+      throw new Error(errorData.message)
+    } else {
+      throw new Error(`Failed to fetch environment details with error ${response.status}: ${JSON.stringify(errorData)}`)
+    }
+  }
+}
+
 /**
  * Resolve the target environment based on (org, proj, env) tuple. We fetch the information
  * from the portal and then construct the `TargetEnvironment` class with the required information
@@ -251,8 +258,10 @@ program
     }
 
     // Store the portal base URL for accessing globally
-    if (opts.portalBaseUrl) {
-      setPortalBaseUrl(opts.portalBaseUrl as string)
+    const overridePortalUrl: string | undefined = opts.portalBaseUrl ?? process.env.AUTHCLI_PORTAL_BASEURL
+    if (overridePortalUrl) {
+      logger.debug(`Using portal URL override: ${overridePortalUrl}`)
+      setPortalBaseUrl(overridePortalUrl)
     }
 
     // Store the stack API base URL for accessing globally
@@ -309,6 +318,7 @@ program
       await removeTokens()
       console.log('Done! You are now logged out.')
     } catch (error) {
+      logger.debug('Invocation failed with error:', error)
       if (error instanceof Error) {
         console.error(`Error logging out: ${error.message}`)
       }
@@ -328,6 +338,7 @@ program
       const tokens = await loadTokens()
       console.log(JSON.stringify(tokens, undefined, 2))
     } catch (error) {
+      logger.debug('Invocation failed with error:', error)
       if (error instanceof Error) {
         console.error(`Error showing tokens: ${error.message}`)
       }
@@ -381,8 +392,9 @@ program
           console.log(kubeconfigPayload)
         }
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
-          console.error('Error getting KubeConfig:', error)
+          console.error('Error getting KubeConfig:', error.message)
         }
         exit(1)
       }
@@ -417,6 +429,7 @@ program
         const credentials = await targetEnv.getKubeExecCredential()
         console.log(credentials)
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Error getting Kubernetes ExecCredential: ${error.message}`)
         }
@@ -464,6 +477,7 @@ program
           )
         }
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Error getting AWS credentials: ${error.message}`)
         }
@@ -522,6 +536,7 @@ program
           )
         }
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Error getting docker login credentials: ${error.message}`)
         }
@@ -551,6 +566,7 @@ program
         const environment = await targetEnv.getEnvironmentDetails()
         console.log(JSON.stringify(environment, undefined, 2))
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Error getting environment details: ${error.message}`)
         }
@@ -644,6 +660,7 @@ program
 
         console.log(`Successfully pushed docker image to ${dstImageName}!`)
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Failed to push docker image: ${error.message}`)
         }
@@ -886,11 +903,13 @@ program
           console.log('Validating game server deployment...')
           await checkGameServerDeployment(envInfo, kubeconfig, imageTag)
         } catch (error) {
+          logger.debug('Invocation failed with error:', error)
           const errMessage = error instanceof Error ? error.message : String(error)
           console.error(`Failed to resolve game server deployment status: ${errMessage}`)
           exit(2)
         }
       } catch (error) {
+        logger.debug('Invocation failed with error:', error)
         if (error instanceof Error) {
           console.error(`Error deploying game server into target environment: ${error.message}`)
         }
@@ -935,6 +954,7 @@ program
         // \todo Get requiredImageTag from the Helm chart
         await checkGameServerDeployment(envInfo, kubeconfig, /* requiredImageTag: */ null)
       } catch (error: any) {
+        logger.debug('Invocation failed with error:', error)
         console.error(`Failed to check deployment status: ${error.message}`)
         exit(1)
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@metaplay/metaplay-auth",
   "description": "Utility CLI for authenticating with the Metaplay Auth and making authenticated calls to infrastructure endpoints.",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://metaplay.io",
@@ -25,10 +25,10 @@
     "@types/node": "20.16.10",
     "@types/semver": "7.5.8",
     "esbuild": "0.24.0",
-    "tsx": "4.19.1",
+    "tsx": "4.19.2",
     "typescript": "5.6.3",
-    "vitest": "2.1.3",
-    "@aws-sdk/client-ecr": "3.675.0",
+    "vitest": "2.1.4",
+    "@aws-sdk/client-ecr": "3.682.0",
     "@kubernetes/client-node": "1.0.0-rc7",
     "@ory/client": "1.15.7",
     "commander": "12.1.0",

package/src/config.ts

@@ -1,5 +1,6 @@
 /**
- * Base URL to the Metaplay developer portal. Override with global flag --portal-base-url.
+ * Base URL to the Metaplay developer portal. Override with global flag --portal-base-url
+ * or environment variable `AUTHCLI_PORTAL_BASEURL'.
  */
 export let portalBaseUrl = 'https://portal.metaplay.dev'
 

package/src/targetenvironment.ts

@@ -85,6 +85,14 @@ export interface DockerCredentials {
   registryUrl: string
 }
 
+class FetchJsonHttpError extends Error {
+    response: Response;
+    constructor(method: string, url: string, response: Response) {
+      super(`Failed to fetch ${method} ${url}: ${response.statusText}, response code=${response.status}`)
+      this.response = response;
+    }
+}
+
 export class TargetEnvironment {
   private readonly accessToken: string
   private readonly humanId: string
@@ -106,7 +114,7 @@ export class TargetEnvironment {
     })
 
     if (response.status !== 200) {
-      throw new Error(`Failed to fetch ${method} ${url}: ${response.statusText}, response code=${response.status}`)
+      throw new FetchJsonHttpError(method, url, response)
     }
 
     return (await response.json()) as T
@@ -172,8 +180,17 @@ export class TargetEnvironment {
     let kubeExecCredential: KubeExecCredential
     try {
       kubeExecCredential = await this.fetchJson<KubeExecCredential>(url, 'POST')
-    } catch {
-      throw new Error(`Failed to fetch Kubernetes KubeConfig from ${url}`)
+    } catch (error) {
+      // User-friendly error messages for well-known HTTP errors.
+      if (error instanceof FetchJsonHttpError) {
+        if (error.response.status === 404) {
+          throw new Error(`Environment ${this.humanId} does not exist.`)
+        } else if (error.response.status === 403) {
+          throw new Error(`Your account does not have permissions to access environment ${this.humanId}.`)
+        }
+      }
+      const errorMessage = (error instanceof Error) ? error.message : String(error)
+      throw new Error(`Failed to fetch Kubernetes KubeConfig: ${errorMessage}`)
     }
 
     if (!kubeExecCredential.spec.cluster) {

package/src/version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = "1.7.1"
+export const PACKAGE_VERSION = "1.7.2"