FED-3160 Improve null safety docs and messages for wrapper components and connect

[greglittlefield-wf]

Motivation

The over_react null safety migration guide currently doesn't mention that:

• Wrapper components that mix in in required props will need to disable validation for any props they set inside the wrapper. This will only become an issue upon migrating those components to null safety (since it doesn't apply to non-null-safe components)
• connected components have an issue where runtime assertions about required props fail when invoking the outer component
  • See: over_react analyzer not reporting at compile time required props that are missing, and at runtime, reporting error on required props that are specified #942 (comment)
  • We also don't mention this in other relevant docs

Also, the messages in the analyzer plugin required props lint and runtime prop validation aren't very helpful when hitting these cases.

We should document these issues properly, and make it easier for consumers to find the information they need to resolve these issues.

Changes

• Add docs around connect and late props
• Add info to migration guide for connect and wrappers
• Required props lint: improve docs, mention edge-cases, add links
• Make missing required props runtime error more helpful by including more context and a link to the docs

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

• Tests were updated and provide good coverage of the changeset and other affected code
• Manual testing was performed if needed
  • Steps from PR author:
    • Rendered markdown docs look good and there are no broken links
    • Analyzer plugin info looks good in playground and references docs
      • This is what it looks like for me:
        • 
      The actual documentation link points to here https://workiva.github.io/over_react/analyzer_plugin/lints/over_react_late_required_prop.html and is currently broken because we haven't redeployed that lints docs site in a while, but we can do so after this merges
    • The runtime error message when a required prop is missing is helpful and has a non-broken link
  • Anything falling under manual testing criteria outlined in CONTRIBUTING.md

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

• A Frontend Frameworks Design member has reviewed these changes
• There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
• For release PRs - Version metadata in Rosie comment is correct

[aviary-wf]

Security Insights

No security relevant content was detected by automated scans.

Action Items

• Review PR for security impact; comment "security review required" if needed or unsure
• Verify aviary.yaml coverage of security relevant code

---

Questions or Comments? Reach out on Slack: #support-infosec.

[sydneyjodon-wk]

Should there be a mention here of what the migration looks like - like they could add the disable validation line themselves too, right?

[sydneyjodon-wk]

Or maybe link to https://github.com/Workiva/over_react/blob/e7c843022475e8e42d9e44bf2722ece990ec7336/doc/null_safety_and_required_props.md#disabling-validation-use-case-connect

[sydneyjodon-wk]

just to make it clear that they don't need to wait for the codemod

[greglittlefield-wf]

I figured that was covered in the above section, which links to the disabling validation docs section that contains the connect cases, but I can definitely clarify that here and maybe link more specifically

[sydneyjodon-wk]

That makes sense! I could go either way, but reading it initially, having that section start with "We'll be adding a codemod" makes it sound like they have to wait for us to do that 🤷

[greglittlefield-wf]

Oh for sure, and I think it should be clarified; I was more over-explaining why I initially wrote it that way, and that there was technically a link.

Addressed in 64c00a0; let me know what you think!

[sydneyjodon-wk]

I love it! Thank you!

[sydneyjodon-wk]

+10

[greglittlefield-wf]

@Workiva/release-management-p

[rmconsole-wf]

+1 from RM