Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ZE changes the way how it treats secure values in the Team Config between minor versions #3399

Open
roman-kupriyanov opened this issue Jan 15, 2025 · 1 comment
Labels
bug Something isn't working

Comments

@roman-kupriyanov
Copy link
Contributor

Describe the bug

We are using the Profiles API from Zowe Explorer in our Explorer for Endevor extension to be able to provide connections to Endevor via API ML using the Team config for our client.

We got a report that the same Team Config that was worked together with Zowe Explorer v2.9.0 and Explorer for Endevor v1.5.2 is not functioning properly anymore after upgrade to ZE v2.18 and E4E v1.8.2. We did not change how we treat the profiles between the versions and we totally rely on the ZE API to provide us proper credentials (basic MF creds or API ML token) depending on the configuration is used, so I assume some behaviour is changed between Zowe Explorer versions.

An investigation on our side shows that with the upgrade to ZE v2.18, the same profiles that were used before started to report basic credentials, rather then API ML token that was in use before, so it seems to us that some rules around concatenation of the different fields in the Team Config have changed (see the examples of the configs are used by our client).

There is a big configuration that describes entire client's environment, so I reduced it to meaningful amount to represent the issue.

zowe.config.json

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "base": {
            "type": "base",
            "properties": {
                "rejectUnauthorized": true,
                "secure-ftp": true,
                "connectionTimeout": 10000,
                "protocol": "https",
                "encoding": 1146
            },
            "secure": [
                "user",
                "password"
            ]
        },
        "test-zowe": {
            "properties": {
                "host": "test.company.net",
                "port": 8080,
            },
            "profiles": {
                "zosmf": {
                    "type": "zosmf",
                    "properties": {
                        "port": 40443
                    }
                },
                "ndvr": {
                    "type": "endevor",
                    "properties": {
                        "basePath": "EndevorService/api/v2"
                    }
                }
            }
        }
    },
    "defaults": {
        "base": "base",
        "zosmf": "test-zowe.zosmf",
        "endevor": "test-zowe.ndvr"
    },
    "autoStore": false
}

zowe.config.user.json

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "test-zowe": {
      "profiles": {
        "zosmf-apiml": {
          "type": "zosmf",
          "properties": {
            "basePath": "/ibmzosmf/api/v1"
          }
        },
        "ndvr-apiml": {
          "type": "endevor",
          "properties": {
            "basePath": "/caendevorapi/api/v2"
          }
        }
      },
      "secure": ["token", "tokenValue"]
    }
  },
  "defaults": {
    "zosmf": "test-zowe.zosmf-apiml",
    "endevor": "test-zowe.ndvr-apiml"
  }
}

To Reproduce

Put a Team config files to ~./zowe folder and make sure that API ML token from the configuration is not used anymore.

Expected behavior

The config that is created between minor versions of the ZE extensions is expected to be working same way until the major version breaking changes or migration procedure is provided before such a change is happening in one of the minor version.

Is there a way to re-arrange the current config so it continues to work as expected?

Desktop (please complete the following information):

  • OS: Windows, Mac
  • Zowe Explorer Version: 2.18
  • (Optional) Zowe CLI Version:
  • (Optional) Are you using Secure Credential Store?
Copy link

Thank you for creating a bug report.
We will investigate the bug and evaluate its impact on the product.
If you haven't already, please ensure you have provided steps to reproduce the bug and as much context as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: New Issues
Development

No branches or pull requests

1 participant