[Scaffolder] Review and create didn't hide when change options #12948

tritri251214 · 2022-08-03T08:08:50Z

bandicam.2022-08-03.15-04-51-966.mp4

apiVersion: scaffolder.backstage.io/v1beta3
kind: Template
metadata:
  name: custom-field-2-example
  title: Custom Field 2 Template
  description: An example template for the scaffolder that creates a simple Node.js service
spec:
  owner: user:guest
  type: service
  parameters:
    - title: Fill in some steps
      required:
        - name
      properties:
        name:
          title: Name
          type: string
          description: Unique name of the component
          ui:autofocus: true
          ui:options:
            rows: 5
        generation:
          type: string
          title: Generation Method
          enum:
            - Option 1
            - Option 2
          default: Option 1
      dependencies:
        generation:
          oneOf:
            - properties:
                generation:
                  const: Option 1
            - required:
                - customField
              properties:
                generation:
                  const: Option 2
                customField:
                  title: Custom Field
                  type: string
                  ui:field: CustomField

    - title: Choose a location
      required:
        - repoUrl
      properties:
        repoUrl:
          title: Repository Location
          type: string
          ui:field: RepoUrlPicker
          ui:options:
            allowedHosts:
              - github.com

  steps:
    - id: fetch-base
      name: Fetch Base
      action: fetch:template
      input:
        url: ./content
        values:
          name: ${{ parameters.name }}

    - id: publish
      name: Publish
      action: publish:github
      input:
        allowedHosts: ['github.com']
        description: This is ${{ parameters.name }}
        repoUrl: ${{ parameters.repoUrl }}

    - id: register
      name: Register
      action: catalog:register
      input:
        repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
        catalogInfoPath: '/catalog-info.yaml'

  output:
    links:
      - title: Repository
        url: ${{ steps.publish.output.remoteUrl }}
      - title: Open in catalog
        icon: catalog
        entityRef: ${{ steps.register.output.entityRef }}

Custom Field Extension file:

Expected Behavior

Hide Custom Field in Review and create

Actual Behavior

Custom Field displayed in Review and create

Steps to Reproduce

Input Name
Select Generation Method is Option 2
Input Custom Field
Click button Next
Input RepoUrl field
Click button Next => Displayed value of Custom Field in Review and create
Click button Back
Click button Back => => Back to Step Fill in some steps
Select Generation Method is Option 1
Click button Next
Click button Next => Custom Field still display in Review and create

Context

Your Environment

Browser Information:
Output of yarn backstage-cli info:

OS:   Windows_NT 10.0.18363 - win32/x64
node: v16.14.0
yarn: 1.22.19
cli:  0.18.1-next.0 (local)
backstage:  N/A

Dependencies:
  @backstage/core-components         0.10.0
  @backstage/core-plugin-api         1.0.4
  @backstage/integration-react       1.1.2
  @backstage/integration             1.2.2
  @backstage/plugin-catalog-common   1.0.4
  @backstage/plugin-catalog-react    1.1.2
  @backstage/plugin-home             0.4.23
  @backstage/plugin-permission-react 0.4.3
  @backstage/plugin-stack-overflow   0.1.3

The text was updated successfully, but these errors were encountered:

benjdlambert · 2022-08-03T09:12:57Z

I think this is because of how the state is set. It's just spread into the existing state, rather than replacing the existing state for each step. So if it's set once it's never reset. Do you want to have a go at fixing this bug? I think what we want to do is to keep an array for each step of the state then merge them together at the end rather than keeping a running state.

tritri251214 · 2022-08-04T07:05:43Z

@benjdlambert , I created PR for this issue.

PR: #12966

Could you help me review it?

Thanks.

tritri251214 · 2022-08-10T01:47:54Z

This issue fixed on PR #13017

github-actions · 2022-10-09T02:34:27Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

eytanhanig · 2023-05-17T20:31:51Z

This issue fixed on PR #13017

@tritri251214 I am still experiencing this issue when testing the original YAML you posted above with Backstage version 1.13.1. Can you confirm whether this is still working for you?

