Fix parsing .databrickscfg profiles that contain a dot (#498)

fixes #497

Author: fjakobs

packages/databricks-sdk-js/src/config/KnownConfigLoader.test.ts

@@ -0,0 +1,22 @@
+import {parse} from "ini";
+import assert from "node:assert";
+import {flattenIniObject} from "./KnownConfigLoader";
+
+describe(__filename, () => {
+    it("should handle profiles with a dot in the name", () => {
+        const config = flattenIniObject(
+            parse(`[foo.bar]
+host = https://foo.bar
+
+[.foo]
+host = https://foo
+
+[bar]
+host = https://bar`)
+        );
+
+        assert.equal(config["foo.bar"].host, "https://foo.bar");
+        assert.equal(config[".foo"].host, "https://foo");
+        assert.equal(config["bar"].host, "https://bar");
+    });
+});

packages/databricks-sdk-js/src/config/KnownConfigLoader.ts

@@ -25,8 +25,8 @@ export class KnownConfigLoader implements Loader {
             return;
         }
 
-        const iniFile = parse(
-            await fs.readFile(configPath, {encoding: "utf-8"})
+        const iniFile = flattenIniObject(
+            parse(await fs.readFile(configPath, {encoding: "utf-8"}))
         );
 
         const profile = cfg.profile || "DEFAULT";
@@ -49,3 +49,44 @@ export class KnownConfigLoader implements Loader {
         cfg.attributes.resolveFromStringMap(iniFile[profile]);
     }
 }
+
+/**
+ * The ini library encodes dots as nested objects, which is not what we want.
+ * See: https://github.com/npm/ini/issues/22
+ *
+ * Reduce the nested object back to a flat object by concatenating object keys with a `.`
+ */
+export function flattenIniObject(obj: {[key: string]: any}): {
+    [key: string]: any;
+} {
+    function _flattenIniObject(
+        obj: {
+            [key: string]: any;
+        },
+        topLevel: Array<string> = [],
+        resp = {}
+    ) {
+        const props: Record<string, any> = {};
+        for (const key in obj) {
+            if (typeof obj[key] === "object") {
+                topLevel.push(key);
+                resp = {
+                    ...resp,
+                    ..._flattenIniObject(obj[key], topLevel, resp),
+                };
+            } else {
+                props[key] = obj[key];
+            }
+        }
+
+        const topLevelName = topLevel.join(".");
+        if (topLevelName !== "" && Object.keys(props).length > 0) {
+            resp = {...resp, [topLevelName]: props};
+        }
+
+        topLevel.pop();
+        return resp;
+    }
+
+    return _flattenIniObject(obj);
+}

packages/databricks-sdk-js/src/config/testdata/.databrickscfg

@@ -34,4 +34,8 @@ azure_client_secret = 10000002
 
 [gcp-example]
 host = https://123.4.gcp.databricks.com/
-google_credentials = paw48590aw8e09t8apu
+google_credentials = paw48590aw8e09t8apu
+
+[pat.with.dot]
+host = https://dbc-XXXXXXXX-YYYY.cloud.databricks.com/
+token = PT0+IC9kZXYvdXJhbmRvbSA8PT0KYFZ

packages/databricks-sdk-js/src/config/testdata/unified-auth-cases.json

@@ -129,6 +129,15 @@
             },
             "assert_error": "default auth: cannot configure default credentials. Config: token=***, profile=nohost. Env: DATABRICKS_CONFIG_PROFILE"
         },
+        {
+            "name": "TestConfig_PatFromDatabricksCfg_DotProfile",
+            "env": {
+                "DATABRICKS_CONFIG_PROFILE": "pat.with.dot",
+                "HOME": "testdata"
+            },
+            "assert_auth": "pat",
+            "assert_host": "https://dbc-XXXXXXXX-YYYY.cloud.databricks.com"
+        },
         {
             "name": "TestConfig_ConfigProfileAndToken",
             "env": {

packages/databricks-vscode/package.json

@@ -707,4 +707,4 @@
         ],
         "report-dir": "coverage"
     }
-}
+}