feat: refactored CLI binary location to be more resilient (#172)

Following options added to the settings * dataformExecutablePath * gcloudExecutablePath

Author: benjaminwestern

package.json

@@ -265,6 +265,18 @@
  "default": "global",
  "markdownDescription": "Dataform installation scope to use. Default to `global` which uses the dataform cli installed in global scope when running `dataform install -g @dataform/cli`. Selecting `local` scope would mean dataform cli installation in your workspace folder in `./node_modules/.bin/dataform` will be used. This is created when `npm install @dataform/cli` is ran from the root of the workspace folder."
  },
+ "vscode-dataform-tools.dataformExecutablePath": {
+ "type": "string",
+ "default": null,
+ "markdownDescription": "**Override path to dataform executable**\n\n⚠️ **Only use this if the extension cannot find dataform automatically**\n\nThe extension automatically searches:\n- System PATH\n- Common tool managers (mise, asdf, nvm, etc.)\n- Standard installation locations\n\nUse this setting for:\n- **Specific versions** for testing: `/path/to/dataform-v3.0.25`\n- **Company-approved versions**: `/opt/company-tools/dataform`\n- **Non-standard locations**: Custom installation paths\n\n**Example**: `/usr/local/bin/dataform` or `${HOME}/.local/share/mise/installs/npm-dataform-cli/3.0.26/bin/dataform`",
+ "pattern": "^.*dataform(?:\\.cmd|\\.exe)?$"
+ },
+ "vscode-dataform-tools.gcloudExecutablePath": {
+ "type": "string",
+ "default": null,
+ "markdownDescription": "**Override path to gcloud executable**\n\n⚠️ **Only use this if the extension cannot find gcloud automatically**\n\nThe extension automatically searches:\n- System PATH\n- Common tool managers (mise, asdf, etc.)\n- Standard gcloud installation locations\n\nUse this setting for:\n- **Specific versions** for testing: `/path/to/gcloud-v530.0.0`\n- **Company-approved versions**: `/opt/company-tools/gcloud`\n- **Non-standard locations**: Custom installation paths\n\n**Example**: `/usr/local/bin/gcloud` or `${HOME}/google-cloud-sdk/bin/gcloud`",
+ "pattern": "^.*gcloud(?:\\.cmd|\\.exe)?$"
+ },
  "vscode-dataform-tools.compileAndDryRunBeforeFormatting": {
  "type": "boolean",
  "default": true,

src/constants.ts

@@ -5,7 +5,7 @@ import { getWorkspaceFolder } from './utils';
 
 const tempDir = os.tmpdir();
 export const sqlFileToFormatPath = path.join(tempDir, "format.sql");
-export const executablesToCheck = ['dataform', 'gcloud'];
+export const executablesToCheck: ('dataform' | 'gcloud')[] = ['dataform', 'gcloud'];
 export const tableQueryOffset = 2;
 export const incrementalTableOffset = 1;
 export const assertionQueryOffset = 4;
@@ -105,15 +105,17 @@ export const sqlKeywordsToExcludeFromHoverDefinition = [
  "qualify"
 ];
 
+export const cacheDurationMs = 5 * 60 * 1000; // 5 minutes
 
-export async function getFileNotFoundErrorMessageForWebView(relativeFilePath:string){
 
- if(!workspaceFolder){
- workspaceFolder = await getWorkspaceFolder();
- }
- 
- // Create a single HTML string with the error message
- const errorMessage = `
+export async function getFileNotFoundErrorMessageForWebView(relativeFilePath: string) {
+
+ if (!workspaceFolder) {
+ workspaceFolder = await getWorkspaceFolder();
+ }
+
+ // Create a single HTML string with the error message
+ const errorMessage = `
  <div>
  <p>File <b>"${relativeFilePath}"</b> not found in Dataform compiled json with workspace folder <b>"${workspaceFolder}"</b></p>
  <p>Ignore the error if the file you are in is not expected to produce a sql output</p>
@@ -134,6 +136,6 @@ export async function getFileNotFoundErrorMessageForWebView(relativeFilePath:str
  </ol>
  </div>
  `;
- 
-  return errorMessage;
+
+ return errorMessage;
 }

src/extension.ts

@@ -38,7 +38,7 @@ export async function activate(context: vscode.ExtensionContext) {
  });
 
  globalThis.CACHED_COMPILED_DATAFORM_JSON = undefined as DataformCompiledJson | undefined;
- logger.debug('Initialized global cache');
+ logger.debug('Extension activated - initialized global cache (CACHED_COMPILED_DATAFORM_JSON = undefined)');
  globalThis.declarationsAndTargets = [] as string[];
  globalThis.dataformTags = [] as string[];
  globalThis.isRunningOnWindows = os.platform() === 'win32' ? true : false;
@@ -70,7 +70,8 @@ export async function activate(context: vscode.ExtensionContext) {
 
  for (let i = 0; i < executablesToCheck.length; i++) {
  let executable = executablesToCheck[i];
- executableIsAvailable(executable);
+ logger.debug(`Checking executable availability: ${executable}`);
+ executableIsAvailable(executable, true); // Show error if not found
  }
 
  // Clean up on deactivation

src/types.ts

@@ -17,10 +17,10 @@ export interface Table {
  incrementalPreOps: string[];
  dependencyTargets: Target[];
  bigquery: TableBigQueryConfig;
- actionDescriptor:ActionDescription;
+ actionDescriptor: ActionDescription;
 }
 
-export interface ActionDescription{
+export interface ActionDescription {
  description: string;
  columns: Column[]
 }
@@ -31,7 +31,7 @@ export interface Column {
 }
 
 export interface QueryMeta {
- type:string,
+ type: string,
  tableOrViewQuery: string
  nonIncrementalQuery: string
  incrementalQuery: string
@@ -117,7 +117,7 @@ export interface Operation {
  bigquery?: TableBigQueryConfig;
 }
 
-type GraphErrors  = {
+type GraphErrors = {
  compilationErrors: {
  fileName: string,
  message: string,
@@ -150,7 +150,7 @@ export interface ConfigBlockMetadata {
  exists: boolean;
 }
 
-interface BlockMeta{
+interface BlockMeta {
  startLine: number;
  endLine: number;
  exists: boolean;
@@ -189,20 +189,20 @@ export interface TableBigQueryConfig {
 }
 
 export type GraphError = {
- error: string;
- fileName: string;
+  error: string;
+  fileName: string;
 };
 
 export interface ColumnMetadata {
  name: string;
  type: string;
  mode?: string;
- description?:string;
+ description?: string;
 };
 
 export interface ErrorLocation {
-  line: number;
-  column: number;
+ line: number;
+ column: number;
 };
 
 interface DryRunErorr {
@@ -216,7 +216,7 @@ export interface BigQueryDryRunResponse {
  location: string | undefined;
  statistics: {
  totalBytesProcessed: number;
- cost?:{
+ cost?: {
  currency: string
  value: number
  };
@@ -227,11 +227,11 @@ export interface BigQueryDryRunResponse {
 }
 
 export interface CompiledQuerySchema {
- fields:  ColumnMetadata[];
+ fields: ColumnMetadata[];
 }
 
 export type Metadata = {
- type:string,
+ type: string,
  description: string,
  fullTableId: string,
 };
@@ -241,32 +241,32 @@ export type SchemaMetadata = {
 };
 
 export type CurrentFileMetadata = {
- isDataformWorkspace?: boolean;
- errors?: { errorGettingFileNameFromDocument?:string, dataformCompilationErrors?: GraphError[]; fileNotFoundError?: boolean; queryMetaError?: string | undefined}
- fileMetadata?: TablesWtFullQuery;
- possibleResolutions?: any[];
- dependents?: any;
- lineageMetadata?: {
- dependencies: undefined;
- error: undefined;
- };
- pathMeta?: {
- filename: string;
- extension: string;
- relativeFilePath: string;
- };
- document?: TextDocument;
+  isDataformWorkspace?: boolean;
+  errors?: { errorGettingFileNameFromDocument?: string, dataformCompilationErrors?: GraphError[]; fileNotFoundError?: boolean; queryMetaError?: string | undefined }
+  fileMetadata?: TablesWtFullQuery;
+  possibleResolutions?: any[];
+  dependents?: any;
+  lineageMetadata?: {
+  dependencies: undefined;
+  error: undefined;
+  };
+  pathMeta?: {
+  filename: string;
+  extension: string;
+  relativeFilePath: string;
+  };
+  document?: TextDocument;
 };
 
 export type TagDryRunStats = {
- type: string;
- targetName: string;
- costOfRunningModel: number;
- currency: SupportedCurrency;
- totalGBProcessed: string;
- totalBytesProcessedAccuracy: string | undefined;
- statementType: string | undefined;
- error: string
+  type: string;
+  targetName: string;
+  costOfRunningModel: number;
+  currency: SupportedCurrency;
+  totalGBProcessed: string;
+  totalBytesProcessedAccuracy: string | undefined;
+  statementType: string | undefined;
+  error: string
 };
 
 export type TagDryRunStatsMeta = {
@@ -275,13 +275,13 @@ export type TagDryRunStatsMeta = {
 };
 
 export const supportedCurrencies = {
- USD: "USD",
- EUR: "EUR",
- GBP: "GBP",
- JPY: "JPY",
- CAD: "CAD",
- AUD: "AUD",
- INR: "INR",
+  USD: "USD",
+  EUR: "EUR",
+  GBP: "GBP",
+  JPY: "JPY",
+  CAD: "CAD",
+  AUD: "AUD",
+  INR: "INR",
 } as const;
 
 export type SupportedCurrency = keyof typeof supportedCurrencies;
@@ -308,4 +308,12 @@ export type ErrorMeta = {
  nonIncrementalError?: DryRunError;
  incrementalError?: DryRunError;
  assertionError?: DryRunError;
-};
+};
+
+export type ExecutablePathInfo = {
+ path: string | null;
+ timestamp: number;
+};
+
+export type ExecutablePathCache = Map<string, ExecutablePathInfo>;
+