Use Fewer Deprecated Functions in Master #2217

awharn · 2024-08-06T18:46:25Z

What It Does

Resolves #2191
Reduces the use of deprecated functions in preparation to support Node 22

How to Test

Install, build, run commands to verify new build does not trigger deprecation warnings on Node 22

Review Checklist
I certify that I have:

tested my changes
added/updated automated tests
updated the changelog
followed the contribution guidelines

Additional Comments

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

packages/zosfiles/__tests__/__unit__/methods/utilities/Utilities.unit.test.ts

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

codecov · 2024-08-06T19:09:14Z

Codecov Report

Attention: Patch coverage is 96.82540% with 6 lines in your changes missing coverage. Please review.

Project coverage is 91.15%. Comparing base (5883be1) to head (bd6d84c).

Files	Patch %	Lines
...src/cmd/src/help/abstract/AbstractHelpGenerator.ts	80.00%	2 Missing ⚠️
...s/imperative/src/cmd/src/syntax/SyntaxValidator.ts	91.30%	2 Missing ⚠️
...li/src/zosconsole/issue/command/Command.handler.ts	66.66%	1 Missing ⚠️
...ckages/imperative/src/operations/src/Operations.ts	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2217      +/-   ##
==========================================
- Coverage   91.16%   91.15%   -0.01%     
==========================================
  Files         638      638              
  Lines       19134    19103      -31     
  Branches     4041     4041              
==========================================
- Hits        17444    17414      -30     
+ Misses       1689     1688       -1     
  Partials        1        1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

awharn · 2024-08-07T13:17:07Z

Please wait to merge - system tests are in progress.

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

anaxceron · 2024-08-07T17:16:33Z

__tests__/__packages__/cli-test-utils/CHANGELOG.md

@@ -2,6 +2,10 @@

 All notable changes to the Zowe CLI test utils package will be documented in this file.

+## Recent Changes
+
+- BugFix: Refactored code to reduce the use of deprecated functions to prepare for Node 22 support. [#2191](https://github.com/zowe/zowe-cli/issues/2191)


Can we explain why we need Node 22 support?

I don't quite know how to explain it in the changelog. The CLI supports running on all Node LTS versions that are actively supported by the NodeJS project maintainers, and Node 22 will reach that point in October. That commitment is documented in the Zowe CLI system requirements. This PR sets the ground work to honor that commitment.

How about: " ... upcoming NodeJS 22 support"

Sounds good. Changelogs updated. Thanks!

awharn · 2024-08-07T17:21:47Z

System Tests are complete and pass.

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

anaxceron

Looks good, thanks @awharn!

zFernand0

LGTM! 😋

All of my comments are mostly minor things that can be done at a later time, or be forgotten since they should not impact performance or behavior 😋

zFernand0 · 2024-08-07T20:03:09Z

packages/provisioning/__tests__/tsconfig.json

Is there a way we could avoid having to maintain a separate tsconfig.json file in every package?

I'm thinking of techniques similar to how jest config can be combined.

Not really requesting changes, though! 😋

We made the same change in Next, but no, I don't think there is anything we can do. ESLint expects a TSConfig everywhere it scans, and you need different TSConfigs between tests and source. We could try to have them all extend a common TSConfig, but that would need to be a separate effort in V3. I don't expect we will change any of these TSConfigs through the rest of V2.

packages/imperative/tsconfig-tests.json

zFernand0 · 2024-08-07T20:05:33Z

packages/imperative/src/utilities/src/TextUtils.ts

@@ -274,7 +274,7 @@ export class TextUtils {
     * @returns {string} - a formatted string with the variables inserted
     */
    public static formatMessage(message: string, ...values: any[]): string {
-        if (!isNullOrUndefined(values)) {
+        if (!(values == null)) {


There are multiple occasions (in this file and maybe others) where we do !(a == null) instead of a != null Curious if we could replace them with the shorthand version of != null 😋

That is what the hundred plus issues flagged are. I just did this as shorthand since when I did that on V3, I made several mistakes when trying to do exactly that change that ended up breaking people and causing issues. This will all go away in V3, I just wanted to minimize the amount of time spent and mistakes made in V2.

packages/imperative/src/security/__tests__/DefaultCredentialManager.unit.test.ts

zFernand0 · 2024-08-07T20:10:23Z

packages/imperative/src/profiles/src/abstract/AbstractProfileManager.ts

@@ -200,12 +200,12 @@ export abstract class AbstractProfileManager<T extends IProfileTypeConfiguration
        if (parms.loadCounter != null) {
            this.mLoadCounter = parms.loadCounter;
        }
-        this.mLogger = isNullOrUndefined(parms.logger) ? this.mLogger : parms.logger;
+        this.mLogger = parms.logger == null ? this.mLogger : parms.logger;


It is possible that this comment may apply to other files...

Curious if we should take advantage of other operators like ?? 😋

I was just doing a find and replace. I was not evaluating any of the other logic. I would think if we want to change something like this, it might make more sense as another issue in order to reduce scope creep.

zFernand0 · 2024-08-07T20:20:48Z

packages/imperative/src/profiles/src/abstract/AbstractProfileManager.ts

        this.mProfileType = parms.type;
        this.mProfileRootDirectory = parms.profileRootDirectory;
        this.mProfileTypeConfigurations = parms.typeConfigurations;
        this.mProductDisplayName = parms.productDisplayName;
-        if (isNullOrUndefined(this.profileTypeConfigurations) || this.profileTypeConfigurations.length === 0) {
+        if (this.profileTypeConfigurations == null || this.profileTypeConfigurations.length === 0) {


Similar to the previous comment...

what about using ?. 😋

There are edge cases where ?. may not be desired since it can technically change the behavior. For example, if (a != null && !a.booleanValue) is not the same as if (!a?.booleanValue) since the condition will evaluate to true if A is undefined 😋

Same as previous comment.

zFernand0 · 2024-08-07T20:23:03Z

packages/imperative/src/imperative/__tests__/Imperative.unit.test.ts

@@ -21,6 +21,7 @@ import * as yargs from "yargs";
 import { ImperativeError } from "../../error/src/ImperativeError";

 describe("Imperative", () => {
+    // eslint-disable-next-line deprecation/deprecation
    const mainModule = process.mainModule;


Curious if there is a way to configure the deprecation/deprecation eslint plug-in to ignore all uses of process.mainModule 😋

There is not. I checked.

zFernand0 · 2024-08-07T20:28:44Z

packages/zosmf/src/ZosmfBaseHandler.ts

    /**
     * Loaded z/OSMF profile if needed
+     * @deprecated
     */
    protected mZosmfProfile: IProfile;

    /**
     * Loaded z/OSMF profile with meta information
+     * @deprecated
     */
    protected mZosmfLoadedProfile: IProfileLoaded;


Are this newly deprecated properties?

I believe they still exist in the next branch 😋

Should we create an issue to remove them/replace them over there?

I only deprecated them because the code around them didn't actually do anything, and the process of setting them used deprecated functions. I can undo this if we prefer.

After in person discussion, we are planning to remove these in V3 since nothing sets the protected variables anymore.

packages/zosuss/src/SshBaseHandler.ts

t1m0thyj

Looks pretty good, thanks @awharn!

packages/.madgerc

packages/cli/src/zosfiles/create/Create.options.ts

packages/imperative/package.json

packages/imperative/src/utilities/src/TextUtils.ts

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

sonarcloud · 2024-08-08T14:05:02Z

Quality Gate passed

Issues
136 New issues
0 Accepted issues

Measures
0 Security Hotspots
83.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

t1m0thyj

LGTM, thanks @awharn!

gejohnston

Thanks for the painstaking effort.

awharn added 6 commits August 6, 2024 10:14

Make initial linter changes

ba48994

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Fix packages except Imperative

2de65e2

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Implement CLI fixes

7d10b59

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Fix issues from resolving deprecated functions

64f9973

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Update changelogs

1ee1b97

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Try to fix integration tests

5054bcf

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

awharn requested review from t1m0thyj, gejohnston, zFernand0, traeok, anaxceron, jace-roell and ATorrise August 6, 2024 18:46

awharn self-assigned this Aug 6, 2024

github-advanced-security bot found potential problems Aug 6, 2024

View reviewed changes

packages/zosfiles/__tests__/__unit__/methods/utilities/Utilities.unit.test.ts Fixed Show fixed Hide fixed

Remove unused line in test

d413383

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Remove deprecated buffer slice and replace with subarray

bb5b894

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

anaxceron reviewed Aug 7, 2024

View reviewed changes

Update changelogs

ec84fc8

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

anaxceron approved these changes Aug 7, 2024

View reviewed changes

zFernand0 approved these changes Aug 7, 2024

View reviewed changes

t1m0thyj requested changes Aug 7, 2024

View reviewed changes

packages/.madgerc Outdated Show resolved Hide resolved

packages/cli/src/zosfiles/create/Create.options.ts Show resolved Hide resolved

packages/imperative/package.json Outdated Show resolved Hide resolved

packages/imperative/src/utilities/src/TextUtils.ts Outdated Show resolved Hide resolved

awharn added 2 commits August 8, 2024 09:27

Make requested changes

7919322

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Move .madgerc

bd6d84c

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

t1m0thyj approved these changes Aug 8, 2024

View reviewed changes

gejohnston approved these changes Aug 8, 2024

View reviewed changes

awharn merged commit de6aacc into master Aug 8, 2024
21 checks passed

awharn deleted the fix-deprecation-master branch August 8, 2024 15:26

awharn added the release-current Indicates that there is no new functionality being delivered label Aug 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use Fewer Deprecated Functions in Master #2217

Use Fewer Deprecated Functions in Master #2217

awharn commented Aug 6, 2024

codecov bot commented Aug 6, 2024 •

edited

Loading

awharn commented Aug 7, 2024

anaxceron Aug 7, 2024

awharn Aug 7, 2024

anaxceron Aug 7, 2024

awharn Aug 7, 2024

awharn commented Aug 7, 2024

anaxceron left a comment

zFernand0 left a comment

zFernand0 Aug 7, 2024

awharn Aug 8, 2024

zFernand0 Aug 7, 2024

awharn Aug 8, 2024 •

edited

Loading

zFernand0 Aug 7, 2024

awharn Aug 8, 2024

zFernand0 Aug 7, 2024

awharn Aug 8, 2024

zFernand0 Aug 7, 2024

awharn Aug 8, 2024

zFernand0 Aug 7, 2024

awharn Aug 8, 2024 •

edited

Loading

awharn Aug 8, 2024

t1m0thyj left a comment

sonarcloud bot commented Aug 8, 2024

t1m0thyj left a comment

gejohnston left a comment

Use Fewer Deprecated Functions in Master #2217

Use Fewer Deprecated Functions in Master #2217

Conversation

awharn commented Aug 6, 2024

codecov bot commented Aug 6, 2024 • edited Loading

Codecov Report

awharn commented Aug 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awharn commented Aug 7, 2024

anaxceron left a comment

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awharn Aug 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

awharn Aug 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

t1m0thyj left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 8, 2024

Quality Gate passed

t1m0thyj left a comment

Choose a reason for hiding this comment

gejohnston left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 6, 2024 •

edited

Loading

awharn Aug 8, 2024 •

edited

Loading

awharn Aug 8, 2024 •

edited

Loading