add support for connection strings

Author: shivaji-kharse

src/clientStubFromSlash.ts

@@ -7,7 +7,20 @@ import * as grpc from "@grpc/grpc-js"
 import * as Url from "url-parse"
 import { DgraphClientStub } from "./clientStub"
 
-const PORT = "443"
+const PORT = 443
+// Constants for Dgraph client configuration
+const cloudPort = "443"
+const dgraphScheme = "dgraph"
+
+// Optional parameters for connection string
+const cloudAPIKeyParam = "apikey" // Parameter for providing a Dgraph Cloud API key
+const bearerTokenParam = "bearertoken" // Parameter for providing an access token
+
+// SSL mode parameters
+const sslModeParam = "sslmode" // Parameter for providing a Dgraph SSL mode
+const sslModeDisable = "disable" // Disable SSL
+const sslModeRequire = "require" // Require SSL without certificate verification
+const sslModeVerifyCA = "verify-ca" // Require SSL with certificate verification
 /**
  * @deprecated since v21.3 and will be removed in v21.07 release.
  *     Please use {@link clientStubFromCloudEndpoint} instead.
@@ -37,3 +50,60 @@ export function clientStubFromCloudEndpoint(graphqlEndpoint: string, apiKey: str
   )
   return new DgraphClientStub(backenedURL, credentials)
 }
+
+export function clientStubFromConnectionString(connStr: string): DgraphClientStub {
+  const parsedUrl = new URL(connStr)
+
+  if (parsedUrl.protocol !== dgraphScheme) {
+    throw new Error("Invalid scheme: must start with dgraph://")
+  }
+
+  const host = parsedUrl.hostname
+  const port = parsedUrl.port || "9080"
+
+  const queryParams = parsedUrl.searchParams
+  const bearerToken = queryParams.get(bearerTokenParam) || ""
+  const apiKey = queryParams.get(cloudAPIKeyParam) || ""
+
+  if (apiKey !== "" && bearerToken != "") {
+    throw new Error(`invalid connection string: both apikey and bearertoken cannot be provided`)
+  }
+
+  const sslMode = queryParams.get("sslmode") || "disable"
+
+  // Validate SSL mode
+  const validSslModes = ["disable", "require", "verify-ca"]
+  if (!validSslModes.includes(sslMode)) {
+    throw new Error(`Invalid SSL mode: ${sslMode} (must be one of ${validSslModes.join(", ")})`)
+  }
+
+  // Set up gRPC credentials based on SSL mode
+  let credentials: grpc.ChannelCredentials
+  switch (sslMode) {
+    case "disable":
+      credentials = grpc.credentials.createInsecure()
+      break
+    case "require":
+      credentials = grpc.credentials.createSsl()
+      break
+    case "verify-ca":
+      credentials = grpc.credentials.createSsl(null, null, null, {
+        checkServerIdentity: () => null,
+      })
+      break
+    default:
+      throw new Error(`Unsupported SSL mode: ${sslMode}`)
+  }
+
+  const username = parsedUrl.username
+  const password = parsedUrl.password
+
+  const stub = new DgraphClientStub(`${host}:${port}`, credentials)
+  if (username && password) {
+    stub.login(username, password).catch((err) => {
+      throw new Error(`Failed to sign in user: ${err.message}`)
+    })
+  }
+
+  return stub
+}