* docs: clarify difference between use_context and consume_context
Document the key distinction: use_context is a hook that captures the
context value once on first render and caches it, following the rules
of hooks. consume_context reads directly from the runtime each time
and can be called from anywhere (event handlers, async tasks, etc.).
Fixes#3862
* fix: remove redundant explicit rustdoc link targets
* fix: use plain text for cross-crate use_context reference in rustdoc
overhaul dioxus fullstack using a new implementation of server_fn
This PR is a complete rewrite of dioxus fullstack designed to improve compatibility with axum and to fix a number of compilation errors based on feature flag unification plumbing through macros.
* map signals mutably
* boxed signals
* remove mutable borrow type from boxed writable
* improve map mut example
* restore boxed_mut helper
* make boxed readable/writable types copy
* Move away from the ReadOnlySignal alias in examples
* automatically convert Write
* Fix some tests
* ReadSignal and WriteSignal
* move read only signal alias
* make maps copy
* store prototype
* implement derive macro
* Handle generics in the derive macro
* Make Selector boxable
* derive boxed conversion
* Get rid of store type
* Remove hardcoded type from derive macro
* selector -> store
* Refactor store implementation
* more vec methods
* todo mvc store example
* Implement Storable for HashMap
* fix write
* restore sorting logic in todomvc
* derive readable and writable
* improve todomvc store example
* Result store
* Option store
* collect dead subscribers
* fix clippy and formatting
* recognize some common foreign types automatically
* fix foreign stores in props
* slice and array selectors
* clean up store example
* writable is child owned
* box selector
* read and write to builtins
* re-use the proc macro in the derive macro
* Switch to a extension trait based approach
* switch to extension traits in the derive macro
* transposed method
* derive enums
* Expose Store::new
* remove stores from the prelude
* More consistent naming scheme for SelectorScope methods
* document hashmap methods
* document index extension
* document option ext
* document result ext
* document slice extension
* document the vec extension
* make more methods borrow the store mutably
* Move to impls to have higher priority over the builtin write extension traits
* fix deadlock
* finish stores documentation
* Document the store macro
* cleanup docs and organization
* finish derive docs
* fix typo
* fix clippy
* fix doc tests
* fix derive macro with generics
* fix clippy
* test and fix empty structs
* clean up todomvc store example
* default to a boxed store writer to make it easier to type when providing to the context api
* fix cargo doc
* fix clippy in store example
* relax generational box lifetime bounds
* relax bounds
* relax signal bounds
* fix compilation
* read store
* relax bounds on default store impls
* fix enum derive
* Convert to readsignal and writesignal automatically
* simplify type matching logic
* add write store
* unsized stores
* shrink the path vec type
* use more concrete types
* remove opaque types
* remove copy bounds
* use lens as generic name everywhere
* more consistent borrow semantics
* use a concrete type for the signal metadata and mention references in the map docs
* improve todomvc store docs
* document store derive macro internals
* refactor macro
* improve selector node documentation
* fix clippy
* add btreemap
* fix doc tests
* more option methods
* fix doc
* fix clippy
* add a bunch more result methods
* add a bunch of bounds to the iterators
* fix clippy
* remove option from subscribers
* add store macro to generate extension traits
* fix store example
* fix deadlock
* fix docs
* fix doc tests
* fix clippy
* add stores to public api
* add store macro, and then update todomvc_store example
---------
Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
This PR contains just the breaking changes required for the upcoming store implementation. It adds two new primitives:
Mutable mapped signals (without a different subscriber list). This lets you scope a writable value and pass it to a child component. It requires two closures to map the immutable and mutable references to the inner signal. With stores, these closures will be derived
Boxed readable and writable values (ReadSignal, and WriteSignal). Any readable or writable types can be converted to a read signal or write signal with the boxed method or built in types are automatically converted into the boxed variants when passing into props
* map signals mutably
* boxed signals
* remove mutable borrow type from boxed writable
* improve map mut example
* restore boxed_mut helper
* make boxed readable/writable types copy
* Move away from the ReadOnlySignal alias in examples
* automatically convert Write
* Fix some tests
* ReadSignal and WriteSignal
* move read only signal alias
* make maps copy
* store prototype
* implement derive macro
* Handle generics in the derive macro
* Make Selector boxable
* derive boxed conversion
* Get rid of store type
* Remove hardcoded type from derive macro
* selector -> store
* Refactor store implementation
* more vec methods
* todo mvc store example
* Implement Storable for HashMap
* fix write
* restore sorting logic in todomvc
* derive readable and writable
* improve todomvc store example
* Result store
* Option store
* collect dead subscribers
* fix clippy and formatting
* recognize some common foreign types automatically
* fix foreign stores in props
* slice and array selectors
* clean up store example
* remove stores
* writable is child owned
* fix typo
* fix clippy
* fix doc tests
* Change the suspense streaming context after suspense is resolved in the router
* Wait for the suspense context before streaming the first chunk in ssr
* forward more response parts
* warn
* extract the hydration format into a crate
* Fix hydration when no data is sent
* forward web and server features
* Fix suspense that starts on the client
* fix use_server_future on the client
* Add documentation for fullstack hooks and protocol
* downgrade rust edition
* fix clippy
* fix tests
* fix clippy
* Fix pure web compile
* undo changes to the fullstack router example
* fix formatting
* fiexed the bug when future restarts the state goes to ready instead of pending
* fix typo
* Fix future and formatting
---------
Co-authored-by: Evan Almloff <evanalmloff@gmail.com>
* Implement Rc generational pointers
* Clean up error handling a bit
* start adding tests
* Simplify a few types
* Separate Rc and normal generational boxes
* Add tests for rc drop and read
* Move over the pointer instead of the data in ReadOnlySignal props
* Fix panic on ref drop and release mode builds
* final rc signal cleanup
* use rc generational boxes for event handlers as well
* add a regression test for read only signal cloning
* merge main
---------
Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
* Expose a generic lazy type
* Switch to generic lazy globals
* simplify global lazy context a bit
* rename LazyGlobal to Global
* use Memo::global in more examples
* Fix soundness issue with deref_impl. It relies on the size of self, so it cannot be safe
* add a comment about safety
* Make clippy happy
* fix formatting
* Restore changes to signal impl
* Add helper methods for global signal and global memo to make getting the inner value easier
* Fix#2612: adjust readable trait to allow try_peek
Our implementation for Readable was inconsistent.
We had a try_unchecked variant for read but not for peek.
This resolves that by making a breaking change to the
Readable interface.
* fix doctests too
* unify the warning system
* fix VirtualDom::new warning with a component
* move warnings to dioxuslabs
* also allow writes in the component body when converting from T -> ReadOnlySignal<T>
* fix clippy from merge conflict
---------
Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
* create static site generation helpers in the router crate
* work on integrating static site generation into fullstack
* move ssg into a separate crate
* integrate ssg with the launch builder
* simplify ssg example
* fix static_routes for child routes
* move CLI hot reloading websocket code into dioxus-hot-reload
* fix some unused imports
* use the same hot reloading websocket code for fullstack
* fix fullstack hot reloading
* move cli hot reloading logic into the hot reload crate
* ssg example working with dx serve
* add more examples
* fix clippy
* switch to a result for Element
* fix formatting
* fix hot reload doctest imports
* fix axum imports
* add show method to error context
* implement retaining nodes during suspense
* fix unterminated if statements
* communicate between tasks and suspense boundaries
* make suspense placeholders easier to use
* implement IntoDynNode and IntoVNode for more wrappers
* fix clippy examples
* fix rsx tests
* add streaming html utilities to the ssr package
* unify hydration and non-hydration ssr cache
* fix router with Result Element
* don't run server doc tests
* Fix hot reload websocket doc examples
* simple apps working with fullstack streaming
* fix preloading wasm
* Report errors encountered while streaming
* remove async from incremental renderer
* document new VirtualDom suspense methods
* make streaming work with incremental rendering
* fix static site generation
* document suspense structs
* create closure type; allow async event handlers in props; allow shorthand event handlers
* test forwarding event handlers with the shorthand syntax
* fix clippy
* fix imports in spawn async doctest
* fix empty rsx
* fix async result event handlers
* fix mounting router in multiple places
* Fix task dead cancel race condition
* simplify diffing before adding suspense
* fix binary size increase
* fix attribute diffing
* more diffing fixes
* create minimal fullstack feature
* smaller fullstack bundles
* allow mounting nodes that are already created and creating nodes without mounting them
* fix hot reload feature
* fix replacing components
* don't reclaim virtual nodes
* client side suspense working!
* fix CLI
* slightly smaller fullstack builds
* fix multiple suspended scopes
* fix merge errors
* yield back to tokio every few polls to fix suspending on many tasks at once
* remove logs
* document suspense boundary and update suspense example
* fix ssg
* make streaming optional
* fix some router and core tests
* fix suspense example
* fix serialization with out of order server futures
* add incremental streaming hackernews demo
* fix hackernews demo
* fix root hackernews redirect
* fix formatting
* add tests for suspense cases
* slightly smaller binaries
* slightly smaller
* improve error handling docs
* fix errors example link
* fix doc tests
* remove log file
* fix ssr cache type inference
* remove index.html
* fix ssg render template
* fix assigning ids on elements with dynamic attributes
* add desktop feature to the workspace examples
* remove router static generation example; ssg lives in the dioxus-static-generation package
* add a test for effects during suspense
* only run effects on mounted nodes
* fix multiple suspense roots
* fix node iterator
* fix closures without arguments
* fix dioxus-core readme doctest
* remove suspense logs
* fix scope stack
* fix clippy
* remove unused suspense boundary from hackernews
* assert that launch never returns for better compiler errors
* fix static generation launch function
* fix web renderer
* pass context providers into server functions
* add an example for FromContext
* clean up DioxusRouterExt
* fix server function context
* fix fullstack desktop example
* forward CLI serve settings to fullstack
* re-export serve config at the root of fullstack
* forward env directly instead of using a guard
* just set the port in the CLI for fullstack playwright tests
* fix fullstack dioxus-cli-config feature
* fix launch server merge conflicts
* fix fullstack launch context
* Merge branch 'main' into suspense-2.0
* fix fullstack html data
* remove drop virtual dom feature
* add a comment about only_write_templates binary size workaround
* remove explicit dependencies from use_server_future
* make ErrorContext and SuspenseContext more similar
* Tweak: small tweaks to tomls to make diff smaller
* only rerun components under suspense after the initial placeholders are sent to the client
* add module docs for suspense
* keep track of when suspense boundaries are resolved
* start implementing JS out of order streaming
* fix core tests
* implement the server side of suspense with js
* fix streaming ssr with nested suspense
* move streaming ssr code into fullstack
* revert minification changes
* serialize server future data as the html streams
* start loading scripts wasm immediately instead of defering the script
* very basic nested suspense example working with minimal html updates
* clean up some suspense/error docs
* fix hydrating nested pending server futures
* sort resolved boundaries by height
* Fix disconnecting clients while streaming
* fix static generation crate
* don't insert extra divs when hydrating streamed chunks
* wait to swap in the elements until they are hydrated
* remove inline streaming script
* hackernews partially working
* fix spa mode
* banish the open shadow dom
* fix removing placeholder
* set up streaming playwright test
* run web playwright tests on 9999 to avoid port conflicts with other local servers
* remove suspense nodes if the suspense boundary is replaced before the suspense resolves on the server
* ignore hydration of removed suspense boundaries
* use path based indexing to fix hydrating suspense after parent suspense with child is removed
* re-export dioxus error
* remove resolved suspense divs if the suspense boundary has been removed
* Fix client side initialized server futures
* ignore comment nodes while traversing nodes in core to avoid lists getting swapped out with suspense
* Pass initial hydration data to the client
* hide pre nodes
* don't panic if reclaiming an element fails
* fix scope stack when polling tasks
* improve deserialization out of length message
* Ok(VNode::placeholder()) -> VNode::empty()
* fix typo in rsx usage
* restore testing changes from suspense example
* clean up some logs and comments
* fix playwright tests
* clean up more changes in core
* clean up core tests
* remove anymap dependency
* clean up changes to hooks
* clean up changes in the router, rsx, and web
* revert changes to axum-hello-world
* fix use_server_future
* fix clippy in dioxus-core
* check that the next or previous node exist before checking if we should ignore them
* fix formatting
* fix suspense playwright test
* remove unused suspense code
* add more suspense playwright tests
* add more docs for error boundaries
* fix suspense core tests
* fix ErrorBoundary example
* remove a bunch of debug logging in js
* fix router failure_external_navigation
* use absolute paths in the interpreter build.rs
* strip '\r' while hashing ts files
* add a wrapper with a default error boundary and suspense boundary
* restore hot reloading
* ignore non-ts files when hashing
* sort ts files before hashing them
* fix rsx tests
* fix fullstack doc tests
* fix core tests
* fix axum auth example
* update suspense hydration diagram
* longer playwright build limit
* tiny fixes - spelling, formatting
* update diagram link
* remove comment and template nodes for suspense placeholders
* remove comment nodes as we hydrate text
* simplify hackernews example
* clean up hydrating text nodes
* switch to a separate environment variable for the base path for smaller binaries
* clean up file system html trait
* fix form data
* move streaming code into fullstack
* implement serialize and deserialize for CapturedError
* remove waits in the nested suspense playwright spec
* force sequential fullstack builds for CI
* longer nested suspense delay for CI
* fix --force-sequential flag
* wait to launch server until client build is done
---------
Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
* deduplicate effect updates
* only subscribe to signals read in the current run of reactive scopes
* subscribe to memo reads after recomputing the value
Improve inline docs
* improve incorrect event handler return error message
* Improve event handler docs
* document the eval functions
* document spawn and common spawn errors
* fix event handler docs
* add notes about how you use attributes and elements in rsx
* add doc aliases for attributes and events we rename
* add some more aliases for common search terms
* don't doc ignore any public examples in core
* don't ignore public doc examples in ssr
* don't ignore examples in the dioxus package readme
* add a warning when you launch without a renderer enabled
* fix some outdated element docs
* add a bunch of examples to resource
* add notes about desktop events
* add more docs for use_resource
* add on_unimplemented hint to Dependency
* fix some unresolved links
* add examples to each of the router traits
* add not implemented errors for router traits
* add an example to the routable trait
* expand rsx macro docs
* improve memo docs
* update the dioxus readme
* mention dioxus crate features in the docs
* fix a bunch of doc tests
* fix html doc tests
* fix router doc tests
* fix dioxus signals doc tests
* fix dioxus ssr doc tests
* fix use_future example in the hooks cheat sheet
* add a javascript alias for eval
* fix hook explanation values
* remove unused embed-doc-image dependency
* outline work scheduling
* move scheduling code from dirty_scope to scheduler
* introduce queue_effect
* Run effects after all tasks are polled if there are no components rerendered
* add a new test for async effects
* restore set compare hook
* fix use_set_compare doc example
* add a hook to compare a value with a set
* implement partialeq for SetCompare
* export the new hook
* fix the use_set_compare hook
Jonathan Kelley