chore: convert consolidated api etag to a weak one by dvj1988 · Pull Request #38939 · appsmithorg/appsmith

dvj1988 · 2025-01-31T07:56:56Z

Description

Updated the computeConsolidatedAPIResponseEtag method to return weak ETags instead of strong ETags to ensure compatibility with nginx when gzip is enabled. This change includes adding a prefix "W/" to the ETag value and includes references to related issues and documentation.

Ref: kubernetes/ingress-nginx#1390

Fixes #Issue Number
or
Fixes Issue URL

Warning

If no issue exists, please create an issue first, and check with the maintainers if the issue is valid.

Automation

/ok-to-test tags="@tag.All"

🔍 Cypress test results

Tip

🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/13069342399
Commit: b09d978
Cypress dashboard.
Tags: @tag.All
Spec:

Fri, 31 Jan 2025 10:40:19 UTC

Communication

Should the DevRel and Marketing teams inform users about this change?

Yes
No

Summary by CodeRabbit

Configuration Changes
- Modified NGINX configuration to potentially enable gzip compression for API responses
- Updated ETag generation to use weak ETag format for better compatibility
- Removed specific route handling for consolidated API endpoint in Caddy configuration

coderabbitai · 2025-01-31T07:57:04Z

Walkthrough

This pull request involves configuration changes across multiple files related to NGINX, Caddy, and server-side API response handling. The modifications primarily focus on adjusting how API responses are compressed, routed, and tagged, with specific changes to ETag generation and route configuration. The changes aim to address potential issues with header management and compression in the application's server infrastructure.

Changes

File	Change Summary
`app/client/start-https.sh`	Removed `gzip off;` line in NGINX configuration, potentially allowing default gzip compression for API responses
`app/server/.../ConsolidatedAPIServiceCEImpl.java`	Modified ETag generation to use weak ETag format, prefixed with "W/" to handle gzip compression interactions
`deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs`	Removed specific route handling block for `/api/v1/consolidated-api/view` endpoint

Sequence Diagram

sequenceDiagram
    Client->>NGINX: Send API Request
    NGINX->>Server: Forward Request
    Server->>Server: Generate Weak ETag
    Server-->>NGINX: Response with Weak ETag
    NGINX-->>Client: Compressed Response

Possibly related PRs

fix: remove cache control headers for requests handled with an error in Caddy #36590: Changes to Cache Control header handling in Caddy configuration

Suggested labels

bug

Suggested reviewers

sharat87
pratapaprasanna
rajatagrawal
nidhi-nair

Poem

🌐 Configs dance, headers sway
Gzip whispers, ETags play
Nginx bows, Caddy takes flight
Compression's magic, pure delight!
Code evolves, smooth and bright 🚀

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 26510c9 and b09d978.

📒 Files selected for processing (3)

app/client/start-https.sh (0 hunks)
app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java (1 hunks)
deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs (0 hunks)

💤 Files with no reviewable changes (2)

deploy/docker/fs/opt/appsmith/caddy-reconfigure.mjs
app/client/start-https.sh

✅ Files skipped from review due to trivial changes (1)

app/server/appsmith-server/src/main/java/com/appsmith/server/services/ce/ConsolidatedAPIServiceCEImpl.java

⏰ Context from checks skipped due to timeout of 90000ms (7)

GitHub Check: perform-test / client-build / client-build
GitHub Check: perform-test / rts-build / build
GitHub Check: perform-test / server-build / server-unit-tests
GitHub Check: client-unit-tests / client-unit-tests
GitHub Check: client-build / client-build
GitHub Check: client-lint / client-lint
GitHub Check: server-unit-tests / server-unit-tests

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

dvj1988 · 2025-01-31T07:57:10Z

/build-deploy-preview skip-tests=true

github-actions · 2025-01-31T07:57:31Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/13068639819.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 38939.
recreate: .

github-actions · 2025-01-31T08:03:19Z

Deploy-Preview-URL: https://ce-38939.dp.appsmith.com

dvj1988 · 2025-01-31T08:41:48Z

/build-deploy-preview skip-tests=true recreate=true

github-actions · 2025-01-31T08:42:11Z

Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/13069261022.
Workflow: On demand build Docker image and deploy preview.
skip-tests: true.
env: ``.
PR: 38939.
recreate: true.

github-actions · 2025-01-31T08:55:03Z

Deploy-Preview-URL: https://ce-38939.dp.appsmith.com

## Description Updated the computeConsolidatedAPIResponseEtag method to return weak ETags instead of strong ETags to ensure compatibility with nginx when gzip is enabled. This change includes adding a prefix "W/" to the ETag value and includes references to related issues and documentation. Ref: kubernetes/ingress-nginx#1390 Fixes #`Issue Number` _or_ Fixes `Issue URL` > [!WARNING] > _If no issue exists, please create an issue first, and check with the maintainers if the issue is valid._ ## Automation /ok-to-test tags="@tag.All" ### 🔍 Cypress test results  > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/13069342399> > Commit: b09d978 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13069342399&attempt=3" target="_blank">Cypress dashboard</a>. > Tags: `@tag.All` > Spec: > <hr>Fri, 31 Jan 2025 10:40:19 UTC  ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No  ## Summary by CodeRabbit - **Configuration Changes** - Modified NGINX configuration to potentially enable gzip compression for API responses - Updated ETag generation to use weak ETag format for better compatibility - Removed specific route handling for consolidated API endpoint in Caddy configuration

chore: convert consolidated api etag to a weak one

ac23afb

github-actions bot added the skip-changelog Adding this label to a PR prevents it from being listed in the changelog label Jan 31, 2025

Diljit VJ added 2 commits January 31, 2025 14:06

revert the changes in caddy and nginx configs

2055a3e

retain cache control header changes in nginx config

79f89a8

fix a typo

b09d978

dvj1988 added the ok-to-test Required label for CI label Jan 31, 2025

dvj1988 marked this pull request as ready for review January 31, 2025 08:48

dvj1988 requested review from pratapaprasanna and sharat87 as code owners January 31, 2025 08:48

dvj1988 requested a review from rajatagrawal January 31, 2025 08:48

dvj1988 enabled auto-merge (squash) January 31, 2025 09:54

dvj1988 disabled auto-merge January 31, 2025 09:54

rajatagrawal approved these changes Jan 31, 2025

View reviewed changes

dvj1988 merged commit d538d0d into release Jan 31, 2025
94 checks passed

dvj1988 deleted the chore/weak-etag-consolidated-api branch January 31, 2025 11:05

coderabbitai bot mentioned this pull request Feb 2, 2025

chore: add logs in computeConsolidatedAPIResponseEtag fn #38948

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: convert consolidated api etag to a weak one#38939

chore: convert consolidated api etag to a weak one#38939
dvj1988 merged 4 commits intoreleasefrom
chore/weak-etag-consolidated-api

dvj1988 commented Jan 31, 2025 •

edited by github-actions bot

Loading

Uh oh!

coderabbitai bot commented Jan 31, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

dvj1988 commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

dvj1988 commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dvj1988 commented Jan 31, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Automation

🔍 Cypress test results

Communication

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jan 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

dvj1988 commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

dvj1988 commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

github-actions bot commented Jan 31, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dvj1988 commented Jan 31, 2025 •

edited by github-actions bot

Loading

coderabbitai bot commented Jan 31, 2025 •

edited

Loading