@metaplay/metaplay-auth 1.7.2 → 1.8.0

package/src/utils.ts

@@ -4,6 +4,9 @@ import path from 'path'
 import * as semver from 'semver'
 
 import { logger } from './logging.js'
+import { tmpdir } from 'os'
+import { randomBytes } from 'crypto'
+import { unlink, writeFile } from 'fs/promises'
 
 /**
  * Checks if the given string is a fully qualified domain name (FQDN).
@@ -47,10 +50,11 @@ export function splitUrlComponents(urlString: string): {
   }
 }
 
+/** Output from executing a shell command with executeCommand(). */
 export interface ExecuteCommandResult {
   exitCode: number | null
-  stdout: any[]
-  stderr: any[]
+  stdout: string[]
+  stderr: string[]
 }
 
 export interface ExecuteCommandOptions {
@@ -215,3 +219,77 @@ export function resolveBestMatchingVersion(versions: string[], range: semver.Ran
   const sortedVersions = satisfyingVersions.sort(semver.rcompare)
   return sortedVersions[0]
 }
+
+/**
+ * Execute a Helm command by invoking the Helm CLI client with the given kubeconfig and arguments to `helm`.
+ * The provided kubeconfig is written to a temporary file and cleaned up after, and passed to `helm` with
+ * `--kubeconfig <path>`.
+ */
+export async function executeHelmCommand(kubeconfigPayload: string, args: string[]): Promise<ExecuteCommandResult> {
+  // Store kubeconfig in a temporary file.
+  const kubeconfigPath = pathJoin(tmpdir(), randomBytes(20).toString('hex'))
+  logger.debug(`Write temporary kubeconfig in ${kubeconfigPath}`)
+  await writeFile(kubeconfigPath, kubeconfigPayload, { mode: 0o600 })
+  args = args.concat(['--kubeconfig', kubeconfigPath])
+
+  // Use try-finally to remove the temp kubeconfig at the end
+  try {
+    // Execute the Helm invocation
+    let helmResult: ExecuteCommandResult
+    try {
+      helmResult = await executeCommand('helm', args)
+      // \todo output something from Helm result?
+    } catch (error) {
+      const errMessage = error instanceof Error ? error.message : String(error)
+      throw new Error(`Failed to execute 'helm': ${errMessage}. You need to have Helm v3 installed to deploy a game server with metaplay-auth.`)
+    }
+
+    // Throw on Helm non-success exit code
+    if (helmResult.exitCode !== 0) {
+      throw new Error(`Helm invocation failed with exit code ${helmResult.exitCode}: ${String(helmResult.stderr)}`)
+    }
+
+    // Return stdout as string
+    return helmResult
+  } finally {
+    // Remove temporary kubeconfig file
+    await unlink(kubeconfigPath)
+  }
+}
+
+/**
+ * Information about a Helm release. The results of 'helm ls -o=json'.
+ */
+export interface HelmRelease {
+  name: string // Eg, "gameserver"
+  namespace: string // Eg, "idler-develop"
+  revision: string // Eg, "334"
+  updated: string // Eg, "2024-11-21 10:38:06.105016472 +0000 UTC"
+  status: string // Eg, "deployed"
+  chart: string // Eg, "metaplay-gameserver-0.6.4"
+  app_version: string // Eg, ""
+}
+
+/**
+ * Get the game server Helm release details (or null if no server deployed).
+ * Assumes that the kubeconfig is already targeting a tenant namespace.
+ */
+export async function getGameServerHelmRelease(kubeconfigPayload: string): Promise<HelmRelease | null> {
+  // Fetch all Helm releases.
+  const result = await executeHelmCommand(kubeconfigPayload, ['ls', '-o=json'])
+
+  // Parse the releases from output JSON.
+  const helmReleases = JSON.parse(result.stdout.join('')) as HelmRelease[]
+
+  // Only select any that are game servers.
+  const serverReleases = helmReleases.filter(r => r.chart.startsWith('metaplay-gameserver-'))
+
+  // Cannot have multiple game servers installed.
+  if (serverReleases.length === 0) {
+    return null
+  } else if (serverReleases.length === 1) {
+    return serverReleases[0]
+  } else {
+    throw new Error(`Multiple game server Helm charts installed: ${JSON.stringify(serverReleases, undefined, 2)}`)
+  }
+}

package/src/version.ts

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