@metaplay/metaplay-auth 1.8.0 → 1.9.0

package/eslint.config.js

@@ -1,3 +1,12 @@
 import MetaplayEslintConfig from '@metaplay/eslint-config'
 
-export default MetaplayEslintConfig
+export default [
+  ...MetaplayEslintConfig,
+  {
+    rules: {
+      'no-console': 'off', // CLI tools need to output stuff.
+      complexity: 'off', // YOLO
+      '@typescript-eslint/no-unsafe-type-assertion': 'off', // This project is going away, not fixing
+    }
+  }
+]

package/index.ts

@@ -86,7 +86,6 @@ interface PortalEnvironmentInfo {
  * @param environment Environment slug.
  * @returns The portal's information about the environment.
  */
- 
 async function fetchManagedEnvironmentInfoWithSlugs(
   tokens: TokenSet,
   organization: string,
@@ -107,6 +106,7 @@ async function fetchManagedEnvironmentInfoWithSlugs(
   await checkEnvironmentInfoResponseError(response)
 
   // \todo Validate response?
+
   const portalEnvInfo = (await response.json()) as PortalEnvironmentInfo
   logger.debug(`Portal returned environment info: ${JSON.stringify(portalEnvInfo, undefined, 2)}`)
   return portalEnvInfo
@@ -206,17 +206,18 @@ async function resolveTargetEnvironment(
     // Address is one of:
     // - FQDN of the target environment, eg, 'idler-develop.p1.metaplay.io'
     // - Tuple of '<organization>-<project>-<environment>' slugs (eg, 'metaplay-idler-develop')
-    // - Stable humanId, eg, 'delicious-elephant'
+    // - Stable human ID (2 or 4 segments), eg, 'delicious-elephant' or 'fancy-delicious-bear-jumps'
     if (isValidFQDN(address)) {
       console.warn('Using the FQDN to specify target environment is deprecated. Use the "<organization>-<project>-<environment>" slugs instead.')
       return resolveTargetEnvironmentFromFQDN(tokens, address)
     } else {
       const parts = address.split('-')
-      if (parts.length === 2) {
-        // Two parts is humanId, eg, 'delicious-elephant'
+      if (parts.length === 2 || parts.length === 4) {
+        // Two segments is old-style environment human ID, eg, 'delicious-elephant'.
+        // Four segments is new-style project-suffixed human ID, eg, 'fancy-delicious-bear-jumps'.
         return await resolveTargetEnvironmentHumanId(tokens, address)
       } else if (parts.length === 3) {
-        // Three parts is tuple of slush '<organization>-<project>-<environment>'
+        // Three parts is tuple of slugs '<organization>-<project>-<environment>'
         return await resolveTargetEnvironmentFromSlugs(tokens, parts[0], parts[1], parts[2])
       } else {
         throw new Error(`Invalid environment address syntax '${address}'. Specify either the environment's id (eg, "delicious-elephant") or its slug tripled (eg, "<organization>-<project>-<environment>")`)
@@ -609,7 +610,7 @@ program
   .argument('image-tag', 'docker image tag to deploy (usually the SHA of the build)')
   .requiredOption('-f, --values <path-to-values-file>', 'path to Helm values file to use for this deployment')
   .option('--local-chart-path <path-to-chart-directory>', 'path to local Helm chart directory (to use a chart from local disk)')
-  .option('--helm-chart-repo <url>', 'override the URL of the Helm chart repository (eg, https://charts.metaplay.dev/testing)')
+  .option('--helm-chart-repo <url>', 'override the URL of the Helm chart repository (eg, https://customchartrepo.domain.com)')
   .option('--helm-chart-version <version>', 'the Helm chart version to use (eg, 0.6.0)')
   .option('--deployment-name', 'Helm deployment name to use', 'gameserver')
   .hook('preAction', async () => {

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.8.0",
+  "version": "1.9.0",
   "type": "module",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://metaplay.io",
@@ -20,25 +20,25 @@
     "@types/dockerode": "3.3.32",
     "@types/express": "5.0.0",
     "@types/js-yaml": "4.0.9",
-    "@types/jsonwebtoken": "9.0.7",
+    "@types/jsonwebtoken": "9.0.8",
     "@types/jwk-to-pem": "2.0.3",
-    "@types/node": "22.10.1",
+    "@types/node": "22.13.5",
     "@types/semver": "7.5.8",
-    "esbuild": "0.24.0",
-    "tsx": "4.19.2",
+    "esbuild": "0.25.0",
+    "tsx": "4.19.3",
     "typescript": "5.6.3",
-    "vitest": "2.1.8",
-    "@aws-sdk/client-ecr": "3.699.0",
+    "vitest": "3.0.6",
+    "@aws-sdk/client-ecr": "3.750.0",
     "@kubernetes/client-node": "1.0.0-rc7",
-    "@ory/client": "1.15.13",
+    "@ory/client": "1.16.7",
     "commander": "12.1.0",
     "dockerode": "4.0.2",
-    "h3": "1.13.0",
+    "h3": "1.15.0",
     "js-yaml": "4.1.0",
     "jsonwebtoken": "9.0.2",
     "jwk-to-pem": "2.0.7",
     "open": "8.4.2",
-    "semver": "7.6.3",
+    "semver": "7.7.1",
     "tslog": "4.9.3"
   }
 }

package/src/auth.ts

@@ -1,4 +1,4 @@
- 
+
 import { toNodeListener, createApp, defineEventHandler, getQuery, sendError } from 'h3'
 import jwt from 'jsonwebtoken'
 import jwkToPem from 'jwk-to-pem'
@@ -131,18 +131,11 @@ export async function loginAndSaveTokens(): Promise<void> {
 
       // Raise an error if the query parameters contain an error message.
       if (error) {
-        let errorMessage
-
-        if (typeof error === 'object') {
-          errorMessage = JSON.stringify(error)
-        } else {
-          errorMessage = error
-        }
+        const errorMessage = (typeof error === 'object') ? JSON.stringify(error) : String(error)
+        const errorDescriptionStr = (typeof errorDescription === 'object') ? JSON.stringify(errorDescription) : String(errorDescription)
 
-        console.error(
-          `Error logging in. Received the following error:\n\n${errorMessage}: ${String(errorDescription)}`
-        )
-        sendError(event, new Error(`Authentication failed: ${errorMessage}: ${String(errorDescription)}`))
+        console.error(`Error logging in. Received the following error:\n\n${errorMessage}: ${errorDescriptionStr}`)
+        sendError(event, new Error(`Authentication failed: ${errorMessage}: ${errorDescriptionStr}`))
         server.close()
         process.exit(1)
       }
@@ -332,7 +325,7 @@ async function extendCurrentSessionWithRefreshToken(
  * @param code
  * @returns
  */
- 
+
 async function getTokensWithAuthorizationCode(
   state: string,
   redirectUri: string,
@@ -399,7 +392,7 @@ export async function saveTokens(tokens: Record<string, string>): Promise<void>
 
     logger.debug('Tokens successfully stored.')
 
-    await showTokenInfo(tokens.access_token)
+    showTokenInfo(tokens.access_token)
   } catch (error) {
     if (error instanceof Error) {
       throw new Error(`Failed to save tokens: ${error.message}`)
@@ -465,7 +458,7 @@ async function validateToken(token: string): Promise<boolean> {
  * A helper function which shows token info after being fully decoded.
  * @param token The token to show info for.
  */
-async function showTokenInfo(token: string): Promise<void> {
+function showTokenInfo(token: string): void {
   logger.debug('Showing access token info...')
   // Decode the token
   const completeTokenData = jwt.decode(token, { complete: true })

package/src/buildCommand.ts

@@ -1,7 +1,8 @@
 import { Command } from 'commander'
-import { existsSync } from 'fs'
+import { readFileSync, existsSync } from 'fs'
 import path from 'path'
 import { exit } from 'process'
+import * as semver from 'semver'
 
 import { pathJoin, executeCommand, ExecuteCommandResult } from './utils.js'
 
@@ -26,6 +27,15 @@ function resolveBuildEngine(engine?: string): string {
   return engine
 }
 
+function extractSdkVersionFromDockerfile(filePath: string): string {
+  const content = readFileSync(filePath, 'utf8')
+  const match = /LABEL\s+io\.metaplay\.sdk_version\s*=\s*([\d.]+(?:-[\w.]+)?)(?:[\s\\]*)/.exec(content)
+  if (!match) {
+    throw Error('Unable to parse SDK version from Dockerfile.server')
+  }
+  return match[1]
+}
+
 export function registerBuildCommand(program: Command): void {
   program
     .command('build-image [extraArgs...]')
@@ -98,6 +108,17 @@ export function registerBuildCommand(program: Command): void {
           exit(2)
         }
 
+        // Check for Metaplay SDK R32 or above; the new CLI must be used.
+        const sdkVersion = extractSdkVersionFromDockerfile(dockerFilePath)
+        console.log(`Metaplay SDK version: ${sdkVersion}`)
+        if (semver.gte(sdkVersion, '32.0.0')) {
+          console.error('ERROR: metaplay-auth is not compatible with Metaplay SDK Release 32 and above.')
+          console.error('See the Release 32 migration guide for more details:')
+          // \todo Add direct link to migration guide (when available)
+          console.error('  https://docs.metaplay.io/miscellaneous/sdk-updates/release-notes/release-32.html#')
+          exit(2)
+        }
+
         // Check projectRoot directory
         const projectRootPath = options.projectRoot.replaceAll('\\', '/')
         if (path.isAbsolute(sdkRootPath)) {

package/src/deployment.ts

@@ -254,7 +254,7 @@ function resolvePodGameServerImageTag(pod: V1Pod): string | null {
   if (!containerSpec.image) {
     return null
   }
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+   
   const [_, imageTag] = containerSpec.image.split(':')
   return imageTag
 }

package/src/secret_store.ts

@@ -89,7 +89,7 @@ export async function removeSecret(key: string): Promise<void> {
   logger.debug(`Removing secret ${key}...`)
 
   const currentSecrets = await loadSecrets()
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+   
   const { [key]: _, ...secrets } = currentSecrets // remove key from secrets
 
   const secretJson = JSON.stringify(secrets)

package/src/version.ts

@@ -1 +1 @@
-export const PACKAGE_VERSION = "1.8.0"
+export const PACKAGE_VERSION = "1.9.0"