@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.4

package/dist/telemetry/stores/greptime/greptime-host.js

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DNS_ERROR_CODES = exports.GREPTIME_DNS_TIMEOUT_MS = void 0;
+exports.isDnsError = isDnsError;
+exports.hostNotFoundMessage = hostNotFoundMessage;
+exports.checkHostResolves = checkHostResolves;
+const promises_1 = require("node:dns/promises");
+const node_net_1 = require("node:net");
+// =============================================================================
+// GreptimeDB host resolution — telling "no such host" from "timed out"
+// (issue #564, epic #528)
+// =============================================================================
+//
+// When the GreptimeDB host does not exist on the network at all (the usual
+// case: the automatic host `greptimedb` names a container that is not running
+// on this deployment yet), Docker's embedded DNS takes ~5 s to give up and answer
+// `getaddrinfo EAI_AGAIN greptimedb`. That is just past
+// `GREPTIME_CONNECT_TIMEOUT_MS`, so the connect attempt loses the race and the
+// administrator is told "timeout expired" / "Connection terminated due to
+// connection timeout" — the real, actionable cause is swallowed.
+//
+// This module resolves the host ON ITS OWN, under a much longer ceiling, so a
+// DNS failure is reported as what it is:
+//
+//   - the connection test resolves the candidate host once, before probing;
+//   - `GreptimeClient` resolves the host only AFTER a connect attempt failed
+//     with a timeout (never on the success path: every query would pay for a
+//     lookup).
+//
+// It never throws. `null` means "nothing to report" — the host resolved, is an
+// IP literal, the lookup failed for a non-DNS reason, or the lookup itself ran
+// out of time (inconclusive: let the connect attempt speak).
+// =============================================================================
+/**
+ * How long a host lookup may take before it is treated as inconclusive.
+ *
+ * Deliberately far beyond Docker's ~5 s EAI_AGAIN retry window, and separate
+ * from `GREPTIME_CONNECT_TIMEOUT_MS`: the whole point is to outlast the
+ * resolver long enough to hear its verdict, which the connect timeout cannot.
+ * It only runs when the host is about to be (or was just) unreachable, so the
+ * wait costs nothing on a healthy connection.
+ */
+exports.GREPTIME_DNS_TIMEOUT_MS = 15_000;
+/** `getaddrinfo` / `dns` error codes that mean "no host by that name". */
+exports.DNS_ERROR_CODES = new Set([
+    'ENOTFOUND',
+    'EAI_AGAIN',
+    'EAI_NONAME',
+    'EAI_FAIL',
+    'EAI_NODATA',
+]);
+const defaultLookup = (host) => (0, promises_1.lookup)(host);
+/** Whether an error is a name-resolution failure (checks its `code`). */
+function isDnsError(error) {
+    if (typeof error !== 'object' || error === null)
+        return false;
+    const code = error.code;
+    return typeof code === 'string' && exports.DNS_ERROR_CODES.has(code);
+}
+/**
+ * The administrator-facing explanation of a DNS failure for `host`.
+ *
+ * ⚠ Shown in `/admin/settings/telemetry`. It must never tell an administrator
+ * to start compose files, edit files or run the CLI: GreptimeDB ships with
+ * every deployment, so an automatic host that does not resolve is fixed from
+ * this same page ("Deploy GreptimeDB" in its Telemetry services section, #567),
+ * and a custom one by correcting (or clearing) it.
+ */
+function hostNotFoundMessage(host, error, options = {}) {
+    const detail = error instanceof Error ? error.message : String(error);
+    if (options.automatic) {
+        return (`GreptimeDB is not running alongside this application: the built-in host "${host}" does not exist on its network (${detail}). ` +
+            'GreptimeDB is deployed with the application but its container is not running. ' +
+            'Use "Deploy GreptimeDB" in the Telemetry services section of this page to start it.');
+    }
+    return (`GreptimeDB host "${host}" could not be resolved (${detail}): no host by that name exists on this network. ` +
+        'Check the host name, or clear it to use the GreptimeDB deployed with this application.');
+}
+/**
+ * Resolves `host` and returns a human message when it does not exist, else
+ * `null` (see the header for every `null` case). Never throws.
+ */
+async function checkHostResolves(host, lookup = defaultLookup, timeoutMs = exports.GREPTIME_DNS_TIMEOUT_MS, options = {}) {
+    if (!host || (0, node_net_1.isIP)(host) !== 0)
+        return null;
+    let timer;
+    const TIMED_OUT = Symbol('timed-out');
+    const timeout = new Promise((resolve) => {
+        timer = setTimeout(() => resolve(TIMED_OUT), timeoutMs);
+        timer.unref?.();
+    });
+    let pending;
+    try {
+        pending = Promise.resolve(lookup(host));
+    }
+    catch (error) {
+        // A lookup that throws synchronously is still a verdict.
+        return isDnsError(error) ? hostNotFoundMessage(host, error, options) : null;
+    }
+    // Settle to a value either way, so a late rejection (after the timeout won)
+    // is never an unhandled one.
+    const outcome = pending.then(() => ({ ok: true }), (error) => ({ ok: false, error }));
+    try {
+        const result = await Promise.race([outcome, timeout]);
+        if (result === TIMED_OUT || result.ok)
+            return null;
+        return isDnsError(result.error) ? hostNotFoundMessage(host, result.error, options) : null;
+    }
+    finally {
+        if (timer)
+            clearTimeout(timer);
+    }
+}
+//# sourceMappingURL=greptime-host.js.map

