Remove use of deprecated utils functions & Enable deprecation linter #2169

awharn · 2024-06-06T18:11:42Z

What It Does

Stops using deprecated utility functions
Changes logic to use require.main over process.mainModule, which is deprecated
Enables linters for detecting extra parenthesis and deprecated function use

How to Test

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>

…nter

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

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

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

…nter

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

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

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

codecov · 2024-06-06T18:18:54Z

Codecov Report

Attention: Patch coverage is 91.06628% with 31 lines in your changes missing coverage. Please review.

Project coverage is 91.18%. Comparing base (bbffec2) to head (bf8d8ad).
Report is 2 commits behind head on next.

Files	Patch %	Lines
...ackages/imperative/src/cmd/src/CommandProcessor.ts	80.00%	3 Missing ⚠️
...s/imperative/src/cmd/src/syntax/SyntaxValidator.ts	90.62%	3 Missing ⚠️
...perative/src/cmd/src/yargs/AbstractCommandYargs.ts	57.14%	3 Missing ⚠️
...kages/imperative/src/cmd/src/yargs/CommandYargs.ts	70.00%	3 Missing ⚠️
...s/imperative/src/imperative/src/OverridesLoader.ts	50.00%	3 Missing ⚠️
...workflows/delete/Delete.archived.common.handler.ts	50.00%	2 Missing ⚠️
...src/cmd/src/help/abstract/AbstractHelpGenerator.ts	81.81%	2 Missing ⚠️
...es/imperative/src/config/src/ProfileCredentials.ts	66.66%	2 Missing ⚠️
...ackages/imperative/src/operations/src/Operation.ts	0.00%	2 Missing ⚠️
...ckages/imperative/src/operations/src/Operations.ts	50.00%	2 Missing ⚠️
... and 6 more

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2169      +/-   ##
==========================================
- Coverage   91.18%   91.18%   -0.01%     
==========================================
  Files         628      628              
  Lines       17874    17850      -24     
  Branches     3796     3693     -103     
==========================================
- Hits        16299    16276      -23     
+ Misses       1574     1573       -1     
  Partials        1        1

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

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

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

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

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

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

t1m0thyj

Looks pretty good, thanks @awharn! Left a few comments

packages/.madgerc

packages/cli/scripts/validatePlugins.js

t1m0thyj · 2024-06-11T14:27:31Z

packages/cli/src/config/auto-init/ApimlAutoInitHandler.ts

@@ -70,7 +70,7 @@ export default class ApimlAutoInitHandler extends BaseAutoInitHandler {
     */
    protected async doAutoInit(session: AbstractSession, params: IHandlerParameters): Promise<IConfig> {
        // Login with token authentication first, so we can support certificates
-        if ((session.ISession.user && session.ISession.password) || (session.ISession.cert && session.ISession.certKey)) {
+        if (session.ISession.user && session.ISession.password || session.ISession.cert && session.ISession.certKey) {


Generally I like the no-extra-parens rule, but in a few cases like this one it may make the code less readable. I'm probably just dumb but it's not obvious to me what the order of precedence is across these 4 conditions. Not a request to change anything, just an observation 😋

packages/imperative/src/imperative/__tests__/plugins/PluginRequireProvider.unit.test.ts

packages/imperative/src/logger/src/Logger.ts

t1m0thyj · 2024-06-11T14:56:51Z

packages/imperative/src/security/src/DefaultCredentialManager.ts

+            const initPath = ImperativeConfig.instance.callerLocation ?? require.main.filename;
+            if (initPath != null) {
+                requireOpts.paths = [initPath, ...require.resolve.paths("@zowe/secrets-for-zowe-sdk")];


We may want to keep the code structured the same as before:

Suggested change

const initPath = ImperativeConfig.instance.callerLocation ?? require.main.filename;

if (initPath != null) {

requireOpts.paths = [initPath, ...require.resolve.paths("@zowe/secrets-for-zowe-sdk")];

if (require.main?.filename != null) {

requireOpts.paths = [require.main.filename, ...require.resolve.paths("@zowe/secrets-for-zowe-sdk")];

I don't think we want to add a reference to ImperativeConfig.instance here because it is called by extenders like Zowe Explorer outside of a CLI context where the Imperative config is undefined.

I was under the impression that was the reason why it falls back to require.main.filename, since if there is no callerLocation, then it just behaves as it did before.

Follow up to our earlier discussion - ImperativeConfig.instance.callerLocation returns null so it would be ok to access in Zowe Explorer. However this may only be because we call ProfileInfo.initImpUtils which initializes a fake Imperative config object. Thanks for removing the reference, I think it is the safer option for extenders using our SDKs - will leave this comment unresolved for now to get a second opinion 😋

t1m0thyj · 2024-06-11T14:58:45Z

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

+        const maxWidth = !((yargs.terminalWidth() && yargs.terminalWidth() > 0) == null) ?
+            yargs.terminalWidth() - widthSafeGuard : preferredWidth;


This faithfully reflects the old logic, but I think the old logic may have been wrong - would the following make more sense?

Suggested change

const maxWidth = !((yargs.terminalWidth() && yargs.terminalWidth() > 0) == null) ?

yargs.terminalWidth() - widthSafeGuard : preferredWidth;

const maxWidth = (!(yargs.terminalWidth() == null) && yargs.terminalWidth() > 0) ?

yargs.terminalWidth() - widthSafeGuard : preferredWidth;

packages/zosfiles/src/methods/create/Create.ts

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

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

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

t1m0thyj

LGTM, thanks @awharn!

traeok

LGTM, thanks for all your work on this Andrew! I left a couple comments but I don't have any requests for changes.

packages/cli/src/provisioning/list/registry/RegistryInstances.handler.ts

packages/imperative/src/imperative/__tests__/plugins/PluginRequireProvider.unit.test.ts

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

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

sonarcloud · 2024-06-17T19:56:13Z

Quality Gate failed

Failed conditions
79.2% Coverage on New Code (required ≥ 80%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

github-actions · 2024-06-17T20:55:56Z

Release succeeded for the next branch. 🎉

The following packages have been published:

npm: @zowe/secrets-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/imperative@8.0.0-next.202406172053
npm: @zowe/cli-test-utils@8.0.0-next.202406172053
npm: @zowe/core-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-uss-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/provisioning-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-console-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-files-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-logs-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zosmf-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-workflows-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-jobs-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/zos-tso-for-zowe-sdk@8.0.0-next.202406172053
npm: @zowe/cli@8.0.0-next.202406172053

_{Powered by Octorelease 🚀}

awharn added 8 commits May 28, 2024 15:58

Make initial linter changes

bd1333a

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

Merge remote-tracking branch 'origin/next' into enable-deprecation-li…

d890066

…nter

Fix deprecated functions

ef5a689

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

Commit fixes

72c44fa

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

Handle if the instance ID provided by provisioning is not defined and…

a9239c9

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

Fix mistake

f89dd32

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

Merge remote-tracking branch 'origin/next' into enable-deprecation-li…

4248284

…nter

Fix mistakes that were made

3b1a255

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

awharn added the no-changelog label Jun 6, 2024

awharn requested review from t1m0thyj, gejohnston, zFernand0, traeok, jace-roell and ATorrise June 6, 2024 18:11

awharn self-assigned this Jun 6, 2024

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

View reviewed changes

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

packages/imperative/src/utilities/src/TextUtils.ts Fixed Show fixed Hide fixed

packages/imperative/src/utilities/src/TextUtils.ts Fixed Show fixed Hide fixed

awharn and others added 5 commits June 6, 2024 15:38

Change findup import

24cff30

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

Try to reset require method after plugin tests

55d70da

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Make flagged changes

3c8fcce

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

Do cleanup

73fbe6f

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

Move ConfigLoading integration test to run in band

24019b2

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

github-advanced-security bot found potential problems Jun 10, 2024

View reviewed changes

packages/imperative/src/utilities/src/TextUtils.ts Dismissed Show dismissed Hide dismissed

packages/imperative/src/utilities/src/TextUtils.ts Dismissed Show dismissed Hide dismissed

Fix broken test

7706b3a

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

t1m0thyj requested changes Jun 11, 2024

View reviewed changes

Make requested changes

ed6fdab

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

t1m0thyj self-requested a review June 11, 2024 22:54

awharn added 2 commits June 12, 2024 10:18

Merge remote-tracking branch 'origin/next' into enable-deprecation-li…

c1d37c9

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

Fix lint issues

ec3e09c

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

t1m0thyj approved these changes Jun 12, 2024

View reviewed changes

traeok approved these changes Jun 13, 2024

View reviewed changes

packages/cli/src/provisioning/list/registry/RegistryInstances.handler.ts Outdated Show resolved Hide resolved

packages/imperative/src/imperative/__tests__/plugins/PluginRequireProvider.unit.test.ts Outdated Show resolved Hide resolved

awharn added 2 commits June 13, 2024 13:20

Make requested changes

0b71370

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

Merge remote-tracking branch 'origin/next' into enable-deprecation-li…

bf8d8ad

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

awharn merged commit 38ac81f into next Jun 17, 2024
45 of 46 checks passed

awharn deleted the enable-deprecation-linter branch June 17, 2024 20:15

awharn mentioned this pull request Jun 17, 2024

Remove deprecated/unstable Utils functions #1947

Closed

1 task

github-actions bot added the released label Jun 17, 2024

t1m0thyj mentioned this pull request Jul 9, 2024

Remove deprecated methods in V2 #2191

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove use of deprecated utils functions & Enable deprecation linter #2169

Remove use of deprecated utils functions & Enable deprecation linter #2169

awharn commented Jun 6, 2024

codecov bot commented Jun 6, 2024 •

edited

Loading

t1m0thyj left a comment

t1m0thyj Jun 11, 2024

t1m0thyj Jun 11, 2024

awharn Jun 11, 2024

t1m0thyj Jun 12, 2024

t1m0thyj Jun 11, 2024

t1m0thyj left a comment

traeok left a comment

sonarcloud bot commented Jun 17, 2024

github-actions bot commented Jun 17, 2024

		const maxWidth = !((yargs.terminalWidth() && yargs.terminalWidth() > 0) == null) ?
		yargs.terminalWidth() - widthSafeGuard : preferredWidth;

Remove use of deprecated utils functions & Enable deprecation linter #2169

Remove use of deprecated utils functions & Enable deprecation linter #2169

Conversation

awharn commented Jun 6, 2024

codecov bot commented Jun 6, 2024 • edited Loading

Codecov Report

t1m0thyj left a comment

Choose a reason for hiding this comment

t1m0thyj Jun 11, 2024

Choose a reason for hiding this comment

t1m0thyj Jun 11, 2024

Choose a reason for hiding this comment

awharn Jun 11, 2024

Choose a reason for hiding this comment

t1m0thyj Jun 12, 2024

Choose a reason for hiding this comment

t1m0thyj Jun 11, 2024

Choose a reason for hiding this comment

t1m0thyj left a comment

Choose a reason for hiding this comment

traeok left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Jun 17, 2024

Quality Gate failed

github-actions bot commented Jun 17, 2024

codecov bot commented Jun 6, 2024 •

edited

Loading