Run App: app may be opened in Viewer before it's ready #5187
Assignees
Labels
area: run app
area: workbench
Issues related to Workbench category.
bug
Something isn't working
theme: app builder
usability
Milestone
Comments
sharon-wang
added
bug
This was referenced Oct 28, 2024
This was referenced Nov 4, 2024
sharon-wang
added a commit
that referenced
this issue
Nov 6, 2024
- addresses #5187 - ❓ possibly also addresses #4949 ### Implementation Notes - adds optional `appReadyMessage` property to `RunAppOptions` and `DebugAppOptions` - specify an `appReadyMessage` of `'Application startup complete'` for FastAPI and Shiny apps, which leverage uvicorn and output that message when the app is ready - delete empty `DebugConfiguration` object from the `positron-run-app.d.ts` files, as I think they are unused? - modified the logging level in `api.ts` for a few messages - `previewUrlInExecutionOutput` now checks for both the app url and the `appReadyMessage` if provided, - an app is considered ready if: - the `appReadyMessage` was not provided and the app url has been matched; or - the `appReadyMessage` was provided and matched, and the app url has been matched - if the `appReadyMessage` was provided but not matched, and the app url has been matched, we'll time out of the `raceTimeout`, but the url will have been matched, so we'll still try to open the app in the Viewer ### QA Notes - I've renabled `Python - Verify Basic FastAPI App [C903306]` which now passes - Please use the repro steps from the issue: #5187
sharon-wang
added a commit
that referenced
this issue
Nov 6, 2024
- addresses #5187 - ❓ possibly also addresses #4949 ### Implementation Notes - adds optional `appReadyMessage` property to `RunAppOptions` and `DebugAppOptions` - specify an `appReadyMessage` of `'Application startup complete'` for FastAPI and Shiny apps, which leverage uvicorn and output that message when the app is ready - delete empty `DebugConfiguration` object from the `positron-run-app.d.ts` files, as I think they are unused? - modified the logging level in `api.ts` for a few messages - `previewUrlInExecutionOutput` now checks for both the app url and the `appReadyMessage` if provided, - an app is considered ready if: - the `appReadyMessage` was not provided and the app url has been matched; or - the `appReadyMessage` was provided and matched, and the app url has been matched - if the `appReadyMessage` was provided but not matched, and the app url has been matched, we'll time out of the `raceTimeout`, but the url will have been matched, so we'll still try to open the app in the Viewer ### QA Notes - I've renabled `Python - Verify Basic FastAPI App [C903306]` which now passes - Please use the repro steps from the issue: #5187
|
This fix will be backported to the 2024.11.1 patch in #5284. |
Verified FixedPositron Version(s) : 2024.12.0-15 Test scenario(s)Fastapi app loads everytime now as expected. Link(s) to TestRail test cases run or created: |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
System details:
Positron and OS details:
Ubuntu 24.04 x86_64
Positron on Workbench; Latest on
mainonce #5138 is merged.Browser: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36 Edg/127.0.0.0
Interpreter details:
Python 3.12.3
Describe the issue:
Discovered in #5138. The app url may be opened in the Viewer slightly before the app is actually ready, resulting in an error in the Viewer pane.
Screencast.from.2024-10-28.16-53-29.webm
Steps to reproduce the issue:
Note: this seems to only reproduce in Positron on Workbench.
Expected or desired behavior:
The app should be ready to interact with in the Viewer after running the app.
Perhaps we can add something like
appReadyTexttoRunAppOptions/DebugAppOptionsin https://github.com/posit-dev/positron/blob/main/extensions/positron-run-app/src/positron-run-app.d.ts, which we can then wait for somewhere around here, before we extract the app url to display in the Viewer:https://github.com/posit-dev/positron/blob/main/extensions/positron-run-app/src/api.ts#L331-L349
In the case of fastapi, we could have
appReadyText = Application startup complete.Were there any error messages in the UI, Output panel, or Developer Tools console?
No
The text was updated successfully, but these errors were encountered: