Major Refactor #180

timgerstel · 2024-06-12T23:20:54Z

Make sure yaml and schema are ALWAYS set
Change the description of smpe on the "Installation Type" stage as per @struga0258 's suggestion
Wrap all global variables in components in useState() to reduce memory cost *Edit: this is still here but it was actually useless lol
Fix scrolling on most stages
Fix Initialization stage status not updating when all substeps are complete
Add popup messages for upload yaml button on Launch Config/Networking stages
Make editor use entire Zowe schema
Use more Constants.tsx
Add ability to retrieve example-zowe.yaml and JSON schemas when using SMPE mode
Remove duplicate and unused vars
Fix cursor jumping to end of port input on networking stage
"Skip" on Unpax stage now fetches example-zowe.yaml and schemas
Integrate @skurnevich's method of downloading example-zowe.yaml and schemas instead of parsing cat commands🐈
Fix upload not working
Fix improper merging of example-zowe.yaml and current config thanks to @skurnevich deep merge method
Remove unused imports
Reduce duplication
Remove unused or unnecessary function args
Fix schema errors
Fix difference between smpe install dir and download/upload. Download/upload will no longer unpax to /runtime
Fix makeDir infinite loop on planning stage with invalid dirs
Fix yaml encoding so that zwe start can be run
Make editor wider
Fix certificates stage resetting zowe.setup.certificate values when changing zowe.verifyCertificates
Increase editor width and height
Probably more i forgot

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Change in a documentation
Refactor the code
Chore, repository cleanup, updates the dependencies.
Breaking change (fix or feature that would cause existing functionality to not work as expected)

PR Checklist

Please delete options that are not relevant.

If the changes in this PR are meant for the next release / mainline, this PR targets a "staging" branch.
My code follows the style guidelines of this project (see: Contributing guideline)
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
New and existing unit tests pass locally with my changes
video or image is included if visual changes are made

My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works, or describe a test method below

Testing

Further comments

…s UI properly Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…e editor was making things too tedious given the deadline Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…, and installation args are now set on the Home component. Wrap naked component global vars in useState calls. Fix auto scrolling when a stage has been complete Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…perly, remove unneeded ipcRenderer hooks Signed-off-by: Timothy Gerstel <[email protected]>

…ve refs properly Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

…mode Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

skurnevich · 2024-06-13T12:50:57Z

Does not work for me:

Local pax file uploading fails

While downloading pax fails on schema parsing

14:43:42.429 › error setting schema from pax: SyntaxError: Unexpected end of JSON input
    at JSON.parse (<anonymous>)

For the last one i have created the PR 179 to replace cat command output parsing with files downloading.
You can merge it first, or incorporate changes into this PR. The factual change is smaller than it looks, you just need to replace readExampleYamlAndSchema function and remove parseExampleYamlFromPax blocks as downloaded yaml and json files are ready to use

skurnevich · 2024-06-21T09:33:14Z

Hi @timgerstel is this PR ready for review/merge or would you like to add more changes?

Signed-off-by: Leanid Astrakou <[email protected]>

DivergentEuropeans · 2024-06-24T02:13:13Z

Created PR: #194

Signed-off-by: Leanid Astrakou <[email protected]>

Revert create recursive dirs + add edgecase

Signed-off-by: Timothy Gerstel <[email protected]>

…t longer attempt to create these Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Timothy Gerstel <[email protected]>

Signed-off-by: Leanid Astrakou <[email protected]>

Reset counter properly + don't forget the current char

Signed-off-by: Leanid Astrakou <[email protected]>

Another small edgecase

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans · 2024-06-26T16:03:44Z

src/main/index.ts

