@effectuate/cubejs-mongosql-driver 1.0.1 → 1.0.2

package/index.d.ts

@@ -0,0 +1,160 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+/**
+ * Schema source — Collection mode, File mode, or Atlas SQL mode.
+ *
+ * Wire shape across napi-rs is a tagged object. `kind` is one of
+ * `"collection"`, `"file"`, or `"atlas-sql"`; `path` is required for
+ * `"file"`. See `schema.rs` module docs for the per-mode loading
+ * strategy.
+ */
+export interface SchemaSource {
+  /** Discriminant: `"collection"`, `"file"`, or `"atlas-sql"`. */
+  kind: string
+  /** Path to schema file (file mode only). */
+  path?: string
+}
+/**
+ * Client configuration object passed across the napi-rs boundary.
+ *
+ * `Debug` is hand-rolled to **redact the URI** because it may contain
+ * credentials (SPEC NFR-4).
+ */
+export interface ClientConfig {
+  /** MongoDB connection URI. **Sensitive: contains credentials.** */
+  uri: string
+  /** Database name to query. */
+  database: string
+  /** Schema source. None defaults to Collection (handled by `with_defaults_applied`). */
+  schemaSource?: SchemaSource
+  /** Refresh interval in seconds. None defaults to 300. */
+  schemaRefreshSec?: number
+  /** If true, testConnection succeeds even on initial schema load failure. None defaults to false. */
+  schemaFailOpen?: boolean
+  /** Per-query timeout in milliseconds. None defaults to 60000. */
+  queryTimeoutMs?: number
+  /** Max rows returned per query (buffered). None defaults to 100000. */
+  maxRows?: number
+}
+/**
+ * Public napi-rs entry point. Cube's TypeScript driver instantiates this once
+ * per Cube driver instance.
+ */
+export declare class MongoSqlClient {
+  /**
+   * Construct a new client. No I/O is performed.
+   *
+   * Validation is deferred to [`Self::test_connection`] so the constructor
+   * stays infallible — napi-rs 2.16's `#[napi(constructor)]` requires
+   * `Self` directly, not `Result<Self>`. A subsequent `query()` before
+   * `test_connection()` returns a clear `MONGOSQL_CONFIG_INVALID` error
+   * rather than panicking.
+   */
+  constructor(config: ClientConfig)
+  /**
+   * Verify cluster connectivity and load initial schema, then spawn the
+   * background refresh task. Sequence:
+   *
+   * 1. `config.validate()` — synchronous shape checks (URI scheme, db name, ...).
+   * 2. Build the `mongodb::Client` (lazily; cached for subsequent calls).
+   * 3. `db("admin").run_command({ping: 1})` with a bounded timeout.
+   * 4. Initial schema load (collection or file mode).
+   * 5. Swap into the cache; build the column map.
+   * 6. Spawn the refresh task.
+   *
+   * Each step's failure preserves the SPEC §6 error code. Optional
+   * `signal` cancels the in-flight ping/load if the caller (or a
+   * concurrent `close()`) fires it; on cancellation we surface
+   * [`Error::Cancelled`] with site `"test_connection"`.
+   */
+  testConnection(signal?: AbortHandle | undefined | null): Promise<void>
+  /**
+   * Translate `sql` and execute the resulting MQL pipeline. Returns rows
+   * as a JSON array.
+   *
+   * Database-name handling: for file-mode catalogs, `default_db` passed to
+   * `translate::translate` is [`FILE_MODE_DB_PLACEHOLDER`]; the resulting
+   * `Translation::target_db` is rewritten to `config.database` before the
+   * executor runs the aggregate, so the wire-level command targets the
+   * real database the user configured.
+   *
+   * If `signal` is provided, abort propagates to the in-flight cursor:
+   * the racing `tokio::select!` short-circuits with [`Error::Cancelled`].
+   * `close()` also cancels via the parent [`Self::close_token`].
+   * `biased` polling on the cancel branch ensures cancellation has
+   * priority if the abort fires before/while the executor schedules.
+   */
+  query(sql: string, signal?: AbortHandle | undefined | null): Promise<any>
+  /**
+   * Returns Cube's expected `tablesSchema` payload built from the cached
+   * schema. Shape: `{ <db>: { <coll>: [{name, type}, ...] } }`.
+   *
+   * Only the configured database is exposed (one driver instance = one
+   * db). For file-mode catalogs the internal placeholder key is rewritten
+   * to the configured database name so consumers see a single coherent
+   * database label.
+   *
+   * Optional `signal` cancels the lock acquisition / map clone if a
+   * large `__sql_schemas` is being copied. In practice the body is
+   * memory-only, but the guard keeps the API symmetrical with `query()`
+   * and lets `close()` short-circuit pending callers.
+   */
+  tablesSchema(signal?: AbortHandle | undefined | null): Promise<any>
+  /**
+   * Closes underlying connections and stops background tasks.
+   *
+   * Idempotent: calling `close()` after a previous `close()` (or before
+   * `test_connection()` ever spawned a refresh task) is a no-op rather
+   * than an error. The mongodb client itself has no explicit close on
+   * v3.x — its connection pool drops when the last `Arc<Client>` goes out
+   * of scope.
+   *
+   * **SIGTERM-during-pre-agg fix.** Before this method existed, `close()`
+   * only stopped the schema-refresh task; in-flight queries kept draining
+   * their cursors until the server-side `maxTimeMS` fired (default 60s,
+   * tunable via `CUBEJS_MONGOSQL_QUERY_TIMEOUT_MS`). That leaks
+   * connections and wastes Mongo work when the caller has already
+   * signalled "stop everything". We now:
+   *
+   * 1. Cancel the parent token, which fans out to every per-call child
+   *    token (created in `query()` / `test_connection()` /
+   *    `tables_schema()`). Each in-flight async fn breaks out of its
+   *    `tokio::select!` with `Error::Cancelled`.
+   * 2. Wait up to [`CLOSE_DRAIN_TIMEOUT`] for the in-flight counter to
+   *    reach zero — the upper bound on caller-visible delay.
+   * 3. Stop the schema refresh task.
+   *
+   * The 5s drain budget is conservative; in practice in-flight cursors
+   * abandon their `try_next()` within microseconds of the cancel and
+   * the counter hits zero in O(milliseconds). We keep the bounded wait
+   * as defence-in-depth for slow TCP closes.
+   */
+  close(): Promise<void>
+}
+/**
+ * Public napi-rs handle exposed to JavaScript.
+ *
+ * JS lifecycle:
+ * 1. `const handle = new AbortHandle();`
+ * 2. Wire to a `AbortSignal`: `signal.addEventListener('abort', () => handle.abort());`
+ * 3. Pass to a cancellable Rust async method.
+ *
+ * The handle is a thin newtype around `Arc<CancelToken>` so it can be
+ * cloned cheaply across the napi boundary if a future API needs to share
+ * one signal across several calls.
+ */
+export declare class AbortHandle {
+  /** Construct a fresh, un-aborted handle. */
+  constructor()
+  /**
+   * Mark this handle aborted. Safe to call from any thread; idempotent.
+   * JS-callable; the conventional use is from an `AbortSignal`'s
+   * `'abort'` event listener.
+   */
+  abort(): void
+  /** Synchronous probe — true once `abort()` has been called. */
+  aborted(): boolean
+}

