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

fix(regulations-admin): Increase body limit on regulations backend #15884

Merged
merged 2 commits into from
Sep 5, 2024

Conversation

thordurhhh
Copy link
Member

@thordurhhh thordurhhh commented Sep 4, 2024

What

Increase JSON body limit on regulations-admin-backend.
Fixing this error: ...PayloadTooLargeError: request entity too large...

Why

Some of the body transferred can be quite big, it's rare but happens occasionally. Around 150-200kb are some of the biggest I've noticed.
apps-api already has a 300kb body limit. We need the same for regulations-admin-backend.

Checklist:

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • Formatting passes locally with my changes
  • I have rebased against main before asking for a review

Summary by CodeRabbit

  • New Features
    • Introduced a new configuration option to limit the size of JSON request bodies to 300kb, enhancing the application's ability to manage larger payloads effectively.

Copy link
Contributor

coderabbitai bot commented Sep 4, 2024

Walkthrough

The change introduces a new configuration option, jsonBodyLimit, to the bootstrap function in the main.ts file of the regulations-admin-backend application. This option is set to '300kb', establishing a maximum size limit for JSON request bodies that the application can accept.

Changes

File Change Summary
.../regulations-admin-backend/src/main.ts Added jsonBodyLimit: '300kb' to the bootstrap function to set a limit on JSON request body size.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

@datadog-island-is
Copy link

datadog-island-is bot commented Sep 4, 2024

Datadog Report

All test runs 77d2f5a 🔗

2 Total Test Services: 0 Failed, 2 Passed
⬆️ Test Sessions change in coverage: 1 increased (+0.03%), 4 no change

Test Services
Service Name Failed Known Flaky New Flaky Passed Skipped Total Time Code Coverage Change Test Service View
api 0 0 0 4 0 2.81s 1 no change Link
download-service 0 0 0 1 0 19.09s 1 increased (+0.03%) Link

@thordurhhh thordurhhh marked this pull request as ready for review September 4, 2024 13:31
@thordurhhh thordurhhh requested a review from a team as a code owner September 4, 2024 13:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9279407 and af103c3.

Files selected for processing (1)
  • apps/services/regulations-admin-backend/src/main.ts (1 hunks)
Additional context used
Path-based instructions (1)
apps/services/regulations-admin-backend/src/main.ts (2)

Pattern apps/services/**/*: "Confirm that the code adheres to the following:

  • NestJS architecture, including modules, services, and controllers.
  • Dependency injection patterns and service encapsulation.
  • Integration and unit testing coverage and practices."

Pattern apps/**/*: "Confirm that the code adheres to the following:

  • NextJS best practices, including file structure, API routes, and static generation methods.
  • Efficient state management and server-side rendering techniques.
  • Optimal use of TypeScript for component and utility type safety."
Additional comments not posted (1)
apps/services/regulations-admin-backend/src/main.ts (1)

10-10: LGTM!

The code change is approved for the following reasons:

  • The jsonBodyLimit configuration option is a valid option for the bootstrap function provided by the @island.is/infra-nest-server package.
  • The value of '300kb' is consistent with the limit set in the apps-api, as mentioned in the PR summary.
  • The change adheres to the NestJS architecture and dependency injection patterns, as it only modifies the application configuration without affecting the core architecture.
  • No new tests are required for this configuration change, as it does not affect the application's behavior or functionality.

@thordurhhh thordurhhh added the deprecated:automerge (Disabled) Merge this PR as soon as all checks pass label Sep 5, 2024
Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.93%. Comparing base (e61152a) to head (a4f665f).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main   #15884   +/-   ##
=======================================
  Coverage   36.93%   36.93%           
=======================================
  Files        6681     6681           
  Lines      136472   136463    -9     
  Branches    38756    38749    -7     
=======================================
- Hits        50401    50400    -1     
+ Misses      86071    86063    -8     
Flag Coverage Δ
api 3.39% <ø> (ø)
download-service 44.75% <ø> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 5 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e61152a...a4f665f. Read the comment docs.

@kodiakhq kodiakhq bot merged commit e0f0050 into main Sep 5, 2024
38 checks passed
@kodiakhq kodiakhq bot deleted the regulations-admin/increase-body-regulations branch September 5, 2024 10:06
jonnigs pushed a commit that referenced this pull request Sep 12, 2024
…15884)

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecated:automerge (Disabled) Merge this PR as soon as all checks pass
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants