ref: Remodel graphql schemas #742
Conversation
| coverageSha: String | ||
| hits: Int | ||
| misses: Int | ||
| lines: Int |
There was a problem hiding this comment.
Shown as deleted in this diff for illustrative purposes. In practice, we plan to delete the old fields only after everything is migrated over to the new fields and stable.
There was a problem hiding this comment.
Will you be duplicating the resolvers during the migration process as well? Ideally there would be a way to bind both the new and old schemas to the same resolvers at the same time so that the Python codes don't get duped.
| branch: String | ||
| ): [Measurement!]! | ||
|
|
||
| ### FLAGS ### |
There was a problem hiding this comment.
We have the option of keeping Flags and Components as flat fields within Coverage as here, or pulling them out into separate sub types (like below). That would futureproof it getting added to TestAnalysis or BundleAnalysis as filters. But we thought that would be overengineering for now.
type FlagMeasurements {
flagsCount: Int!
flagsMeasurementsActive: Boolean!
flagsMeasurementsBackfilled: Boolean!
...
}
Another option is
Measurements {
count: Int!
active: Boolean!
backfilled: Boolean!
...
}
type CoverageV2 {
flagMeasurements: Measurements
componentMeasurements: Measurements
}
There was a problem hiding this comment.
The schema under "Another option is" looks so clean! But yeah right now there's some small nuances between different types of measurements (eg coverage, flag, component, bundle analysis) that will require alot of refactoring to make it happen :(
| misses: Int | ||
| lines: Int | ||
| coverageSha: String | ||
| percentCovered: Float # formerly repo.coverage |
There was a problem hiding this comment.
We have the option of using the CoverageTotals type instead of these flat fields hits, mises, etc.
We decided against that because the query pattern may be different, and data may be coming from a different table. Open for discussion.
| @@ -25,6 +36,7 @@ type Repository { | |||
| last: Int | |||
| before: String | |||
| ): PullConnection @cost(complexity: 10, multipliers: ["first", "last"]) | |||
| # TODO - does this refer to commits on main only? | |||
There was a problem hiding this comment.
If anyone can answer this question, please let us know. What happens for other branches?
There was a problem hiding this comment.
It's just on default branch I'm pretty sure. You can get any commit by its SHA with Repository { commit(id: SHA) {} } per the API docs. idk how that maps onto this file, however lol.
There was a problem hiding this comment.
Repository.commits can be any set of commits depending on the filters used (see: filters: CommitsSetFilters)
In the filters it specifies:
type CommitsSetFilters {
hideFailedCI: Boolean
branchName: String
pullId: Int
search: String
states: [CommitState!]
coverageStatus: [CommitStatus!]
}
There was a problem hiding this comment.
Dangg that's good to know thanks for clarifying @JerrySentry
| @@ -1,15 +1,26 @@ | |||
| # Repository is a named collection of files uploaded | |||
There was a problem hiding this comment.
btw if you follow this notation:
https://spec.graphql.org/June2018/#sec-Descriptions
these doc strings would appear in the ariadne gql playground tool.
This is a draft PR that serves as a way to view the proposed diff for Restructure GraphQL project - https://www.notion.so/sentry/Project-Plan-Restructure-GraphQL-9b47b646b797451090c733be880615e7?pvs=4
Please comment any suggestions!!