Migrate from Zowe CLI package to Zowe SDKs #2730

t1m0thyj · 2024-02-20T18:14:04Z

Proposed changes

Resolves #2719

Had to temporarily add an override for @zowe/imperative in FTP extension's package.json, because we don't yet have a vNext version of the FTP plug-in with an Imperative vNext peer dependency.

Also adds a build script for updating Zowe SDKs: pnpm run update-sdks. In the future when v3 goes GA, we'll want to update the tag in this script from next to zowe-v3-lts 😋

Release Notes

Milestone: 3.0.0

Changelog: Migrated from @zowe/cli package to individual Zowe SDK packages.

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

Further comments

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

codecov · 2024-02-20T18:15:13Z

Codecov Report

Attention: Patch coverage is 95.58824% with 15 lines in your changes are missing coverage. Please review.

Project coverage is 93.43%. Comparing base (7f11560) to head (d6670af).

Files	Patch %	Lines
packages/zowe-explorer/src/Profiles.ts	85.29%	5 Missing ⚠️
...-explorer-api/src/profiles/ZoweExplorerZosmfApi.ts	96.39%	4 Missing ⚠️
...xplorer-ftp-extension/src/ZoweExplorerFtpJesApi.ts	86.66%	2 Missing ⚠️
packages/zowe-explorer/src/job/ZoweJobNode.ts	71.42%	2 Missing ⚠️
packages/zowe-explorer/src/ZoweExplorerExtender.ts	75.00%	1 Missing ⚠️
...kages/zowe-explorer/src/dataset/ZoweDatasetNode.ts	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2730      +/-   ##
==========================================
+ Coverage   93.41%   93.43%   +0.02%     
==========================================
  Files         109      109              
  Lines       10236    10241       +5     
  Branches     2184     2188       +4     
==========================================
+ Hits         9562     9569       +7     
+ Misses        673      671       -2     
  Partials        1        1

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

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

t1m0thyj · 2024-02-21T13:25:02Z

Since this PR introduces a lot more @zowe-scoped dependencies across multiple package.json files, would it be helpful to have a script in the repo that we could run to update them all to the latest version?

JillieBeanSim

Thanks @t1m0thyj LGTM!

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

t1m0thyj · 2024-02-26T16:54:56Z

Build is currently failing because we use a method marked as internal in Imperative, waiting on zowe/zowe-cli#2068 to be published

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

zFernand0

LGTM! 😋

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

traeok

LGTM, thanks @t1m0thyj 🎉

traeok · 2024-02-27T20:24:04Z

packages/zowe-explorer-api/__tests__/__unit__/profiles/ZoweExplorerZosmfApi.unit.test.ts

+import * as imperative from "@zowe/imperative";
+import * as zosconsole from "@zowe/zos-console-for-zowe-sdk";
+import * as zosfiles from "@zowe/zos-files-for-zowe-sdk";
+import * as zosjobs from "@zowe/zos-jobs-for-zowe-sdk";
+import * as zostso from "@zowe/zos-tso-for-zowe-sdk";
+import * as zosuss from "@zowe/zos-uss-for-zowe-sdk";
+import * as zosmf from "@zowe/zosmf-for-zowe-sdk";


We might want to evaluate the amount of import * statements in production code. Nothing here to worry about as this is test code - was mostly used as an example - but would help to maintain runtime efficiency 😋

Granted, since we use a bundler this really doesn't apply to us, but it might provide indirect performance benefits for non-Webpacked extenders.

zFernand0

LGTM! 😋

zFernand0 · 2024-02-27T22:39:10Z

package.json

@@ -76,6 +75,7 @@
    "package": "pnpm run -r package",
    "pretest:integration": "ts-node ./scripts/create-env.ts",
    "posttest:integration": "ts-node ./scripts/clean-env.ts",
-    "preinstall": "npx only-allow pnpm"
+    "preinstall": "npx only-allow pnpm",
+    "update-sdks": "pnpm -r update \"@zowe/*@next\" \"!@zowe/zowe-explorer-api\""


zFernand0 · 2024-02-28T14:15:17Z

This shall be merged last 😋

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

JillieBeanSim

when I run pnpm run build on this branch it creates/updates 3 files with licenses but files have nothing else in them. Should they be removed or updated as seen?

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

t1m0thyj · 2024-02-28T18:09:39Z

when I run pnpm run build on this branch it creates/updates 3 files with licenses but files have nothing else in them. Should they be removed or updated as seen?

@JillieBeanSim Thanks for catching this! I think what was happening was pnpm license added a trailing line and then pnpm pretty removed it 😆 The empty module mocks were kind of weird, so I removed them and updated tests to work without them.

sonarqubecloud · 2024-02-28T18:09:46Z

Quality Gate failed

Failed conditions
6.6% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

JillieBeanSim

LGTM! thanks @t1m0thyj

traeok

Thanks @t1m0thyj for updating the newly-merged changes to use the SDKs 😁

Migrate from Zowe CLI package to Zowe SDKs

db162f4

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

github-actions bot assigned t1m0thyj Feb 20, 2024

t1m0thyj added 2 commits February 20, 2024 13:38

Update import style to be consistent

25ca603

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

Merge branch 'next' into dev/migrate-to-sdks

1870392

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

t1m0thyj requested review from rudyflores, zFernand0, JillieBeanSim, awharn and traeok February 20, 2024 18:41

