ChilliCream / ChilliCream/graphql-platform
Nitro CLI Audit For Complexity on Operations
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 5.8k
- Forks
- 810
- Avg merge
- 15h 39m
- Merged PRs (30d)
- 98
Description
Product
Nitro
Is your feature request related to a problem?
Summary
As an engineer, when writing or updating client operations and cost analysis is enabled on the server, I would like to know if these operations adhere to cost limits before releasing.
The solution you'd like
Summary
As an engineer, I would like to be able to pass a glob pattern into nitro that would represent a path to my graphql documents. Nitro would then read through the documents and report the cost analysis for these documents.
When enforcing cost limits, this would be very helpful for determining if persisted operations adhere these limits.
See: https://the-guild.dev/graphql/inspector/docs/commands/audit
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading Nitro's CLI entry point and the linked GraphQL Inspector audit documentation. Determine how Nitro currently discovers GraphQL documents and how the server's cost-analysis limits are represented. Done means a glob path can be supplied, matching documents are analyzed, and their cost-limit status is reported before release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- graphql
- Domain
- backend-api-design, cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100