chore: add packagePullStatus to consolidated API#38179
Conversation
WalkthroughThis pull request introduces a new mechanism for tracking package upgrade status across the Appsmith application. The changes primarily focus on adding a Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (8)
✅ Files skipped from review due to trivial changes (2)
🔇 Additional comments (9)app/client/src/entities/Engine/AppEditorEngine.ts (2)
Destructuring
Passing app/client/src/ce/constants/ModuleConstants.ts (1)
The app/client/src/components/BottomBar/index.tsx (2)
The import statement for
Rendering app/client/src/pages/Editor/index.tsx (1)
Passing an object with app/client/src/sagas/InitSagas.ts (1)
The addition of Also applies to: 137-137 app/client/src/actions/pageActions.tsx (2)
The refactoring of Also applies to: 662-662, 665-676
The function signature has changed from positional parameters to object destructuring. Let's verify all callers have been updated to use the new signature. ✅ Verification successfulAll callers of setupPageAction are using the new object parameter signature The verification shows that both callers in the codebase are already using the new object parameter syntax:
🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Search for all calls to setupPageAction to verify they use the new signature
rg -A 2 "setupPageAction\("
Length of output: 608 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
the
skip-changelog
| setupPageAction({ | ||
| id: toLoadPageId, | ||
| isFirstLoad: true, | ||
| pageWithMigratedDsl, | ||
| packagePullStatus, |
There was a problem hiding this comment.
|
/build-deploy-preview skip-tests=true |
|
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12367985438. |
|
/build-deploy-preview skip-tests=true |
|
Deploying Your Preview: https://github.com/appsmithorg/appsmith/actions/runs/12368011119. |
|
Deploy-Preview-URL: https://ce-38179.dp.appsmith.com |
1 similar comment
|
Deploy-Preview-URL: https://ce-38179.dp.appsmith.com |
## Description This is a refactor PR to support auto pull of packages on page load. 1. adds an additional property on the consolidated API which reflects if the application needs to upgrade it's packages (`packagePullStatus`) 2. A scaffold component to be extended in EE to show the package pull status as it's called in parallel to consolidated API and is non-blocking to the app's first page load Not this is only relevant to the edit mode of the application PR for appsmithorg/appsmith-ee#5745 ## Automation /ok-to-test tags="@tag.All" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/12349195312> > Commit: 9112f8a > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=12349195312&attempt=2" target="_blank">Cypress dashboard</a>. > Tags: `@tag.All` > Spec: > <hr>Mon, 16 Dec 2024 12:30:28 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Introduced a new `PackageUpgradeStatus` component for future use. - Added a new enumeration `PACKAGE_PULL_STATUS` with status constants. - **Enhancements** - Updated `setupPageAction` to accept additional parameters for improved data handling. - Enhanced error handling and logic in methods related to loading application data and managing plugins. - **Bug Fixes** - Adjusted the argument structure for the `setupPage` method to ensure compatibility with updated action handling. - **Documentation** - Updated interfaces and method signatures to reflect new parameters and structures. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
2 participants
Description
This is a refactor PR to support auto pull of packages on page load.
packagePullStatus)Not this is only relevant to the edit mode of the application
PR for https://github.com/appsmithorg/appsmith-ee/pull/5745
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/12349195312
Commit: 9112f8a
Cypress dashboard.
Tags:
@tag.AllSpec:
Mon, 16 Dec 2024 12:30:28 UTC
Communication
Should the DevRel and Marketing teams inform users about this change?
Summary by CodeRabbit
PackageUpgradeStatuscomponent for future use.PACKAGE_PULL_STATUSwith status constants.setupPageActionto accept additional parameters for improved data handling.setupPagemethod to ensure compatibility with updated action handling.