t1m0thyj marked this pull request as ready for review February 20, 2024 18:41

JillieBeanSim previously approved these changes Feb 22, 2024

View reviewed changes

Add pnpm script to update zowe sdks

8107b47

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

t1m0thyj dismissed JillieBeanSim’s stale review via 8107b47 February 26, 2024 16:41

t1m0thyj requested a review from JillieBeanSim February 26, 2024 16:42

Merge branch 'next' into dev/migrate-to-sdks

54333e2

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

t1m0thyj added 2 commits February 26, 2024 12:38

Update SDKs to fix internal import breakage

8a22b76

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

Allow range for zowe sdk deps in uss sample

c0b8649

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

zFernand0 previously approved these changes Feb 26, 2024

View reviewed changes

JillieBeanSim added this to the v3 pre-releases milestone Feb 26, 2024

t1m0thyj mentioned this pull request Feb 27, 2024

[v3 port] feat(cfg): Allow extenders to contribute to Zowe schema #2739

Merged

16 tasks

Merge branch 'next' into dev/migrate-to-sdks

3ee3d16

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

t1m0thyj dismissed zFernand0’s stale review via 3ee3d16 February 27, 2024 20:18

Fix references to cli package after merge

9db2a22

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

traeok previously approved these changes Feb 27, 2024

View reviewed changes

t1m0thyj requested a review from zFernand0 February 27, 2024 20:32

zFernand0 previously approved these changes Feb 27, 2024

View reviewed changes

Merge branch 'next' into dev/migrate-to-sdks

9ad58a3

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

t1m0thyj dismissed stale reviews from zFernand0 and traeok via 9ad58a3 February 28, 2024 15:39

t1m0thyj added 2 commits February 28, 2024 10:47

Fix references to cli package after merge

ddc5ed8

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

Fix tests and use sdk peer deps in uss sample

f983528

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

t1m0thyj force-pushed the dev/migrate-to-sdks branch from 5732f1d to f983528 Compare February 28, 2024 16:28

JillieBeanSim requested review from traeok and zFernand0 February 28, 2024 16:40

JillieBeanSim requested changes Feb 28, 2024

View reviewed changes

Remove empty module mocks

d6670af

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

t1m0thyj requested a review from JillieBeanSim February 28, 2024 18:11

JillieBeanSim approved these changes Feb 28, 2024

View reviewed changes

traeok approved these changes Feb 28, 2024

View reviewed changes

t1m0thyj merged commit ceaba7c into next Feb 28, 2024
15 of 17 checks passed

t1m0thyj deleted the dev/migrate-to-sdks branch February 28, 2024 19:03

t1m0thyj linked an issue Mar 5, 2024 that may be closed by this pull request

V3: Migrate away from @zowe/cli to @zowe/*-for-zowe-sdk packages #2719

Closed

zFernand0 mentioned this pull request Apr 30, 2024

vNext: ZE is unable to create standard base profile #2887

Closed

traeok mentioned this pull request Sep 4, 2024

IApiRegisterClient.onProfilesUpdate() does not work #3078

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate from Zowe CLI package to Zowe SDKs #2730

Migrate from Zowe CLI package to Zowe SDKs #2730

t1m0thyj commented Feb 20, 2024 •

edited

Loading

codecov bot commented Feb 20, 2024 •

edited

Loading

t1m0thyj commented Feb 21, 2024 •

edited

Loading

JillieBeanSim left a comment

t1m0thyj commented Feb 26, 2024

zFernand0 left a comment

traeok left a comment

traeok Feb 27, 2024 •

edited

Loading

zFernand0 left a comment

zFernand0 Feb 27, 2024

zFernand0 commented Feb 28, 2024

JillieBeanSim left a comment

t1m0thyj commented Feb 28, 2024 •

edited

Loading

sonarqubecloud bot commented Feb 28, 2024

JillieBeanSim left a comment

traeok left a comment

Migrate from Zowe CLI package to Zowe SDKs #2730

Migrate from Zowe CLI package to Zowe SDKs #2730

Conversation

t1m0thyj commented Feb 20, 2024 • edited Loading

Proposed changes

Release Notes

Types of changes

Checklist

Further comments

codecov bot commented Feb 20, 2024 • edited Loading

Codecov Report

t1m0thyj commented Feb 21, 2024 • edited Loading

JillieBeanSim left a comment

Choose a reason for hiding this comment

t1m0thyj commented Feb 26, 2024

zFernand0 left a comment

Choose a reason for hiding this comment

traeok left a comment

Choose a reason for hiding this comment

traeok Feb 27, 2024 • edited Loading

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

zFernand0 Feb 27, 2024

Choose a reason for hiding this comment

zFernand0 commented Feb 28, 2024

JillieBeanSim left a comment

Choose a reason for hiding this comment

t1m0thyj commented Feb 28, 2024 • edited Loading

sonarqubecloud bot commented Feb 28, 2024

Quality Gate failed

JillieBeanSim left a comment

Choose a reason for hiding this comment

traeok left a comment

Choose a reason for hiding this comment

t1m0thyj commented Feb 20, 2024 •

edited

Loading

codecov bot commented Feb 20, 2024 •

edited

Loading

t1m0thyj commented Feb 21, 2024 •

edited

Loading

traeok Feb 27, 2024 •

edited

Loading

t1m0thyj commented Feb 28, 2024 •

edited

Loading