package/dist/telemetry/stores/greptime/greptime-host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"greptime-host.js","sourceRoot":"","sources":["../../../../src/telemetry/stores/greptime/greptime-host.ts"],"names":[],"mappings":";;;AAuDA,gCAMC;AAwBD,kDAeC;AAMD,8CAwCC;AAlJD,gDAAwD;AACxD,uCAAgC;AAEhC,gFAAgF;AAChF,uEAAuE;AACvE,0BAA0B;AAC1B,gFAAgF;AAChF,EAAE;AACF,2EAA2E;AAC3E,8EAA8E;AAC9E,kFAAkF;AAClF,wDAAwD;AACxD,+EAA+E;AAC/E,0EAA0E;AAC1E,iEAAiE;AACjE,EAAE;AACF,8EAA8E;AAC9E,yCAAyC;AACzC,EAAE;AACF,4EAA4E;AAC5E,6EAA6E;AAC7E,6EAA6E;AAC7E,eAAe;AACf,EAAE;AACF,+EAA+E;AAC/E,+EAA+E;AAC/E,6DAA6D;AAC7D,gFAAgF;AAEhF;;;;;;;;GAQG;AACU,QAAA,uBAAuB,GAAG,MAAM,CAAC;AAE9C,0EAA0E;AAC7D,QAAA,eAAe,GAAwB,IAAI,GAAG,CAAC;IAC1D,WAAW;IACX,WAAW;IACX,YAAY;IACZ,UAAU;IACV,YAAY;CACb,CAAC,CAAC;AAKH,MAAM,aAAa,GAAe,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,iBAAS,EAAC,IAAI,CAAC,CAAC;AAE5D,yEAAyE;AACzE,SAAgB,UAAU,CAAC,KAAc;IACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IAE9D,MAAM,IAAI,GAAI,KAA4B,CAAC,IAAI,CAAC;IAEhD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,uBAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AAC/D,CAAC;AAeD;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,IAAY,EAAE,KAAc,EAAE,UAA4B,EAAE;IAC9F,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEtE,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,CACL,4EAA4E,IAAI,oCAAoC,MAAM,KAAK;YAC/H,gFAAgF;YAChF,qFAAqF,CACtF,CAAC;IACJ,CAAC;IAED,OAAO,CACL,oBAAoB,IAAI,4BAA4B,MAAM,kDAAkD;QAC5G,wFAAwF,CACzF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAY,EACZ,SAAqB,aAAa,EAClC,SAAS,GAAG,+BAAuB,EACnC,UAA4B,EAAE;IAE9B,IAAI,CAAC,IAAI,IAAI,IAAA,eAAI,EAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE3C,IAAI,KAAiC,CAAC;IAEtC,MAAM,SAAS,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IACtC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,EAAE;QACxD,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACxD,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,IAAI,OAAyB,CAAC;IAC9B,IAAI,CAAC;QACH,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,yDAAyD;QACzD,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9E,CAAC;IAED,4EAA4E;IAC5E,6BAA6B;IAC7B,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAC1B,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAa,EAAE,CAAC,EAC7B,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,KAAc,EAAE,KAAK,EAAE,CAAC,CACpD,CAAC;IAEF,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAEtD,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;QAEnD,OAAO,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5F,CAAC;YAAS,CAAC;QACT,IAAI,KAAK;YAAE,YAAY,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;AACH,CAAC"}

