Rename endpoints #5534

sfc-gh-kbregula · 2022-10-13T00:58:34Z

📚 Context

Close: #3028
Spec: https://www.notion.so/streamlit/Product-spec-1caef53a784d4482a129aca184c000a5

Please describe the project or issue background here

What kind of change does this PR introduce?
- Bugfix
- Feature
- Refactoring
- Other, please describe:

🧠 Description of Changes

Add bullet points summarizing your changes here
- This is a breaking API change
- This is a visible (user-facing) change

Revised:

Insert screenshot of your updated UI/code here

Current:

Insert screenshot of existing UI/code here

🧪 Testing Done

Screenshots included
Added/Updated unit tests
Added/Updated e2e tests

🌐 References

Does this depend on other work, documents, or tickets?

Issue: Closes #XXXX

Contribution License Agreement

By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

jrieke · 2022-10-18T23:38:22Z

Just had a quick look through some things from product side and looks great! Make sure we also update the snippets in the docs that are affected by this. Talk to @snehankekre if you need help, he's owning our docs (might still be OOO though).

lib/streamlit/web/server/routes.py

vdonato

Hey @sfc-gh-kbregula,

We'll want to do this eventually, but I think we may want to hold off for a few months to coordinate with some other teams. I'll follow up in Slack with more details.

For now, I'm requesting changes to ensure this isn't merged, and I think what we'll want to do is close this PR but keep the branch alive until ~January or so, at which point we should be able to make these changes.

Thankfully, these areas of the code are rarely changed, so I don't think leaving the branch alive until then will be too expensive.

stale · 2022-11-16T02:38:43Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

vdonato · 2022-11-23T02:45:54Z

@sfc-gh-kbregula heads up that, given the plans that the SiS team currently has (which is to not update their Streamlit lib version until after PrPr launches), we may be able to go ahead and get this change merged into develop rather than waiting until January to do so. We'll just need to make sure that we document the changes necessary for non-OS teams when they first upgrade to a Streamlit version containing these changes.

I'll start a conversation in Slack next week since I think most people on other teams that would have an opinion on this are out this week for the holidays.

sfc-gh-kbregula · 2022-12-06T01:50:39Z

@vdonato I update the PR. I deleted all deprecation warnings for endpoints that are internal. Now we have the deprecation warnings for the following endpoints:

/st-metrics
/healthz
/script-health-check

lib/streamlit/web/server/server_util.py

lib/streamlit/web/server/stats_request_handler.py

lib/streamlit/web/server/server_util.py

stale · 2022-12-22T02:43:50Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

vdonato

Sorry for the delay on reviewing this @sfc-gh-kbregula!

I have two very minor comments, but otherwise this LGTM.

I'm going to leave this in the "Changes requested" state for now because we still need to finalize the exact process we'll be following for making changes that have implications for the SiS team (I was a bit ambitious to think that we could figure this out early), but once that's sorted out, this PR should be ready to be merged.

