Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(graphql): Set max execution depth to 10 #1431

Merged
merged 2 commits into from
Nov 11, 2024

Conversation

oskogstad
Copy link
Collaborator

@oskogstad oskogstad commented Nov 10, 2024

Description

We have the possibility for "infinite" recursion in our parties query (sub-parties)

  parties {
    subParties {
      subParties {
        subParties {
          subParties {
            ...
          }
        }
      }
    }
  }

Capping the global query depth level at 10.
(Max depth on dialogById seems to be 7)

query q {
  dialogById(dialogId: "c8147d41-936e-4124-8119-ea1add40c4b4") {
    dialog {
      transmissions {
        content {
          title {
            mediaType
            value {
              value
            }
          }
        }
      }
    }
  }
}

Related Issue(s)

Verification

  • Your code builds clean without any errors or warnings
  • Manual testing done (required)
  • Relevant automated test added (if you find this hard, leave it and we'll help out)

Documentation

  • Documentation is updated (either in docs-directory, Altinnpedia or a separate linked PR in altinn-studio-docs., if applicable)

Summary by CodeRabbit

  • New Features
    • Introduced a maximum execution depth for GraphQL queries, enhancing server performance and stability by limiting query complexity.

@oskogstad oskogstad requested a review from a team as a code owner November 10, 2024 18:17
Copy link
Contributor

coderabbitai bot commented Nov 10, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes in this pull request introduce a new method call to the AddDialogportenGraphQl method in the ServiceCollectionExtensions class. Specifically, the addition of .AddMaxExecutionDepthRule(10) establishes a maximum execution depth of 10 for GraphQL queries, thereby limiting how deeply nested queries can be executed. This adjustment modifies the behavior of the GraphQL server without altering any other logic or control flow in the existing code.

Changes

File Path Change Summary
src/Digdir.Domain.Dialogporten.GraphQL/ServiceCollectionExtensions.cs Added .AddMaxExecutionDepthRule(10) to the AddDialogportenGraphQl method to set a maximum execution depth for GraphQL queries.

Possibly related issues

  • Set execution depth limit for GQL #1430: This issue discusses setting a query depth limit for GraphQL to prevent infinite recursion in nested queries, which aligns with the new maximum execution depth of 10 implemented in this pull request.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@oskogstad oskogstad merged commit 8845e49 into main Nov 11, 2024
23 checks passed
@oskogstad oskogstad deleted the feat/set-max-depth-level-for-graphql-queries branch November 11, 2024 10:19
oskogstad pushed a commit that referenced this pull request Nov 12, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.32.0](v1.31.0...v1.32.0)
(2024-11-12)


### Features

* **graphql:** Set max execution depth to 10
([#1431](#1431))
([8845e49](8845e49)),
closes [#1430](#1430)
* **performance:** create a k6 purge script to run after creating
dialogs ([#1435](#1435))
([9555d78](9555d78))
* **performance:** Expands search for serviceowners, improved tracing
and logging
([#1439](#1439))
([b1d6eaf](b1d6eaf))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants