@babylonjs-toolkit/server 0.0.0-stage → 9.35.0

package/lib/admin/ColyseusCloudSettings.js

@@ -0,0 +1,29 @@
+// Settings of the console's Colyseus Cloud page derived from the server config (colyseus-cloud-console D8, D11).
+import { isColyseusCloud } from "../GameServerConfig.js";
+/**
+ * Whether the console's Colyseus Cloud page applies to this server (colyseus-cloud-console D8): "configured" when a
+ * Cloud API token is set, "setupNeeded" on Colyseus Cloud without one (the page explains how to add it), else "off".
+ * @param config The resolved server config.
+ * @param environment The process environment (COLYSEUS_CLOUD is set only on Colyseus Cloud).
+ * @returns The feature state.
+ */
+export function colyseusCloudFeatureOf(config, environment) {
+    if (config.admin.colyseusCloud.apiToken != null)
+        return "configured";
+    return isColyseusCloud(environment) ? "setupNeeded" : "off";
+}
+/**
+ * The host name players reach this server at, from publicUrl, used to mark this console's own Cloud instance (D11).
+ * @param config The resolved server config.
+ * @returns The host name, or null when publicUrl is unset or not a URL.
+ */
+export function ownHostNameOf(config) {
+    if (config.publicUrl == null)
+        return null;
+    try {
+        return new URL(config.publicUrl).hostname;
+    }
+    catch {
+        return null;
+    }
+}

package/lib/admin/ColyseusCloudViews.d.ts

