Repository navigation
Add reflex, the API browser code reaches Reflex through
#7949
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
FarhanAliRaza
wants to merge
7
commits into
main
Choose a base branch
from
farhan/focused-darwin-dx76ek-env
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+704
−11
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
83fd080
Add env, the API scripts reach Reflex through
FarhanAliRaza 5dd9697
Format script_env.js with biome
FarhanAliRaza 20fc39d
Add docstrings to the script env tests
FarhanAliRaza 2c92b05
Rename the script API to reflex and keep env.json in scripts
FarhanAliRaza e95f417
Put ref, add_events and library directly on rx.js
FarhanAliRaza 4ae5dbc
Test reflex and rx.js end to end in the call_script app
FarhanAliRaza 2557adf
Document reflex and rx.js usage-first
FarhanAliRaza File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add `rx.js.ref(id)`, `rx.js.add_events(*events)` and `rx.js.library(name)`, vars that call the browser's `reflex` API from Python and work both in an event trigger and returned from an event handler, e.g. `rx.run_script(rx.js.add_events(State.handler))`. See [Reaching Reflex from JavaScript](https://reflex.dev/docs/api-reference/browser-javascript/#reaching-reflex-from-javascript). |
2 changes: 1 addition & 1 deletion
2
packages/reflex-base/news/+eval-minified-shared-chunk.performance.md
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| Shrink the shared JavaScript chunk by about 88 KB (11 KB gzipped) when `frontend_lazy_bundled_libraries` is on: server-provided scripts and callbacks no longer use a direct `eval`, so the minifier can shorten every name in that chunk. Scripts passed to `rx.call_script` and `rx.call_function` still see every export of `utils/state.js` (such as `ReflexEvent`, `refs` and `queueEvents`), plus `addEvents`, `socket`, `navigate`, `params`, `token` and the globals; names the module does not export, such as its imports, are no longer in scope. | ||
| Shrink the shared JavaScript chunk by about 88 KB (11 KB gzipped) when `frontend_lazy_bundled_libraries` is on: server-provided scripts and callbacks no longer use a direct `eval`, so the minifier can shorten every name in that chunk. Scripts passed to `rx.call_script` and `rx.call_function` still see every export of `utils/state.js` (such as `ReflexEvent`, `refs` and `queueEvents`), plus `addEvents`, `socket`, `navigate`, `params`, `token`, `env` (which `rx.get_upload_url` reads) and the globals; names the module does not export, such as its other imports, are no longer in scope. |
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Add `reflex`, the API browser JavaScript reaches Reflex through: `rx.call_script` code, and JavaScript modules through `import { reflex } from "$/utils/reflex"`, can call `reflex.ref(id)`, `reflex.addEvents(events)`, `reflex.event(name, payload)` and `reflex.library(name)` instead of frontend internals, e.g. `rx.call_script("reflex.ref('search').current.focus()")`. See [Reaching Reflex from JavaScript](https://reflex.dev/docs/api-reference/browser-javascript/#reaching-reflex-from-javascript). |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| """Build calls on ``reflex``, the API browser code reaches Reflex through. | ||
|
|
||
| The frontend defines ``reflex`` in ``utils/reflex.js``. Each function here | ||
| returns a Var that renders as a call on it, such as ``reflex.ref("search")``. | ||
| A page that uses one imports ``reflex``, and code ``rx.run_script`` sends from | ||
| the backend has ``reflex`` in scope, so the same Var works in both. | ||
| """ | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from collections.abc import Mapping | ||
| from typing import Any, cast | ||
|
|
||
| from reflex_base.constants.base import Dirs | ||
| from reflex_base.event import ( | ||
| EventCallback, | ||
| EventHandler, | ||
| EventSpec, | ||
| call_event_handler, | ||
| no_args_event_spec, | ||
| ) | ||
| from reflex_base.utils.exceptions import EventFnArgMismatchError | ||
| from reflex_base.utils.imports import ImportVar | ||
| from reflex_base.vars.base import LiteralVar, Var, VarData | ||
| from reflex_base.vars.function import FunctionVar | ||
| from reflex_base.vars.object import ObjectVar | ||
|
|
||
| __all__ = ["add_events", "library", "ref"] | ||
|
|
||
| _REFLEX_VAR_DATA = VarData( | ||
| imports={f"$/{Dirs.REFLEX_API_PATH}": [ImportVar(tag="reflex")]} | ||
| ) | ||
|
|
||
|
|
||
| def _call(member: str, *args: Any) -> Var: | ||
| """Call a member of ``reflex``. | ||
|
|
||
| Args: | ||
| member: The member's name. | ||
| *args: The arguments to call it with. | ||
|
|
||
| Returns: | ||
| The call. | ||
| """ | ||
| return ( | ||
| Var(_js_expr=f"reflex.{member}", _var_data=_REFLEX_VAR_DATA) | ||
| .to(FunctionVar) | ||
| .call(*args) | ||
| ) | ||
|
|
||
|
|
||
| def _event_spec(event: EventSpec | EventHandler | EventCallback[()]) -> EventSpec: | ||
| """Build the event ``add_events`` dispatches for a handler or an event. | ||
|
|
||
| Args: | ||
| event: The event, or a handler that takes no arguments. | ||
|
|
||
| Returns: | ||
| The event. | ||
|
|
||
| Raises: | ||
| EventFnArgMismatchError: If the handler needs arguments it was not given. | ||
| """ | ||
| try: | ||
| return call_event_handler( | ||
| cast("EventSpec | EventHandler", event), no_args_event_spec | ||
| ) | ||
| except EventFnArgMismatchError as err: | ||
| handler = event.handler if isinstance(event, EventSpec) else event | ||
| name = handler.fn.__qualname__ | ||
| msg = ( | ||
| f"rx.js.add_events cannot dispatch {name}: the handler needs " | ||
| "arguments, and add_events has none to pass it. Pass them where you " | ||
| f"add it, as in rx.js.add_events({name}(...))." | ||
| ) | ||
| raise EventFnArgMismatchError(msg) from err | ||
|
|
||
|
|
||
| def ref(id: str | Var[str]) -> ObjectVar[Mapping[str, Mapping[str, Any]]]: | ||
| """Get the ref of a component by its id. | ||
|
|
||
| Args: | ||
| id: The component's id. | ||
|
|
||
| Returns: | ||
| The ref, whose ``current`` is the mounted element, or undefined if no | ||
| component with that id has mounted. | ||
| """ | ||
| return _call("ref", id).to(ObjectVar, Mapping[str, Mapping[str, Any]]) | ||
|
|
||
|
|
||
| def add_events(*events: EventSpec | EventHandler | EventCallback[()]) -> Var: | ||
| """Dispatch events through the event loop, as event triggers do. | ||
|
|
||
| Args: | ||
| *events: The events, or handlers that take no arguments. | ||
|
|
||
| Returns: | ||
| The dispatch call. | ||
| """ | ||
| return _call( | ||
| "addEvents", LiteralVar.create([_event_spec(event) for event in events]) | ||
| ) | ||
|
|
||
|
|
||
| def library(name: str | Var[str]) -> Var: | ||
| """Get an npm library bundled for dynamic components. | ||
|
|
||
| Args: | ||
| name: The library's import name, e.g. ``"react"``. | ||
|
|
||
| Returns: | ||
| A promise of the library's module namespace. | ||
| """ | ||
| return _call("library", name) |
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // `reflex`: the API JavaScript run by an app reaches Reflex through, in place | ||
| // of the internals of utils/state.js. `rx.call_script` code sees it as | ||
| // `reflex`, a module imports it from here, and `rx.js` builds calls on it from | ||
| // Python. Its members read the runtime at call time, so it is safe to import | ||
| // before the event loop mounts and from a module utils/state.js imports. | ||
| import { eventLoop } from "$/utils/context-registry"; | ||
| import { ReflexEvent, refs } from "$/utils/state"; | ||
|
|
||
| /** | ||
| * Get the name a component id is registered under in `refs`. | ||
| * | ||
| * Mirrors `format_ref` in reflex_base.utils.format: every run of characters | ||
| * that are not letters, digits or underscores becomes one underscore. | ||
| * @param {string} id The component id. | ||
| * @returns {string} The registry key. | ||
| */ | ||
| const refName = (id) => `ref_${String(id).replace(/[^\p{L}\p{N}_]+/gu, "_")}`; | ||
|
|
||
| export const reflex = Object.freeze({ | ||
| /** | ||
| * Get the ref of a component by its id. | ||
| * @param {string} id The component id. | ||
| * @returns {{current: any} | undefined} The ref, or undefined if no | ||
| * component with that id has mounted. | ||
| */ | ||
| ref: (id) => refs[refName(id)], | ||
|
|
||
| /** | ||
| * Dispatch events through the mounted event loop, as event triggers do. | ||
| * @param {any[]} events The events, built with `reflex.event`. | ||
| */ | ||
| addEvents: (events) => { | ||
| eventLoop.addEvents(events); | ||
| }, | ||
|
|
||
| /** | ||
| * Build an event for `addEvents`. | ||
| * @param {string} name The full name of the event handler. | ||
| * @param {object} [payload] The handler's arguments, by name. | ||
| * @returns {any} The event. | ||
| */ | ||
| event: (name, payload = {}) => ReflexEvent(name, payload), | ||
|
|
||
| /** | ||
| * Get an npm library bundled for dynamic components, loading it first when | ||
| * the app loads optional libraries lazily. | ||
| * @param {string} name The library's import name, e.g. "react". | ||
| * @returns {Promise<any>} The library's module namespace. | ||
| */ | ||
| library: async (name) => { | ||
| if (name.startsWith("$/")) { | ||
| throw new Error( | ||
| `reflex.library("${name}") cannot load "${name}": a name starting with "$/" is a module of the app's frontend, not a bundled npm library. Use reflex.ref, reflex.addEvents and reflex.event instead of Reflex internals, and import your own modules from a JavaScript module.`, | ||
| ); | ||
| } | ||
| await window.__reflex_load?.([name]); | ||
| // Without lazy loading, the app root registers the libraries in an effect. | ||
| if (window.__reflex === undefined) { | ||
| throw new Error( | ||
| `reflex.library("${name}") cannot load "${name}" yet: the app registers its bundled libraries when it first mounts, and it has not mounted. Call reflex.library from an event, such as on_mount or on_click, rather than while a module loads.`, | ||
| ); | ||
| } | ||
| const module = window.__reflex[name]; | ||
| if (module === undefined) { | ||
| throw new Error( | ||
| `reflex.library("${name}") cannot load "${name}": the app does not bundle it for dynamic components. Bundle it by calling bundle_library("${name}") from reflex.components.dynamic in your app's Python code.`, | ||
| ); | ||
| } | ||
| return module; | ||
| }, | ||
| }); | ||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PRs #7950 and #7951 still write a
page_script.jsthat importsenvfrom$/utils/script_envand callsenv.addEvents. This rename removes that module, so their test app cannot bundle.Both PRs also retain
environment.py, which reads the removedDirs.SCRIPT_ENV_PATHand builds calls to__reflexEnv, whichrunScriptno longer provides. Update those dependent callers and exports to the new API before merging the stack.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. #7950 and #7951 are being rebased onto this change now:
page_script.jswill import{ reflex }from$/utils/reflex, andenvironment.py,Dirs.SCRIPT_ENV_PATHand__reflexEnvare being removed from them. I'll resolve this thread once both PRs are pushed with the new API.Generated by Claude Code