Pass on upstream tool and version to bricks sync (#432)

Author: fjakobs

packages/databricks-vscode/src/cli/BricksTasks.test.ts

@@ -6,6 +6,7 @@ import {ProfileAuthProvider} from "../configuration/auth/AuthProvider";
 import type {ConnectionManager} from "../configuration/ConnectionManager";
 import {DatabricksWorkspace} from "../configuration/DatabricksWorkspace";
 import {SyncDestination} from "../configuration/SyncDestination";
+import {PackageMetaData} from "../utils/packageJsonUtils";
 import {LazyCustomSyncTerminal, SyncTask} from "./BricksTasks";
 import type {CliWrapper} from "./CliWrapper";
 
@@ -23,6 +24,7 @@ describe(__filename, () => {
             instance(connection),
             instance(cli),
             "incremental",
+            {} as PackageMetaData,
             () => {}
         );
 
@@ -78,6 +80,7 @@ describe(__filename, () => {
                 instance(connection),
                 instance(cli),
                 "full",
+                {} as PackageMetaData,
                 () => {}
             );
         });

packages/databricks-vscode/src/cli/BricksTasks.ts

@@ -17,6 +17,7 @@ import {BricksSyncParser} from "./BricksSyncParser";
 import {withLogContext} from "@databricks/databricks-sdk/dist/logging";
 import {Loggers} from "../logger";
 import {Context, context} from "@databricks/databricks-sdk/dist/context";
+import {PackageMetaData} from "../utils/packageJsonUtils";
 
 export const TaskSyncType = {
     syncFull: "sync-full",
@@ -34,6 +35,7 @@ export class SyncTask extends Task {
         connection: ConnectionManager,
         cli: CliWrapper,
         syncType: SyncType,
+        packageMetadata: PackageMetaData,
         syncStateCallback: (state: SyncState) => void
     ) {
         super(
@@ -49,6 +51,7 @@ export class SyncTask extends Task {
                     connection,
                     cli,
                     syncType,
+                    packageMetadata,
                     syncStateCallback
                 );
             })
@@ -175,6 +178,7 @@ export class LazyCustomSyncTerminal extends CustomSyncTerminal {
         private connection: ConnectionManager,
         private cli: CliWrapper,
         private syncType: SyncType,
+        private packageMetadata: PackageMetaData,
         syncStateCallback: (state: SyncState) => void
     ) {
         super("", [], {}, syncStateCallback);
@@ -251,6 +255,8 @@ export class LazyCustomSyncTerminal extends CustomSyncTerminal {
             env: {
                 /* eslint-disable @typescript-eslint/naming-convention */
                 BRICKS_ROOT: workspacePath,
+                BRICKS_UPSTREAM: "databricks-vscode",
+                BRICKS_UPSTREAM_VERSION: this.packageMetadata.version,
                 DATABRICKS_CONFIG_FILE: process.env.DATABRICKS_CONFIG_FILE,
                 HOME: process.env.HOME,
                 PATH: process.env.PATH,

packages/databricks-vscode/src/extension.ts

@@ -57,8 +57,9 @@ export async function activate(
         loggerManager.initLoggers();
     }
 
+    const packageMetadata = await PackageJsonUtils.getMetadata(context);
     NamedLogger.getOrCreate(Loggers.Extension).debug("Metadata", {
-        metadata: await PackageJsonUtils.getMetadata(context),
+        metadata: packageMetadata,
     });
 
     const configureAutocomplete = new ConfigureAutocomplete(
@@ -117,7 +118,11 @@ export async function activate(
         )
     );
 
-    const synchronizer = new CodeSynchronizer(connectionManager, cli);
+    const synchronizer = new CodeSynchronizer(
+        connectionManager,
+        cli,
+        packageMetadata
+    );
     const clusterModel = new ClusterModel(connectionManager);
 
     const connectionCommands = new ConnectionCommands(

packages/databricks-vscode/src/sync/CodeSynchronizer.ts

@@ -2,6 +2,7 @@ import {Disposable, Event, EventEmitter, TaskExecution, tasks} from "vscode";
 import {SyncTask, TaskSyncType} from "../cli/BricksTasks";
 import {CliWrapper} from "../cli/CliWrapper";
 import {ConnectionManager} from "../configuration/ConnectionManager";
+import {PackageMetaData} from "../utils/packageJsonUtils";
 
 export type SyncState =
     | "IN_PROGRESS"
@@ -25,7 +26,8 @@ export class CodeSynchronizer implements Disposable {
 
     constructor(
         private connection: ConnectionManager,
-        private cli: CliWrapper
+        private cli: CliWrapper,
+        private packageMetadata: PackageMetaData
     ) {
         this.disposables.push(
             this.connection.onDidChangeState(() => {
@@ -68,6 +70,7 @@ export class CodeSynchronizer implements Disposable {
             this.connection,
             this.cli,
             syncType,
+            this.packageMetadata,
             (state: SyncState) => {
                 this._state = state;
                 this._onDidChangeStateEmitter.fire(state);

packages/databricks-vscode/src/utils/packageJsonUtils.ts

@@ -9,14 +9,6 @@ interface ArchDetails {
     arch?: ArchType;
 }
 
-interface MetaData {
-    packageName: string;
-    version: string;
-    bricksArch?: string;
-    vsixArch?: string;
-    commitSha?: string;
-}
-
 // Possible values https://nodejs.org/api/process.html#processplatform
 export const nodeOsMap: Map<string, OsType> = new Map([
     ["darwin", "macos"],
@@ -51,6 +43,14 @@ export const vsixArchMap: Map<string, ArchDetails> = new Map([
     ["win32-ia32", {os: "windows", arch: "x86_32"}],
 ]);
 
+export interface PackageMetaData {
+    packageName: string;
+    version: string;
+    bricksArch?: string;
+    vsixArch?: string;
+    commitSha?: string;
+}
+
 function getNodeArchDetails(): ArchDetails {
     return {
         os: nodeOsMap.get(process.platform),
@@ -62,7 +62,9 @@ export function isEqual(l: ArchDetails, r: ArchDetails) {
     return l.os === r.os && l.arch === r.arch;
 }
 
-export async function getMetadata(context: ExtensionContext) {
+export async function getMetadata(
+    context: ExtensionContext
+): Promise<PackageMetaData> {
     const rawData = await fs.readFile(
         context.asAbsolutePath("./package.json"),
         {
@@ -82,7 +84,7 @@ export async function getMetadata(context: ExtensionContext) {
 
 export function getCorrectVsixInstallString(
     nodeArch: ArchDetails,
-    metaData: MetaData
+    metaData: PackageMetaData
 ): string | undefined {
     const correctVsix = Array.from(vsixArchMap.entries()).find((keyValue) =>
         isEqual(keyValue[1], nodeArch)
@@ -97,7 +99,7 @@ export function isCompatibleArchitecture(
     depName: string,
     depArch: ArchDetails | undefined,
     nodeArch: ArchDetails,
-    metaData: MetaData
+    metaData: PackageMetaData
 ) {
     if (depArch && !isEqual(depArch, nodeArch)) {
         window.showErrorMessage(
@@ -119,13 +121,15 @@ export async function checkArchCompat(context: ExtensionContext) {
     return (
         isCompatibleArchitecture(
             "extension",
-            vsixArchMap.get(metaData.vsixArch),
+            metaData.vsixArch ? vsixArchMap.get(metaData.vsixArch) : undefined,
             nodeArch,
             metaData
         ) &&
         isCompatibleArchitecture(
             "bricks-cli",
-            bricksArchMap.get(metaData.bricksArch),
+            metaData.bricksArch
+                ? bricksArchMap.get(metaData.bricksArch)
+                : undefined,
             nodeArch,
             metaData
         )