Here are the abbreviated results of running `yarn backstage-cli info:

yarn run v1.22.19
$ REDACTED/backstage/node_modules/.bin/backstage-cli info
OS:   Darwin 22.4.0 - darwin/arm64
node: v18.16.0
yarn: 1.22.19
cli:  0.22.6 (installed)
backstage:  1.13.1

Dependencies:
  ...
  @backstage/plugin-scaffolder-backend             1.13.1
  @backstage/plugin-scaffolder-common              1.2.7
  @backstage/plugin-scaffolder-node                0.1.2
  @backstage/plugin-scaffolder-react               1.3.0
  @backstage/plugin-scaffolder                     1.13.0
  ...

benjdlambert · 2023-05-18T07:57:54Z

Can you try this with the scaffolder/next work that's been going on? We think that this is related to the underlying library which has been upgraded in the next version. https://backstage.io/docs/features/software-templates/testing-scaffolder-alpha/

eytanhanig · 2023-05-18T17:27:27Z

Hi @benjdlambert, thank you for the fast response!

I just tested using the master branch (6c0867b) which appears to come with scaffolder/next installed. So instead I just went to http://localhost:3000/settings/feature-flags and enabled scaffolder-next-preview there. I believe it worked since the display of step numbers switch from a vertical layout to a horizontal one. Let me know if that was the correct course of action.

Unfortunately even with the feature flag toggled on the same issue still occurred. I've attached a video below showing it.

Backstage_-_Scaffolder_Next_-_Issue_12948.mov

benjdlambert · 2023-05-19T08:50:52Z

Ah ok - I've re-opened this as I think that we need to add the omitExtraData prop to the form. Do you want to make this change and contribute? 🙏

eytanhanig · 2023-05-20T00:33:15Z

@benjdlambert I'd be happy to give it a try, although I'll confess I'm not sure where to add it since I'm very new to TypeScript and this codebase.

benjdlambert · 2023-05-22T11:02:16Z

I think you might be able to add it to this:

backstage/plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx

Lines 175 to 186 in 2589d22

    
           <Form 
        
             validator={validator} 
        
             extraErrors={errors as unknown as ErrorSchema} 
        
             formData={formState} 
        
             formContext={{ formData: formState }} 
        
             schema={currentStep.schema} 
        
             uiSchema={currentStep.uiSchema} 
        
             onSubmit={handleNext} 
        
             fields={{ ...FieldOverrides, ...extensions }} 
        
             showErrorList={false} 
        
             onChange={handleChange} 
        
             {...(props.FormProps ?? {})}

and try it locally using the scaffolder/next route and see if that works 🤞

eytanhanig · 2023-05-22T17:49:15Z

Great minds think alike! Over the weekend I tried adding it to the following files:

plugins/scaffolder-react/src/next/components/Stepper/Stepper.tsx
plugins/scaffolder/src/next/TemplateEditorPage/CustomFieldExplorer.tsx

Unfortunately there was no change in behavior. I also tried adding liveOmit, but that similarly had no impact.

When you say "try it locally using the scaffolder/next route", does that encompass doing anything beyond using the master branch and enabling the scaffolder-next-preview feature flag in the settings UI?

github-actions · 2023-07-21T17:53:55Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

TKA14EH · 2023-08-17T20:10:09Z

Any update on a fix for the issue of Review and Create not resetting/hiding the form fields after changing selections?

Looking for a fix that doesn't include the experimental version of scaffolder/next plugin. omitExtraData added to typescript props doesn't seem to work.

benjdlambert · 2023-08-21T12:42:23Z

Hmm so trying this in the editor in the new playground this seems to work upstream, so I think we just need to bump the library and turn on omitExtraData and possibly liveOmit. @TKA14EH we're moving the scaffolder/next work to be the default soon it's coming here: #19484

Here's something that seems to work here

github-actions · 2023-10-20T12:57:05Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Teemukoivumaa · 2024-01-08T08:03:17Z

@benjdlambert Should this work now? Tested this on our Backstage instance that uses the scaffolder/next but it doesn't omit the extra data

benjdlambert · 2024-01-11T08:25:08Z

@Teemukoivumaa sorry I think this got stale. Will re-open this, do you want to perhaps raise a PR with the using the omitExtraData prop and see if it works for you?

github-actions · 2024-03-11T08:41:58Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Teemukoivumaa · 2024-03-24T12:27:43Z

@benjdlambert Got some time (and motivation) to try to fix this, but it just doesn't seem to work. I have set the omitExtraData & liveOmit to true. But it doesn't remove the hidden fields like it does in the RJSF playground.

See the demo video:

2024-03-24.14-21-15.mp4

Teemukoivumaa · 2024-05-16T10:27:17Z

Still a problem

tritri251214 added the bug Something isn't working label Aug 3, 2022

github-actions bot added the area:scaffolder Everything and all things related to the scaffolder project area label Aug 3, 2022

tritri251214 mentioned this issue Aug 4, 2022

[Scaffolder] Fix review and create dependencies #12966

Closed

5 tasks

benjdlambert mentioned this issue Aug 10, 2022

scaffolder: change how we lookup the ui:schema for properties in the form for validation #13017

Closed

github-actions bot added the stale label Oct 9, 2022

github-actions bot closed this as completed Oct 16, 2022

benjdlambert reopened this May 19, 2023

github-actions bot removed the stale label May 19, 2023

Rugvip added the help wanted Help/Contributions wanted from community members label May 22, 2023

github-actions bot added the stale label Jul 21, 2023

benjdlambert removed the stale label Jul 26, 2023

github-actions bot added the stale label Oct 20, 2023

github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Oct 27, 2023

benjdlambert reopened this Jan 11, 2024

github-actions bot removed the stale label Jan 11, 2024

github-actions bot added the stale label Mar 11, 2024

github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 18, 2024

benjdlambert reopened this May 16, 2024

github-actions bot removed the stale label May 16, 2024

benjdlambert linked a pull request May 17, 2024 that will close this issue

scaffolder: Enable omitExtraData and liveOmit to trim extraneous properties from the model #24826

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Scaffolder] Review and create didn't hide when change options #12948

[Scaffolder] Review and create didn't hide when change options #12948

tritri251214 commented Aug 3, 2022

benjdlambert commented Aug 3, 2022

tritri251214 commented Aug 4, 2022

tritri251214 commented Aug 10, 2022

github-actions bot commented Oct 9, 2022

eytanhanig commented May 17, 2023

benjdlambert commented May 18, 2023 •

edited

eytanhanig commented May 18, 2023 •

edited

benjdlambert commented May 19, 2023

eytanhanig commented May 20, 2023

benjdlambert commented May 22, 2023

eytanhanig commented May 22, 2023

github-actions bot commented Jul 21, 2023

TKA14EH commented Aug 17, 2023 •

edited

benjdlambert commented Aug 21, 2023 •

edited

github-actions bot commented Oct 20, 2023

Teemukoivumaa commented Jan 8, 2024

benjdlambert commented Jan 11, 2024

github-actions bot commented Mar 11, 2024

Teemukoivumaa commented Mar 24, 2024

Teemukoivumaa commented May 16, 2024

[Scaffolder] Review and create didn't hide when change options #12948

[Scaffolder] Review and create didn't hide when change options #12948

Comments

tritri251214 commented Aug 3, 2022

Expected Behavior

Actual Behavior

Steps to Reproduce

Context

Your Environment

benjdlambert commented Aug 3, 2022

tritri251214 commented Aug 4, 2022

tritri251214 commented Aug 10, 2022

github-actions bot commented Oct 9, 2022

eytanhanig commented May 17, 2023

benjdlambert commented May 18, 2023 • edited

eytanhanig commented May 18, 2023 • edited

benjdlambert commented May 19, 2023

eytanhanig commented May 20, 2023

benjdlambert commented May 22, 2023

eytanhanig commented May 22, 2023

github-actions bot commented Jul 21, 2023

TKA14EH commented Aug 17, 2023 • edited

benjdlambert commented Aug 21, 2023 • edited

github-actions bot commented Oct 20, 2023

Teemukoivumaa commented Jan 8, 2024

benjdlambert commented Jan 11, 2024

github-actions bot commented Mar 11, 2024

Teemukoivumaa commented Mar 24, 2024

Teemukoivumaa commented May 16, 2024

benjdlambert commented May 18, 2023 •

edited

eytanhanig commented May 18, 2023 •

edited

TKA14EH commented Aug 17, 2023 •

edited

benjdlambert commented Aug 21, 2023 •

edited