flutter / flutter/devtools

[Property Editor] Tests to make sure our constants are in-sync with those in the analysis_server

Open
#8,824 0 comments 0 reactions 0 assignees View on GitHub
P3 property editor testing
Dominant language
Dart
Stars
1.7k
Forks
404
Avg merge
6d 17h
Merged PRs (30d)
18

Description

DevTools relies on keeping some of our constant values in sync with those in the `analysis_server`:

See for example:
* https://github.com/flutter/devtools/blob/ee87359095a5c1a832fdd8084098206f44d4b733/packages/devtools_app/lib/src/shared/editor/api_classes.dart#L30
* https://github.com/flutter/devtools/pull/8818#discussion_r1934170082

This could be accomplished by fetching the raw contents of the file from the Dart SDK repo on Github. However, I believe the requests will be rate-limited to 60/hour unless we authenticate with a Github token.

* https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28
* https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-unauthenticated-users

We should either 1) create a Github token secret we can use for these tests 2) schedule the tests to only run daily so as not to exceed the rate limit

Contributor guide

Open the contributing guide

Research direction

Start with packages/devtools_app/lib/src/shared/editor/api_classes.dart and the linked discussion in pull request 8818. Review the analysis_server source and GitHub Contents API and determine whether authentication or daily scheduling is needed. Done means tests detect constants that drift from analysis_server without exceeding the stated rate limit.

Written by the indexing model from the issue text.

Assessment

Tech stack
dart, github
Domain
ci-cd, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.