Using required constants throught the shared interfaces.

ssreerama · ssreerama · commit 95e62d68a536 · 2025-10-09T13:13:36.000-05:00
diff --git a/src/constants/constants.ts b/src/constants/constants.ts
@@ -319,12 +319,6 @@ export const DBProjectConfigurationKey = "sqlDatabaseProjects";
 export const enablePreviewFeaturesKey = "enablePreviewFeatures";
 export const AzureSqlV12 = "AzureV12";
 
-export const PublishTargets = {
-    EXISTING_SERVER: "existingServer" as const,
-    LOCAL_CONTAINER: "localContainer" as const,
-    NEW_AZURE_SERVER: "newAzureServer" as const,
-} as const;
-export type PublishTargetType = (typeof PublishTargets)[keyof typeof PublishTargets];
 export const PublishFormFields = {
     PublishProfilePath: "publishProfilePath",
     ServerName: "serverName",
@@ -337,10 +331,6 @@ export const PublishFormFields = {
     ContainerImageTag: "containerImageTag",
     AcceptContainerLicense: "acceptContainerLicense",
 } as const;
-
-// Group of all container-specific publish form field identifiers used together when
-// the target is a local container. Centralizing this list avoids duplication in
-// controllers (e.g., building active component arrays and computing hidden fields).
 export const PublishFormContainerFields = [
     PublishFormFields.ContainerPort,
     PublishFormFields.ContainerAdminPassword,
diff --git a/src/publishProject/formComponentHelpers.ts b/src/publishProject/formComponentHelpers.ts
@@ -11,6 +11,7 @@ import {
     IPublishForm,
     PublishDialogFormItemSpec,
     PublishDialogState,
+    PublishTarget,
 } from "../sharedInterfaces/publishDialog";
 import { getPublishServerName, validateSqlServerPortNumber } from "./projectUtils";
 import { validateSqlServerPassword } from "../deployment/dockerUtils";
@@ -40,21 +41,21 @@ function generatePublishTargetOptions(projectTargetVersion?: string): FormItemOp
             displayName: isAzureSqlProject
                 ? Loc.PublishTargetExistingLogical
                 : Loc.PublishTargetExisting,
-            value: constants.PublishTargets.EXISTING_SERVER,
+            value: PublishTarget.ExistingServer,
         },
         {
             displayName: isAzureSqlProject
                 ? Loc.PublishTargetAzureEmulator
                 : Loc.PublishTargetContainer,
-            value: constants.PublishTargets.LOCAL_CONTAINER,
+            value: PublishTarget.LocalContainer,
         },
     ];
     if (isAzureSqlProject) {
         // Only show "Publish to New Azure Server" option if preview feature tag is enabled
         if (isPreviewFeaturesEnabled()) {
             options.push({
                 displayName: Loc.PublishTargetNewAzureServer,
-                value: constants.PublishTargets.NEW_AZURE_SERVER,
+                value: PublishTarget.NewAzureServer,
             });
         }
     }
diff --git a/src/publishProject/publishProjectWebViewController.ts b/src/publishProject/publishProjectWebViewController.ts
@@ -14,6 +14,7 @@ import {
     PublishDialogFormItemSpec,
     IPublishForm,
     PublishDialogState,
+    PublishTarget,
 } from "../sharedInterfaces/publishDialog";
 import { generatePublishFormComponents } from "./formComponentHelpers";
 import { loadDockerTags } from "./dockerUtils";
@@ -170,7 +171,7 @@ export class PublishProjectWebViewController extends FormWebviewController<
             constants.PublishFormFields.DatabaseName,
         ] as (keyof IPublishForm)[];
 
-        if (state.formState.publishTarget === constants.PublishTargets.LOCAL_CONTAINER) {
+        if (state.formState.publishTarget === PublishTarget.LocalContainer) {
             activeComponents.push(...constants.PublishFormContainerFields);
         }
 
@@ -182,12 +183,12 @@ export class PublishProjectWebViewController extends FormWebviewController<
         const target = currentState.formState?.publishTarget;
         const hidden: string[] = [];
 
-        if (target === constants.PublishTargets.LOCAL_CONTAINER) {
+        if (target === PublishTarget.LocalContainer) {
             // Container deployment: hide server name field
             hidden.push(constants.PublishFormFields.ServerName);
         } else if (
-            target === constants.PublishTargets.EXISTING_SERVER ||
-            target === constants.PublishTargets.NEW_AZURE_SERVER
+            target === PublishTarget.ExistingServer ||
+            target === PublishTarget.NewAzureServer
         ) {
             // Existing server or new Azure server: hide container-specific fields
             hidden.push(...constants.PublishFormContainerFields);
diff --git a/src/reactviews/pages/PublishProject/components/PublishTargetSection.tsx b/src/reactviews/pages/PublishProject/components/PublishTargetSection.tsx
@@ -7,7 +7,11 @@ import { useContext, useEffect, useState } from "react";
 import { makeStyles } from "@fluentui/react-components";
 import { PublishProjectContext } from "../publishProjectStateProvider";
 import { usePublishDialogSelector } from "../publishDialogSelector";
-import * as constants from "../../../../constants/constants";
+import {
+    PublishTarget,
+    PublishFormFields,
+    DefaultSqlPortNumber,
+} from "../../../../sharedInterfaces/publishDialog";
 import { renderInput, renderDropdown, renderCheckbox } from "./FormFieldComponents";
 import { parseHtmlLabel } from "../../../common/utils";
 
@@ -34,48 +38,46 @@ export const PublishTargetSection: React.FC = () => {
 
     // Select form components and values - components needed for rendering, values for logic
     const targetComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.PublishTarget],
+        (s) => s.formComponents[PublishFormFields.PublishTarget],
     );
     const targetValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.PublishTarget],
+        (s) => s.formState[PublishFormFields.PublishTarget],
     );
 
-    const isContainer = targetValue === constants.PublishTargets.LOCAL_CONTAINER;
+    const isContainer = targetValue === PublishTarget.LocalContainer;
 
     // Container-specific fields (only select when needed)
     const portComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.ContainerPort],
-    );
-    const portValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.ContainerPort],
+        (s) => s.formComponents[PublishFormFields.ContainerPort],
     );
+    const portValue = usePublishDialogSelector((s) => s.formState[PublishFormFields.ContainerPort]);
 
     const passwordComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.ContainerAdminPassword],
+        (s) => s.formComponents[PublishFormFields.ContainerAdminPassword],
     );
     const passwordValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.ContainerAdminPassword],
+        (s) => s.formState[PublishFormFields.ContainerAdminPassword],
     );
 
     const confirmPasswordComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.ContainerAdminPasswordConfirm],
+        (s) => s.formComponents[PublishFormFields.ContainerAdminPasswordConfirm],
     );
     const confirmPasswordValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.ContainerAdminPasswordConfirm],
+        (s) => s.formState[PublishFormFields.ContainerAdminPasswordConfirm],
     );
 
     const imageTagComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.ContainerImageTag],
+        (s) => s.formComponents[PublishFormFields.ContainerImageTag],
     );
     const imageTagValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.ContainerImageTag],
+        (s) => s.formState[PublishFormFields.ContainerImageTag],
     );
 
     const licenseComponent = usePublishDialogSelector(
-        (s) => s.formComponents[constants.PublishFormFields.AcceptContainerLicense],
+        (s) => s.formComponents[PublishFormFields.AcceptContainerLicense],
     );
     const licenseValue = usePublishDialogSelector(
-        (s) => s.formState[constants.PublishFormFields.AcceptContainerLicense],
+        (s) => s.formState[PublishFormFields.AcceptContainerLicense],
     );
 
     // Password visibility state management
@@ -106,17 +108,17 @@ export const PublishTargetSection: React.FC = () => {
         // Default container port if not set
         if (!portValue) {
             publishCtx.formAction({
-                propertyName: constants.PublishFormFields.ContainerPort,
+                propertyName: PublishFormFields.ContainerPort,
                 isAction: false,
-                value: constants.DefaultSqlPortNumber,
+                value: DefaultSqlPortNumber,
                 updateValidation: true,
             });
         }
 
         // Auto-select first image tag if not set
         if (!imageTagValue && imageTagComponent?.options?.[0]) {
             publishCtx.formAction({
-                propertyName: constants.PublishFormFields.ContainerImageTag,
+                propertyName: PublishFormFields.ContainerImageTag,
                 isAction: false,
                 value: imageTagComponent.options[0].value,
                 updateValidation: true,
@@ -133,7 +135,7 @@ export const PublishTargetSection: React.FC = () => {
         // Only revalidate if confirm password field has a value
         if (confirmPasswordValue !== undefined && confirmPasswordValue !== "") {
             publishCtx.formAction({
-                propertyName: constants.PublishFormFields.ContainerAdminPasswordConfirm,
+                propertyName: PublishFormFields.ContainerAdminPasswordConfirm,
                 isAction: false,
                 value: confirmPasswordValue as string,
                 updateValidation: true,
diff --git a/src/reactviews/pages/PublishProject/publishProject.tsx b/src/reactviews/pages/PublishProject/publishProject.tsx
@@ -7,13 +7,12 @@ import { useContext } from "react";
 import { Button, makeStyles } from "@fluentui/react-components";
 import { useFormStyles } from "../../common/forms/form.component";
 import { PublishProjectContext } from "./publishProjectStateProvider";
-import { IPublishForm } from "../../../sharedInterfaces/publishDialog";
+import { IPublishForm, PublishTarget } from "../../../sharedInterfaces/publishDialog";
 import { usePublishDialogSelector } from "./publishDialogSelector";
 import { LocConstants } from "../../common/locConstants";
 import { PublishProfileField } from "./components/PublishProfileSection";
 import { PublishTargetSection } from "./components/PublishTargetSection";
 import { ConnectionSection } from "./components/ConnectionSection";
-import * as constants from "../../../constants/constants";
 
 const useStyles = makeStyles({
     root: { padding: "12px" },
@@ -101,8 +100,7 @@ function PublishProjectDialog() {
                             appearance="secondary"
                             disabled={
                                 readyToPublish ||
-                                formState?.publishTarget !==
-                                    constants.PublishTargets.EXISTING_SERVER
+                                formState?.publishTarget !== PublishTarget.ExistingServer
                             }
                             onClick={() => context.generatePublishScript()}>
                             {loc.generateScript}
diff --git a/src/sharedInterfaces/publishDialog.ts b/src/sharedInterfaces/publishDialog.ts
@@ -6,14 +6,25 @@
 import * as constants from "../constants/constants";
 import { FormItemSpec, FormState, FormReducers, FormEvent } from "./form";
 
+// Publish target options - defines where the database project will be published
+export enum PublishTarget {
+    ExistingServer = "existingServer",
+    LocalContainer = "localContainer",
+    NewAzureServer = "newAzureServer",
+}
+
+// export publish-related constants for use in webview code
+export const PublishFormFields = constants.PublishFormFields;
+export const DefaultSqlPortNumber = constants.DefaultSqlPortNumber;
+
 /**
  * Data fields shown in the Publish form.
  */
 export interface IPublishForm {
     publishProfilePath?: string;
     serverName?: string;
     databaseName?: string;
-    publishTarget?: constants.PublishTargetType;
+    publishTarget?: PublishTarget;
     sqlCmdVariables?: { [key: string]: string };
     // Container deployment specific fields (only used when publishTarget === 'localContainer')
     containerPort?: string;
diff --git a/test/unit/publishProjectWebViewController.test.ts b/test/unit/publishProjectWebViewController.test.ts
@@ -6,7 +6,6 @@
 import * as vscode from "vscode";
 import { expect } from "chai";
 import * as sinon from "sinon";
-import * as constants from "../../src/constants/constants";
 
 import VscodeWrapper from "../../src/controllers/vscodeWrapper";
 import { PublishProjectWebViewController } from "../../src/publishProject/publishProjectWebViewController";
@@ -15,6 +14,7 @@ import {
     isValidSqlAdminPassword,
 } from "../../src/publishProject/projectUtils";
 import { stubVscodeWrapper } from "./utils";
+import { PublishTarget } from "../../src/sharedInterfaces/publishDialog";
 
 suite("PublishProjectWebViewController Tests", () => {
     let sandbox: sinon.SinonSandbox;
@@ -99,9 +99,7 @@ suite("PublishProjectWebViewController Tests", () => {
 
         await controller.initialized.promise;
 
-        expect(controller.state.formState.publishTarget).to.equal(
-            constants.PublishTargets.EXISTING_SERVER,
-        );
+        expect(controller.state.formState.publishTarget).to.equal(PublishTarget.ExistingServer);
     });
 
     test("getActiveFormComponents returns correct fields for EXISTING_SERVER target", async () => {
@@ -115,7 +113,7 @@ suite("PublishProjectWebViewController Tests", () => {
         await controller.initialized.promise;
 
         // Set publish target to EXISTING_SERVER (default)
-        controller.state.formState.publishTarget = constants.PublishTargets.EXISTING_SERVER;
+        controller.state.formState.publishTarget = PublishTarget.ExistingServer;
 
         const activeComponents = controller["getActiveFormComponents"](controller.state);
 
@@ -141,7 +139,7 @@ suite("PublishProjectWebViewController Tests", () => {
         await controller.initialized.promise;
 
         // Set publish target to LOCAL_CONTAINER
-        controller.state.formState.publishTarget = constants.PublishTargets.LOCAL_CONTAINER;
+        controller.state.formState.publishTarget = PublishTarget.LocalContainer;
 
         const activeComponents = controller["getActiveFormComponents"](controller.state);
 
@@ -195,7 +193,7 @@ suite("PublishProjectWebViewController Tests", () => {
         await formAction(controller.state, {
             event: {
                 propertyName: "publishTarget",
-                value: constants.PublishTargets.LOCAL_CONTAINER,
+                value: PublishTarget.LocalContainer,
                 isAction: false,
             },
         });
@@ -226,9 +224,7 @@ suite("PublishProjectWebViewController Tests", () => {
         });
 
         // Verify all values are saved
-        expect(controller.state.formState.publishTarget).to.equal(
-            constants.PublishTargets.LOCAL_CONTAINER,
-        );
+        expect(controller.state.formState.publishTarget).to.equal(PublishTarget.LocalContainer);
         expect(controller.state.formState.containerPort).to.equal("1434");
         expect(controller.state.formState.containerAdminPassword).to.equal("TestPassword123!");
         expect(controller.state.formState.containerAdminPasswordConfirm).to.equal(
@@ -263,10 +259,10 @@ suite("PublishProjectWebViewController Tests", () => {
 
         const publishTargetComponent = controller.state.formComponents.publishTarget;
         const existingServerOption = publishTargetComponent.options?.find(
-            (opt) => opt.value === constants.PublishTargets.EXISTING_SERVER,
+            (opt) => opt.value === PublishTarget.ExistingServer,
         );
         const containerOption = publishTargetComponent.options?.find(
-            (opt) => opt.value === constants.PublishTargets.LOCAL_CONTAINER,
+            (opt) => opt.value === PublishTarget.LocalContainer,
         );
 
         expect(existingServerOption?.displayName).to.equal("Existing Azure SQL logical server");
@@ -303,7 +299,7 @@ suite("PublishProjectWebViewController Tests", () => {
         expect(publishTargetComponent.options?.length).to.equal(3);
 
         const azureOption = publishTargetComponent.options?.find(
-            (opt) => opt.value === constants.PublishTargets.NEW_AZURE_SERVER,
+            (opt) => opt.value === PublishTarget.NewAzureServer,
         );
         expect(azureOption).to.exist;
         expect(azureOption?.displayName).to.equal("New Azure SQL logical server (Preview)");
