endpoint falls back to FAUNA_ENDPOINT env variable (#206)

fauna · Aug 31, 2023 · 9d87555 · 9d87555
1 parent c5dacdd
commit 9d87555
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 6 deletions.
diff --git a/__tests__/functional/client-configuration.test.ts b/__tests__/functional/client-configuration.test.ts
@@ -15,6 +15,10 @@ beforeEach(() => {
   process.env = { ...PROCESS_ENV };
 });
 
+afterEach(() => {
+  process.env = PROCESS_ENV;
+});
+
 describe("ClientConfiguration", () => {
   it("Client exposes a default client configuration", () => {
     process.env["FAUNA_SECRET"] = "foo";
@@ -24,6 +28,15 @@ describe("ClientConfiguration", () => {
     );
   });
 
+  it("can be initialized with an endpoint from the environment", async () => {
+    process.env["FAUNA_ENDPOINT"] = "https://localhost:9999/";
+
+    const client = new Client({ secret: "secret" });
+    expect(client.clientConfiguration.endpoint?.toString()).toEqual(
+      "https://localhost:9999/"
+    );
+  });
+
   it("Client respectes passed in client configuration over defaults", () => {
     // TODO: when the Client accepts an http client add a mock that validates
     //   the configuration changes were applied.

diff --git a/src/client.ts b/src/client.ts
@@ -55,10 +55,9 @@ type RequiredClientConfig = ClientConfiguration &
 
 const DEFAULT_CLIENT_CONFIG: Omit<
   ClientConfiguration & RequiredClientConfig,
-  "secret"
+  "secret" | "endpoint"
 > = {
   client_timeout_buffer_ms: 5000,
-  endpoint: endpoints.default,
   format: "tagged",
   http2_session_idle_ms: 5000,
   http2_max_streams: 100,
@@ -106,6 +105,7 @@ export class Client {
       ...DEFAULT_CLIENT_CONFIG,
       ...clientConfiguration,
       secret: this.#getSecret(clientConfiguration),
+      endpoint: this.#getEndpoint(clientConfiguration),
     };
 
     this.#validateConfiguration();
@@ -295,20 +295,20 @@ export class Client {
   }
 
   #getSecret(partialClientConfig?: ClientConfiguration): string {
-    let fallback = undefined;
+    let env_secret = undefined;
     if (
       typeof process !== "undefined" &&
       process &&
       typeof process === "object" &&
       process.env &&
       typeof process.env === "object"
     ) {
-      fallback = process.env["FAUNA_SECRET"];
+      env_secret = process.env["FAUNA_SECRET"];
     }
 
-    const maybeSecret = partialClientConfig?.secret || fallback;
+    const maybeSecret = partialClientConfig?.secret ?? env_secret;
     if (maybeSecret === undefined) {
-      throw new Error(
+      throw new TypeError(
         "You must provide a secret to the driver. Set it \
 in an environmental variable named FAUNA_SECRET or pass it to the Client\
  constructor."
@@ -317,6 +317,35 @@ in an environmental variable named FAUNA_SECRET or pass it to the Client\
     return maybeSecret;
   }
 
+  #getEndpoint(partialClientConfig?: ClientConfiguration): URL {
+    // If the user explicitly sets the endpoint to undefined, we should throw a
+    // TypeError, rather than override with the default endpoint.
+    if (
+      partialClientConfig &&
+      "endpoint" in partialClientConfig &&
+      partialClientConfig.endpoint === undefined
+    ) {
+      throw new TypeError(
+        `ClientConfiguration option endpoint must be defined.`
+      );
+    }
+
+    let env_endpoint: URL | undefined = undefined;
+    if (
+      typeof process !== "undefined" &&
+      process &&
+      typeof process === "object" &&
+      process.env &&
+      typeof process.env === "object"
+    ) {
+      env_endpoint = process.env["FAUNA_ENDPOINT"]
+        ? new URL(process.env["FAUNA_ENDPOINT"])
+        : undefined;
+    }
+
+    return partialClientConfig?.endpoint ?? env_endpoint ?? endpoints.default;
+  }
+
   #getServiceError(failure: QueryFailure, httpStatus: number): ServiceError {
     switch (httpStatus) {
       case 400: