Fix logout to give base profile precedence over parent profile

packages/zowe-explorer-api/CHANGELOG.md

@@ -6,6 +6,9 @@ All notable changes to the "zowe-explorer-api" extension will be documented in t
 
 ### New features and enhancements
 
+- Added the `BaseProfileAuthOptions` interface to define base profile authentication options for SSO login and logout. [#3076](https://github.com/zowe/zowe-explorer-vscode/pull/3076)
+- Deprecated the methods `ZoweVsCodeExtension.loginWithBaseProfile` and `ZoweVsCodeExtension.logoutWithBaseProfile`. Use `ZoweVsCodeExtension.ssoLogin` and `ZoweVsCodeExtension.ssoLogout` instead, which use the `BaseProfileAuthOptions` interface and allow you to choose whether the token value in the base profile should have precedence in case there are conflicts. [#3076](https://github.com/zowe/zowe-explorer-vscode/pull/3076)
+
 ### Bug fixes
 
 - Fixed behavior of logout action when token is defined in both base profile and parent profile. [#3076](https://github.com/zowe/zowe-explorer-vscode/issues/3076)

packages/zowe-explorer-api/__tests__/__unit__/vscode/ZoweVsCodeExtension.unit.test.ts

@@ -186,7 +186,7 @@ describe("ZoweVsCodeExtension", () => {
             const errorMessageSpy = jest.spyOn(Gui, "errorMessage");
             const fetchBaseProfileSpy = jest.spyOn(blockMocks.testCache, "fetchBaseProfile").mockResolvedValue(undefined);
             const updateBaseProfileFileLoginSpy = jest.spyOn(blockMocks.testCache, "updateBaseProfileFileLogin");
-            await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" });
+            await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" });
             expect(fetchBaseProfileSpy).toHaveBeenCalledTimes(1);
             expect(updateBaseProfileFileLoginSpy).not.toHaveBeenCalled();
             expect(errorMessageSpy).toHaveBeenCalledWith(expect.stringContaining("Login failed: No base profile found"));
@@ -195,7 +195,7 @@ describe("ZoweVsCodeExtension", () => {
             const errorMessageSpy = jest.spyOn(Gui, "errorMessage");
             const fetchBaseProfileSpy = jest.spyOn(blockMocks.testCache, "fetchBaseProfile").mockResolvedValue(undefined);
             const updateBaseProfileFileLoginSpy = jest.spyOn(blockMocks.testCache, "updateBaseProfileFileLogin");
-            await ZoweVsCodeExtension.logoutWithBaseProfile({ serviceProfile: "service" });
+            await ZoweVsCodeExtension.ssoLogout({ serviceProfile: "service" });
             expect(fetchBaseProfileSpy).toHaveBeenCalledTimes(1);
             expect(updateBaseProfileFileLoginSpy).not.toHaveBeenCalled();
             expect(errorMessageSpy).toHaveBeenCalledWith(expect.stringContaining("Logout failed: No base profile found"));
@@ -210,7 +210,7 @@ describe("ZoweVsCodeExtension", () => {
                 const loginSpy = jest.spyOn(Login, "apimlLogin").mockResolvedValue("tokenValue");
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" });
+                await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 delete testSession.ISession.user;
@@ -231,7 +231,7 @@ describe("ZoweVsCodeExtension", () => {
                 const logoutSpy = jest.spyOn(Logout, "apimlLogout").mockImplementation(jest.fn());
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.logoutWithBaseProfile({ serviceProfile: "service" });
+                await ZoweVsCodeExtension.ssoLogout({ serviceProfile: "service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 testSession.ISession.tokenValue = "tokenValue";
@@ -259,7 +259,7 @@ describe("ZoweVsCodeExtension", () => {
                 const loginSpy = jest.spyOn(Login, "apimlLogin").mockResolvedValue("tokenValue");
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" });
+                await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 delete testSession.ISession.user;
@@ -288,7 +288,7 @@ describe("ZoweVsCodeExtension", () => {
                 const loginSpy = jest.spyOn(Login, "apimlLogin").mockResolvedValue("tokenValue");
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" });
+                await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 delete testSession.ISession.user;
@@ -338,7 +338,7 @@ describe("ZoweVsCodeExtension", () => {
                 };
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "lpar.service" });
+                await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "lpar.service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 delete testSession.ISession.user;
@@ -379,7 +379,7 @@ describe("ZoweVsCodeExtension", () => {
                 const logoutSpy = jest.spyOn(Logout, "apimlLogout").mockImplementation(jest.fn());
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.logoutWithBaseProfile({ serviceProfile: "service" });
+                await ZoweVsCodeExtension.ssoLogout({ serviceProfile: "service" });
 
                 const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
                 testSession.ISession.hostname = "service";
@@ -401,7 +401,7 @@ describe("ZoweVsCodeExtension", () => {
                 const loginSpy = jest.spyOn(Login, "apimlLogin").mockResolvedValue("tokenValue");
 
                 const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-                await ZoweVsCodeExtension.loginWithBaseProfile({
+                await ZoweVsCodeExtension.ssoLogin({
                     serviceProfile: blockMocks.serviceProfile,
                     defaultTokenType: "apimlAuthenticationToken",
                     profileNode: blockMocks.testNode,
@@ -427,7 +427,7 @@ describe("ZoweVsCodeExtension", () => {
             const logoutSpy = jest.spyOn(Logout, "apimlLogout").mockImplementation(jest.fn());
             const newServiceProfile = { ...blockMocks.serviceProfile, profile: { ...blockMocks.testProfile, ...blockMocks.updProfile } };
 
-            await ZoweVsCodeExtension.logoutWithBaseProfile({
+            await ZoweVsCodeExtension.ssoLogout({
                 serviceProfile: newServiceProfile,
                 zeRegister: blockMocks.testRegister,
                 zeProfiles: blockMocks.testCache,
@@ -458,7 +458,7 @@ describe("ZoweVsCodeExtension", () => {
             // case 1: User selects "user/password" for login quick pick
             const promptCertMock = jest.spyOn(ZoweVsCodeExtension as any, "promptCertificate").mockImplementation();
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[1]);
-            await ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" });
+            await ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" });
 
             const testSession = new imperative.Session(JSON.parse(JSON.stringify(blockMocks.expectedSession.ISession)));
             delete testSession.ISession.user;
@@ -485,15 +485,15 @@ describe("ZoweVsCodeExtension", () => {
             const promptCertMock = jest
                 .spyOn(ZoweVsCodeExtension as any, "promptCertificate")
                 .mockRejectedValueOnce(new Error("invalid certificate"));
-            await expect(ZoweVsCodeExtension.loginWithBaseProfile({ serviceProfile: "service" })).resolves.toBe(false);
+            await expect(ZoweVsCodeExtension.ssoLogin({ serviceProfile: "service" })).resolves.toBe(false);
             expect(promptCertMock).toHaveBeenCalled();
             expect(quickPickMock).toHaveBeenCalled();
         });
 
         it("should not login if the user cancels the operation when selecting the authentication method", async () => {
             jest.spyOn(blockMocks.testCache, "fetchBaseProfile").mockResolvedValue(blockMocks.baseProfile);
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation(() => undefined as any);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: blockMocks.serviceProfile,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -512,7 +512,7 @@ describe("ZoweVsCodeExtension", () => {
 
             const testSpy = jest.spyOn(ZoweVsCodeExtension as any, "promptUserPass").mockResolvedValue(undefined);
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -544,7 +544,7 @@ describe("ZoweVsCodeExtension", () => {
             await ZoweVsCodeExtension.profilesCache.refresh({
                 registeredApiTypes: jest.fn().mockReturnValue(["service"]),
             } as unknown as Types.IApiRegisterClient);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -571,7 +571,7 @@ describe("ZoweVsCodeExtension", () => {
 
             const testSpy = jest.spyOn(ZoweVsCodeExtension as any, "promptUserPass").mockResolvedValue(["abc", "def"]);
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -596,7 +596,7 @@ describe("ZoweVsCodeExtension", () => {
 
             const testSpy = jest.spyOn(ZoweVsCodeExtension as any, "promptUserPass").mockResolvedValue(["abc", "def"]);
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -633,7 +633,7 @@ describe("ZoweVsCodeExtension", () => {
 
             const testSpy = jest.spyOn(ZoweVsCodeExtension as any, "promptUserPass").mockResolvedValue(["abc", "def"]);
             const quickPickMock = jest.spyOn(Gui, "showQuickPick").mockImplementation((items) => items[0]);
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,
@@ -655,7 +655,7 @@ describe("ZoweVsCodeExtension", () => {
 
             const testSpy = jest.spyOn(ZoweVsCodeExtension as any, "promptUserPass");
             const errorMessageSpy = jest.spyOn(Gui, "errorMessage");
-            const didLogin = await ZoweVsCodeExtension.loginWithBaseProfile({
+            const didLogin = await ZoweVsCodeExtension.ssoLogin({
                 serviceProfile: serviceProfileLoaded,
                 defaultTokenType: "apimlAuthenticationToken",
                 profileNode: blockMocks.testNode,

packages/zowe-explorer-api/src/vscode/ZoweVsCodeExtension.ts

@@ -95,7 +95,6 @@
                 shouldSave = await ZoweVsCodeExtension.saveCredentials(loadProfile);
             }
 
-            // TODO Should we call updateProfileInCache method here?
             if (shouldSave) {
                 // write changes to the file, autoStore value determines if written to file
                 const upd = { profileName: loadProfile.name, profileType: loadProfile.type };
@@ -113,13 +112,30 @@
      * Trigger a login operation with the merged contents between the service profile and the base profile.
      *  If the connection details (host:port) do not match (service vs base), the token will be stored in the service profile.
      *  If there is no API registered for the profile type, this method defaults the login behavior to that of the APIML.
+     * @deprecated Use `ZoweVsCodeExtension.ssoLogin` instead
      * @param serviceProfile Profile to be used for login purposes (either the name of the IProfileLoaded instance)
      * @param loginTokenType The tokenType value for compatibility purposes
      * @param node The node for compatibility purposes
      * @param zeRegister The ZoweExplorerApiRegister instance for compatibility purposes
      * @param zeProfiles The Zowe Explorer "Profiles.ts" instance for compatibility purposes
      */
-    public static async loginWithBaseProfile(opts: BaseProfileAuthOptions): Promise<boolean> {
+    public static async loginWithBaseProfile(
+        serviceProfile: string | imperative.IProfileLoaded,
+        loginTokenType?: string,
+        node?: Types.IZoweNodeType,
+        zeRegister?: Types.IApiRegisterClient, // ZoweExplorerApiRegister
+        zeProfiles?: ProfilesCache // Profiles extends ProfilesCache
+    ): Promise<boolean> {
+        return this.ssoLogin({ serviceProfile, defaultTokenType: loginTokenType, profileNode: node, zeRegister, zeProfiles });
+    }
+
+    /**
+     * Trigger a login operation with the merged contents between the service profile and the base profile.
+     *  If the connection details (host:port) do not match (service vs base), the token will be stored in the service profile.
+     *  If there is no API registered for the profile type, this method defaults the login behavior to that of the APIML.
+     * @param {BaseProfileAuthOptions} opts Object defining options for base profile authentication
+     */
+    public static async ssoLogin(opts: BaseProfileAuthOptions): Promise<boolean> {
         const cache: ProfilesCache = opts.zeProfiles ?? ZoweVsCodeExtension.profilesCache;
         const serviceProfile =
             typeof opts.serviceProfile === "string"
@@ -207,11 +223,26 @@
      * Trigger a logout operation with the merged contents between the service profile and the base profile.
      *  If the connection details (host:port) do not match (service vs base), the token will be removed from the service profile.
      *  If there is no API registered for the profile type, this method defaults the logout behavior to that of the APIML.
+     * @deprecated Use `ZoweVsCodeExtension.ssoLogout` instead
      * @param serviceProfile Profile to be used for logout purposes (either the name of the IProfileLoaded instance)
      * @param zeRegister The ZoweExplorerApiRegister instance for compatibility purposes
      * @param zeProfiles The Zowe Explorer "Profiles.ts" instance for compatibility purposes
      */
-    public static async logoutWithBaseProfile(opts: BaseProfileAuthOptions): Promise<boolean> {
+    public static async logoutWithBaseProfile(
+        serviceProfile: string | imperative.IProfileLoaded,
+        zeRegister?: Types.IApiRegisterClient, // ZoweExplorerApiRegister
+        zeProfiles?: ProfilesCache // Profiles extends ProfilesCache
+    ): Promise<boolean> {
+        return this.ssoLogout({ serviceProfile, zeRegister, zeProfiles });
+    }
+
+    /**
+     * Trigger a logout operation with the merged contents between the service profile and the base profile.
+     *  If the connection details (host:port) do not match (service vs base), the token will be removed from the service profile.
+     *  If there is no API registered for the profile type, this method defaults the logout behavior to that of the APIML.
+     * @param {BaseProfileAuthOptions} opts Object defining options for base profile authentication
+     */
+    public static async ssoLogout(opts: BaseProfileAuthOptions): Promise<boolean> {
         const cache: ProfilesCache = opts.zeProfiles ?? ZoweVsCodeExtension.profilesCache;
         const serviceProfile =
             typeof opts.serviceProfile === "string"
@@ -229,7 +260,7 @@
             primaryProfile.profile.tokenType ??
             secondaryProfile.profile.tokenType ??
             opts.defaultTokenType ??
             imperative.SessConstants.TOKEN_TYPE_APIML;
         const updSession = new imperative.Session({
             hostname: serviceProfile.profile.host,
             port: serviceProfile.profile.port,

packages/zowe-explorer/__tests__/__unit__/configuration/Profiles.unit.test.ts

@@ -1210,7 +1210,7 @@ describe("Profiles Unit Tests - function ssoLogin", () => {
             getTokenTypeName: () => imperative.SessConstants.TOKEN_TYPE_APIML,
             login: jest.fn(),
         } as never);
-        const loginBaseProfMock = jest.spyOn(ZoweVsCodeExtension, "loginWithBaseProfile").mockRejectedValueOnce(new Error("test error."));
+        const loginBaseProfMock = jest.spyOn(ZoweVsCodeExtension, "ssoLogin").mockRejectedValueOnce(new Error("test error."));
         jest.spyOn(Profiles.getInstance() as any, "loginCredentialPrompt").mockReturnValue(["fake", "12345"]);
         await expect(Profiles.getInstance().ssoLogin(testNode, "fake")).resolves.not.toThrow();
         expect(ZoweLogger.error).toHaveBeenCalled();
@@ -1309,7 +1309,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
             getTokenTypeName: () => "apimlAuthenticationToken",
         } as never);
 
-        jest.spyOn(ZoweVsCodeExtension, "loginWithBaseProfile").mockResolvedValue(true);
+        jest.spyOn(ZoweVsCodeExtension, "ssoLogin").mockResolvedValue(true);
         await Profiles.getInstance().handleSwitchAuthentication(testNode);
         expect(Gui.showMessage).toHaveBeenCalled();
         expect(testNode.profile.profile.tokenType).toBe(modifiedTestNode.profile.profile.tokenType);
@@ -1368,7 +1368,7 @@ describe("Profiles Unit Tests - function handleSwitchAuthentication", () => {
             getTokenTypeName: () => "apimlAuthenticationToken",
         } as never);
 
-        jest.spyOn(ZoweVsCodeExtension, "loginWithBaseProfile").mockResolvedValue(false);
+        jest.spyOn(ZoweVsCodeExtension, "ssoLogin").mockResolvedValue(false);
         await Profiles.getInstance().handleSwitchAuthentication(testNode);
         expect(Gui.errorMessage).toHaveBeenCalled();
         expect(testNode.profile.profile.tokenType).toBe(modifiedTestNode.profile.profile.tokenType);