Update JSON Forms #241

sakshibobade21 · 2024-08-09T10:20:02Z

Proposed changes

This PR addresses Issue:

Updates json forms to work with the schemas with oneOf attribute
Adds the radio buttons to choose from the available schemas
Conditionally showing the "Vsam Dataset" field only if "name" does not exists on the vsam object
The "name" field in the vsam object updates the attribute components.caching-service.storage.vsam.name
Updated the dataset pattern to allow 38 characters ate max. Basically I replaced the previous dataset pattern to the one over here: https://github.com/zowe/zowe-install-packaging/blob/v2.x/staging/schemas/server-common.json#L31 so that we have consistency
Code Organization and Cleanup

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

skurnevich · 2024-08-23T12:48:04Z

src/actions/InstallationHandler.ts

            const serverCommon = JSON.parse(readPaxYamlAndSchema.details.serverCommon);
+            updateSchemaReferences(readPaxYamlAndSchema.details, yamlSchema);


Why are we duplicating changes made in #240 here?

This PR is built on the top of #240

skurnevich · 2024-08-23T12:54:43Z

src/actions/InstallationHandler.ts

@@ -181,7 +175,7 @@ class Installation {
          ConfigurationStore.setSchema(FALLBACK_SCHEMA);
          return {status: false, details: {message: 'no schemas found from pax'}}
        }
-        return {status: parsedSchema && parsedYaml, details: {message: "Successfully retrieved example-zowe.yaml and schemas", mergedYaml: yamlObj}}
+        return {status: parsedSchema && parsedYaml, details: {message: "Successfully retrieved example-zowe.yaml and schemas", mergedYaml: yamlObj, yamlSchema: yamlSchema}}


Schema is already saved to the ConfigurationStore, lines 162, 169 and 175.
Then we take yamlSchema that will exist only in successful case (as you only set it in the try block on line 157 and so it will be empty in other cases instead of FALLBACK_SCHEMA)
And then you return it to the UI (Unpax.tsx:180) where use for rendering and override the ConfigurationStore scheme if it exists, which makes not much sense to me, or am i missing something?

That's a good catch. Thanks. I fixed it.

skurnevich · 2024-08-23T15:16:57Z

src/renderer/components/common/JsonForms.tsx

