[Fix] Adding default sdk version incase config inspect returns null (#21449)

* Adding default sdk version incase config inspect returns null

* get the fallback version from package.json during runtime

* updating tests

* adding fall back version

* removing the parameter that can be accessed from constants directly

Author: ssreerama

extensions/sql-database-projects/src/controllers/projectController.ts

@@ -138,9 +138,7 @@ export class ProjectsController {
         }
 
         const sqlProjectsService = await utils.getSqlProjectsService();
-        const microsoftBuildSqlSDKStyleDefaultVersion = getMicrosoftBuildSqlVersion(
-            constants.microsoftBuildSqlVersionKey,
-        );
+        const microsoftBuildSqlSDKStyleDefaultVersion = getMicrosoftBuildSqlVersion();
         const projectStyle = creationParams.sdkStyle
             ? mssqlVscode.ProjectType.SdkStyle
             : mssqlVscode.ProjectType.LegacyStyle;

extensions/sql-database-projects/src/templates/templates.ts

@@ -86,12 +86,7 @@ export async function loadTemplates(templateFolderPath: string) {
         Promise.resolve(
             (newSdkSqlProjectTemplate = macroExpansion(
                 await loadTemplate(templateFolderPath, "newSdkSqlProjectTemplate.xml"),
-                new Map([
-                    [
-                        "MICROSOFT_BUILD_SQL_VERSION",
-                        getMicrosoftBuildSqlVersion(constants.microsoftBuildSqlVersionKey),
-                    ],
-                ]),
+                new Map([["MICROSOFT_BUILD_SQL_VERSION", getMicrosoftBuildSqlVersion()]]),
             )),
         ),
         loadObjectTypeInfo(

extensions/sql-database-projects/src/tools/buildHelper.ts

@@ -69,8 +69,7 @@ export class BuildHelper {
             "Microsoft.SqlServer.Server.dll",
         ];
 
-        const sdkVersion = getMicrosoftBuildSqlVersion(constants.microsoftBuildSqlVersionKey);
-
+        const sdkVersion = getMicrosoftBuildSqlVersion();
         const microsoftBuildSqlDllLocation = path.join("tools", "net8.0");
         return this.ensureNugetAndFilesPresence(
             sdkName,

extensions/sql-database-projects/src/tools/netcoreTool.ts

@@ -17,6 +17,7 @@ import {
     DotnetInstallationConfirmation,
     NetCoreSupportedVersionInstallationConfirmation,
     UpdateDotnetLocation,
+    microsoftBuildSqlVersionKey,
 } from "../common/constants";
 import * as utils from "../common/utils";
 import { ShellCommandOptions, ShellExecutionHelper } from "./shellExecutionHelper";
@@ -32,6 +33,13 @@ export const macPlatform = "darwin";
 export const linuxPlatform = "linux";
 export const minSupportedNetCoreVersionForBuild = "8.0.0";
 
+/**
+ * Fallback version for Microsoft.Build.Sql when the setting is not configured or invalid.
+ * NOTE: Keep this in sync with the default value in package.json:
+ * sqlDatabaseProjects.microsoftBuildSqlVersion.default
+ */
+export const FALLBACK_MICROSOFT_BUILD_SQL_VERSION = "2.1.0";
+
 export const enum netCoreInstallState {
     netCoreNotPresent,
     netCoreVersionNotSupported,
@@ -41,18 +49,24 @@ export const enum netCoreInstallState {
 const dotnet = os.platform() === "win32" ? "dotnet.exe" : "dotnet";
 
 /**
- * Returns the configured Microsoft.Build.Sql version, falling back to the extension's
- * registered default (from package.json) when the setting is blank or not a valid semver.
+ * Returns the configured Microsoft.Build.Sql version.
+ *
+ * Resolution order:
+ * 1. User's configured value (global or workspace settings.json) — if it is a valid semver.
+ * 2. Package.json default value — returned by config.get() when the user has not overridden the setting.
+ * 3. FALLBACK_MICROSOFT_BUILD_SQL_VERSION — used only when both of the above are unavailable or
+ *    not a valid semver (e.g. the extension package.json default is missing or the user typed an
+ *    invalid version string).
  */
-export function getMicrosoftBuildSqlVersion(microsoftBuildSqlVersionKey: string): string {
+export function getMicrosoftBuildSqlVersion(): string {
     const config = vscode.workspace.getConfiguration(DBProjectConfigurationKey);
     const configured = config.get<string>(microsoftBuildSqlVersionKey)?.trim();
     if (configured && semver.valid(configured)) {
         return configured;
     }
-    // Fall back to the default registered in package.json
-    const defaultValue = config.inspect<string>(microsoftBuildSqlVersionKey)?.defaultValue ?? "";
-    return defaultValue;
+
+    // Fall back to the hardcoded constant if config value is unavailable or invalid
+    return FALLBACK_MICROSOFT_BUILD_SQL_VERSION;
 }
 
 export class NetCoreTool extends ShellExecutionHelper {

extensions/sql-database-projects/test/netCoreTool.test.ts

@@ -13,8 +13,11 @@ import {
     NetCoreTool,
     DBProjectConfigurationKey,
     DotnetInstallLocationKey,
+    FALLBACK_MICROSOFT_BUILD_SQL_VERSION,
+    getMicrosoftBuildSqlVersion,
 } from "../src/tools/netcoreTool";
 import { getQuotedPath } from "../src/common/utils";
+import * as constants from "../src/common/constants";
 import { deleteGeneratedTestFolder, generateTestFolderPath } from "./testUtils";
 import { createContext, TestContext } from "./testContext";
 
@@ -102,4 +105,58 @@ suite("NetCoreTool: Net core tests", function (): void {
             }
         }
     });
+
+    suite("getMicrosoftBuildSqlVersion tests", function (): void {
+        teardown(async function (): Promise<void> {
+            // Clean up configuration after each test
+            await vscode.workspace
+                .getConfiguration(DBProjectConfigurationKey)
+                .update(
+                    constants.microsoftBuildSqlVersionKey,
+                    undefined,
+                    vscode.ConfigurationTarget.Global,
+                );
+        });
+
+        test("Should return valid configured value when set", async function (): Promise<void> {
+            // Arrange: Set a valid semver version
+            await vscode.workspace
+                .getConfiguration(DBProjectConfigurationKey)
+                .update(
+                    constants.microsoftBuildSqlVersionKey,
+                    "3.0.0",
+                    vscode.ConfigurationTarget.Global,
+                );
+
+            // Act
+            const result = getMicrosoftBuildSqlVersion();
+
+            // Assert
+            expect(result).to.equal("3.0.0");
+        });
+
+        test("Should fall back to FALLBACK_MICROSOFT_BUILD_SQL_VERSION when configured value is invalid or empty", async function (): Promise<void> {
+            // Test with invalid semver
+            await vscode.workspace
+                .getConfiguration(DBProjectConfigurationKey)
+                .update(
+                    constants.microsoftBuildSqlVersionKey,
+                    "not-a-valid-version",
+                    vscode.ConfigurationTarget.Global,
+                );
+            let result = getMicrosoftBuildSqlVersion();
+            expect(result).to.equal(FALLBACK_MICROSOFT_BUILD_SQL_VERSION);
+
+            // Test with empty config
+            await vscode.workspace
+                .getConfiguration(DBProjectConfigurationKey)
+                .update(
+                    constants.microsoftBuildSqlVersionKey,
+                    undefined,
+                    vscode.ConfigurationTarget.Global,
+                );
+            result = getMicrosoftBuildSqlVersion();
+            expect(result).to.equal(FALLBACK_MICROSOFT_BUILD_SQL_VERSION);
+        });
+    });
 });