Fixed fetch implementation, added rate limit header support.

Author: niemyjski

.vscode/settings.json

@@ -25,6 +25,7 @@
     "lage",
     "maxcdn",
     "ncaught",
+    "ratelimit",
     "tsproject",
     "webcompat"
   ],

packages/browser/src/submission/BrowserFetchSubmissionClient.ts

@@ -5,7 +5,7 @@ import {
 } from "@exceptionless/core";
 
 export class BrowserFetchSubmissionClient extends SubmissionClientBase {
-  protected async fetch<T>(url: string, options: FetchOptions): Promise<Response<T>> {
+  protected async fetch(url: string, options: FetchOptions): Promise<Response> {
     // TODO: Figure out how to set a 10000 timeout.
     const requestOptions: RequestInit = {
       method: options.method,
@@ -23,7 +23,8 @@ export class BrowserFetchSubmissionClient extends SubmissionClientBase {
     }
 
     const response = await fetch(url, requestOptions);
+    const rateLimitRemaining: number = parseInt(response.headers.get(this.RateLimitRemainingHeader), 10);
     const settingsVersion: number = parseInt(response.headers.get(this.ConfigurationVersionHeader), 10);
-    return new Response(response.status, response.statusText, settingsVersion, response.ok ? await response.json() : await response.text())
+    return new Response(response.status, response.statusText, rateLimitRemaining, settingsVersion, await response.text())
   }
 }

packages/core/src/queue/DefaultEventQueue.ts

@@ -12,7 +12,7 @@ export class DefaultEventQueue implements IEventQueue {
    * @private
    */
   private _handlers: Array<
-    (events: Event[], response: Response<void>) => void
+    (events: Event[], response: Response) => void
   > = [];
 
   /**
@@ -150,11 +150,11 @@ export class DefaultEventQueue implements IEventQueue {
   }
 
   // TODO: See if this makes sense.
-  public onEventsPosted(handler: (events: Event[], response: Response<void>) => void): void {
+  public onEventsPosted(handler: (events: Event[], response: Response) => void): void {
     handler && this._handlers.push(handler);
   }
 
-  private eventsPosted(events: Event[], response: Response<void>) {
+  private eventsPosted(events: Event[], response: Response) {
     const handlers = this._handlers; // optimization for minifier.
     for (const handler of handlers) {
       try {
@@ -188,11 +188,8 @@ export class DefaultEventQueue implements IEventQueue {
     }
   }
 
-  private processSubmissionResponse(
-    response: Response<void>,
-    events: IStorageItem[],
-  ): void {
-    const noSubmission: string = "The event will not be submitted."; // Optimization for minifier.
+  private processSubmissionResponse(response: Response, events: IStorageItem[]): void {
+    const noSubmission: string = "The event will not be submitted"; // Optimization for minifier.
     const config: Configuration = this.config; // Optimization for minifier.
     const log: ILog = config.services.log; // Optimization for minifier.
 
@@ -202,7 +199,7 @@ export class DefaultEventQueue implements IEventQueue {
       return;
     }
 
-    if (response.status === 429 || response.status === 503) {
+    if (response.status === 429 || response.rateLimitRemaining === 0 || response.status === 503) {
       // You are currently over your rate limit or the servers are under stress.
       log.error("Server returned service unavailable.");
       this.suspendProcessing();

packages/core/src/queue/IEventQueue.ts

@@ -11,5 +11,5 @@ export interface IEventQueue {
   /** Suspends processing of events for a specific duration */
   suspendProcessing(durationInMinutes?: number, discardFutureQueuedItems?: boolean, clearQueue?: boolean): void;
   // TODO: See if this makes sense.
-  onEventsPosted(handler: (events: Event[], response: Response<void>) => void): void;
+  onEventsPosted(handler: (events: Event[], response: Response) => void): void;
 }

packages/core/src/submission/ISubmissionClient.ts

@@ -4,8 +4,8 @@ import { UserDescription } from "../models/data/UserDescription.js";
 import { Response } from "./Response.js";
 
 export interface ISubmissionClient {
-  getSettings(version: number): Promise<Response<ClientSettings>>;
-  submitEvents(events: Event[]): Promise<Response<void>>;
-  submitUserDescription(referenceId: string, description: UserDescription): Promise<Response<void>>;
-  submitHeartbeat(sessionIdOrUserId: string, closeSession: boolean): Promise<Response<void>>;
+  getSettings(version: number): Promise<Response>;
+  submitEvents(events: Event[]): Promise<Response>;
+  submitUserDescription(referenceId: string, description: UserDescription): Promise<Response>;
+  submitHeartbeat(sessionIdOrUserId: string, closeSession: boolean): Promise<Response>;
 }

packages/core/src/submission/Response.ts

@@ -1,10 +1,11 @@
 
-export class Response<T> {
+export class Response {
   constructor(
     public status: number,
     public message: string,
+    public rateLimitRemaining: number,
     public settingsVersion: number,
-    public data: T
+    public data: string
   ) { }
 
   public get success(): boolean {

packages/core/src/submission/SubmissionClientBase.ts

@@ -14,18 +14,19 @@ export interface FetchOptions {
 }
 
 export abstract class SubmissionClientBase implements ISubmissionClient {
+  protected readonly RateLimitRemainingHeader: string = "x-ratelimit-remaining";
   protected readonly ConfigurationVersionHeader: string = "x-exceptionless-configversion";
 
   public constructor(protected config: Configuration) { }
 
-  public getSettings(version: number): Promise<Response<ClientSettings>> {
+  public getSettings(version: number): Promise<Response> {
     const url = `${this.config.serverUrl}/api/v2/projects/config?v=${version}`;
     return this.fetch<ClientSettings>(url, {
       method: "GET",
     });
   }
 
-  public async submitEvents(events: Event[]): Promise<Response<void>> {
+  public async submitEvents(events: Event[]): Promise<Response> {
     const url = `${this.config.serverUrl}/api/v2/events`;
     const response = await this.fetch<void>(url, {
       method: "POST",
@@ -36,10 +37,8 @@ export abstract class SubmissionClientBase implements ISubmissionClient {
     return response;
   }
 
-  public async submitUserDescription(referenceId: string, description: UserDescription): Promise<Response<void>> {
-    const url = `${this.config.serverUrl}/api/v2/events/by-ref/${
-      encodeURIComponent(referenceId)
-    }/user-description`;
+  public async submitUserDescription(referenceId: string, description: UserDescription): Promise<Response> {
+    const url = `${this.config.serverUrl}/api/v2/events/by-ref/${encodeURIComponent(referenceId)}/user-description`;
 
     const response = await this.fetch<void>(url, {
       method: "POST",
@@ -50,15 +49,11 @@ export abstract class SubmissionClientBase implements ISubmissionClient {
     return response;
   }
 
-  public async submitHeartbeat(sessionIdOrUserId: string, closeSession: boolean): Promise<Response<void>> {
+  public async submitHeartbeat(sessionIdOrUserId: string, closeSession: boolean): Promise<Response> {
     const url = `${this.config.heartbeatServerUrl}/api/v2/events/session/heartbeat?id=${sessionIdOrUserId}&close=${closeSession}`;
-
-    const response = await this.fetch<void>(url, {
+    return await this.fetch<void>(url, {
       method: "GET"
     });
-
-    await this.updateSettingsVersion(response.settingsVersion);
-    return response;
   }
 
   protected async updateSettingsVersion(settingsVersion: number): Promise<void> {
@@ -69,5 +64,5 @@ export abstract class SubmissionClientBase implements ISubmissionClient {
     }
   }
 
-  protected abstract fetch<T>(url: string, options: FetchOptions): Promise<Response<T>>;
+  protected abstract fetch<T>(url: string, options: FetchOptions): Promise<Response>;
 }

packages/core/test/submission/TestSubmissionClient.test.ts

@@ -14,7 +14,7 @@ describe("TestSubmissionClient", () => {
 
   test("should submit events", async () => {
     const fetchMock = TestSubmissionClient.prototype.fetch = jest.fn()
-      .mockReturnValueOnce(new Response<void>(202, "", -1, undefined));
+      .mockReturnValueOnce(new Response(202, "", undefined, undefined, undefined));
 
     const events = [{ type: "log", message: "From js client", reference_id: "123454321" }];
     const client = new TestSubmissionClient(config);
@@ -29,7 +29,7 @@ describe("TestSubmissionClient", () => {
 
   test("should submit invalid object data", async () => {
     const fetchMock = TestSubmissionClient.prototype.fetch = jest.fn()
-      .mockReturnValueOnce(new Response<void>(202, "", -1, undefined));
+      .mockReturnValueOnce(new Response(202, "", undefined, undefined, undefined));
 
     const events: Event[] = [{
       type: "log", message: "From js client", reference_id: "123454321", data: {
@@ -50,7 +50,7 @@ describe("TestSubmissionClient", () => {
 
   test("should submit user description", async () => {
     const fetchMock = TestSubmissionClient.prototype.fetch = jest.fn()
-      .mockReturnValueOnce(new Response<void>(202, "", -1, undefined));
+      .mockReturnValueOnce(new Response(202, "", undefined, undefined, undefined));
 
     const description: UserDescription = {
       email_address: "[email protected]",
@@ -69,8 +69,8 @@ describe("TestSubmissionClient", () => {
 
   test("should submit heartbeat", async () => {
     const fetchMock = TestSubmissionClient.prototype.fetch = jest.fn()
-      .mockReturnValueOnce(new Response<void>(200, "", 1, undefined))
-      .mockReturnValueOnce(new Response<ClientSettings>(200, "", 1, new ClientSettings({}, 1)));
+      .mockReturnValueOnce(new Response(200, "", undefined, 1, undefined))
+      .mockReturnValueOnce(new Response(200, "", undefined, 1, JSON.stringify(new ClientSettings({}, 1))));
 
     const client = config.services.submissionClient = new TestSubmissionClient(config);
     await client.submitHeartbeat("sessionId", true);
@@ -83,7 +83,7 @@ describe("TestSubmissionClient", () => {
 
   test("should get project settings", async () => {
     const fetchMock = TestSubmissionClient.prototype.fetch = jest.fn()
-      .mockReturnValueOnce(new Response<ClientSettings>(200, "", undefined, new ClientSettings({}, 1)));
+      .mockReturnValueOnce(new Response(200, "", undefined, undefined, JSON.stringify(new ClientSettings({}, 1))));
 
     const client = new TestSubmissionClient(config);
     await client.getSettings(0);

packages/core/test/submission/TestSubmissionClient.ts

@@ -5,7 +5,7 @@ import {
 } from "../../src/submission/SubmissionClientBase.js";
 
 export class TestSubmissionClient extends SubmissionClientBase {
-  public fetch<T>(url: string, options: FetchOptions): Promise<Response<T>> {
+  public fetch<T>(url: string, options: FetchOptions): Promise<Response> {
     throw new Error("Missing mock");
   }
 }

packages/node/src/submission/NodeFetchSubmissionClient.ts

@@ -11,7 +11,7 @@ import {
 } from "@exceptionless/core";
 
 export class NodeFetchSubmissionClient extends SubmissionClientBase {
-  protected async fetch<T>(url: string, options: FetchOptions): Promise<Response<T>> {
+  protected async fetch<T>(url: string, options: FetchOptions): Promise<Response> {
     // TODO: Figure out how to set a 10000 timeout.
     const requestOptions: RequestInit = {
       method: options.method,
@@ -29,7 +29,8 @@ export class NodeFetchSubmissionClient extends SubmissionClientBase {
     }
 
     const response = await fetch(url, requestOptions);
+    const rateLimitRemaining: number = parseInt(response.headers.get(this.RateLimitRemainingHeader), 10);
     const settingsVersion: number = parseInt(response.headers.get(this.ConfigurationVersionHeader), 10);
-    return new Response(response.status, response.statusText, settingsVersion, await response.json())
+    return new Response(response.status, response.statusText, rateLimitRemaining, settingsVersion, await response.text())
   }
 }