feat(sdk): in-place app updates in simulator #5821
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In order to reduce iteration time when updating an application, introduce a new simulator API to support in-place updates of an app in the simulator. It is now possible to use `simulator.update(simDir)` without needing to stop the simulator and start a new instance. This method will analyze the diff between the currently loaded app and the new app defined in `simDir` and will create/update/delete resources accordingly. This implies that if a resource was not updated, it won't be restarted across app updates. As a future improvement, we can add support for watching the sim directory and automatically updating the app inside the simulator. Wow!
|
Thanks for opening this pull request! 🎉
|
|
Console preview environment is available at https://wing-console-pr-5821.fly.dev 🚀 Last Updated (UTC) 2024-03-12 16:20 |
skyrpex
reviewed
Feb 29, 2024
BenchmarksComparison to Baseline ⬜⬜🟩⬜⬜⬜⬜🟥⬜⬜⬜⬜🟥
⬜ Within 1.5 standard deviations Benchmarks may vary outside of normal expectations, especially when running in GitHub Actions CI. Results
Last Updated (UTC) 2024-03-12 16:26 |
Signed-off-by: monada-bot[bot] <monabot@monada.co>
Co-authored-by: Cristian Pallarés <cristianp@wing.cloud>
Chriscbr
reviewed
Feb 29, 2024
MarkMcCulloh
reviewed
Mar 1, 2024
Co-authored-by: Mark McCulloh <Mark.McCulloh@gmail.com>
eladb
commented
Mar 1, 2024
Signed-off-by: monada-bot[bot] <monabot@monada.co>
eladb
commented
Mar 1, 2024
libs/wingsdk/test/simulator/__snapshots__/simulator.test.ts.snap
Outdated
Show resolved
Hide resolved
Chriscbr
reviewed
Mar 1, 2024
Chriscbr
reviewed
Mar 1, 2024
Chriscbr
approved these changes
Mar 1, 2024
Signed-off-by: monada-bot[bot] <monabot@monada.co>
eladb
commented
Mar 12, 2024
Chriscbr
approved these changes
Mar 12, 2024
Signed-off-by: monada-bot[bot] <monabot@monada.co>
polamoros
approved these changes
Mar 12, 2024
skyrpex
approved these changes
Mar 12, 2024
|
Thanks for contributing, @eladb! This PR will now be added to the merge queue, or immediately merged if |
|
Congrats! 🚀 This was released in Wing 0.61.0. |
16 tasks
5 tasks
mergify bot
pushed a commit
that referenced
this pull request
Mar 12, 2024
Wing Console used `tryGetResource` and expected it to return `undefined` if the node was not found, but #5821 did not respect this contract. Fixed and added a test. Fixes #5923 Fixes #5922 ## Checklist - [x] Title matches [Winglang's style guide](https://www.winglang.io/contributing/start-here/pull_requests#how-are-pull-request-titles-formatted) - [x] Description explains motivation and solution - [x] Tests added (always) - [x] Docs updated (only required for features) - [x] Added `pr/e2e-full` label if this feature requires end-to-end testing *By submitting this pull request, I confirm that my contribution is made under the terms of the [Wing Cloud Contribution License](https://github.com/winglang/wing/blob/main/CONTRIBUTION_LICENSE.md)*.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In order to improve iteration speed when updating an application, introduce a new simulator API to support in-place updates of an app in the simulator.
It is now possible to use
simulator.update(simDir)without needing to stop the simulator and start a new instance. This method will analyze the diff between the currently loaded app and the new app defined insimDirand will create/update/delete resources accordingly.This implies that if a resource was not updated, it won't be restarted across app updates.
The way this works is that when
update(simDir)is called, we read the newsimulator.jsonfile and analyze the diff between the current resource configuration and the new one to determine which resources were added (exists only in the new config), removed (doesn't exist in the new config), updated (an attribute was changed) or retained (no change). Then, we:Modeled dependencies via an execution graph. This allows us to automatically replace any dependent resources and start in topological order.
Until we can deprecate
sim.State(waiting for #5882), we sill have an initialization loop which allows late resolution of tokens.Next step is to update the Wing Console to use this new API when a new version of the app is compiled.
Future improvements
give resources an opportunity to do an in-place update (basically call
resource.update()).updating the app inside the simulator. Wow!
Misc
The
api.cleanup()method did not wait for the server to close.Checklist
pr/e2e-fulllabel if this feature requires end-to-end testingBy submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.