Merge branch 'main' into readme-logging

__tests__/functional/client-configuration.test.ts

@@ -110,9 +110,6 @@ an environmental variable named FAUNA_SECRET or pass it to the Client constructo
       },
 
       close() {},
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
 
     const client = getClient(
@@ -150,9 +147,6 @@ an environmental variable named FAUNA_SECRET or pass it to the Client constructo
         },
 
         close() {},
-        getURL(): string {
-          return "https://foo.com/bar";
-        },
       };
 
       const client = getClient(

__tests__/functional/feed-client.test.ts

@@ -31,7 +31,6 @@ const mockHttpClient = {
     .fn()
     .mockImplementation(() => Promise.resolve({ ...mockHttpResponse })),
   close: jest.fn(),
-  getURL: jest.fn(() => "bar"),
 };
 
 const defaultConfig: FeedClientConfiguration = {

__tests__/integration/client-last-txn-tracking.test.ts

@@ -15,9 +15,6 @@ describe("last_txn_ts tracking in client", () => {
       },
 
       close() {},
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
 
     const myClient = getClient(
@@ -66,9 +63,6 @@ describe("last_txn_ts tracking in client", () => {
       },
 
       close() {},
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
 
     const myClient = getClient(

__tests__/integration/query.test.ts

@@ -140,9 +140,6 @@ describe("query", () => {
           return dummyResponse;
         },
         close() {},
-        getURL(): string {
-          return "http://foo.com/bar";
-        },
       };
       const clientConfiguration: Partial<ClientConfiguration> = {
         linearized: true,
@@ -166,9 +163,6 @@ describe("query", () => {
         return dummyResponse;
       },
       close() {},
-      getURL() {
-        return "http://foo.com/bar";
-      },
     };
 
     let clientConfiguration: Partial<ClientConfiguration> = {
@@ -277,9 +271,6 @@ describe("query", () => {
           );
         },
         close() {},
-        getURL() {
-          return "http://foo.com/bar";
-        },
       };
       badClient = getClient({}, httpClient);
       await badClient.query(fql`"dummy"`);
@@ -388,9 +379,6 @@ describe("query", () => {
         return httpClient.request(badRequest);
       },
       close() {},
-      getURL() {
-        return "http://foo.com/bar";
-      },
     };
 
     const badClient = getClient({}, badHTTPClient);
@@ -412,9 +400,6 @@ describe("query", () => {
         throw new Error("boom!");
       },
       close() {},
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
     const badClient = getClient(
       {

__tests__/integration/set.test.ts

@@ -213,9 +213,6 @@ describe("SetIterator", () => {
       close() {
         return;
       },
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
     const testClient = getClient({}, httpClient);
 
@@ -251,9 +248,6 @@ describe("SetIterator", () => {
       close() {
         return;
       },
-      getURL(): string {
-        return "http://foo.com/bar";
-      },
     };
     const testClient = getClient({}, httpClient);
 

__tests__/unit/query.test.ts

@@ -5,6 +5,7 @@ import {
   AuthorizationError,
   FetchClient,
   fql,
+  ProtocolError,
   QueryTimeoutError,
   ServiceError,
   ServiceInternalError,
@@ -123,6 +124,25 @@ describe("query", () => {
     expect(actual.summary).toEqual("the summary");
   });
 
+  it("Throws ProtocolError on an empty 200 response", async () => {
+    expect.assertions(2);
+    fetchMock.mockResponse("", {
+      status: 200,
+      headers: [["content-length", "0"]],
+    });
+    try {
+      const result = await client.query(fql`'foo'.length`);
+      console.log("result", result);
+    } catch (e) {
+      if (e instanceof ProtocolError) {
+        expect(e.message).toEqual(
+          "There was an issue communicating with Fauna. Response is empty. Please try again.",
+        );
+        expect(e.httpStatus).toEqual(500);
+      }
+    }
+  });
+
   // it("throws an NetworkError on a timeout", async () => {
   //   expect.assertions(2);
   //   // axios mock adapater currently has a bug that cannot match

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fauna",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "description": "A driver to query Fauna databases in browsers, Node.js, and other Javascript runtimes",
   "homepage": "https://fauna.com",
   "bugs": {

src/client.ts

@@ -1,62 +1,63 @@
 import {
-  ClientConfiguration,
-  FeedClientConfiguration,
-  StreamClientConfiguration,
   endpoints,
+  type ClientConfiguration,
+  type FeedClientConfiguration,
+  type StreamClientConfiguration,
 } from "./client-configuration";
 import {
   ClientClosedError,
   ClientError,
   FaunaError,
+  getServiceError,
   NetworkError,
   ProtocolError,
   ServiceError,
   ThrottlingError,
-  getServiceError,
 } from "./errors";
 import {
   FaunaAPIPaths,
-  HTTPRequest,
-  HTTPStreamClient,
   StreamAdapter,
   getDefaultHTTPClient,
   isHTTPResponse,
   isStreamClient,
   type HTTPClient,
-  HTTPResponse,
+  type HTTPRequest,
+  type HTTPResponse,
+  type HTTPStreamRequest,
+  type HTTPStreamClient,
 } from "./http-client";
 import { Query } from "./query-builder";
 import { TaggedTypeFormat } from "./tagged-type";
 import { getDriverEnv } from "./util/environment";
 import { withRetries } from "./util/retryable";
 import {
-  EmbeddedSet,
-  EventSource,
   FeedPage,
+  isEventSource,
   Page,
   SetIterator,
-  isEventSource,
+  type EmbeddedSet,
+  type EventSource,
 } from "./values";
 import {
-  EncodedObject,
-  FeedError,
-  FeedRequest,
-  FeedSuccess,
-  QueryOptions,
-  QueryRequest,
-  StreamEvent,
-  StreamEventData,
-  StreamEventStatus,
   isQueryFailure,
   isQuerySuccess,
+  type EncodedObject,
+  type FeedError,
+  type FeedRequest,
+  type FeedSuccess,
+  type QueryOptions,
+  type QueryRequest,
   type QuerySuccess,
   type QueryValue,
+  type StreamEvent,
+  type StreamEventData,
+  type StreamEventStatus,
 } from "./wire-protocol";
 import {
   ConsoleLogHandler,
   parseDebugLevel,
-  LogHandler,
   LOG_LEVELS,
+  type LogHandler,
 } from "./util/logging";
 
 type RequiredClientConfig = ClientConfiguration &
@@ -617,10 +618,9 @@ in an environmental variable named FAUNA_SECRET or pass it to the Client\
         this.#clientConfiguration.client_timeout_buffer_ms;
       const method = "POST";
       this.#clientConfiguration.logger.debug(
-        "Fauna HTTP %s Request to %s (timeout: %s), headers: %s",
+        "Fauna HTTP %s request to %s (timeout: %s), headers: %s",
         method,
-        this.#httpClient.getURL(),
-        this.#clientConfiguration.endpoint.toString(),
+        FaunaAPIPaths.QUERY,
         client_timeout_ms.toString(),
         JSON.stringify(headers),
       );
@@ -633,12 +633,25 @@ in an environmental variable named FAUNA_SECRET or pass it to the Client\
       });
 
       this.#clientConfiguration.logger.debug(
-        "Fauna HTTP Response %s from %s, headers: %s",
+        "Fauna HTTP response %s from %s, headers: %s",
         response.status,
-        this.#httpClient.getURL(),
+        FaunaAPIPaths.QUERY,
         JSON.stringify(response.headers),
       );
 
+      // Receiving a 200 with no body/content indicates an issue with core router
+      if (
+        response.status === 200 &&
+        (response.body.length === 0 ||
+          response.headers["content-length"] === "0")
+      ) {
+        throw new ProtocolError({
+          message:
+            "There was an issue communicating with Fauna. Response is empty. Please try again.",
+          httpStatus: 500,
+        });
+      }
+
       let parsedResponse;
       try {
         parsedResponse = {
@@ -915,18 +928,25 @@ export class StreamClient<T extends QueryValue = any> {
     const headers = {
       Authorization: `Bearer ${this.#clientConfiguration.secret}`,
     };
-
-    const streamAdapter = this.#clientConfiguration.httpStreamClient.stream({
+    const request: HTTPStreamRequest = {
       data: {
         token: eventSource.token,
         cursor: this.#last_cursor || this.#clientConfiguration.cursor,
       },
       headers,
       method: "POST",
-    });
-
+    };
+    const streamAdapter =
+      this.#clientConfiguration.httpStreamClient.stream(request);
     this.#streamAdapter = streamAdapter;
 
+    this.#clientConfiguration.logger.debug(
+      "Fauna HTTP %s request to '%s', headers: %s",
+      request.method,
+      FaunaAPIPaths.STREAM,
+      JSON.stringify(request.headers),
+    );
+
     for await (const event of streamAdapter.read) {
       // stream events are always tagged
       const deserializedEvent: StreamEvent<T> = TaggedTypeFormat.decode(event, {
@@ -996,8 +1016,6 @@ export class FeedClient<T extends QueryValue = any> {
   #query: () => Promise<EventSource>;
   /** The event feed's client options */
   #clientConfiguration: FeedClientConfiguration;
-  /** A LogHandler instance */
-  #logger: LogHandler;
   /** The last `cursor` value received for the current page */
   #lastCursor?: string;
   /** A saved copy of the EventSource once received */
@@ -1026,7 +1044,6 @@ export class FeedClient<T extends QueryValue = any> {
 
     this.#clientConfiguration = clientConfiguration;
     this.#lastCursor = clientConfiguration.cursor;
-    this.#logger = clientConfiguration.logger;
 
     this.#validateConfiguration();
   }
@@ -1098,10 +1115,10 @@ export class FeedClient<T extends QueryValue = any> {
 
     const request: HTTPRequest<FeedRequest> = await this.#nextPageHttpRequest();
 
-    this.#logger.debug(
-      "Fauna HTTP %s Request to %s (timeout: %s), headers: %s",
+    this.#clientConfiguration.logger.debug(
+      "Fauna HTTP %s request to '%s' (timeout: %s), headers: %s",
       request.method,
-      httpClient.getURL(),
+      FaunaAPIPaths.EVENT_FEED,
       request.client_timeout_ms,
       JSON.stringify(request.headers),
     );
@@ -1110,10 +1127,10 @@ export class FeedClient<T extends QueryValue = any> {
       maxBackoff: this.#clientConfiguration.max_backoff,
       shouldRetry: (error) => error instanceof ThrottlingError,
     });
-    this.#logger.debug(
-      "Fauna HTTP Response %s from %s, headers: %s",
+    this.#clientConfiguration.logger.debug(
+      "Fauna HTTP response '%s' from %s, headers: %s",
       response.status,
-      httpClient.getURL(),
+      FaunaAPIPaths.EVENT_FEED,
       JSON.stringify(response.headers),
     );
 

src/http-client/fetch-client.ts

@@ -32,10 +32,6 @@ export class FetchClient implements HTTPClient, HTTPStreamClient {
     return new URL(path, this.#baseUrl).toString();
   }
 
-  getURL(): string {
-    return this.#resolveURL(this.#defaultRequestPath);
-  }
-
   /** {@inheritDoc HTTPClient.request} */
   async request<T = QueryRequest>({
     data,

src/http-client/http-client.ts

@@ -68,11 +68,6 @@ export interface HTTPClient {
    * is a no-op as there is no shared resource to close.
    */
   close(): void;
-
-  /**
-   * Return the full URL (path and endpoint) for the query endpoint for this client.
-   */
-  getURL(): string;
 }
 
 /**

src/http-client/node-http2-client.ts

@@ -54,10 +54,6 @@ export class NodeHTTP2Client implements HTTPClient, HTTPStreamClient {
     this.#session = null;
   }
 
-  getURL(): string {
-    return this.#url;
-  }
-
   /**
    * Gets a {@link NodeHTTP2Client} matching the {@link HTTPClientOptions}
    * @param httpClientOptions - the {@link HTTPClientOptions}

src/util/package-version.ts

@@ -1,4 +1,4 @@
 //THIS FILE IS AUTOGENERATED. DO NOT EDIT. SEE .husky/pre-commit
 
 /** The current package version. */
-export const packageVersion = "2.4.0";
+export const packageVersion = "2.4.1";