support ajv-errors for scaffolder validation

[mbenson]

Hey, I just made a Pull Request!

First pass for discussion on issue #22575 . I'd love some guidance on how to formally test these changes.

I will attempt a pass at the documentation, but for now the items of note:

• All levels of the UI schema are searched for ui:message with message template overrides for the encountered validation error
• "message template" because embedded @{{ }} sequences may refer to the original, rewritten error object as err to support the case that the original message or other data should be exposed in the custom message.

Here is a sample template to exercise the functionality:

apiVersion: scaffolder.backstage.io/v1beta3
kind: Template

metadata:
  name: foo
  title: Foo
  description: FOO

spec:
  owner: user:bruiser
  type: testing

  parameters:
    - title: Strings
      required:
        - foo
        - bar
      properties:
        foo:
          title: Foo
          description: FOO
          type: string
          pattern: foo
          default: foo
          ui:message:
            pattern: WTF
        bar:
          title: Bar
          description: BAR
          type: string
          pattern: bar
          default: bar
        notBaz:
          title: notBaz
          description: NOT BAZ
          type: string
          not:
            pattern: baz
      ui:message:
        bar:
          pattern: WTAF
        notBaz:
          not: BAZ (@{{ err.message }})
    - title: Arrays
      properties:
        s:
          type: array
          items:
            type: string
            pattern: .{2,}
            ui:message:
              pattern: must be at least 2 characters (@{{ err.message }})
    - title: Nested
      properties:
        o:
          type: object
          properties:
            n:
              type: number
              multipleOf: 2
            a:
              type: array
              items:
                type: object
                properties:
                  s:
                    type: string
                    pattern: .{2,}
              ui:message:
                items:
                  s:
                    pattern: too short (@{{err.message}})
          ui:message:
            n:
              multipleOf: even only, dummy
  steps:
    - id: logstuff
      name: Log Stuff
      action: debug:log
      input:
        message: Nothing to see here

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)
• All your commits have a Signed-off-by line in the message. (more info)

[backstage-goalie]

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@backstage/plugin-scaffolder-react	plugins/scaffolder-react	patch	v1.9.0

[github-actions]

Uffizzi Ephemeral Environment - Virtual Cluster

Your cluster pr-23435 was successfully created. Learn more about Uffizzi virtual clusters
To connect to this cluster, follow these steps:

1. Download and install the Uffizzi CLI from https://docs.uffizzi.com/install
2. Login to Uffizzi, then select the backstage account and project:

uffizzi login

Select an account: 
  ‣ backstage
    jdoe

Select a project or create a new project: 
  ‣ backstage-6783521

3. Update your kubeconfig: uffizzi cluster update-kubeconfig pr-23435 --kubeconfig=[PATH_TO_KUBECONFIG]
   After updating your kubeconfig, you can manage your cluster with kubectl, kustomize, helm, and other tools that use kubeconfig files: kubectl get namespace --kubeconfig [PATH_TO_KUBECONFIG]

Access the backstage endpoint at https://backstage-default-pr-23435-c5333.uclusters.app.uffizzi.com

[benjdlambert]

See this comment too: #23283 (comment)

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[mbenson]

bump, awaiting direction from Backstage team

[mbenson]

not stale

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[mbenson]

Not stale

…

On Fri, Mar 22, 2024, 12:16 PM github-actions[bot] ***@***.***> wrote: This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution! — Reply to this email directly, view it on GitHub <#23435 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADXAJRZ2SXF3WMUPSE2I33YZRRP3AVCNFSM6AAAAABEJ7JOAOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMJVGU2DMNBUGU> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[freben]

Sorry that this is taking time. You've caught me in a pretty bad time, with KubeCon/BackstageCon, a large and important release, and PTO time all conspiring to make the review queue grow. I haven't forgotten you.

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[freben]

Mm right handing this over to the scaffolder maintainers to see how they feel about the templating and stuff

[mbenson]

Mm right handing this over to the scaffolder maintainers to see how they feel about the templating and stuff

Note that this PR is also blocked by #23893 .

[lulala1126]

Hi @mbenson, I really appreciate this feature PR, as I'm also waiting for this feature.
I've also looked at how to add a custom error message in react-jsonschema-form.
It looks like in addition to the methods supported by react itself (custom-error-messages) https://rjsf-team.github.io/react-jsonschema-form/docs/usage/validation/#custom-error- messages, the ajv it dependencies on already supports custom error messages (rjsf-team/react-jsonschema-form#4119). so would you mind looking into that option? 🙏 CC @hulu-xu

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[github-actions]

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!

[mbenson]

Reopen

…

On Tue, Jul 9, 2024, 5:55 PM github-actions[bot] ***@***.***> wrote: Closed #23435 <#23435>. — Reply to this email directly, view it on GitHub <#23435 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADXAJSQVI4UZ4YJPJ6SIXTZLRS4ZAVCNFSM6AAAAABEJ7JOAOVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJTGQ2DONJYHAZTQMA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[mbenson]

Hi @mbenson, I really appreciate this feature PR, as I'm also waiting for this feature. I've also looked at how to add a custom error message in react-jsonschema-form. It looks like in addition to the methods supported by react itself (custom-error-messages) https://rjsf-team.github.io/react-jsonschema-form/docs/usage/validation/#custom-error- messages, the ajv it dependencies on already supports custom error messages (rjsf-team/react-jsonschema-form#4119). so would you mind looking into that option? 🙏 CC @hulu-xu

@lulala1126 I forgot to look at this when you first mentioned it, but I [think I] agree that it makes more sense to leverage ajv-errors for this functionality, a possible caveat being that the ${} backref syntax supported by ajv-errors could potentially "sidestep" whatever nested template construct arises from #23893 @benjdlambert .

[benjdlambert]

@mbenson im out on holiday at the minute, but I'll reopen this before I forget the ping.

I like the direction of using ajv-errors if we can, and using their syntax if possible. Maybe can promote that through the bep too.

More on this when I get back late next week.

[benjdlambert]

Im fact I can't reopen it for some reason? 😅

[mbenson]

I'll just open a new PR with the ajv-errors impl