Initial F.A.R.R related implementations

api-extractor.jsonc

@@ -402,10 +402,10 @@
         // "addToApiReportFile": false
       },
 
-//      "ae-internal-missing-underscore": {
-//        "logLevel": "none",
-//        "addToApiReportFile": false
-//      }
+      "ae-internal-missing-underscore": {
+        "logLevel": "none",
+        "addToApiReportFile": false
+      },
 
       "ae-unresolved-link": {
         "logLevel": "none",

scripts/repl.sh

@@ -73,7 +73,7 @@ node -i -e "
   let table = db.table('$default_table_name');
 
   if (process.env.LOG_ALL_TO_STDOUT) {
-    for (const event of ['commandSucceeded', 'adminCommandSucceeded', 'commandFailed', 'adminCommandFailed']) {
+    for (const event of ['commandSucceeded', 'adminCommandSucceeded', 'commandFailed', 'adminCommandFailed', /.*Warning/]) {
       client.on(event, (e) => console.dir(e, { depth: null }));
     }
   }

src/administration/astra-admin.ts

@@ -24,7 +24,7 @@ import { buildAstraDatabaseAdminInfo } from '@/src/administration/utils.js';
 import { DEFAULT_DEVOPS_API_ENDPOINTS, DEFAULT_KEYSPACE, HttpMethods } from '@/src/lib/api/constants.js';
 import { DevOpsAPIHttpClient } from '@/src/lib/api/clients/devops-api-http-client.js';
 import type { OpaqueHttpClient, WithTimeout } from '@/src/lib/index.js';
-import { HierarchicalEmitter, TokenProvider } from '@/src/lib/index.js';
+import { HierarchicalLogger, TokenProvider } from '@/src/lib/index.js';
 import type { AstraDbAdminInfo } from '@/src/administration/types/admin/database-info.js';
 import { buildAstraEndpoint } from '@/src/lib/utils.js';
 import type { DbOptions } from '@/src/client/index.js';
@@ -64,7 +64,7 @@ import type { AdminCommandEventMap } from '@/src/administration/events.js';
  *
  * @public
  */
-export class AstraAdmin extends HierarchicalEmitter<AdminCommandEventMap> {
+export class AstraAdmin extends HierarchicalLogger<AdminCommandEventMap> {
   readonly #defaultOpts: ParsedRootClientOpts;
   readonly #httpClient: DevOpsAPIHttpClient;
   readonly #environment: 'dev' | 'test' | 'prod';
@@ -75,9 +75,7 @@ export class AstraAdmin extends HierarchicalEmitter<AdminCommandEventMap> {
    * @internal
    */
   constructor(rootOpts: ParsedRootClientOpts, adminOpts: ParsedAdminOptions) {
-    super(rootOpts.client);
-
-    this.#defaultOpts = {
+    const defaultOpts = {
       ...rootOpts,
       adminOptions: AdminOptsHandler.concat([rootOpts.adminOptions, adminOpts]),
       dbOptions: {
@@ -86,16 +84,18 @@ export class AstraAdmin extends HierarchicalEmitter<AdminCommandEventMap> {
       },
     };
 
+    super(rootOpts.client, defaultOpts.adminOptions.logging);
+
+    this.#defaultOpts = defaultOpts;
     this.#environment = this.#defaultOpts.adminOptions.astraEnv ?? 'prod';
 
     this.#httpClient = new DevOpsAPIHttpClient({
-      logging: this.#defaultOpts.adminOptions.logging,
       baseUrl: this.#defaultOpts.adminOptions.endpointUrl ?? DEFAULT_DEVOPS_API_ENDPOINTS[this.#environment],
-      emitter: this,
+      logger: this,
       fetchCtx: rootOpts.fetchCtx,
       caller: rootOpts.caller,
       tokenProvider: this.#defaultOpts.adminOptions.adminToken,
-      additionalHeaders: this.#defaultOpts.adminOptions.additionalHeaders,
+      additionalHeaders: this.#defaultOpts.additionalHeaders,
       timeoutDefaults: Timeouts.cfg.concat([rootOpts.adminOptions.timeoutDefaults, this.#defaultOpts.adminOptions.timeoutDefaults]),
     });
 

src/administration/astra-db-admin.ts

@@ -18,14 +18,13 @@ import { DbAdmin } from '@/src/administration/db-admin.js';
 import type { OpaqueHttpClient, WithTimeout } from '@/src/lib/index.js';
 import { TokenProvider } from '@/src/lib/index.js';
 import { buildAstraDatabaseAdminInfo, extractAstraEnvironment } from '@/src/administration/utils.js';
-import type { FindEmbeddingProvidersResult } from '@/src/administration/types/db-admin/find-embedding-providers.js';
 import { DEFAULT_DEVOPS_API_ENDPOINTS, HttpMethods } from '@/src/lib/api/constants.js';
 import { DevOpsAPIHttpClient } from '@/src/lib/api/clients/devops-api-http-client.js';
 import type { Db } from '@/src/db/index.js';
 import { $CustomInspect } from '@/src/lib/constants.js';
 import type { AstraDbAdminInfo } from '@/src/administration/types/admin/database-info.js';
-import { Logger } from '@/src/lib/logging/logger.js';
-import type { TimeoutManager} from '@/src/lib/api/timeouts/timeouts.js';
+import { InternalLogger } from '@/src/lib/logging/internal-logger.js';
+import type { TimeoutManager } from '@/src/lib/api/timeouts/timeouts.js';
 import { Timeouts } from '@/src/lib/api/timeouts/timeouts.js';
 import type { DataAPIHttpClient } from '@/src/lib/api/clients/index.js';
 import type { ParsedAdminOptions } from '@/src/client/opts-handlers/admin-opts-handler.js';
@@ -77,18 +76,18 @@ export class AstraDbAdmin extends DbAdmin {
    * @internal
    */
   constructor(db: Db, rootOpts: ParsedRootClientOpts, adminOpts: ParsedAdminOptions, dbToken: ParsedTokenProvider, endpoint: string) {
-    super(rootOpts.client);
+    const loggingConfig = InternalLogger.cfg.concat([rootOpts.adminOptions.logging, adminOpts.logging]);
+    super(rootOpts.client, loggingConfig);
 
     this.#environment = adminOpts?.astraEnv ?? rootOpts.adminOptions.astraEnv ?? extractAstraEnvironment(endpoint);
 
     this.#httpClient = new DevOpsAPIHttpClient({
       baseUrl: DEFAULT_DEVOPS_API_ENDPOINTS[this.#environment],
-      logging: Logger.cfg.concat([rootOpts.adminOptions.logging, adminOpts.logging]),
       fetchCtx: rootOpts.fetchCtx,
-      emitter: this,
+      logger: this,
       caller: rootOpts.caller,
       tokenProvider: TokenProvider.opts.concat([dbToken, rootOpts.adminOptions.adminToken, adminOpts.adminToken]),
-      additionalHeaders: { ...rootOpts.adminOptions.additionalHeaders, ...adminOpts?.additionalHeaders },
+      additionalHeaders: rootOpts.additionalHeaders,
       timeoutDefaults: Timeouts.cfg.concat([rootOpts.adminOptions.timeoutDefaults, adminOpts.timeoutDefaults]),
     });
 
@@ -130,31 +129,6 @@ export class AstraDbAdmin extends DbAdmin {
     return this.#db;
   }
 
-  /**
-   * Returns detailed information about the availability and usage of the vectorize embedding providers available on the
-   * current database (may vary based on cloud provider & region).
-   *
-   * @example
-   * ```typescript
-   * const { embeddingProviders } = await dbAdmin.findEmbeddingProviders();
-   *
-   * // ['text-embedding-3-small', 'text-embedding-3-large', 'text-embedding-ada-002']
-   * console.log(embeddingProviders['openai'].models.map(m => m.name));
-   * ```
-   *
-   * @param options - The options for the timeout of the operation.
-   *
-   * @returns The available embedding providers.
-   */
-  public override async findEmbeddingProviders(options?: WithTimeout<'databaseAdminTimeoutMs'>): Promise<FindEmbeddingProvidersResult> {
-    const resp = await this.#dataApiHttpClient.executeCommand({ findEmbeddingProviders: {} }, {
-      timeoutManager: this.#httpClient.tm.single('databaseAdminTimeoutMs', options),
-      methodName: 'dbAdmin.findEmbeddingProviders',
-      keyspace: null,
-    });
-    return resp.status as FindEmbeddingProvidersResult;
-  }
-
   /**
    * Fetches the complete information about the database, such as the database name, IDs, region, status, actions, and
    * other metadata.
@@ -346,4 +320,11 @@ export class AstraDbAdmin extends DbAdmin {
 
     return buildAstraDatabaseAdminInfo(resp.data!, this.#environment);
   }
+
+  /**
+   * @internal
+   */
+  protected override _getDataAPIHttpClient(): DataAPIHttpClient<'admin'> {
+    return this.#dataApiHttpClient;
+  }
 }

src/administration/data-api-db-admin.ts

@@ -16,12 +16,13 @@
 import type { DataAPICreateKeyspaceOptions } from '@/src/administration/types/index.js';
 import { DbAdmin } from '@/src/administration/db-admin.js';
 import type { OpaqueHttpClient, WithTimeout } from '@/src/lib/index.js';
-import type { FindEmbeddingProvidersResult } from '@/src/administration/types/db-admin/find-embedding-providers.js';
 import type { DataAPIHttpClient } from '@/src/lib/api/clients/data-api-http-client.js';
 import type { Db } from '@/src/db/index.js';
 import { $CustomInspect } from '@/src/lib/constants.js';
 import type { ParsedAdminOptions } from '@/src/client/opts-handlers/admin-opts-handler.js';
 import type { DataAPIClient } from '@/src/client/data-api-client.js';
+import { InternalLogger } from '@/src/lib/logging/internal-logger.js';
+import type { ParsedRootClientOpts } from '@/src/client/opts-handlers/root-opts-handler.js';
 
 /**
  * An administrative class for managing non-Astra databases, including creating, listing, and deleting keyspaces.
@@ -65,8 +66,9 @@ export class DataAPIDbAdmin extends DbAdmin {
    *
    * @internal
    */
-  constructor(db: Db, client: DataAPIClient, httpClient: DataAPIHttpClient, adminOpts: ParsedAdminOptions) {
-    super(client);
+  constructor(db: Db, client: DataAPIClient, httpClient: DataAPIHttpClient, rootOpts: ParsedRootClientOpts, adminOpts: ParsedAdminOptions) {
+    const loggingConfig = InternalLogger.cfg.concat([rootOpts.dbOptions.logging, adminOpts.logging]);
+    super(client, loggingConfig);
 
     this.#httpClient = httpClient.forDbAdmin(this, adminOpts);
     this.#db = db;
@@ -97,31 +99,6 @@ export class DataAPIDbAdmin extends DbAdmin {
     return this.#db;
   }
 
-  /**
-   * Returns detailed information about the availability and usage of the vectorize embedding providers available on the
-   * current database (may vary based on cloud provider & region).
-   *
-   * @example
-   * ```typescript
-   * const { embeddingProviders } = await dbAdmin.findEmbeddingProviders();
-   *
-   * // ['text-embedding-3-small', 'text-embedding-3-large', 'text-embedding-ada-002']
-   * console.log(embeddingProviders['openai'].models.map(m => m.name));
-   * ```
-   *
-   * @param options - The options for the timeout of the operation.
-   *
-   * @returns The available embedding providers.
-   */
-  public override async findEmbeddingProviders(options?: WithTimeout<'databaseAdminTimeoutMs'>): Promise<FindEmbeddingProvidersResult> {
-    const resp = await this.#httpClient.executeCommand({ findEmbeddingProviders: {} }, {
-      timeoutManager: this.#httpClient.tm.single('databaseAdminTimeoutMs', options),
-      methodName: 'dbAdmin.findEmbeddingProviders',
-      keyspace: null,
-    });
-    return resp.status as FindEmbeddingProvidersResult;
-  }
-
   /**
    * Lists the keyspaces in the database.
    *
@@ -226,4 +203,11 @@ export class DataAPIDbAdmin extends DbAdmin {
   public get _httpClient(): OpaqueHttpClient {
     return this.#httpClient;
   }
+
+  /**
+   * @internal
+   */
+  protected override _getDataAPIHttpClient(): DataAPIHttpClient<'admin'> {
+    return this.#httpClient;
+  }
 }