-  ipcMain.handle('download-unpax', async (event, connectionArgs, installationArgs, version, zoweConfig) => {
-    const res = await installActions.downloadUnpax(connectionArgs, installationArgs, version, zoweConfig);
+  ipcMain.handle('get-yaml-schema', async (event, connectionArgs, installationArgs) => {
+    const res = await installActions.smpeGetExampleYamlAndSchemas(connectionArgs, installationArgs);


shouldn't this be called "getExampleYamlAndSchemas"

I only see this used in 2 places, 1 in Stepper which is conditional to not SMPE and 2 in
Unpax step which is also not SMPE

DivergentEuropeans · 2024-06-26T16:09:39Z

src/renderer/components/Home.tsx

-        <Card id={`card-${id}`} square={true} >
+    <Link key={`link-${id}`} to={link} >
+      <Box sx={{ width: '40vw', height: '40vh'}} onClick={(e) => {
+        const flattenedData = flatten(lastActiveState);


lastActiveState is already a flat object with no nested properties, at a quick glance, don't see it set anywhere. Is this essential?

yeah youre right but that's pretty minor i dont that one time call when the user clicks "new installation" would cause a noticeable performance impact

src/renderer/components/Home.tsx

src/renderer/components/common/EditorDialog.tsx

src/renderer/components/stages/Certificates.tsx

-  const STAGE_ID = getStageDetails(stageLabel).id;
-  const SUB_STAGES = !!getStageDetails(stageLabel).subStages;
-  const SUB_STAGE_ID = SUB_STAGES ? getSubStageDetails(STAGE_ID, subStageLabel).id : 0;
+  const [STAGE_ID] = useState(getStageDetails(INIT_STAGE_LABEL).id);


DivergentEuropeans · 2024-06-26T18:44:32Z

src/renderer/components/stages/Networking.tsx

-            "minimum": 0,
-            "maximum": 65535,
-            "description": "Port number of how you access Zowe APIML Gateway from your local computer."
+const schema: any = {


So if BASE_SCHEMA is AJV "fixed", can't we remove the schemas in Networking + Launch Config and use BASE_SCHEMA? Or lmk I might be missing something

src/renderer/components/stages/Networking.tsx

DivergentEuropeans · 2024-06-26T21:26:14Z

src/renderer/components/stages/Security.tsx

-      } else {
-        console.warn('zwe init security failed', err?.toString()); // toString() throws run-time error on undefined or null
-      }
+      window.electron.ipcRenderer.setStandardOutput(`zwe init security failed:  ${typeof err === "string" ? err : err.toString()}`).then((res: any) => {


If this was tested, then you want to add:
alertEmitter.emit('showAlert', 'Please view Job Output for more details', 'error');

So if BASE_SCHEMA is AJV "fixed", can't we remove the schemas in Networking + Launch Config and use BASE_SCHEMA? Or lmk I might be missing something

No because the networking stage had some caveats that required its own schema which is modified from the one packaged with Zowe, maybe it can now be amended ill have to look into it

src/renderer/components/stages/installation/Installation.tsx

src/renderer/components/stages/Unpax.tsx

Signed-off-by: Timothy Gerstel <[email protected]>

Addressed

timgerstel added 27 commits June 10, 2024 18:20

Updating editor no longer crashes Zen. Updating components now update…

dc4e101

…s UI properly Signed-off-by: Timothy Gerstel <[email protected]>

More robust conditional

7610db6

Signed-off-by: Timothy Gerstel <[email protected]>

Update stage status when uploading yaml

8f01cc6

Signed-off-by: Timothy Gerstel <[email protected]>

Ideally this would be its own separate component but overhead with th…

e0de281

…e editor was making things too tedious given the deadline Signed-off-by: Timothy Gerstel <[email protected]>

Disallow non numeric input

46de0b7

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into bugfix/externalDomainsAndYaml

2383b00

Signed-off-by: Timothy Gerstel <[email protected]>

Add error notification for failed yaml upload. Set state false if fail

e5b5ce3

Signed-off-by: Timothy Gerstel <[email protected]>

Remove console log

ed32d1e

Signed-off-by: Timothy Gerstel <[email protected]>

Bulk commit because i need to check staging for something

f49f088

Signed-off-by: Timothy Gerstel <[email protected]>

Better AJV implementation

1558d04

Signed-off-by: Timothy Gerstel <[email protected]>

use useState

0660889

Signed-off-by: Timothy Gerstel <[email protected]>

useState

f05d9d7

Signed-off-by: Timothy Gerstel <[email protected]>

Update verbage

989cbe3

Signed-off-by: Timothy Gerstel <[email protected]>

Update initialization status properly when all substages are complete

3427101

Signed-off-by: Timothy Gerstel <[email protected]>

Reset stage status when uploading yaml

91f3e9b

Signed-off-by: Timothy Gerstel <[email protected]>

Fix crash on first run of Zen, fix installation args not setting pero…

0dd8f70

…perly, remove unneeded ipcRenderer hooks Signed-off-by: Timothy Gerstel <[email protected]>

Original fallback schema is needed because of AJVs inability to resol…

e88acf3

…ve refs properly Signed-off-by: Timothy Gerstel <[email protected]>

Fix schema errors

85a3672

Signed-off-by: Timothy Gerstel <[email protected]>

Fix init apf auth weird scrolling

08f2b40

Signed-off-by: Timothy Gerstel <[email protected]>

Fix launch config status resetting

6d5eeee

Signed-off-by: Timothy Gerstel <[email protected]>

Fix edge case of zowe.job not being set??? shouldnt be possible

107c0e5

Signed-off-by: Timothy Gerstel <[email protected]>

Fix installation type not being saved

4a4c3e5

Signed-off-by: Timothy Gerstel <[email protected]>

remove console logs

d4aa580

Signed-off-by: Timothy Gerstel <[email protected]>

Use correct installation args

461530f

Signed-off-by: Timothy Gerstel <[email protected]>

Add button to retrieve example-zowe.yaml and schemas when using SMPE …

4d2afc5

…mode Signed-off-by: Timothy Gerstel <[email protected]>

Always use installation args

cb79379

Signed-off-by: Timothy Gerstel <[email protected]>

timgerstel requested a review from skurnevich June 13, 2024 05:28

Rewrite all of pattern properties so port input doesnt jump to end lol

a5a0e24

Signed-off-by: Timothy Gerstel <[email protected]>

Revert create recursive dirs + add edgecase

fb2486c

Signed-off-by: Leanid Astrakou <[email protected]>

DivergentEuropeans and others added 19 commits June 24, 2024 15:19

Added a stop recursion flag for bad permissions edgecase

338585e

Signed-off-by: Leanid Astrakou <[email protected]>

Merge pull request #194 from zowe/fix-recursive-dirs

4394cad

Revert create recursive dirs + add edgecase

Only create runtime dir

79f5420

Signed-off-by: Timothy Gerstel <[email protected]>

Fix typo

725cc3f

Signed-off-by: Timothy Gerstel <[email protected]>

Fix yaml being out of sync on cert stage

3f56a11

Signed-off-by: Timothy Gerstel <[email protected]>

Reset certificates status on input change

4e02307

Signed-off-by: Timothy Gerstel <[email protected]>

Remove status checks for workspace, log, extension dir as zen will no…

b08f8df

…t longer attempt to create these Signed-off-by: Timothy Gerstel <[email protected]>

New installation now resets state properly

c0b0893

Signed-off-by: Timothy Gerstel <[email protected]>

Dont load last state if isResume

bbfe3b6

Signed-off-by: Timothy Gerstel <[email protected]>

Increase editor width and height

de7835e

Signed-off-by: Timothy Gerstel <[email protected]>

Merge branch 'v2.x/staging' into fullRewrite

968458f

Reset values on new install

4f8f067

Signed-off-by: Timothy Gerstel <[email protected]>

Fix error for undefined object

b098fdd

Signed-off-by: Timothy Gerstel <[email protected]>

Reset counter properly + don't forget the current char

9ec8658

Signed-off-by: Leanid Astrakou <[email protected]>

Remove comments

f20c239

Signed-off-by: Leanid Astrakou <[email protected]>

Merge pull request #198 from zowe/bugfix/script-parsing

4564ee3

Reset counter properly + don't forget the current char

Another small edgecase

e70a664

Signed-off-by: Leanid Astrakou <[email protected]>

Merge pull request #199 from zowe/bugfix/script-parsing

0ea3670

Another small edgecase

Fix undefined port

82a4149

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans reviewed Jun 26, 2024

View reviewed changes

timgerstel added 3 commits June 26, 2024 18:09

Add worpWrap

65519fd

Signed-off-by: Timothy Gerstel <[email protected]>

Fix job output, mostly

2091fee

Signed-off-by: Timothy Gerstel <[email protected]>

Dont store password

8dc51a5

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans approved these changes Jun 27, 2024

View reviewed changes

Only wordwrap non yaml output

02878ec

Signed-off-by: Timothy Gerstel <[email protected]>

DivergentEuropeans merged commit 5c46605 into v2.x/staging Jun 27, 2024
4 of 5 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Major Refactor #180

Major Refactor #180

timgerstel commented Jun 12, 2024 •

edited

Loading

skurnevich commented Jun 13, 2024 •

edited

Loading

skurnevich commented Jun 21, 2024

DivergentEuropeans commented Jun 24, 2024

DivergentEuropeans Jun 26, 2024

timgerstel Jul 2, 2024

DivergentEuropeans Jun 26, 2024

timgerstel Jul 2, 2024

This comment was marked as resolved.

DivergentEuropeans Jun 26, 2024

DivergentEuropeans Jun 26, 2024

timgerstel Jul 2, 2024 •

edited

Loading

Major Refactor #180

Major Refactor #180

Conversation

timgerstel commented Jun 12, 2024 • edited Loading

Type of change

PR Checklist

Testing

Further comments

skurnevich commented Jun 13, 2024 • edited Loading

skurnevich commented Jun 21, 2024

DivergentEuropeans commented Jun 24, 2024

DivergentEuropeans Jun 26, 2024

Choose a reason for hiding this comment

timgerstel Jul 2, 2024

Choose a reason for hiding this comment

DivergentEuropeans Jun 26, 2024

Choose a reason for hiding this comment

timgerstel Jul 2, 2024

Choose a reason for hiding this comment

This comment was marked as resolved.

DivergentEuropeans Jun 26, 2024

Choose a reason for hiding this comment

DivergentEuropeans Jun 26, 2024

Choose a reason for hiding this comment

timgerstel Jul 2, 2024 • edited Loading

Choose a reason for hiding this comment

timgerstel commented Jun 12, 2024 •

edited

Loading

skurnevich commented Jun 13, 2024 •

edited

Loading

timgerstel Jul 2, 2024 •

edited

Loading