-  if (!schema || !formData) {
-    return "";
+// To handle the "if", "else", and "then" in the schema
+const conditionalSchema = (schema: any, formData: any, prop: any): boolean=> {


What reference were you using for this definition? I am looking at https://json-schema.org/understanding-json-schema/reference/conditionals#ifthenelse and it states that then or else can be omitted, also then and else sections can have properties with pattern, not only required field

This section was initially added to handle if-else conditions in the certificate schema for previous versions of Zowe. At that time, we were only verifying whether the conditional attributes were met.

These sections can also contain properties, and while all the properties were displayed, our primary focus was on checking if the condition matched.

skurnevich · 2024-08-28T15:22:35Z

src/renderer/components/common/JsonForms.tsx

-      config={{showUnfocusedDescription: true}}
-      onChange={({ data, errors }) => { onChange(data) }}
-    />
+      {  schema.oneOf &&


General question, can't JSONForms work with "oneOf" out of the box?
I didn't research much but from here it seems that is should be supported using tabs?

It could work, but we had a slightly different approach in mind:

We preferred radio buttons instead of tabs.

The JSON form data is stored in YAML, so we needed the YAML to comply with only one schema at a time. For this, we created a function called filterFormData.

We also required AJV to validate the data against the correct schema selected from the oneOf schemas.

Additionally, we don't use the JsonForms renderer as-is. We customize it as needed in the makeUISchema function. To make this work, we had to take this approach

skurnevich

Ok, but please review the comment to InitApfAuth.tsx before merge

skurnevich · 2024-09-03T14:26:55Z

src/renderer/components/stages/InitApfAuth.tsx

@@ -231,21 +230,7 @@ const InitApfAuth = () => {
      }, {});
    }

-    if(validate) {


Why did you remove this validation here? There is unused code block a few lines above, newData is never being used, so i wonder if it is not a mistake?

I removed this part of the code because it is unnecessary. The APF authorization stage includes read-only fields populated during the previous "Dataset Initialization" stage, where validations for these fields have already been performed. Re-validating them here is redundant.

I also considered removing the formChangeHandler function, as it's no longer required. However, I chose not to do so in this PR to keep the focus solely on the schema updates. I plan to address it in future code optimization PRs.

sakshibobade21 added 12 commits August 9, 2024 15:47

Merge remote-tracking branch 'origin' into update-jsonforms

164ede7

code-reorganizing

d4a6b1e

Handling oneOf schema

3ba5acd

Updating the certificates

3e28854

Updating the json forms

e1b30c8

More updates

ad2ca35

Merge remote-tracking branch 'origin' into update-jsonforms

3db0d79

Merging

1f0cdc8

More updates to the json forms

b95bf39

updating the jsonforms

c916384

More updates to the json forms

88d6f75

Successful Schema Update

68600ba

skurnevich mentioned this pull request Aug 16, 2024

Fix "Cannot read properties of undefined (reading 'pkcs12')" #235

Closed

14 tasks

sakshibobade21 added 11 commits August 19, 2024 10:47

Updating the referense resolver

ec25ec6

Updating the refrence resolver

d06288c

Minor code cleanup

2c49b91

Hardcoding

0894057

Updating the ref resolvation

206a72b

Updating the refernce resler

01457a5

Updating the json forms

bf689de

final changes to ref resolver

467998d

Merge remote-tracking branch 'origin' into update-jsonforms

1e8f757

Updating the resolv eref

5435dbb

More updates to json form

aaeeff0

sakshibobade21 requested a review from skurnevich August 21, 2024 14:34

sakshibobade21 changed the title ~~[WIP] Update JSON Forms~~ Update JSON Forms Aug 21, 2024

sakshibobade21 added 4 commits August 22, 2024 15:31

Updating the forms to update pattern

0941dc7

Final update sto the resolver

878d0d2

Removing unused codes

7acb0da

Handling the anyof schemas

24a2d2d

sakshibobade21 added 4 commits August 26, 2024 16:06

Like;y final changes for the anyon properties

51bed09

Updating the error msg to a normal log

e77d944

Updating the schema options label

a6e85fb

Updating the error message

b50df4b

skurnevich requested changes Aug 28, 2024

View reviewed changes

sakshibobade21 added 3 commits August 29, 2024 15:38

Updating the resolve ref parameters

daf26fd

small typo

5e2ecac

Setting schema

b46725e

sakshibobade21 requested a review from skurnevich August 30, 2024 09:23

sakshibobade21 added 11 commits August 30, 2024 15:01

Merging with the staging

daa6b62

Meging to staging

03536c0

Referencing new name attr to the the cashing servive

4e95647

Updating the vsam stage

7d8c883

Code opt for the vsam stage

0da9969

minor chage

f17aacd

Minor changes

2173c78

Merge remote-tracking branch 'origin' into update-jsonforms

854dff5

More updates to vsam stage

307d97b

More changes

bbd0a70

Code optimizations

7384113

skurnevich approved these changes Sep 3, 2024

View reviewed changes

Limiting the vsam dataset name to 38 characters

151e9e9

skurnevich merged commit e8960c5 into v2.x/staging Sep 3, 2024
5 of 6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update JSON Forms #241

Update JSON Forms #241

sakshibobade21 commented Aug 9, 2024 •

edited

Loading

skurnevich Aug 23, 2024

sakshibobade21 Aug 29, 2024

skurnevich Aug 23, 2024

sakshibobade21 Aug 29, 2024

skurnevich Aug 23, 2024

sakshibobade21 Aug 30, 2024

skurnevich Aug 28, 2024

sakshibobade21 Aug 30, 2024 •

edited

Loading

skurnevich left a comment •

edited

Loading

skurnevich Sep 3, 2024

sakshibobade21 Sep 3, 2024

		const serverCommon = JSON.parse(readPaxYamlAndSchema.details.serverCommon);
		updateSchemaReferences(readPaxYamlAndSchema.details, yamlSchema);

Update JSON Forms #241

Update JSON Forms #241

Conversation

sakshibobade21 commented Aug 9, 2024 • edited Loading

Proposed changes

Type of change

PR Checklist

Testing

Further comments

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

sakshibobade21 Aug 30, 2024 • edited Loading

Choose a reason for hiding this comment

skurnevich left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sakshibobade21 commented Aug 9, 2024 •

edited

Loading

sakshibobade21 Aug 30, 2024 •

edited

Loading

skurnevich left a comment •

edited

Loading