I hope to get the process for making this change finalized early next year, but I think the only necessary thing to do will be to document the necessary changes that a service replacing the Tornado server will have to implement to be compatible with the Streamlit web client (in this case, just renaming a few endpoints to the new _stcore/* versions)

vdonato · 2022-12-23T06:30:23Z

lib/streamlit/web/server/server.py

@@ -77,8 +77,16 @@
 # to an unix socket.
 UNIX_SOCKET_PREFIX = "unix://"

-# The endpoint we serve media files from.
+# The endpoints


nit: I think it'd be fine to just remove this comment entirely

vdonato · 2022-12-23T06:40:12Z

lib/streamlit/web/server/routes.py

+        if config.get_option("server.enableXsrfProtection"):
+            self.set_cookie("_xsrf", self.xsrf_token)


nit: I think it should be okay to remove this and allow the /_stcore/health endpoint be reponsible for setting the browser tab's xsrf

stale · 2023-01-06T23:24:18Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

vdonato

@sfc-gh-kbregula sorry that it took awhile to confirm that we should be able to proceed with this change -- we should be unblocked on being able to merge this PR now!

sfc-gh-kbregula · 2023-01-11T19:19:19Z

All fixed. When CI passes, I will merge these changes tomorrow.

sfc-gh-kbregula · 2023-01-18T18:25:51Z

We waiting for QA team.

sfc-gh-kbregula · 2023-01-20T13:58:25Z

QA done. Now I'm doing a rebase and merging the change.

* Update the streamlit submodule to v1.18.1 * Update the wheel file name * Update react-scripts to 5.0.1 * Replace path with path-browserify in the worker, that were automatically polyfilled by Webpack4 but it isnt' with v5 * Remove worker-loader that has been deprecated for Webpack5 * Update dependencies and craco config in @stlite/sharing adapting to streamlit@1.18.1 * Update dependencies and craco config in @stlite/desktop adapting to streamlit@1.18.1 * Set streamlit-browser dependency version * [WIP] Override mountable/* with files ejected from a newly scaffolded package with CRA5.0.1 * Customize the build config and dependency list for @stlite/mountable upon the ejected files * Update dependency versions following the streamlit-browser package * Fix typing in sharing-editor * Update mountable/DEVELOPMENT.md * Update yarn.lock * Rename the websocket endpoint path following streamlit/streamlit#5534 * Fix packages/kernel/py/e2etests/tests/test_httpserver.py * Fix the CI to run test-tornado-e2e anytime * Fix tornado-e2e tests * Fix CI * Replace @st.experimental_memo with @st.cache_data in the samples * Rename the file upload endpoint path following streamlit/streamlit#5534 * Fix BROWSER envvar value for CRA5 * Fix to avoid forbidden access to LocalStorage due to #476 * Add streamlit-browser@^1.18.1 to the deps list of @stlite/mountable * Fix comments in packages/mountable/config/webpack.config.js * Remove the type declarations for inline raw-loader import * Move the deps list from dependencies to devDependencies in @stlite/mountable * Introduce a hack to handle cross-origin policy of worker creation * Set local package name for dump_artifacts.ts * Fix CSP

* Update the streamlit submodule to v1.18.1 * Update the wheel file name * Update react-scripts to 5.0.1 * Replace path with path-browserify in the worker, that were automatically polyfilled by Webpack4 but it isnt' with v5 * Remove worker-loader that has been deprecated for Webpack5 * Update dependencies and craco config in @stlite/sharing adapting to streamlit@1.18.1 * Update dependencies and craco config in @stlite/desktop adapting to streamlit@1.18.1 * Set streamlit-browser dependency version * [WIP] Override mountable/* with files ejected from a newly scaffolded package with CRA5.0.1 * Customize the build config and dependency list for @stlite/mountable upon the ejected files * Update dependency versions following the streamlit-browser package * Fix typing in sharing-editor * Update mountable/DEVELOPMENT.md * Update yarn.lock * Rename the websocket endpoint path following streamlit/streamlit#5534 * Fix packages/kernel/py/e2etests/tests/test_httpserver.py * Fix the CI to run test-tornado-e2e anytime * Fix tornado-e2e tests * Fix CI * Replace @st.experimental_memo with @st.cache_data in the samples * Rename the file upload endpoint path following streamlit/streamlit#5534 * Fix BROWSER envvar value for CRA5 * Fix to avoid forbidden access to LocalStorage due to whitphx/stlite#476 * Add streamlit-browser@^1.18.1 to the deps list of @stlite/mountable * Fix comments in packages/mountable/config/webpack.config.js * Remove the type declarations for inline raw-loader import * Move the deps list from dependencies to devDependencies in @stlite/mountable * Introduce a hack to handle cross-origin policy of worker creation * Set local package name for dump_artifacts.ts * Fix CSP

sfc-gh-kbregula marked this pull request as ready for review October 13, 2022 22:27

tconkling requested a review from vdonato October 24, 2022 18:41

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from 8f78f3d to d439393 Compare October 24, 2022 20:02

github-advanced-security bot found potential problems Oct 24, 2022

View reviewed changes

lib/streamlit/web/server/routes.py Fixed Show resolved Hide resolved

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from d439393 to e66e9b7 Compare October 24, 2022 21:39

vdonato requested changes Nov 2, 2022

View reviewed changes

vdonato mentioned this pull request Nov 3, 2022

Temporarily have /st-allowed-message-origins double as a healthcheck #5642

Merged

3 tasks

stale bot added the stale label Nov 16, 2022

vdonato removed the stale label Nov 22, 2022

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from d9d229d to f2f8a40 Compare December 6, 2022 01:46

github-advanced-security bot found potential problems Dec 6, 2022

View reviewed changes

lib/streamlit/web/server/server_util.py Fixed Show fixed Hide fixed

lib/streamlit/web/server/stats_request_handler.py Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Dec 6, 2022

View reviewed changes

lib/streamlit/web/server/server_util.py Fixed Show fixed Hide fixed

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from 90666cf to bafb6b8 Compare December 7, 2022 11:48

stale bot added the stale label Dec 22, 2022

vdonato removed the stale label Dec 22, 2022

vdonato reviewed Dec 23, 2022

View reviewed changes

stale bot added the stale label Jan 6, 2023

vdonato added security-assessment-completed and removed stale labels Jan 7, 2023

vdonato approved these changes Jan 9, 2023

View reviewed changes

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from 8b9dd65 to 4a484d5 Compare January 11, 2023 14:01

Rename endpoints

5dcf626

sfc-gh-kbregula force-pushed the sfc-gh-kbregula-cloud-run-endpoint branch from bb17170 to 5dcf626 Compare January 20, 2023 13:56

sfc-gh-kbregula merged commit 3664a85 into develop Jan 20, 2023

nicornk mentioned this pull request Feb 10, 2023

Rename endpoints #5534 breaks streamlit behind load balancer #6095

Closed

5 tasks

whitphx added a commit to whitphx/stlite that referenced this pull request Feb 13, 2023

Rename the websocket endpoint path following streamlit/streamlit#5534

a04ea2d

whitphx added a commit to whitphx/stlite that referenced this pull request Feb 14, 2023

Rename the websocket endpoint path following streamlit/streamlit#5534

a128a99

whitphx added a commit to whitphx/stlite that referenced this pull request Feb 14, 2023

Rename the file upload endpoint path following streamlit/streamlit#5534

9589e38

vdonato mentioned this pull request Mar 3, 2023

Fix retrieving messages from the server's ForwardMsgCache #6210

Merged

1 task

sfc-gh-kmcgrady deleted the sfc-gh-kbregula-cloud-run-endpoint branch October 5, 2023 19:29

eric-skydio pushed a commit to eric-skydio/streamlit that referenced this pull request Dec 20, 2023

Rename endpoints (streamlit#5534)

fc02063

zyxue pushed a commit to zyxue/streamlit that referenced this pull request Mar 22, 2024

Rename endpoints (streamlit#5534)

feea005

zyxue pushed a commit to zyxue/streamlit that referenced this pull request Apr 16, 2024

Rename endpoints (streamlit#5534)

74e5f71

sfc-gh-pchiu pushed a commit to sfc-gh-pchiu/streamlit that referenced this pull request Sep 3, 2024

Rename endpoints (streamlit#5534)

f72ca5c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename endpoints #5534

Rename endpoints #5534

sfc-gh-kbregula commented Oct 13, 2022 •

edited

Loading

jrieke commented Oct 18, 2022

vdonato left a comment

stale bot commented Nov 16, 2022

vdonato commented Nov 23, 2022

sfc-gh-kbregula commented Dec 6, 2022

stale bot commented Dec 22, 2022

vdonato left a comment

vdonato Dec 23, 2022

sfc-gh-kbregula Jan 11, 2023

vdonato Dec 23, 2022

sfc-gh-kbregula Jan 11, 2023

stale bot commented Jan 6, 2023

vdonato left a comment

sfc-gh-kbregula commented Jan 11, 2023

sfc-gh-kbregula commented Jan 18, 2023

sfc-gh-kbregula commented Jan 20, 2023

		if config.get_option("server.enableXsrfProtection"):
		self.set_cookie("_xsrf", self.xsrf_token)

Rename endpoints #5534

Rename endpoints #5534

Conversation

sfc-gh-kbregula commented Oct 13, 2022 • edited Loading

📚 Context

🧠 Description of Changes

🧪 Testing Done

🌐 References

jrieke commented Oct 18, 2022

vdonato left a comment

Choose a reason for hiding this comment

stale bot commented Nov 16, 2022

vdonato commented Nov 23, 2022

sfc-gh-kbregula commented Dec 6, 2022

stale bot commented Dec 22, 2022

vdonato left a comment

Choose a reason for hiding this comment

vdonato Dec 23, 2022

Choose a reason for hiding this comment

sfc-gh-kbregula Jan 11, 2023

Choose a reason for hiding this comment

vdonato Dec 23, 2022

Choose a reason for hiding this comment

sfc-gh-kbregula Jan 11, 2023

Choose a reason for hiding this comment

stale bot commented Jan 6, 2023

vdonato left a comment

Choose a reason for hiding this comment

sfc-gh-kbregula commented Jan 11, 2023

sfc-gh-kbregula commented Jan 18, 2023

sfc-gh-kbregula commented Jan 20, 2023

sfc-gh-kbregula commented Oct 13, 2022 •

edited

Loading