appsmithorg / appsmith

Platform to build admin panels, internal tools, and dashboards. Integrates with 25+ databases and any API.
https://www.appsmith.com
Apache License 2.0
34.69k stars 3.75k forks source link

chore: Include version in all requests #37551

Open sharat87 opened 6 days ago

sharat87 commented 6 days ago

We're adding x-appsmith-version to every request from the client. If server sees a request with a x-appsmith-version that doesn't match its own, it rejects. If the server sees a request without any x-appsmith-version header, we don't reject it... for now.

On the client, when server responds with the "version mismatch" error, we trigger the "There's a new version, please refresh" toast UI flow.

This is a step towards removing our dependency on websockets and client—RTS connection.

Automation

/test sanity

:mag: Cypress test results

[!TIP] 🟒 🟒 🟒 All cypress tests have passed! πŸŽ‰ πŸŽ‰ πŸŽ‰ Workflow run: https://github.com/appsmithorg/appsmith/actions/runs/12005502452 Commit: 35d9ba637c554ecc9e7e8ffc8a323fef828421cc Cypress dashboard. Tags: @tag.Sanity Spec:


Mon, 25 Nov 2024 08:29:55 UTC

Communication

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

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 6 days ago

Walkthrough

The pull request introduces several changes primarily focused on enhancing configuration parsing and error handling across various files. Key modifications include updating the handling of the APPSMITH_VERSION_ID to provide a default value, adding a new function to include version information in request headers, and introducing error handling for 400 Bad Request responses. Additionally, the management of version updates has been simplified by removing state tracking, and new error codes have been added to improve error reporting.

Changes

File Change Summary
app/client/public/index.html Updated APPSMITH_VERSION_ID handling to default to "UNKNOWN" if not set.
app/client/src/api/interceptors/request/apiRequestInterceptor.ts Added addVersionHeader function to include X-Appsmith-Version in request headers.
app/client/src/api/interceptors/response/apiFailureResponseInterceptor.ts Introduced handleBadRequestError for specific handling of 400 Bad Request errors.
app/client/src/api/interceptors/response/failureHandlers/handleBadRequestError.ts New file for handleBadRequestError function to process 400 errors and handle version mismatches.
app/client/src/api/interceptors/response/failureHandlers/index.ts Exported handleBadRequestError from the index file for error handling functions.
app/client/src/sagas/WebsocketSagas/handleAppLevelSocketEvents.tsx Removed handling for APP_LEVEL_SOCKET_EVENTS.RELEASE_VERSION_NOTIFICATION, simplifying control flow.
app/client/src/sagas/WebsocketSagas/versionUpdatePrompt.ts Removed version state management; simplified version update handling and logging.
app/client/src/utils/storage.ts Removed functions related to version update state management from local storage.
app/server/appsmith-server/src/main/java/com/appsmith/server/configurations/SecurityConfig.java Enhanced error handling by adding version checks against request headers and modifying error response logic.
app/server/appsmith-server/src/main/java/com/appsmith/server/exceptions/AppsmithErrorCode.java Added new error code VERSION_MISMATCH for version mismatch scenarios.

Possibly related PRs

Suggested labels

Bug

Suggested reviewers

πŸŽ‰ In code we trust, with changes so bright,
Handling versions, we set things right.
From headers to errors, we’ve made it clear,
Appsmith’s now stronger, let’s all give a cheer!
πŸš€


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
sharat87 commented 5 days ago

/build-deploy-preview skip-tests=true

github-actions[bot] commented 5 days ago

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

github-actions[bot] commented 5 days ago

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

github-actions[bot] commented 2 days ago

Failed server tests

trishaanand commented 11 hours ago

@sharat87 : Server side changes LGTM. Can proceed with approval post client side review.