Allow to disable field suggestions #3537

patrick91 · 2024-06-10T09:01:14Z

:)

Summary by Sourcery

This pull request introduces a new configuration option suggest_field in StrawberryConfig to allow disabling field suggestions in error responses. Documentation and tests have been updated to reflect this new feature.

New Features:
- Introduced a new configuration option suggest_field in StrawberryConfig to disable field suggestions in error responses.
Documentation:
- Updated the schema configurations documentation to include the new suggest_field option and other available configurations.
Tests:
- Added tests to verify the default behavior of field suggestions and the ability to disable field suggestions using the new suggest_field configuration.

sourcery-ai · 2024-06-10T09:01:22Z

Reviewer's Guide by Sourcery

This pull request introduces a new configuration option to disable field suggestions in Strawberry's GraphQL schema. The changes include updates to the documentation, new tests to verify the functionality, and modifications to the core schema processing logic to respect the new configuration.

File-Level Changes

Files	Changes
`docs/types/schema-configurations.mdx` `RELEASE.md`	Updated documentation to include the new 'suggest_field' configuration and added a release note.
`tests/schema/test_execution_errors.py`	Added new tests to verify the default behavior and the ability to disable field suggestions.
`strawberry/schema/base.py` `strawberry/schema/schema.py` `strawberry/schema/config.py`	Modified core schema processing logic to respect the new 'suggest_field' configuration.

Tips

Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
You can change your review settings at any time by accessing your dashboard:
- Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
- Change the review language;
You can always contact us if you have any questions or feedback.

patrick91 · 2024-06-10T09:02:14Z

RELEASE.md

+    name: str
+
+
+schema = strawberry.Schema(query=Query, config=StrawberryConfig(suggest_field=False))


Suggested change

schema = strawberry.Schema(query=Query, config=StrawberryConfig(suggest_field=False))

schema = strawberry.Schema(query=Query, config=StrawberryConfig(suggest_fields=False))

not sure about this name though

This is something that is usually referred as "command not found suggestion"

Maybe field_not_found_suggestions? But not sure either =P

maybe disable_field_suggestions would work better

sourcery-ai

Hey @patrick91 - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟡 General issues: 5 issues found
🟢 Security: all looks good
🟡 Testing: 2 issues found
🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

docs/types/schema-configurations.mdx

strawberry/schema/base.py

sourcery-ai · 2024-06-10T09:02:26Z

strawberry/schema/base.py

+        if not self.config.suggest_field:
+            for error in errors:


issue (performance): Potential performance impact in _process_errors.

Iterating over all errors to remove field suggestions could have a performance impact if the error list is large. Consider evaluating the performance implications or adding a note about this.

strawberry/schema/base.py

strawberry/schema/config.py

tests/schema/test_execution_errors.py

botberry · 2024-06-10T09:02:30Z

Thanks for adding the RELEASE.md file!

Here's a preview of the changelog:

This release adds a new configuration to disable field suggestions in the error
response.

@strawberry.type
class Query:
    name: str


schema = strawberry.Schema(
    query=Query, config=StrawberryConfig(disable_field_suggestions=True)
)

Trying to query { nam } will not suggest to query name instead.

Here's the tweet text:

🆕 Release (next) is out! Thanks to @patrick91 for the PR 👏

This release allows to disable field suggestions when sending an operation with
the wrong field.

Get it here 👉 https://strawberry.rocks/release/(next)

codecov · 2024-06-10T09:06:18Z

Codecov Report

Attention: Patch coverage is 97.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 96.57%. Comparing base (b7f2881) to head (ea7cbe5).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #3537    +/-   ##
========================================
  Coverage   96.56%   96.57%            
========================================
  Files         523      523            
  Lines       33485    33591   +106     
  Branches     5554     5573    +19     
========================================
+ Hits        32336    32440   +104     
- Misses        914      915     +1     
- Partials      235      236     +1

codspeed-hq · 2024-06-10T09:07:39Z

CodSpeed Performance Report

Merging #3537 will not alter performance

_{Comparing feature/disable-field-suggestions (ea7cbe5) with main (ad1f2eb)}

Summary

✅ 12 untouched benchmarks

bellini666

LGTM!

Left one suggestion regarding the config name, but not sure about that either :)

bellini666 · 2024-06-10T12:24:20Z

RELEASE.md

+    name: str
+
+
+schema = strawberry.Schema(query=Query, config=StrawberryConfig(suggest_field=False))


This is something that is usually referred as "command not found suggestion"

Maybe field_not_found_suggestions? But not sure either =P

Allow to disable field suggestions

7c521b7

patrick91 commented Jun 10, 2024

View reviewed changes

patrick91 requested a review from bellini666 June 10, 2024 09:02

sourcery-ai bot reviewed Jun 10, 2024

View reviewed changes

botberry added bot:has-release-file bot:release-type-minor labels Jun 10, 2024

bellini666 approved these changes Jun 10, 2024

View reviewed changes

patrick91 added 3 commits June 10, 2024 16:49

Better name

b1db6c6

Add tweet

7d155e3

Add test with two fields

ea7cbe5

patrick91 merged commit d615081 into main Jun 10, 2024
64 checks passed

patrick91 deleted the feature/disable-field-suggestions branch June 10, 2024 16:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to disable field suggestions #3537

Allow to disable field suggestions #3537

patrick91 commented Jun 10, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 10, 2024 •

edited

Loading

patrick91 Jun 10, 2024

bellini666 Jun 10, 2024

patrick91 Jun 10, 2024

sourcery-ai bot left a comment

sourcery-ai bot Jun 10, 2024

botberry commented Jun 10, 2024 •

edited

Loading

codecov bot commented Jun 10, 2024 •

edited

Loading

codspeed-hq bot commented Jun 10, 2024 •

edited

Loading

bellini666 left a comment

bellini666 Jun 10, 2024

		name: str


		schema = strawberry.Schema(query=Query, config=StrawberryConfig(suggest_field=False))

Allow to disable field suggestions #3537

Allow to disable field suggestions #3537

Conversation

patrick91 commented Jun 10, 2024 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Jun 10, 2024 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

patrick91 Jun 10, 2024

Choose a reason for hiding this comment

bellini666 Jun 10, 2024

Choose a reason for hiding this comment

patrick91 Jun 10, 2024

Choose a reason for hiding this comment

sourcery-ai bot left a comment

Choose a reason for hiding this comment

sourcery-ai bot Jun 10, 2024

Choose a reason for hiding this comment

botberry commented Jun 10, 2024 • edited Loading

codecov bot commented Jun 10, 2024 • edited Loading

Codecov Report

codspeed-hq bot commented Jun 10, 2024 • edited Loading

CodSpeed Performance Report

Merging #3537 will not alter performance

Summary

bellini666 left a comment

Choose a reason for hiding this comment

bellini666 Jun 10, 2024

Choose a reason for hiding this comment

patrick91 commented Jun 10, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jun 10, 2024 •

edited

Loading

botberry commented Jun 10, 2024 •

edited

Loading

codecov bot commented Jun 10, 2024 •

edited

Loading

codspeed-hq bot commented Jun 10, 2024 •

edited

Loading