package/index.js

@@ -0,0 +1,316 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'cubejs-mongosql-driver-native.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.android-arm64.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'cubejs-mongosql-driver-native.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'cubejs-mongosql-driver-native.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'cubejs-mongosql-driver-native.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'cubejs-mongosql-driver-native.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'cubejs-mongosql-driver-native.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./cubejs-mongosql-driver-native.darwin-universal.node')
+      } else {
+        nativeBinding = require('@effectuate/cubejs-mongosql-driver-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'cubejs-mongosql-driver-native.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.darwin-x64.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'cubejs-mongosql-driver-native.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'cubejs-mongosql-driver-native.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./cubejs-mongosql-driver-native.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@effectuate/cubejs-mongosql-driver-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'cubejs-mongosql-driver-native.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./cubejs-mongosql-driver-native.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'cubejs-mongosql-driver-native.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./cubejs-mongosql-driver-native.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@effectuate/cubejs-mongosql-driver-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { MongoSqlClient, AbortHandle } = nativeBinding
+
+module.exports.MongoSqlClient = MongoSqlClient
+module.exports.AbortHandle = AbortHandle

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@effectuate/cubejs-mongosql-driver",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Cube.js native data source driver for MongoDB via the MongoSQL translator (Rust + napi-rs). Replacement for the EOL'd BI Connector path.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -85,12 +85,12 @@
     "@cubejs-backend/schema-compiler": "^1.6.0"
   },
   "optionalDependencies": {
-    "@effectuate/cubejs-mongosql-driver-linux-x64-gnu": "1.0.1",
-    "@effectuate/cubejs-mongosql-driver-linux-arm64-gnu": "1.0.1",
-    "@effectuate/cubejs-mongosql-driver-linux-x64-musl": "1.0.1",
-    "@effectuate/cubejs-mongosql-driver-linux-arm64-musl": "1.0.1",
-    "@effectuate/cubejs-mongosql-driver-darwin-x64": "1.0.1",
-    "@effectuate/cubejs-mongosql-driver-darwin-arm64": "1.0.1"
+    "@effectuate/cubejs-mongosql-driver-linux-x64-gnu": "1.0.2",
+    "@effectuate/cubejs-mongosql-driver-linux-arm64-gnu": "1.0.2",
+    "@effectuate/cubejs-mongosql-driver-linux-x64-musl": "1.0.2",
+    "@effectuate/cubejs-mongosql-driver-linux-arm64-musl": "1.0.2",
+    "@effectuate/cubejs-mongosql-driver-darwin-x64": "1.0.2",
+    "@effectuate/cubejs-mongosql-driver-darwin-arm64": "1.0.2"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.15",