@cfworker/cosmos 1.9.0 → 1.11.0

package/dist/client.d.ts

@@ -1,5 +1,8 @@
+/// <reference types="@cloudflare/workers-types" />
+/// <reference types="@cfworker/worker-types" />
 import { FeedResponse, ItemResponse } from './response.js';
 import { RetryPolicy } from './retry.js';
+import { SessionContainer } from './session.js';
 import { Collection, ConsistencyLevel, Database, Document, IndexingDirective, IndexingPolicy, OfferType, PartitionKeyDefinition, Resource } from './types.js';
 export interface CosmosClientConfig {
     endpoint: string;
@@ -8,7 +11,7 @@ export interface CosmosClientConfig {
     consistencyLevel?: ConsistencyLevel;
     dbId?: string;
     collId?: string;
-    sessionToken?: string;
+    sessions?: SessionContainer;
     fetch?: typeof fetch;
 }
 export declare class CosmosClient {
@@ -19,7 +22,7 @@ export declare class CosmosClient {
     private readonly dbId;
     private readonly collId;
     private readonly systemFetch;
-    sessionToken: string;
+    readonly sessions: SessionContainer;
     requestCharges: number;
     retries: {
         count: number;
@@ -44,7 +47,7 @@ export declare class CosmosClient {
     private fetch;
     private setHeaders;
 }
-export declare type DocumentInit = BufferSource | ReadableStream<Uint8Array> | string | Resource;
+export declare type DocumentInit = BufferSource | ReadableStream | string | Resource;
 interface CommonArgs {
     activityId?: string;
     consistencyLevel?: ConsistencyLevel;

package/dist/client.js

@@ -1,27 +1,20 @@
 import { FeedResponse, ItemResponse } from './response.js';
 import { defaultRetryPolicy } from './retry.js';
+import { DefaultSessionContainer } from './session.js';
 import { getSigner } from './signer.js';
 import { assertArg, escapeNonASCII, uri } from './util.js';
 export class CosmosClient {
-    endpoint;
-    signer;
-    retryPolicy;
-    consistencyLevel;
-    dbId;
-    collId;
-    systemFetch;
-    sessionToken = '';
-    requestCharges = 0;
-    retries = { count: 0, delayMs: 0 };
     constructor(config) {
+        this.requestCharges = 0;
+        this.retries = { count: 0, delayMs: 0 };
         this.endpoint = config.endpoint;
         this.signer = getSigner(config.masterKey);
-        this.retryPolicy = config.retryPolicy || defaultRetryPolicy;
-        this.consistencyLevel = config.consistencyLevel || 'Session';
+        this.retryPolicy = config.retryPolicy ?? defaultRetryPolicy;
+        this.consistencyLevel = config.consistencyLevel ?? 'Session';
         this.dbId = config.dbId;
         this.collId = config.collId;
-        this.systemFetch = config.fetch || fetch.bind(self);
-        this.sessionToken = config.sessionToken || '';
+        this.sessions = config.sessions ?? new DefaultSessionContainer();
+        this.systemFetch = config.fetch ?? fetch.bind(self);
     }
     async getDatabases(args = {}) {
         const url = this.endpoint + `/dbs`;
@@ -178,34 +171,30 @@ export class CosmosClient {
             return fn.call(this, Object.assign({}, args, { continuation }));
         };
     }
-    async fetchWithRetry(request) {
+    async fetchWithRetry(request, context) {
         const retryRequest = request.clone();
         const response = await this.fetch(request);
-        const retryContext = request.__retryContext__ || {
-            attempts: 0,
-            cumulativeWaitMs: 0,
-            request,
-            response
-        };
-        retryContext.attempts++;
-        retryContext.request = retryRequest;
-        retryContext.response = response;
-        const { retry, delayMs } = await this.retryPolicy.shouldRetry(retryContext);
+        context ??= { attempts: 0, cumulativeWaitMs: 0, request, response };
+        context.attempts++;
+        context.request = retryRequest;
+        context.response = response;
+        const { retry, delayMs } = await this.retryPolicy.shouldRetry(context);
         if (!retry) {
             return response;
         }
-        await new Promise(resolve => setTimeout(resolve, delayMs));
-        retryContext.cumulativeWaitMs += delayMs;
-        retryRequest.__retryContext__ = retryContext;
+        if (delayMs !== 0) {
+            await new Promise(resolve => setTimeout(resolve, delayMs));
+            context.cumulativeWaitMs += delayMs;
+            this.retries.delayMs += delayMs;
+        }
         this.retries.count++;
-        this.retries.delayMs += delayMs;
-        return this.fetchWithRetry(retryContext.request);
+        return this.fetchWithRetry(retryRequest, context);
     }
     async fetch(request) {
+        this.sessions.setRequestSession(request);
         await this.signer.sign(request);
         const response = await this.systemFetch(request);
-        this.sessionToken =
-            response.headers.get('x-ms-session-token') || this.sessionToken;
+        this.sessions.readResponseSession(response);
         const requestCharge = +(response.headers.get('x-ms-request-charge') || 0);
         this.requestCharges += requestCharge;
         return response;
@@ -219,9 +208,6 @@ export class CosmosClient {
         }
         const consistencyLevel = args.consistencyLevel || this.consistencyLevel;
         headers.set('x-ms-consistency-level', consistencyLevel);
-        if (consistencyLevel === 'Session' && this.sessionToken) {
-            headers.set('x-ms-session-token', this.sessionToken);
-        }
         if (args.continuation) {
             headers.set('x-ms-continuation', args.continuation);
         }

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './client.js';
 export * from './response.js';
+export * from './session.js';
 export * from './signer.js';
 export * from './types.js';
 export * from './util.js';

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from './client.js';
 export * from './response.js';
+export * from './session.js';
 export * from './signer.js';
 export * from './types.js';
 export * from './util.js';

package/dist/response.d.ts

@@ -1,10 +1,11 @@
+/// <reference types="@cloudflare/workers-types" />
 import { PersistedResource } from './types.js';
 export declare abstract class CosmosResponse {
     protected readonly response: Response;
     constructor(response: Response);
     get status(): number;
     get headers(): Headers;
-    get body(): ReadableStream<Uint8Array> | null;
+    get body(): ReadableStream | null;
     get activityId(): string | null;
     get etag(): string;
     get requestCharge(): number;

package/dist/response.js

@@ -1,5 +1,4 @@
 export class CosmosResponse {
-    response;
     constructor(response) {
         this.response = response;
     }
@@ -34,8 +33,6 @@ export class ItemResponse extends CosmosResponse {
     }
 }
 export class FeedResponse extends CosmosResponse {
-    next;
-    itemsProperty;
     constructor(response, next, itemsProperty) {
         super(response);
         this.next = next;

package/dist/retry.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@cloudflare/workers-types" />
 export interface RetryContext {
     request: Request;
     response: Response;

package/dist/retry.js

@@ -1,13 +1,14 @@
+import { readSessionNotAvailable } from './session';
 export class DefaultRetryPolicy {
-    maxAttempts;
-    maxCumulativeWaitTimeMs;
-    defaultRetryDelayMs;
     constructor(maxAttempts = 10, maxCumulativeWaitTimeMs = 30000, defaultRetryDelayMs = 5000) {
         this.maxAttempts = maxAttempts;
         this.maxCumulativeWaitTimeMs = maxCumulativeWaitTimeMs;
         this.defaultRetryDelayMs = defaultRetryDelayMs;
     }
     async shouldRetry(context) {
+        if (readSessionNotAvailable(context.response)) {
+            return { retry: true, delayMs: 0 };
+        }
         if (context.response.status !== 429 ||
             context.attempts >= this.maxAttempts ||
             context.cumulativeWaitMs >= this.maxCumulativeWaitTimeMs) {

package/dist/session.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="@cloudflare/workers-types" />
+export declare function readSessionNotAvailable(response: Response): boolean;
+export declare function getCollectionId({ url, headers }: {
+    url: string;
+    headers: Headers;
+}): {
+    dbId: string;
+    collId: string;
+} | null;
+export interface SessionTokens {
+    [dbId: string]: {
+        [collId: string]: string;
+    };
+}
+export interface SessionContainer {
+    tokens: SessionTokens;
+    setRequestSession(request: Request): void;
+    readResponseSession(response: Response): void;
+}
+export declare class DefaultSessionContainer implements SessionContainer {
+    readonly tokens: SessionTokens;
+    constructor(tokens?: SessionTokens);
+    setRequestSession(request: Request): void;
+    readResponseSession(response: Response): void;
+}

package/dist/session.js

@@ -0,0 +1,48 @@
+const readSessionNotAvailableSubstatus = '1002';
+export function readSessionNotAvailable(response) {
+    return (response.status === 404 &&
+        response.headers.get('x-ms-substatus') === readSessionNotAvailableSubstatus);
+}
+export function getCollectionId({ url, headers }) {
+    const path = headers.get('x-ms-alt-content-path') ?? new URL(url).pathname.substr(1);
+    const [, dbId, colls, collId] = path.split('/');
+    if (colls !== 'colls' || !collId) {
+        return null;
+    }
+    return { dbId, collId };
+}
+export class DefaultSessionContainer {
+    constructor(tokens = {}) {
+        this.tokens = tokens;
+    }
+    setRequestSession(request) {
+        if (request.headers.get('x-ms-consistency-level') !== 'Session') {
+            return;
+        }
+        const ids = getCollectionId(request);
+        if (!ids) {
+            return;
+        }
+        const token = this.tokens?.[ids.dbId]?.[ids.collId];
+        if (token) {
+            request.headers.set('x-ms-session-token', token);
+        }
+    }
+    readResponseSession(response) {
+        const ids = getCollectionId(response);
+        if (!ids) {
+            return;
+        }
+        if (readSessionNotAvailable(response)) {
+            if (this.tokens[ids.dbId]) {
+                delete this.tokens[ids.dbId][ids.collId];
+            }
+        }
+        const token = response.headers.get('x-ms-session-token');
+        if (!token) {
+            return;
+        }
+        this.tokens[ids.dbId] ??= {};
+        this.tokens[ids.dbId][ids.collId] = token;
+    }
+}

package/dist/signer.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="@cloudflare/workers-types" />
 export declare class Signer {
     private readonly masterkey;
     private readonly encoder;

package/dist/signer.js

@@ -1,8 +1,7 @@
 import { decode as base64ToArrayBuffer, encode as arrayBufferToBase64 } from 'base64-arraybuffer';
 export class Signer {
-    masterkey;
-    encoder = new TextEncoder();
     constructor(masterkey) {
+        this.encoder = new TextEncoder();
         const promiseLike = crypto.subtle.importKey('raw', base64ToArrayBuffer(masterkey), { name: 'HMAC', hash: { name: 'SHA-256' } }, false, ['sign']);
         this.masterkey = Promise.resolve(promiseLike);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cfworker/cosmos",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Azure Cosmos DB client for Cloudflare Workers and service workers",
   "keywords": [
     "azure",
@@ -37,17 +37,16 @@
     "test": "cfworker test test/**/*.spec.ts"
   },
   "dependencies": {
-    "@cfworker/worker-types": "^1.9.0",
-    "@cloudflare/workers-types": "^2.1.0",
-    "base64-arraybuffer": "^0.2.0"
+    "@cfworker/worker-types": "^1.11.0",
+    "@cloudflare/workers-types": "^3.2.0",
+    "base64-arraybuffer": "^1.0.1"
   },
   "devDependencies": {
-    "@cfworker/dev": "^1.9.0",
-    "@types/chai": "^4.2.16",
-    "@types/mocha": "^8.2.2",
+    "@cfworker/dev": "^1.11.0",
+    "@types/chai": "^4.2.22",
+    "@types/mocha": "^9.0.0",
     "chai": "^4.3.4",
-    "mocha": "^8.3.2",
-    "typescript": "^4.4.3"
-  },
-  "gitHead": "d333ff940566a7acc384ab791d8b73bed2a9a211"
+    "mocha": "^9.1.3",
+    "typescript": "^4.5.2"
+  }
 }

package/src/client.ts

@@ -1,5 +1,6 @@
 import { FeedResponse, ItemResponse } from './response.js';
 import { defaultRetryPolicy, RetryContext, RetryPolicy } from './retry.js';
+import { DefaultSessionContainer, SessionContainer } from './session.js';
 import { getSigner, Signer } from './signer.js';
 import {
   Collection,
@@ -49,9 +50,9 @@ export interface CosmosClientConfig {
   collId?: string;
 
   /**
-   * The session token to reuse when ConsistencyLevel is "Session"
+   * Reads, writes, and stores session tokens for requests made with ConsistencyLevel is "Session".
    */
-  sessionToken?: string;
+  sessions?: SessionContainer;
 
   /**
    * System fetch function
@@ -67,19 +68,19 @@ export class CosmosClient {
   private readonly dbId: string | undefined;
   private readonly collId: string | undefined;
   private readonly systemFetch: typeof fetch;
-  public sessionToken = '';
+  public readonly sessions: SessionContainer;
   public requestCharges = 0;
   public retries = { count: 0, delayMs: 0 };
 
   constructor(config: CosmosClientConfig) {
     this.endpoint = config.endpoint;
     this.signer = getSigner(config.masterKey);
-    this.retryPolicy = config.retryPolicy || defaultRetryPolicy;
-    this.consistencyLevel = config.consistencyLevel || 'Session';
+    this.retryPolicy = config.retryPolicy ?? defaultRetryPolicy;
+    this.consistencyLevel = config.consistencyLevel ?? 'Session';
     this.dbId = config.dbId;
     this.collId = config.collId;
-    this.systemFetch = config.fetch || fetch.bind(self);
-    this.sessionToken = config.sessionToken || '';
+    this.sessions = config.sessions ?? new DefaultSessionContainer();
+    this.systemFetch = config.fetch ?? fetch.bind(self);
   }
 
   public async getDatabases(
@@ -305,40 +306,37 @@ export class CosmosClient {
     };
   }
 
-  private async fetchWithRetry(request: Request): Promise<Response> {
+  private async fetchWithRetry(
+    request: Request,
+    context?: RetryContext
+  ): Promise<Response> {
     const retryRequest = request.clone();
 
     const response = await this.fetch(request);
 
-    const retryContext: RetryContext = (request as any).__retryContext__ || {
-      attempts: 0,
-      cumulativeWaitMs: 0,
-      request,
-      response
-    };
-    retryContext.attempts++;
-    retryContext.request = retryRequest;
-    retryContext.response = response;
-
-    const { retry, delayMs } = await this.retryPolicy.shouldRetry(retryContext);
+    context ??= { attempts: 0, cumulativeWaitMs: 0, request, response };
+    context.attempts++;
+    context.request = retryRequest;
+    context.response = response;
 
+    const { retry, delayMs } = await this.retryPolicy.shouldRetry(context);
     if (!retry) {
       return response;
     }
-
-    await new Promise(resolve => setTimeout(resolve, delayMs));
-    retryContext.cumulativeWaitMs += delayMs;
-    (retryRequest as any).__retryContext__ = retryContext;
+    if (delayMs !== 0) {
+      await new Promise(resolve => setTimeout(resolve, delayMs));
+      context.cumulativeWaitMs += delayMs;
+      this.retries.delayMs += delayMs;
+    }
     this.retries.count++;
-    this.retries.delayMs += delayMs;
-    return this.fetchWithRetry(retryContext.request);
+    return this.fetchWithRetry(retryRequest, context);
   }
 
   private async fetch(request: Request): Promise<Response> {
+    this.sessions.setRequestSession(request);
     await this.signer.sign(request);
     const response = await this.systemFetch(request);
-    this.sessionToken =
-      response.headers.get('x-ms-session-token') || this.sessionToken;
+    this.sessions.readResponseSession(response);
     const requestCharge = +(response.headers.get('x-ms-request-charge') || 0);
     this.requestCharges += requestCharge;
     return response;
@@ -353,9 +351,6 @@ export class CosmosClient {
     }
     const consistencyLevel = args.consistencyLevel || this.consistencyLevel;
     headers.set('x-ms-consistency-level', consistencyLevel);
-    if (consistencyLevel === 'Session' && this.sessionToken) {
-      headers.set('x-ms-session-token', this.sessionToken);
-    }
     if (args.continuation) {
       headers.set('x-ms-continuation', args.continuation);
     }
@@ -409,11 +404,7 @@ export class CosmosClient {
   }
 }
 
-export type DocumentInit =
-  | BufferSource
-  | ReadableStream<Uint8Array>
-  | string
-  | Resource;
+export type DocumentInit = BufferSource | ReadableStream | string | Resource;
 
 function toBodyInit(obj: DocumentInit): BodyInit {
   if (

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './client.js';
 export * from './response.js';
+export * from './session.js';
 export * from './signer.js';
 export * from './types.js';
 export * from './util.js';

package/src/response.ts

@@ -53,7 +53,7 @@ export class FeedResponse<T> extends CosmosResponse {
   }
 
   async json(): Promise<T[]> {
-    const data = await this.response.json();
+    const data: any = await this.response.json();
     return data[this.itemsProperty];
   }
 }

package/src/retry.ts

@@ -1,3 +1,5 @@
+import { readSessionNotAvailable } from './session';
+
 export interface RetryContext {
   request: Request;
   response: Response;
@@ -22,6 +24,9 @@ export class DefaultRetryPolicy implements RetryPolicy {
   ) {}
 
   async shouldRetry(context: RetryContext): Promise<RetryInstruction> {
+    if (readSessionNotAvailable(context.response)) {
+      return { retry: true, delayMs: 0 };
+    }
     if (
       context.response.status !== 429 ||
       context.attempts >= this.maxAttempts ||

package/src/session.ts

@@ -0,0 +1,74 @@
+const readSessionNotAvailableSubstatus = '1002';
+
+export function readSessionNotAvailable(response: Response): boolean {
+  return (
+    response.status === 404 &&
+    response.headers.get('x-ms-substatus') === readSessionNotAvailableSubstatus
+  );
+}
+
+/**
+ * Get the database and collection id from the x-ms-alt-content-path header or url.
+ * @param requestOrResponse
+ */
+export function getCollectionId({
+  url,
+  headers
+}: {
+  url: string;
+  headers: Headers;
+}): { dbId: string; collId: string } | null {
+  const path =
+    headers.get('x-ms-alt-content-path') ?? new URL(url).pathname.substr(1);
+  const [, dbId, colls, collId] = path.split('/');
+  if (colls !== 'colls' || !collId) {
+    return null;
+  }
+  return { dbId, collId };
+}
+
+export interface SessionTokens {
+  [dbId: string]: { [collId: string]: string };
+}
+
+export interface SessionContainer {
+  tokens: SessionTokens;
+  setRequestSession(request: Request): void;
+  readResponseSession(response: Response): void;
+}
+
+export class DefaultSessionContainer implements SessionContainer {
+  constructor(public readonly tokens: SessionTokens = {}) {}
+
+  setRequestSession(request: Request) {
+    if (request.headers.get('x-ms-consistency-level') !== 'Session') {
+      return;
+    }
+    const ids = getCollectionId(request);
+    if (!ids) {
+      return;
+    }
+    const token = this.tokens?.[ids.dbId]?.[ids.collId];
+    if (token) {
+      request.headers.set('x-ms-session-token', token);
+    }
+  }
+
+  readResponseSession(response: Response) {
+    const ids = getCollectionId(response);
+    if (!ids) {
+      return;
+    }
+    if (readSessionNotAvailable(response)) {
+      if (this.tokens[ids.dbId]) {
+        delete this.tokens[ids.dbId][ids.collId];
+      }
+    }
+    const token = response.headers.get('x-ms-session-token');
+    if (!token) {
+      return;
+    }
+    this.tokens[ids.dbId] ??= {};
+    this.tokens[ids.dbId][ids.collId] = token;
+  }
+}

package/tsconfig.json

@@ -1,9 +1,14 @@
 {
   "extends": "../../tsconfig-base",
   "compilerOptions": {
-    "target": "esnext",
-    "lib": ["esnext", "webworker"],
-    "types": ["@cfworker/worker-types", "@cloudflare/workers-types"],
+    "target": "ES2021",
+    "lib": ["esnext"],
+    "types": [
+      "chai",
+      "mocha",
+      "@cfworker/worker-types",
+      "@cloudflare/workers-types"
+    ],
     "outDir": "dist",
     "rootDir": "./src"
   },

package/LICENSE.md

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 Jeremy Danyow
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.