@@ -0,0 +1,105 @@
+import type { CloudApplicationView, CloudBillingView, CloudDeployDetailView, CloudDeployView, CloudEgressView, CloudFreshnessView, CloudHistoryView, CloudLoadView, CloudPart, CloudProblemView } from "./AdminApiTypes.js";
+import type { CloudApiApplication, CloudApiBilling, CloudApiCurrentMetrics, CloudApiDeploy, CloudApiDeployDetail, CloudApiEgress, CloudApiHistory } from "./ColyseusCloudClient.js";
+/** A stored Cloud resource: the last good data and the last attempt (D3, D5). */
+export interface CloudSnapshot<Data> {
+    /** The last good data, or null. */
+    data: Data | null;
+    /** Last successful fetch (ISO), or null. */
+    fetchedAt: string | null;
+    /** Last attempt (ISO). */
+    attemptedAt: string;
+    /** When the next attempt may run after a 5xx or no answer (ISO); replaces the normal schedule; null otherwise. */
+    retryAt: string | null;
+    /** The last attempt's problem, or null when it succeeded. */
+    problem: CloudProblemView | null;
+}
+/** Which application the page shows, from GET /applications (D9). */
+export interface ApplicationChoice {
+    /** The chosen application, or null when none could be chosen. */
+    application: CloudApplicationView | null;
+    /** The team's slugs when several exist and none is configured. */
+    choices: string[];
+    /** Why none was chosen, or null. */
+    setupProblem: CloudProblemView | null;
+}
+/** The fleet-wide pause after a Cloud 429 (D5). */
+export interface CloudRateLimitRecord {
+    /** No refresh runs before this time (ISO). */
+    blockedUntil: string;
+}
+/** The fleet-wide log request gate (D5). */
+export interface CloudLogGateRecord {
+    /** No new log request is sent before this time (ISO). */
+    nextAllowedAt: string;
+}
+/**
+ * Chooses the application the page shows (D9): the configured slug when it is in the team, else the team's only
+ * application; otherwise no application, with the problem and (for an unknown slug or several applications) every slug.
+ * @param applications The team's applications from GET /applications.
+ * @param configuredSlug The configured slug (admin.colyseusCloud.application), or null.
+ * @param ownHostName publicUrl's host name, to mark this console's own instance (D11), or null.
+ * @returns The choice.
+ */
+export declare function resolveApplication(applications: CloudApiApplication[], configuredSlug: string | null, ownHostName: string | null): ApplicationChoice;
+/**
+ * Converts an application of GET /applications.
+ * @param application The raw application.
+ * @param ownHostName publicUrl's host name, to mark this console's own instance (D11), or null.
+ * @returns The application view.
+ */
+export declare function toApplicationView(application: CloudApiApplication, ownHostName: string | null): CloudApplicationView;
+/**
+ * Converts GET /metrics/current; the application totals sum players and rooms and take the highest CPU and memory over
+ * the locations that have totals (Colyseus's rule), and are null when every location is silent.
+ * @param metrics The raw current metrics.
+ * @returns The load view.
+ */
+export declare function toLoadView(metrics: CloudApiCurrentMetrics): CloudLoadView;
+/**
+ * Converts GET /metrics.
+ * @param history The raw history.
+ * @returns The history view.
+ */
+export declare function toHistoryView(history: CloudApiHistory): CloudHistoryView;
+/**
+ * Converts GET /egress.
+ * @param egress The raw traffic.
+ * @returns The traffic view.
+ */
+export declare function toEgressView(egress: CloudApiEgress): CloudEgressView;
+/**
+ * Converts a deploy of GET /deploys.
+ * @param deploy The raw deploy.
+ * @returns The deploy view.
+ */
+export declare function toDeployView(deploy: CloudApiDeploy): CloudDeployView;
+/**
+ * Converts GET /deploys/{id} data.
+ * @param deploy The raw deploy with its output.
+ * @returns The deploy view with its output.
+ */
+export declare function toDeployDetailView(deploy: CloudApiDeployDetail): CloudDeployDetailView;
+/**
+ * Converts GET /billing for one application: the account, and the subscription of the application with that slug.
+ * @param billing The raw billing figures.
+ * @param slug The slug of the application the page shows.
+ * @returns The billing view (subscription null when that application has none or is not listed).
+ */
+export declare function toBillingView(billing: CloudApiBilling, slug: string): CloudBillingView;
+/**
+ * How current a stored resource is: stale when its last attempt failed or its data is older than
+ * COLYSEUS_CLOUD_STALE_REFRESH_MULTIPLIER refresh intervals plus COLYSEUS_CLOUD_STALE_GRACE_MS.
+ * @param snapshot The stored snapshot, or null before the first attempt.
+ * @param refreshSeconds How often Colyseus refreshes this resource, in seconds.
+ * @param nowMilliseconds The current time, in epoch milliseconds.
+ * @returns The freshness view.
+ */
+export declare function freshnessOf(snapshot: CloudSnapshot<unknown> | null, refreshSeconds: number, nowMilliseconds: number): CloudFreshnessView;
+/**
+ * A page part from a stored resource: its last good data and its freshness.
+ * @param snapshot The stored snapshot, or null before the first attempt.
+ * @param refreshSeconds How often Colyseus refreshes this resource, in seconds.
+ * @param nowMilliseconds The current time, in epoch milliseconds.
+ * @returns The part.
+ */
+export declare function partOf<Data>(snapshot: CloudSnapshot<Data> | null, refreshSeconds: number, nowMilliseconds: number): CloudPart<Data>;

package/lib/admin/ColyseusCloudViews.js

