Added unified User-Agent HTTP header (#52)

* Implements concepts of _product name_ and _product version_.
* Dynamically fetches VSCode extension version.
* Dynamically tracks SDK version.
* Dynamically tracks NodeJS version.
* Dynamically tracks OS name.

Author: nfx

packages/databricks-sdk-js/src/api-client.test.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import assert from "node:assert";
+import {ApiClient} from "./api-client";
+
+const sdkVersion = require("../package.json").version;
+
+describe(__filename, () => {
+    beforeEach(() => {
+        delete process.env.DATABRICKS_CONFIG_FILE;
+    });
+
+    it("should create proper user agent", () => {
+        let ua = new ApiClient("unit", "3.4.5").userAgent();
+        assert.equal(
+            ua,
+            `unit/3.4.5 databricks-sdk-js/${sdkVersion} nodejs/${process.version.slice(
+                1
+            )} os/${process.platform}`
+        );
+    });
+});

packages/databricks-sdk-js/src/api-client.ts

@@ -3,6 +3,8 @@ import fetch from "node-fetch";
 import {TextDecoder} from "node:util";
 import {fromDefaultChain} from "./auth/fromChain";
 
+const sdkVersion = require("../package.json").version;
+
 type HttpMethod = "POST" | "GET";
 
 export class HttpError extends Error {
@@ -16,7 +18,23 @@ export class HttpError extends Error {
 }
 
 export class ApiClient {
-    constructor(private credentialProvider = fromDefaultChain) {}
+    constructor(
+        private readonly product: string,
+        private readonly productVersion: string,
+        private credentialProvider = fromDefaultChain
+    ) {}
+
+    userAgent(): string {
+        let pairs = [
+            `${this.product}/${this.productVersion}`,
+            `databricks-sdk-js/${sdkVersion}`,
+            `nodejs/${process.version.slice(1)}`,
+            `os/${process.platform}`,
+        ];
+        // TODO: add ability of per-request extra-information,
+        // so that we can track sub-functionality, like in Terraform
+        return pairs.join(" ");
+    }
 
     async request(
         path: string,
@@ -26,7 +44,7 @@ export class ApiClient {
         const credentials = await this.credentialProvider();
         const headers = {
             "Authorization": `Bearer ${credentials.token}`,
-            "User-Agent": `vscode-notebook`,
+            "User-Agent": this.userAgent(),
             "Content-Type": "text/json",
         };
 

packages/databricks-sdk-js/src/test/IntegrationTestSetup.ts

@@ -15,7 +15,7 @@ export class IntegrationTestSetup {
     private static _instance: IntegrationTestSetup;
     static async getInstance(): Promise<IntegrationTestSetup> {
         if (!this._instance) {
-            let client = new ApiClient();
+            let client = new ApiClient("integration-tests", "0.0.1");
 
             if (!process.env["TEST_DEFAULT_CLUSTER_ID"]) {
                 throw new Error(

packages/databricks-vscode/src/configuration/ConnectionManager.ts

@@ -3,6 +3,7 @@ import {
     Cluster,
     fromConfigFile,
     ScimService,
+    CredentialProvider,
 } from "@databricks/databricks-sdk";
 import {
     commands,
@@ -16,6 +17,8 @@ import {PathMapper} from "./PathMapper";
 import {ProjectConfigFile} from "./ProjectConfigFile";
 import {selectProfile} from "./selectProfileWizard";
 
+const extensionVersion = require("../../package.json").version;
+
 export type ConnectionState = "CONNECTED" | "CONNECTING" | "DISCONNECTED";
 
 /**
@@ -68,6 +71,10 @@ export class ConnectionManager {
         return this._apiClient;
     }
 
+    private apiClientFrom(creds: CredentialProvider): ApiClient {
+        return new ApiClient("vscode-extension", extensionVersion, creds);
+    }
+
     async login(interactive: boolean = false): Promise<void> {
         await this.logout();
 
@@ -97,7 +104,7 @@ export class ConnectionManager {
 
             await credentialProvider();
 
-            apiClient = new ApiClient(credentialProvider);
+            apiClient = this.apiClientFrom(credentialProvider);
             this._me = await this.getMe(apiClient);
         } catch (e: any) {
             const message = `Can't login to Databricks: ${e.message}`;
@@ -149,7 +156,7 @@ export class ConnectionManager {
             }
 
             try {
-                await this.getMe(new ApiClient(fromConfigFile(profile)));
+                await this.getMe(this.apiClientFrom(fromConfigFile(profile)));
             } catch (e: any) {
                 console.error(e);
                 const response = await window.showWarningMessage(