package/dist/telemetry/stores/greptime/greptime.client.d.ts

@@ -0,0 +1,144 @@
+import { OnModuleDestroy } from '@nestjs/common';
+import { type PoolClient, type PoolConfig } from 'pg';
+import type { TelemetrySchema } from '@marinoscar/platform-contract/telemetry';
+import { TelemetryConnectionService, type GreptimeEnvironmentConfig } from '../../connection/telemetry-connection.service';
+import type { TelemetryPingResult, TelemetryQueryOptions, TelemetryQueryResult, TelemetryRetentionControl, TelemetryStore, TelemetryStoreQueryOptions } from '../telemetry-store';
+import { type HostCheckOptions } from './greptime-host';
+export type { TelemetryField, TelemetryPingResult, TelemetryQueryOptions, TelemetryQueryResult } from '../telemetry-store';
+/** The `greptime` block of `config/configuration.ts` — the deployment default. */
+export type GreptimeConfig = GreptimeEnvironmentConfig;
+/**
+ * The subset of `pg.Pool` the client uses — what a test substitutes.
+ *
+ * @stability experimental
+ */
+export interface GreptimePool {
+    /** Checks out a connection. */
+    connect(): Promise<PoolClient>;
+    /** Closes every connection. */
+    end(): Promise<void>;
+    /**
+     * Listens for an idle connection's error.
+     *
+     * @param event - always `error`.
+     * @param listener - the handler.
+     */
+    on(event: 'error', listener: (error: Error) => void): unknown;
+}
+/** Pool sizes. Small on purpose: telemetry reads are admin-only and rare. */
+export declare const GREPTIME_READER_POOL_MAX = 4;
+export declare const GREPTIME_ADMIN_POOL_MAX = 1;
+/** How long to wait for a TCP connection + authentication before giving up. */
+export declare const GREPTIME_CONNECT_TIMEOUT_MS = 5000;
+/** Timeout for `ping()`. */
+export declare const GREPTIME_PING_TIMEOUT_MS = 5000;
+/** Default ceiling of each `information_schema` read of `schema()`. */
+export declare const GREPTIME_SCHEMA_TIMEOUT_MS = 10000;
+/**
+ * Per-pool type parser: the types above come back as the server's text,
+ * everything else as `pg` would parse it (booleans, int2/int4, floats, json).
+ */
+export declare function greptimeTypeParser(oid: number, format?: 'text' | 'binary'): (value: string) => unknown;
+/**
+ * Double-quotes an SQL identifier. Only for a value that was already
+ * validated (from configuration, or checked against `information_schema`) —
+ * quoting makes an identifier unambiguous, it does not make an arbitrary
+ * string safe to accept.
+ */
+export declare function quoteIdent(name: string): string;
+/** Single-quotes an SQL string literal. Same caveat as `quoteIdent`. */
+export declare function quoteLiteral(value: string): string;
+export { rowsAsObjects } from '../telemetry-store';
+/**
+ * The built-in telemetry store (`greptime`): a read-only reader pool and an
+ * admin pool, built from the runtime connection and rebuilt when it changes.
+ * Implements {@link TelemetryStore} (the port every service depends on) and
+ * keeps its GreptimeDB-specific members (`queryReader`, `queryAdmin`,
+ * `isAdminConfigured`) for the code that is GreptimeDB-specific by nature.
+ * Exported by `TelemetryModule`.
+ *
+ * @stability experimental
+ */
+export declare class GreptimeClient implements TelemetryStore, OnModuleDestroy {
+    private readonly connection;
+    /** The store id: `greptime`. */
+    readonly id = "greptime";
+    private readonly logger;
+    private readonly pools;
+    /** A pool being built (its password is being read), so concurrent calls share it. */
+    private readonly building;
+    /** The retention control: `ALTER DATABASE ... SET 'ttl'` on the admin login, `SHOW CREATE DATABASE` to read it. */
+    readonly retention: TelemetryRetentionControl;
+    /** @internal */
+    constructor(connection: TelemetryConnectionService);
+    /** Whether the reader connection is configured (admin UI or deployment default). */
+    isConfigured(): boolean;
+    /**
+     * Why the reader connection cannot be used, in administrator language, or
+     * null — set only for the GreptimeDB deployed with this application, when
+     * the deployment provisions no reader login (issue #570).
+     */
+    configurationProblem(): string | null;
+    /** Whether the admin connection is configured as well (retention, `SHOW CREATE DATABASE`). */
+    isAdminConfigured(): boolean;
+    /** The GreptimeDB database telemetry is written to (default `public`). */
+    get database(): string;
+    /**
+     * {@link TelemetryStore.query}: one statement as the read-only user. The
+     * login is what makes `readOnly` true (GreptimeDB refuses a write from it);
+     * the SQL is sent as-is, so `params` must be empty (see the header).
+     */
+    query(sql: string, params: readonly unknown[], options: TelemetryStoreQueryOptions): Promise<TelemetryQueryResult>;
+    /** {@link TelemetryStore.schema}: the tables and columns of the telemetry database, read fresh. */
+    schema(options?: {
+        timeoutMs?: number;
+    }): Promise<TelemetrySchema>;
+    /** {@link TelemetryStore.close}: closes both pools. */
+    close(): Promise<void>;
+    /**
+     * Runs one statement as the read-only user. The SQL is sent as-is: see the
+     * header for why there are no parameters.
+     */
+    queryReader(sql: string, options: TelemetryQueryOptions): Promise<TelemetryQueryResult>;
+    /**
+     * Runs one statement as the admin user. NEVER with caller-supplied SQL: this
+     * connection can alter retention and drop data.
+     */
+    queryAdmin(sql: string, options: TelemetryQueryOptions): Promise<TelemetryQueryResult>;
+    /** Reachability probe over the reader connection. Never throws. */
+    ping(): Promise<TelemetryPingResult>;
+    /** Closes both pools. */
+    onModuleDestroy(): Promise<void>;
+    /** Builds a pool. A seam for tests; production code never overrides it. */
+    protected createPool(config: PoolConfig): GreptimePool;
+    /**
+     * `null` when `host` resolves (or the check is inconclusive), else why it
+     * does not. Only consulted after a connect TIMED OUT. A seam for tests;
+     * production code never overrides it.
+     */
+    protected resolveHost(host: string, options: HostCheckOptions): Promise<string | null>;
+    private run;
+    private connect;
+    /**
+     * Why a connect failed. A DNS error names the host; a timeout may be a DNS
+     * failure that lost the race, so the host is looked up once more under a
+     * longer ceiling before "timeout" is believed (#564). Never throws.
+     */
+    private connectFailureReason;
+    /**
+     * The pool for this login, for the connection in force NOW. Rebuilt when
+     * the connection's fingerprint moved since the pool was made (an admin save,
+     * a credential rotation, a reset to the deployment default).
+     */
+    private pool;
+    private build;
+    /** Forget this login's pool and close it in the background. */
+    private retire;
+    /**
+     * `end()` waits for checked-out clients to be released, so it is never
+     * awaited on the query path: in-flight statements on the old pool finish
+     * (or time out) on their own, and nothing new is handed out from it.
+     */
+    private endInBackground;
+}
+//# sourceMappingURL=greptime.client.d.ts.map

