Misc fixes and refactors (#61)

* headers integration testing

* better encapsulation on the core classes

* let data api return unauthenticated error directly

* fixed rebasing mistake

* updated non-astra example to use updateDbNamespace

* slightl update to non-astra example

* tiny update to ObjectIDs internal representation

* reinstated example deps to npm versions

* DefaultEmbeddingHeadersProvider => EmbeddingAPIKeyHeaderProvider

* removed unused var

Author: toptobes

etc/astra-db-ts.api.md

@@ -115,8 +115,8 @@ export class AstraAdmin {
 // @public
 export class AstraDbAdmin extends DbAdmin {
     // @internal
-    constructor(db: Db, rootOpts: InternalRootClientOpts, adminOpts?: AdminSpawnOptions);
-    createNamespace(namespace: string, options?: AdminBlockingOptions): Promise<void>;
+    constructor(db: Db, rootOpts: InternalRootClientOpts, adminOpts: AdminSpawnOptions | undefined, dbToken: TokenProvider);
+    createNamespace(namespace: string, options?: CreateNamespaceOptions): Promise<void>;
     db(): Db;
     drop(options?: AdminBlockingOptions): Promise<void>;
     dropNamespace(namespace: string, options?: AdminBlockingOptions): Promise<void>;
@@ -125,6 +125,12 @@ export class AstraDbAdmin extends DbAdmin {
     listNamespaces(options?: WithTimeout): Promise<string[]>;
 }
 
+// @public
+export class AWSEmbeddingHeadersProvider extends EmbeddingHeadersProvider {
+    constructor(accessKeyId: string, secretAccessKey: string);
+    getHeaders(): Record<string, string>;
+}
+
 // @public
 export class BulkWriteError extends CumulativeDataAPIError {
     name: string;
@@ -230,8 +236,8 @@ export interface CollectionOptions<Schema extends SomeDoc> {
 
 // @public
 export interface CollectionSpawnOptions extends WithNamespace {
-    defaultMaxTimeMS?: number;
-    embeddingApiKey?: string;
+    defaultMaxTimeMS?: number | null;
+    embeddingApiKey?: string | EmbeddingHeadersProvider | null;
 }
 
 // @public
@@ -301,7 +307,7 @@ export type CreateDatabaseOptions = AdminBlockingOptions & {
 
 // @public
 export type CreateNamespaceOptions = AdminBlockingOptions & {
-    replication?: NamespaceReplicationOptions;
+    updateDbNamespace?: boolean;
 };
 
 // @public
@@ -371,7 +377,7 @@ export type DataAPICommandEvents = {
 export class DataAPIDbAdmin extends DbAdmin {
     // @internal
     constructor(db: Db, httpClient: DataAPIHttpClient, adminOpts?: AdminSpawnOptions);
-    createNamespace(namespace: string, options?: CreateNamespaceOptions): Promise<void>;
+    createNamespace(namespace: string, options?: LocalCreateNamespaceOptions): Promise<void>;
     db(): Db;
     dropNamespace(namespace: string, options?: AdminBlockingOptions): Promise<void>;
     listNamespaces(options?: WithTimeout): Promise<string[]>;
@@ -526,12 +532,13 @@ export class Db {
     listCollections(options?: ListCollectionsOptions & {
         nameOnly?: false;
     }): Promise<FullCollectionInfo[]>;
-    readonly namespace: string;
+    get namespace(): string;
+    useNamespace(namespace: string): void;
 }
 
 // @public
 export abstract class DbAdmin {
-    abstract createNamespace(namespace: string, options?: AdminBlockingOptions): Promise<void>;
+    abstract createNamespace(namespace: string, options?: CreateNamespaceOptions): Promise<void>;
     abstract db(): Db;
     abstract dropNamespace(namespace: string, options?: AdminBlockingOptions): Promise<void>;
     abstract listNamespaces(): Promise<string[]>;
@@ -553,6 +560,12 @@ export interface DbSpawnOptions {
     token?: string | TokenProvider | null;
 }
 
+// @public
+export class EmbeddingAPIKeyHeaderProvider extends EmbeddingHeadersProvider {
+    constructor(apiKey: string | nullish);
+    getHeaders(): Record<string, string>;
+}
+
 // @public
 export interface DefaultHttpClientOptions {
     client?: 'default';
@@ -641,6 +654,13 @@ export class DevOpsUnexpectedStateError extends DevOpsAPIError {
 export interface DropCollectionOptions extends WithTimeout, WithNamespace {
 }
 
+// @public
+export abstract class EmbeddingHeadersProvider {
+    abstract getHeaders(): Promise<Record<string, string>> | Record<string, string>;
+    // @internal
+    static parseHeaders(token: unknown): EmbeddingHeadersProvider;
+}
+
 // @public
 export class FailedToLoadDefaultClientError extends Error {
     // @internal
@@ -935,6 +955,11 @@ export interface ListDatabasesOptions extends WithTimeout {
     skip?: number;
 }
 
+// @public
+export type LocalCreateNamespaceOptions = CreateNamespaceOptions & {
+    replication?: NamespaceReplicationOptions;
+};
+
 // @public
 export type MaybeId<T> = NoId<T> & {
     _id?: IdOf<T>;
@@ -1076,7 +1101,7 @@ export type SortDirection = 1 | -1 | 'asc' | 'desc' | 'ascending' | 'descending'
 // @public
 export class StaticTokenProvider extends TokenProvider {
     constructor(token: string | nullish);
-    getToken(): Promise<string | nullish>;
+    getToken(): string | nullish;
 }
 
 // @public
@@ -1168,7 +1193,7 @@ export type ToDotNotation<Schema extends SomeDoc> = Merge<_ToDotNotation<Schema,
 
 // @public
 export abstract class TokenProvider {
-    abstract getToken(): Promise<string | nullish>;
+    abstract getToken(): string | nullish | Promise<string | nullish>;
     // @internal
     static parseToken(token: unknown): TokenProvider;
 }
@@ -1256,7 +1281,7 @@ export interface UpsertedUpdateOptions<Schema extends SomeDoc> {
 // @public
 export class UsernamePasswordTokenProvider extends TokenProvider {
     constructor(username: string, password: string);
-    getToken(): Promise<string>;
+    getToken(): string;
 }
 
 // @public

examples/non-astra-backends/README.md

@@ -48,7 +48,14 @@ const db = client.db('http://localhost:8181', { token: tp });
 const dbAdmin = db.admin({ environment: 'dse' });
 
 (async () => {
-  await dbAdmin.createNamespace('my_keyspace');
+  await dbAdmin.createNamespace('my_keyspace', {
+    updateDbNamespace: true,
+  });
+  
   console.log(await dbAdmin.listNamespaces());
+  
+  const collection = await db.createCollection('my_coll', {
+    checkExists: false,
+  });
 })();
 ```

examples/non-astra-backends/src/index.ts

@@ -1,19 +1,40 @@
-import { DataAPIClient, UsernamePasswordTokenProvider } from '@datastax/astra-db-ts';
+import { DataAPIClient, UsernamePasswordTokenProvider, UUID } from '@datastax/astra-db-ts';
 
-// Creates the client. Need to pass in the environment parameter so `astra-db-ts` can adjust properly.
+// Creates the client. Need to pass in the environment parameter so `astra-db-ts` can adjust properly
 const client = new DataAPIClient({ environment: 'dse' });
 
 // Use the token provide to set up your credentials easily
 const tp = new UsernamePasswordTokenProvider('cassandra', 'cassandra');
+
+// Creates a Db without a namespace
+// The namespace will be set later when doing `createNamespace`
 const db = client.db('http://localhost:8181', { token: tp });
 
 // db.admin() needs the environment passed in for proper typing purposes
 // Note that it's typed as returning 'DataAPIDbAdmin' instead of 'DbAdmin' or 'AstraDbAdmin'
 const dbAdmin = db.admin({ environment: 'dse' });
 
-// Creates a new namespace and lists all namespaces that now exist
-// Note that the db is not properly configured to use the keyspace that's just been created yet.
 (async () => {
-  await dbAdmin.createNamespace('my_keyspace');
+  // Creates the new namespace 'my_keyspace'
+  // The Db that spawned the DbAdmin is updated to use the new namespace
+  await dbAdmin.createNamespace('my_keyspace', {
+    updateDbNamespace: true,
+  });
+
+  // The list of namespaces will now include 'my_keyspace'
   console.log(await dbAdmin.listNamespaces());
+
+  // Creates a collection in the 'my_keyspace' namespace
+  const collection = await db.createCollection('my_coll', {
+    checkExists: false,
+  });
+
+  // Example of document manipulation in the newly created namespace
+  const _id = UUID.v7();
+
+  await collection.insertOne({ _id });
+
+  console.log(await collection.findOne({}))
+
+  await collection.deleteOne({ _id });
 })();

src/api/clients/data-api-http-client.ts

@@ -90,8 +90,8 @@ export const EmissionStrategy: Record<'Normal' | 'Admin', EmissionStrategy> = {
 const adaptInfo4Devops = (info: DataAPIRequestInfo) => (<const>{
   method: 'POST',
   data: info.command,
-  params: {},
   path: info.url,
+  params: {},
 });
 
 interface DataAPIHttpClientOpts extends HTTPClientOptions {
@@ -197,11 +197,6 @@ export class DataAPIHttpClient extends HttpClient {
 
       const data: RawDataAPIResponse = resp.body ? JSON.parse(resp.body, reviver) : {};
 
-      if (resp.status === 401 || (data.errors && data.errors.length > 0 && data.errors[0]?.message === 'UNAUTHENTICATED: Invalid token')) {
-        const fauxResponse = mkFauxErroredResponse('Authentication failed; is your token valid?');
-        throw mkRespErrorFromResponse(DataAPIResponseError, info.command, fauxResponse);
-      }
-
       if (data.errors && data.errors.length > 0 && data.errors[0]?.errorCode === 'COLLECTION_NOT_EXIST') {
         const name = data.errors[0]?.message.split(': ')[1];
         throw new CollectionNotFoundError(info.namespace ?? '<unknown>', name);
@@ -231,10 +226,6 @@ export class DataAPIHttpClient extends HttpClient {
   }
 }
 
-const mkFauxErroredResponse = (message: string): RawDataAPIResponse => {
-  return { errors: [{ message }] };
-}
-
 /**
  * @internal
  */

src/api/clients/http-client.ts

@@ -27,8 +27,9 @@ export abstract class HttpClient {
   readonly monitorCommands: boolean;
   readonly fetchCtx: FetchCtx;
   readonly baseHeaders: Record<string, any>;
+  readonly headerProviders: HeaderProvider[];
 
-  protected constructor(options: HTTPClientOptions, readonly headerProviders: HeaderProvider[]) {
+  protected constructor(options: HTTPClientOptions, headerProviders: HeaderProvider[]) {
     this.baseUrl = options.baseUrl;
     this.emitter = options.emitter;
     this.monitorCommands = options.monitorCommands;
@@ -41,6 +42,8 @@ export abstract class HttpClient {
     this.baseHeaders = {};
     this.baseHeaders['User-Agent'] = options.userAgent;
     this.baseHeaders['Content-Type'] = 'application/json';
+
+    this.headerProviders = headerProviders;
   }
 
   protected async _request(info: HTTPRequestInfo): Promise<FetcherResponseInfo> {

src/api/constants.ts

@@ -53,11 +53,6 @@ export const DEFAULT_NAMESPACE = 'default_keyspace';
  */
 export const DEFAULT_TIMEOUT = 30000;
 
-/**
- * @internal
- */
-export const DEFAULT_EMBEDDING_API_KEY_HEADER = 'x-embedding-api-key';
-
 /**
  * @internal
  */