FED-194 Fully implement hooks exhaustive dependencies diagnostic, add tests

[greglittlefield-wf]

Motivation

The useEffect, useMemo, and useCallback hooks take a dependencies array as an argument, but it's easy to make mistakes when declaring those dependencies, and those mistakes can lead to bugs in those components that are often hard to catch and difficult to diagnose/debug, especially for those new to using hooks.

See more info about these hooks and dependencies in the React docs.

To help ensure these dependencies are valid, React recommends the use of an ESLint rule:

We recommend using the exhaustive-deps rule as part of our eslint-plugin-react-hooks package. It warns when dependencies are specified incorrectly and suggests a fix.

But, unfortunately, Dart consumers of React can't take advantage of that rule.

Changes

Fully implement and test the HooksExhaustiveDeps diagnostic.

Ported/forked from the JS eslint-plugin-react-hooks rule, this new diagnostic aims to provide parity with the dev experience of that lint, with some behavior altered to accommodate differences between JavaScript, Dart, and their respective React APIs.

HooksExhaustiveDeps changes:

• Finish port/implementation
  • Make null-safe
  • Fix and fully implement dependency logic for useState/useReducer hooks
  • Fix dependency logic for function props
  • Fix treatment of property accesses on dependencies
  • Handle edge cases involving cascade operator
  • Treat generic parameters as dependencies (since Dart uses reified generics)
  • Refactor to allow async diagnosticCollector.addErrorWithFix calls
  • Finish porting misc. unported logic
  • Address misc. fixmes
  • Fix misc. mistakes when porting that were caught by manual testing/tests
• Add tests
  • Port tests from JS implementation
  • Add new Dart-specific tests and regression tests
• Enable by default :)

Other changes to support this:

• AnalysisOptionsReader
  • Move field declaration to from DiagnosticMixin plugin so that it can be used in getDiagnosticContributors (and potentially other places outside of diagnostics)
  • Add getOptionsForContextRoot so it can be used in places where we don't have a ResolvedUnitResult (like getDiagnosticContributors)
  • Rename to PluginOptionsReader so it wouldn't be confused with similarly-named analyzer APIs
• New utilities:
  • ast_util.dart
    • lookUpFunction
    • lookUpDeclaration
    • lookUpParameter
    • getNonCascadedPropertyBeingAccessed
    • PropertyInvocation
    • findReferences
  • prettyPrint
  • List.elementAtOrNull
  • WeakMap
  • DiagnosticTestBase.expectNoErrors
• Use a single implementation for debug comments, document in README
• Add diagnostic metrics capturing when using debug:over_react_metrics flag
• Moved code for dart:mirrors-based constant instantiation out of ast_util.dart, since it seemed different enough, that file was getting pretty big, and is currently only used for docs generation

Release Notes

• Add the HooksExhaustiveDeps diagnostic. Ported/forked from the JS eslint-plugin-react-hooks rule, this new diagnostic aims to provide parity with the dev experience of that lint, with some behavior altered to accommodate differences between JavaScript, Dart, and their respective React APIs.

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:
  • 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

[kealjones-wk]

+10

[greglittlefield-wf]

@Workiva/release-management-p

[rmconsole-wf]

+1 from RM