@@ -0,0 +1,371 @@
+// Pure conversions behind the console's Colyseus Cloud page (colyseus-cloud-console D9, D11, D12): Colyseus's raw
+// snake_case answers become the console's camelCase views, a stored snapshot becomes its freshness, and the team's
+// applications become the application choice. Nothing here reads the clock; callers pass nowMilliseconds.
+import { COLYSEUS_CLOUD_STALE_GRACE_MS, COLYSEUS_CLOUD_STALE_REFRESH_MULTIPLIER, MILLISECONDS_PER_SECOND } from "./AdminConstants.js";
+/** The environment variable a team with several applications sets to choose one (D9). */
+const APPLICATION_VARIABLE = "GAME_SERVER_ADMIN_COLYSEUS_CLOUD_APPLICATION";
+/** Status of a problem that is not an answer of Colyseus. */
+const NOT_AN_ANSWER_STATUS = 0;
+/**
+ * Chooses the application the page shows (D9): the configured slug when it is in the team, else the team's only
+ * application; otherwise no application, with the problem and (for an unknown slug or several applications) every slug.
+ * @param applications The team's applications from GET /applications.
+ * @param configuredSlug The configured slug (admin.colyseusCloud.application), or null.
+ * @param ownHostName publicUrl's host name, to mark this console's own instance (D11), or null.
+ * @returns The choice.
+ */
+export function resolveApplication(applications, configuredSlug, ownHostName) {
+    const slugs = applications.map((application) => application.slug);
+    if (configuredSlug != null) {
+        const configured = applications.find((application) => application.slug === configuredSlug);
+        if (configured != null)
+            return chosenApplication(configured, ownHostName);
+        const message = "The application " + configuredSlug + " is not in this team. Set " + APPLICATION_VARIABLE + " to one of: " + slugs.join(", ") + ".";
+        return unchosenApplication("unknown_application", message, slugs);
+    }
+    if (applications.length === 0)
+        return unchosenApplication("no_applications", "This team has no application yet.", []);
+    if (applications.length > 1) {
+        const message = "This team has several applications. Set " + APPLICATION_VARIABLE + " to the one this console watches.";
+        return unchosenApplication("several_applications", message, slugs);
+    }
+    return chosenApplication(applications[0], ownHostName);
+}
+/**
+ * Converts an application of GET /applications.
+ * @param application The raw application.
+ * @param ownHostName publicUrl's host name, to mark this console's own instance (D11), or null.
+ * @returns The application view.
+ */
+export function toApplicationView(application, ownHostName) {
+    return {
+        id: application.id,
+        slug: application.slug,
+        name: application.name,
+        maintenanceMode: application.maintenance_mode,
+        createdAt: application.created_at,
+        locations: application.locations.map((location) => toLocationView(location, ownHostName))
+    };
+}
+/**
+ * Converts GET /metrics/current; the application totals sum players and rooms and take the highest CPU and memory over
+ * the locations that have totals (Colyseus's rule), and are null when every location is silent.
+ * @param metrics The raw current metrics.
+ * @returns The load view.
+ */
+export function toLoadView(metrics) {
+    const locations = metrics.locations.map(toLocationLoadView);
+    const reportingTotals = [];
+    for (const location of locations) {
+        if (location.totals != null)
+            reportingTotals.push(location.totals);
+    }
+    return { windowMinutes: metrics.window_minutes, locations: locations, totals: combineTotals(reportingTotals) };
+}
+/**
+ * Converts GET /metrics.
+ * @param history The raw history.
+ * @returns The history view.
+ */
+export function toHistoryView(history) {
+    return {
+        resolution: history.resolution,
+        from: history.from,
+        to: history.to,
+        locations: history.locations.map(toLocationHistoryView)
+    };
+}
+/**
+ * Converts GET /egress.
+ * @param egress The raw traffic.
+ * @returns The traffic view.
+ */
+export function toEgressView(egress) {
+    return {
+        from: egress.from,
+        to: egress.to,
+        collectedAt: egress.collected_at,
+        locations: egress.locations.map(toLocationEgressView)
+    };
+}
+/**
+ * Converts a deploy of GET /deploys.
+ * @param deploy The raw deploy.
+ * @returns The deploy view.
+ */
+export function toDeployView(deploy) {
+    return {
+        id: deploy.id,
+        status: deploy.status,
+        branch: deploy.branch,
+        commit: deploy.commit,
+        message: deploy.message,
+        startedAt: deploy.started_at,
+        finishedAt: deploy.finished_at
+    };
+}
+/**
+ * Converts GET /deploys/{id} data.
+ * @param deploy The raw deploy with its output.
+ * @returns The deploy view with its output.
+ */
+export function toDeployDetailView(deploy) {
+    return { ...toDeployView(deploy), output: deploy.output };
+}
+/**
+ * Converts GET /billing for one application: the account, and the subscription of the application with that slug.
+ * @param billing The raw billing figures.
+ * @param slug The slug of the application the page shows.
+ * @returns The billing view (subscription null when that application has none or is not listed).
+ */
+export function toBillingView(billing, slug) {
+    const listed = billing.applications.find((application) => application.slug === slug);
+    const subscription = listed?.subscription ?? null;
+    return {
+        account: billing.account == null ? null : toAccountView(billing.account),
+        subscription: subscription == null ? null : toSubscriptionView(subscription),
+        fetchedAt: billing.fetched_at
+    };
+}
+/**
+ * How current a stored resource is: stale when its last attempt failed or its data is older than
+ * COLYSEUS_CLOUD_STALE_REFRESH_MULTIPLIER refresh intervals plus COLYSEUS_CLOUD_STALE_GRACE_MS.
+ * @param snapshot The stored snapshot, or null before the first attempt.
+ * @param refreshSeconds How often Colyseus refreshes this resource, in seconds.
+ * @param nowMilliseconds The current time, in epoch milliseconds.
+ * @returns The freshness view.
+ */
+export function freshnessOf(snapshot, refreshSeconds, nowMilliseconds) {
+    if (snapshot == null)
+        return { fetchedAt: null, attemptedAt: null, refreshSeconds: refreshSeconds, isStale: false, problem: null };
+    const staleAfterMilliseconds = refreshSeconds * MILLISECONDS_PER_SECOND * COLYSEUS_CLOUD_STALE_REFRESH_MULTIPLIER + COLYSEUS_CLOUD_STALE_GRACE_MS;
+    const isTooOld = snapshot.fetchedAt != null && nowMilliseconds - Date.parse(snapshot.fetchedAt) > staleAfterMilliseconds;
+    return {
+        fetchedAt: snapshot.fetchedAt,
+        attemptedAt: snapshot.attemptedAt,
+        refreshSeconds: refreshSeconds,
+        isStale: snapshot.problem != null || isTooOld,
+        problem: snapshot.problem
+    };
+}
+/**
+ * A page part from a stored resource: its last good data and its freshness.
+ * @param snapshot The stored snapshot, or null before the first attempt.
+ * @param refreshSeconds How often Colyseus refreshes this resource, in seconds.
+ * @param nowMilliseconds The current time, in epoch milliseconds.
+ * @returns The part.
+ */
+export function partOf(snapshot, refreshSeconds, nowMilliseconds) {
+    return { data: snapshot?.data ?? null, freshness: freshnessOf(snapshot, refreshSeconds, nowMilliseconds) };
+}
+/**
+ * The choice of one application.
+ * @param application The chosen raw application.
+ * @param ownHostName publicUrl's host name, or null.
+ * @returns The choice without a problem.
+ */
+function chosenApplication(application, ownHostName) {
+    return { application: toApplicationView(application, ownHostName), choices: [], setupProblem: null };
+}
+/**
+ * The choice of no application, with why.
+ * @param code The problem code.
+ * @param message The problem message.
+ * @param choices The slugs the page lists.
+ * @returns The choice without an application.
+ */
+function unchosenApplication(code, message, choices) {
+    return { application: null, choices: choices, setupProblem: { status: NOT_AN_ANSWER_STATUS, code: code, message: message } };
+}
+/**
+ * The host name of an address.
+ * @param text The address, or null.
+ * @returns Its host name, or null for null or an invalid URL.
+ */
+function hostNameOf(text) {
+    if (text == null)
+        return null;
+    try {
+        return new URL(text).hostname;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * Converts a location of GET /applications.
+ * @param location The raw location.
+ * @param ownHostName publicUrl's host name, or null.
+ * @returns The location view.
+ */
+function toLocationView(location, ownHostName) {
+    return {
+        id: location.id,
+        regionCode: location.region.code,
+        city: location.region.city,
+        country: location.region.country,
+        status: location.status,
+        scaleStrategy: location.scale_strategy,
+        endpoint: location.endpoint,
+        plan: { vcpus: location.plan.vcpus, ramMegabytes: location.plan.ram_mb, transferGigabytes: location.plan.transfer_gb },
+        instances: location.instances.map((instance) => toInstanceView(instance, ownHostName))
+    };
+}
+/**
+ * Converts an instance of GET /applications; it is this console's own instance when its endpoint's host name is
+ * publicUrl's host name (D11).
+ * @param instance The raw instance.
+ * @param ownHostName publicUrl's host name, or null.
+ * @returns The instance view.
+ */
+function toInstanceView(instance, ownHostName) {
+    return {
+        id: instance.id,
+        endpoint: instance.endpoint,
+        status: instance.status,
+        deployStatus: instance.deploy_status,
+        deployedAt: instance.deployed_at,
+        isThisInstance: ownHostName != null && hostNameOf(instance.endpoint) === ownHostName
+    };
+}
+/**
+ * Converts a location of GET /metrics/current.
+ * @param location The raw location metrics.
+ * @returns The location load view.
+ */
+function toLocationLoadView(location) {
+    return {
+        id: location.id,
+        regionCode: location.region,
+        totals: location.totals == null ? null : toTotalsView(location.totals),
+        instances: location.instances.map(toInstanceLoadView)
+    };
+}
+/**
+ * Converts an instance sample; a silent instance (no sample within Colyseus's window) has null values and no processes.
+ * @param sample The raw instance sample.
+ * @returns The instance load view.
+ */
+function toInstanceLoadView(sample) {
+    const isSilent = sample.sampled_at == null || sample.cpu_percent == null;
+    if (isSilent) {
+        return { id: sample.id, sampledAt: sample.sampled_at, isSilent: true, players: null, rooms: null, cpuPercent: null, memoryPercent: null, processes: [] };
+    }
+    return {
+        id: sample.id,
+        sampledAt: sample.sampled_at,
+        isSilent: false,
+        players: sample.ccu,
+        rooms: sample.rooms,
+        cpuPercent: sample.cpu_percent,
+        memoryPercent: sample.memory_percent,
+        processes: sample.processes.map(toProcessView)
+    };
+}
+/**
+ * Converts a process of GET /metrics/current.
+ * @param rawProcess The raw process.
+ * @returns The process view.
+ */
+function toProcessView(rawProcess) {
+    return {
+        id: rawProcess.id,
+        status: rawProcess.status,
+        startedAt: rawProcess.started_at,
+        restarts: rawProcess.restarts,
+        cpuPercent: rawProcess.cpu_percent,
+        memoryMegabytes: rawProcess.memory_mb,
+        players: rawProcess.ccu,
+        rooms: rawProcess.rooms,
+        nodeVersion: rawProcess.node_version
+    };
+}
+/**
+ * Converts Colyseus's load totals.
+ * @param totals The raw totals.
+ * @returns The totals view.
+ */
+function toTotalsView(totals) {
+    return { players: totals.ccu, rooms: totals.rooms, cpuPercent: totals.cpu_percent, memoryPercent: totals.memory_percent };
+}
+/**
+ * Combines several totals by Colyseus's rule: players and rooms summed, CPU and memory the highest.
+ * @param totalsList The totals to combine.
+ * @returns The combined totals, or null when the list is empty.
+ */
+function combineTotals(totalsList) {
+    if (totalsList.length === 0)
+        return null;
+    const combined = { players: 0, rooms: 0, cpuPercent: 0, memoryPercent: 0 };
+    for (const totals of totalsList) {
+        combined.players += totals.players;
+        combined.rooms += totals.rooms;
+        combined.cpuPercent = Math.max(combined.cpuPercent, totals.cpuPercent);
+        combined.memoryPercent = Math.max(combined.memoryPercent, totals.memoryPercent);
+    }
+    return combined;
+}
+/**
+ * Converts a location of GET /metrics.
+ * @param location The raw location history.
+ * @returns The location history view.
+ */
+function toLocationHistoryView(location) {
+    return { id: location.id, regionCode: location.region, points: location.points.map(toHistoryPointView) };
+}
+/**
+ * Converts a point of GET /metrics.
+ * @param point The raw point.
+ * @returns The point view.
+ */
+function toHistoryPointView(point) {
+    return { time: point.time, ...toTotalsView(point) };
+}
+/**
+ * Converts a location of GET /egress.
+ * @param location The raw location traffic.
+ * @returns The location traffic view.
+ */
+function toLocationEgressView(location) {
+    return {
+        id: location.id,
+        regionCode: location.region,
+        outgoingBytes: location.outgoing_bytes,
+        incomingBytes: location.incoming_bytes,
+        days: location.days.map(toEgressDayView)
+    };
+}
+/**
+ * Converts a day of GET /egress.
+ * @param day The raw day.
+ * @returns The day view.
+ */
+function toEgressDayView(day) {
+    return { date: day.date, outgoingBytes: day.outgoing_bytes, incomingBytes: day.incoming_bytes };
+}
+/**
+ * Converts the billing account of GET /billing.
+ * @param account The raw account.
+ * @returns The account view.
+ */
+function toAccountView(account) {
+    return {
+        currency: account.currency,
+        creditBalance: account.credit_balance,
+        balanceDue: account.balance_due,
+        unusedTimeCredit: account.unused_time_credit
+    };
+}
+/**
+ * Converts a subscription of GET /billing.
+ * @param subscription The raw subscription.
+ * @returns The subscription view.
+ */
+function toSubscriptionView(subscription) {
+    return {
+        status: subscription.status,
+        monthlyPrice: subscription.monthly_price,
+        currentPeriodEnd: subscription.current_period_end,
+        cancelAtPeriodEnd: subscription.cancel_at_period_end
+    };
+}

package/lib/admin/CommonPasswords.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The 100 entries of SecLists Passwords/Common-Credentials/10-million-password-list-top-100.txt, lower-cased, plus the
+ * product's own names. Most are shorter than MINIMUM_PASSWORD_LENGTH and are refused by length anyway; the list keeps
+ * the check honest if the minimum ever changes.
+ */
+export declare const COMMON_PASSWORDS: ReadonlySet<string>;

package/lib/admin/CommonPasswords.js

@@ -0,0 +1,19 @@
+// Passwords an admin account may not use (game-server-admin-console D8). Compared lower-cased.
+/**
+ * The 100 entries of SecLists Passwords/Common-Credentials/10-million-password-list-top-100.txt, lower-cased, plus the
+ * product's own names. Most are shorter than MINIMUM_PASSWORD_LENGTH and are refused by length anyway; the list keeps
+ * the check honest if the minimum ever changes.
+ */
+export const COMMON_PASSWORDS = new Set([
+    "123456", "password", "12345678", "qwerty", "123456789", "12345", "1234", "111111", "1234567", "dragon",
+    "123123", "baseball", "abc123", "football", "monkey", "letmein", "696969", "shadow", "master", "666666",
+    "qwertyuiop", "123321", "mustang", "1234567890", "michael", "654321", "pussy", "superman", "1qaz2wsx", "7777777",
+    "fuckyou", "121212", "000000", "qazwsx", "123qwe", "killer", "trustno1", "jordan", "jennifer", "zxcvbnm",
+    "asdfgh", "hunter", "buster", "soccer", "harley", "batman", "andrew", "tigger", "sunshine", "iloveyou",
+    "fuckme", "2000", "charlie", "robert", "thomas", "hockey", "ranger", "daniel", "starwars", "klaster",
+    "112233", "george", "asshole", "computer", "michelle", "jessica", "pepper", "1111", "zxcvbn", "555555",
+    "11111111", "131313", "freedom", "777777", "pass", "fuck", "maggie", "159753", "aaaaaa", "ginger",
+    "princess", "joshua", "cheese", "amanda", "summer", "love", "ashley", "6969", "nicole", "chelsea",
+    "biteme", "matthew", "access", "yankees", "987654321", "dallas", "austin", "thunder", "taylor", "matrix",
+    "babylongameserver", "babylon-game-server", "administrator", "changeme1234"
+]);