package/dist/telemetry/stores/greptime/greptime.client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"greptime.client.d.ts","sourceRoot":"","sources":["../../../../src/telemetry/stores/greptime/greptime.client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACrE,OAAO,EAA0B,KAAK,UAAU,EAAE,KAAK,UAAU,EAAyB,MAAM,IAAI,CAAC;AAErG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAE/E,OAAO,EACL,0BAA0B,EAC1B,KAAK,yBAAyB,EAC/B,MAAM,+CAA+C,CAAC;AAUvD,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,cAAc,EACd,0BAA0B,EAC3B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAsD,KAAK,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAI5G,YAAY,EAAE,cAAc,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAoE3H,kFAAkF;AAClF,MAAM,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAC/B,+BAA+B;IAC/B,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACrB;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC;CAC/D;AAaD,6EAA6E;AAC7E,eAAO,MAAM,wBAAwB,IAAI,CAAC;AAC1C,eAAO,MAAM,uBAAuB,IAAI,CAAC;AAEzC,+EAA+E;AAC/E,eAAO,MAAM,2BAA2B,OAAQ,CAAC;AAEjD,4BAA4B;AAC5B,eAAO,MAAM,wBAAwB,OAAQ,CAAC;AAE9C,uEAAuE;AACvE,eAAO,MAAM,0BAA0B,QAAS,CAAC;AAajD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAMtG;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,wEAAwE;AACxE,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAElD;AAGD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD;;;;;;;;;GASG;AACH,qBACa,cAAe,YAAW,cAAc,EAAE,eAAe;IAaxD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAZvC,gCAAgC;IAChC,QAAQ,CAAC,EAAE,cAAc;IAEzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAmC;IAC1D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAwC;IAC9D,qFAAqF;IACrF,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAiD;IAE1E,mHAAmH;IACnH,QAAQ,CAAC,SAAS,EAAE,yBAAyB,CAAC;IAE9C,gBAAgB;gBACa,UAAU,EAAE,0BAA0B;IAInE,oFAAoF;IACpF,YAAY,IAAI,OAAO;IAIvB;;;;OAIG;IACH,oBAAoB,IAAI,MAAM,GAAG,IAAI;IAIrC,8FAA8F;IAC9F,iBAAiB,IAAI,OAAO;IAI5B,0EAA0E;IAC1E,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;OAIG;IACG,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,OAAO,EAAE,EAAE,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAYxH,mGAAmG;IAC7F,MAAM,CAAC,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IAI5E,uDAAuD;IACjD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B;;;OAGG;IACG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7F;;;OAGG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI5F,mEAAmE;IAC7D,IAAI,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAe1C,yBAAyB;IACnB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBtC,2EAA2E;IAC3E,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,YAAY;IAItD;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;YAMxE,GAAG;YAoFH,OAAO;IAYrB;;;;OAIG;YACW,oBAAoB;IAalC;;;;OAIG;YACW,IAAI;YAuBJ,KAAK;IAwDnB,+DAA+D;IAC/D,OAAO,CAAC,MAAM;IAQd;;;;OAIG;IACH,OAAO,CAAC,eAAe;CAKxB"}

package/dist/telemetry/stores/greptime/greptime.client.js

@@ -0,0 +1,381 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var GreptimeClient_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GreptimeClient = exports.rowsAsObjects = exports.GREPTIME_SCHEMA_TIMEOUT_MS = exports.GREPTIME_PING_TIMEOUT_MS = exports.GREPTIME_CONNECT_TIMEOUT_MS = exports.GREPTIME_ADMIN_POOL_MAX = exports.GREPTIME_READER_POOL_MAX = void 0;
+exports.greptimeTypeParser = greptimeTypeParser;
+exports.quoteIdent = quoteIdent;
+exports.quoteLiteral = quoteLiteral;
+const common_1 = require("@nestjs/common");
+const pg_1 = require("pg");
+const telemetry_connection_service_1 = require("../../connection/telemetry-connection.service");
+const telemetry_store_errors_1 = require("../telemetry-store.errors");
+const greptime_host_1 = require("./greptime-host");
+const greptime_retention_1 = require("./greptime.retention");
+const greptime_schema_1 = require("./greptime.schema");
+/** Pool sizes. Small on purpose: telemetry reads are admin-only and rare. */
+exports.GREPTIME_READER_POOL_MAX = 4;
+exports.GREPTIME_ADMIN_POOL_MAX = 1;
+/** How long to wait for a TCP connection + authentication before giving up. */
+exports.GREPTIME_CONNECT_TIMEOUT_MS = 5_000;
+/** Timeout for `ping()`. */
+exports.GREPTIME_PING_TIMEOUT_MS = 5_000;
+/** Default ceiling of each `information_schema` read of `schema()`. */
+exports.GREPTIME_SCHEMA_TIMEOUT_MS = 10_000;
+/** Type OIDs whose text form is kept verbatim instead of parsed by `pg`. */
+const KEEP_AS_TEXT_OIDS = new Set([
+    20, // int8 — beyond Number.MAX_SAFE_INTEGER in practice (durations in ns)
+    1700, // numeric — how UInt64 columns arrive
+    1082, // date
+    1083, // time
+    1114, // timestamp
+    1184, // timestamptz
+    1266, // timetz
+]);
+/**
+ * Per-pool type parser: the types above come back as the server's text,
+ * everything else as `pg` would parse it (booleans, int2/int4, floats, json).
+ */
+function greptimeTypeParser(oid, format) {
+    if (KEEP_AS_TEXT_OIDS.has(oid)) {
+        return (value) => value;
+    }
+    return pg_1.types.getTypeParser(oid, format ?? 'text');
+}
+/**
+ * Double-quotes an SQL identifier. Only for a value that was already
+ * validated (from configuration, or checked against `information_schema`) —
+ * quoting makes an identifier unambiguous, it does not make an arbitrary
+ * string safe to accept.
+ */
+function quoteIdent(name) {
+    return `"${name.replace(/"/g, '""')}"`;
+}
+/** Single-quotes an SQL string literal. Same caveat as `quoteIdent`. */
+function quoteLiteral(value) {
+    return `'${value.replace(/'/g, "''")}'`;
+}
+// Kept here for the callers (and the tests) that import it from the client.
+var telemetry_store_1 = require("../telemetry-store");
+Object.defineProperty(exports, "rowsAsObjects", { enumerable: true, get: function () { return telemetry_store_1.rowsAsObjects; } });
+/**
+ * The built-in telemetry store (`greptime`): a read-only reader pool and an
+ * admin pool, built from the runtime connection and rebuilt when it changes.
+ * Implements {@link TelemetryStore} (the port every service depends on) and
+ * keeps its GreptimeDB-specific members (`queryReader`, `queryAdmin`,
+ * `isAdminConfigured`) for the code that is GreptimeDB-specific by nature.
+ * Exported by `TelemetryModule`.
+ *
+ * @stability experimental
+ */
+let GreptimeClient = GreptimeClient_1 = class GreptimeClient {
+    connection;
+    /** The store id: `greptime`. */
+    id = 'greptime';
+    logger = new common_1.Logger(GreptimeClient_1.name);
+    pools = {};
+    /** A pool being built (its password is being read), so concurrent calls share it. */
+    building = {};
+    /** The retention control: `ALTER DATABASE ... SET 'ttl'` on the admin login, `SHOW CREATE DATABASE` to read it. */
+    retention;
+    /** @internal */
+    constructor(connection) {
+        this.connection = connection;
+        this.retention = (0, greptime_retention_1.createGreptimeRetention)(this);
+    }
+    /** Whether the reader connection is configured (admin UI or deployment default). */
+    isConfigured() {
+        return this.connection.isConfigured();
+    }
+    /**
+     * Why the reader connection cannot be used, in administrator language, or
+     * null — set only for the GreptimeDB deployed with this application, when
+     * the deployment provisions no reader login (issue #570).
+     */
+    configurationProblem() {
+        return this.connection.configurationProblem('reader');
+    }
+    /** Whether the admin connection is configured as well (retention, `SHOW CREATE DATABASE`). */
+    isAdminConfigured() {
+        return this.connection.isAdminConfigured();
+    }
+    /** The GreptimeDB database telemetry is written to (default `public`). */
+    get database() {
+        return this.connection.database;
+    }
+    /**
+     * {@link TelemetryStore.query}: one statement as the read-only user. The
+     * login is what makes `readOnly` true (GreptimeDB refuses a write from it);
+     * the SQL is sent as-is, so `params` must be empty (see the header).
+     */
+    async query(sql, params, options) {
+        if (params.length > 0) {
+            throw new telemetry_store_errors_1.TelemetryQueryFailedError('GreptimeDB does not accept bind parameters; the statement must carry its values as quoted literals.', undefined, 'server');
+        }
+        return this.queryReader(sql, { timeoutMs: options.timeoutMs, signal: options.signal });
+    }
+    /** {@link TelemetryStore.schema}: the tables and columns of the telemetry database, read fresh. */
+    async schema(options = {}) {
+        return (0, greptime_schema_1.readGreptimeSchema)(this, options.timeoutMs ?? exports.GREPTIME_SCHEMA_TIMEOUT_MS);
+    }
+    /** {@link TelemetryStore.close}: closes both pools. */
+    async close() {
+        await this.onModuleDestroy();
+    }
+    /**
+     * Runs one statement as the read-only user. The SQL is sent as-is: see the
+     * header for why there are no parameters.
+     */
+    async queryReader(sql, options) {
+        return this.run('reader', sql, options);
+    }
+    /**
+     * Runs one statement as the admin user. NEVER with caller-supplied SQL: this
+     * connection can alter retention and drop data.
+     */
+    async queryAdmin(sql, options) {
+        return this.run('admin', sql, options);
+    }
+    /** Reachability probe over the reader connection. Never throws. */
+    async ping() {
+        if (!this.isConfigured()) {
+            return { reachable: false, error: this.configurationProblem() ?? new telemetry_store_errors_1.TelemetryNotConfiguredError('reader').message };
+        }
+        try {
+            const result = await this.queryReader('SELECT version()', { timeoutMs: exports.GREPTIME_PING_TIMEOUT_MS });
+            const version = result.rows[0]?.[0];
+            return { reachable: true, ...(typeof version === 'string' ? { version } : {}) };
+        }
+        catch (error) {
+            return { reachable: false, error: describeError(error) };
+        }
+    }
+    /** Closes both pools. */
+    async onModuleDestroy() {
+        const pools = Object.values(this.pools).map((entry) => entry.pool);
+        for (const role of Object.keys(this.pools)) {
+            delete this.pools[role];
+        }
+        await Promise.all(pools.map((pool) => pool.end().catch((error) => {
+            this.logger.warn(`Closing a GreptimeDB pool failed: ${describeError(error)}`);
+        })));
+    }
+    /** Builds a pool. A seam for tests; production code never overrides it. */
+    createPool(config) {
+        return new pg_1.Pool(config);
+    }
+    /**
+     * `null` when `host` resolves (or the check is inconclusive), else why it
+     * does not. Only consulted after a connect TIMED OUT. A seam for tests;
+     * production code never overrides it.
+     */
+    resolveHost(host, options) {
+        return (0, greptime_host_1.checkHostResolves)(host, undefined, undefined, options);
+    }
+    // ---------------------------------------------------------------------------
+    async run(role, sql, { timeoutMs, signal }) {
+        if (signal?.aborted)
+            throw new telemetry_store_errors_1.TelemetryQueryAbortedError();
+        const keyed = await this.pool(role);
+        const client = await this.connect(keyed);
+        if (signal?.aborted) {
+            client.release();
+            throw new telemetry_store_errors_1.TelemetryQueryAbortedError();
+        }
+        let timer;
+        let timedOut = false;
+        let onAbort;
+        const query = client.query({ text: sql, rowMode: 'array' });
+        const timeout = new Promise((_, reject) => {
+            timer = setTimeout(() => {
+                timedOut = true;
+                reject(new telemetry_store_errors_1.TelemetryQueryTimeoutError(timeoutMs));
+            }, timeoutMs);
+            timer.unref?.();
+        });
+        // Abandoned like a timeout: `timedOut` routes it to the destroy branch.
+        const aborted = new Promise((_, reject) => {
+            if (!signal)
+                return;
+            onAbort = () => {
+                timedOut = true;
+                reject(new telemetry_store_errors_1.TelemetryQueryAbortedError());
+            };
+            signal.addEventListener('abort', onAbort, { once: true });
+        });
+        try {
+            const result = await Promise.race([query, timeout, aborted]);
+            client.release();
+            if (Array.isArray(result)) {
+                throw new telemetry_store_errors_1.TelemetryMultiStatementError();
+            }
+            return {
+                fields: result.fields.map((field) => ({ name: field.name, dataTypeID: field.dataTypeID })),
+                rows: result.rows,
+            };
+        }
+        catch (error) {
+            if (timedOut) {
+                // The query is still in flight on this socket: destroy it, and make
+                // sure its eventual rejection (the socket closing under it) is not an
+                // unhandled one.
+                query.catch(() => undefined);
+                client.release(true);
+                throw error;
+            }
+            if (error instanceof telemetry_store_errors_1.TelemetryMultiStatementError) {
+                throw error;
+            }
+            // A server-side error (it has a `severity`) leaves the connection
+            // usable; anything else (a reset socket) does not.
+            const fromServer = isServerError(error);
+            client.release(fromServer ? undefined : true);
+            throw new telemetry_store_errors_1.TelemetryQueryFailedError(describeError(error), sqlState(error), fromServer ? 'server' : 'connection');
+        }
+        finally {
+            if (timer)
+                clearTimeout(timer);
+            if (onAbort)
+                signal?.removeEventListener('abort', onAbort);
+        }
+    }
+    async connect(target) {
+        try {
+            return await target.pool.connect();
+        }
+        catch (error) {
+            throw new telemetry_store_errors_1.TelemetryQueryFailedError(`Could not connect to GreptimeDB: ${await this.connectFailureReason(target, error)}`, sqlState(error), 'connection');
+        }
+    }
+    /**
+     * Why a connect failed. A DNS error names the host; a timeout may be a DNS
+     * failure that lost the race, so the host is looked up once more under a
+     * longer ceiling before "timeout" is believed (#564). Never throws.
+     */
+    async connectFailureReason({ host, automaticHost }, error) {
+        const options = { automatic: automaticHost };
+        if ((0, greptime_host_1.isDnsError)(error))
+            return (0, greptime_host_1.hostNotFoundMessage)(host, error, options);
+        if (isConnectTimeout(error)) {
+            const notFound = await this.resolveHost(host, options).catch(() => null);
+            if (notFound)
+                return notFound;
+        }
+        return describeError(error);
+    }
+    /**
+     * The pool for this login, for the connection in force NOW. Rebuilt when
+     * the connection's fingerprint moved since the pool was made (an admin save,
+     * a credential rotation, a reset to the deployment default).
+     */
+    async pool(role) {
+        const fingerprint = this.connection.fingerprint(role);
+        if (!fingerprint) {
+            // No longer configured: drop a pool left over from when it was.
+            this.retire(role);
+            throw new telemetry_store_errors_1.TelemetryNotConfiguredError(role);
+        }
+        const existing = this.pools[role];
+        if (existing && existing.fingerprint === fingerprint)
+            return existing;
+        const inFlight = this.building[role];
+        if (inFlight)
+            return inFlight;
+        const building = this.build(role).finally(() => {
+            delete this.building[role];
+        });
+        this.building[role] = building;
+        return building;
+    }
+    async build(role) {
+        let credentials;
+        try {
+            credentials = await this.connection.resolveCredentials(role);
+        }
+        catch (error) {
+            // A credential-store read failed (database down, or a password that no
+            // longer decrypts). The message never carries the secret.
+            throw new telemetry_store_errors_1.TelemetryQueryFailedError(`Could not read the GreptimeDB ${role} credential: ${describeError(error)}`, undefined, 'connection');
+        }
+        if (!credentials) {
+            throw new telemetry_store_errors_1.TelemetryNotConfiguredError(role);
+        }
+        const pool = this.createPool({
+            host: credentials.host,
+            port: credentials.port,
+            database: credentials.database,
+            user: credentials.user,
+            password: credentials.password,
+            max: role === 'reader' ? exports.GREPTIME_READER_POOL_MAX : exports.GREPTIME_ADMIN_POOL_MAX,
+            application_name: `api-telemetry-${role}`,
+            connectionTimeoutMillis: exports.GREPTIME_CONNECT_TIMEOUT_MS,
+            idleTimeoutMillis: 30_000,
+            allowExitOnIdle: true,
+            types: { getTypeParser: greptimeTypeParser },
+        });
+        // An idle client's socket dying emits `error` on the pool; unhandled, that
+        // is an uncaught exception that would take the API down with it.
+        pool.on('error', (error) => {
+            this.logger.warn(`GreptimeDB ${role} connection error: ${describeError(error)}`);
+        });
+        const replaced = this.pools[role];
+        const keyed = {
+            pool,
+            fingerprint: credentials.fingerprint,
+            host: credentials.host,
+            automaticHost: credentials.automaticHost,
+        };
+        this.pools[role] = keyed;
+        if (replaced) {
+            this.logger.log(`GreptimeDB ${role} connection changed; replacing its pool`);
+            this.endInBackground(role, replaced.pool);
+        }
+        return keyed;
+    }
+    /** Forget this login's pool and close it in the background. */
+    retire(role) {
+        const existing = this.pools[role];
+        if (!existing)
+            return;
+        delete this.pools[role];
+        this.endInBackground(role, existing.pool);
+    }
+    /**
+     * `end()` waits for checked-out clients to be released, so it is never
+     * awaited on the query path: in-flight statements on the old pool finish
+     * (or time out) on their own, and nothing new is handed out from it.
+     */
+    endInBackground(role, pool) {
+        void pool.end().catch((error) => {
+            this.logger.warn(`Closing a stale GreptimeDB ${role} pool failed: ${describeError(error)}`);
+        });
+    }
+};
+exports.GreptimeClient = GreptimeClient;
+exports.GreptimeClient = GreptimeClient = GreptimeClient_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [telemetry_connection_service_1.TelemetryConnectionService])
+], GreptimeClient);
+function describeError(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+/** pg's connect-timeout errors ("timeout expired", "… due to connection timeout"). */
+function isConnectTimeout(error) {
+    return /timeout/i.test(describeError(error));
+}
+function isServerError(error) {
+    return typeof error === 'object' && error !== null && 'severity' in error;
+}
+function sqlState(error) {
+    const code = typeof error === 'object' && error !== null ? error.code : undefined;
+    return typeof code === 'string' ? code : undefined;
+}
+//# sourceMappingURL=greptime.client.js.map