Development Overview - Githubissues

oscartbeaumont commented 2 years ago

Pre open-source:

Spacedrive Features:

[x] Rename CompiledRouter to Router and Router to RouterBuilder + Give CompiledRouter a set of default generics
[x] selection!(x, { field_one, field_two }) macro
[x] selection! macro on lists
[x] Error Handling
[x] Provide ctx function access to context/session/data/extensions + Alllow it to capture data
[x] #5
[x] Subscriptions
- [x] Access Context
- [x] Export type definitions
- [x] Subscription start/stop
[x] Subscriptions working with middleware
[x] React-query support
[x] Tauri bindings
[x] ~~Handling tenants or libraries. I am thinking maybe the ID comes from the request context but how would the frontend inject context. Maybe something on client but that has React context???~~
[x] Remove trpc compatibility to clean up code + typescript support for error handling
[x] Mattrax bindings are not generating correctly! This is #6

Fixes:

oscartbeaumont commented 2 years ago

Future:

[ ] selection! macro add abritary values Eg. selection!(user, { __type: "user", name, email }); - This would be cool but may not be possible
[ ] selection! macro subselection Eg. selection!(userWithPets, { name, email, pets: { name, email });
[ ] Example with how to do pagination with Prisma Client Rust
[ ] Websocket heartbeat and kill stale connections
[ ] Allow application to detect if websocket connection is dropped -> This could be used for a visual warning.
[ ] Unit testing rspc crate
[ ] Passthrough Rust deprecated to Typescript doc comment

Long Term:

[ ] Remove tokio from dependencies if possible
[ ] #7
[x] Better system for entending frontend hooks. Like Spacedrive does with useBridgeQuery and useLibraryQuery to automatically handle injecting the library id. This shouldn't be such a burden on end application developers.
[ ] Snippets on the documentation website should be unit tested
[x] Client-side navigation on the documentation website with preloading

oscartbeaumont commented 2 years ago

v0.0.5:

[x] Redo the Typescript monorepo. Jump to definition working, Split Tauri and React out of base client.
[x] Split up all Typescript packages
[x] New syntax for defining plugins
[x] Plugin architecture
[x] Migrate to httpz -> Fixes #22
[x] #17
[x] Move example to Astro so it can use microfrontends
[x] Open source httpz
[ ] #29
[ ] Handling Config defined on a subrouter when merging. Warning when mounting multiple Config's.
[ ] sqlx types in Specta
[ ] Rust documentation for docs.rs
[ ] Docs for beginners -> Using Arc + Mutex to get state into rspc. Contrast with Axum and Actix-web approaches to state.
[ ] Contributing guide, PR and Issue template
[ ] GitHub Social Banner + OpenGraph tags on documentation website
[x] Typescript helpers

oscartbeaumont commented 2 years ago

Future:

[ ] #23
[ ] #21
[ ] #4
[ ] #19
[ ] #18
[ ] Investigate JSON RPC compatibility?
[ ] #9
[ ] Caching -> Done through cache control headers. Ensure this doesn't break batching!
[ ] Batch queries
[ ] Prevent needing to box middleware closure using trait with multiple associated types

oscartbeaumont commented 2 years ago

Document using a Cargo Alias to run the unit test

oscartbeaumont commented 2 years ago

Next release plans:

[ ] Redo Axum extractor system
[ ] Test cases for middleware and context switching
[ ] Alpha of create-rspc-app
[ ] ctx.invalidateQuery
[ ] Batching
[ ] AbortController
[ ] #47
[ ] #29
[ ] Rust client
[ ] Cleaning up examples -> They are suck a mess currently
[ ] Plugin metadata store and hooks - So something like OpenAPI could be done.
[ ] Actix-web support
[ ] Rocket support
[ ] Netlify Functions support
[ ] Cloudflare Workers support
[ ] Vercel Functions support
[ ] Ensure everything from my other work is backported
[ ] use Specta for internal types
[ ] Specta support for flatten
[ ] rustdocs on everything
[ ] System for rate limiting http & websocket connections from specific clients (based on IP, cookies, etc)
[ ] Catch panics in resolvers and correctly return an error instead of terminating the HTTP connection.
[ ] Upgrade vscode extension with new middleware syntax
[ ] CI/CD process moved over from rspc

oscartbeaumont commented 2 years ago

Documentation Site v3 Upgrades:

[ ] 404 page is bad in dark mode
[ ] Sidebar on midsized screen text size goes bigger and sucks
[ ] Document the taurignore functionality
[x] SPA routing
- [x] Morphdom
- [x] Disable navigation buttons while in navigation phase
[ ] Reset scroll state of changing page
[ ] IOS support broken with the morphdom stuff
[ ] Edit this page button
[ ] Warnings section like the Spacedrive docs
[ ] Jump to content thing for accessibility
[ ] Interactive demos -> Idk how but make it happen (Rust compiler on Netlify Functions would be wack).
[ ] Search
[ ] Upgrading landing page to show code examples and discuss advantages
[ ] Right click logo for brand page
[ ] Valid link checker in CI
[ ] Unit test examples to ensure they are valid
[ ] Random animation on homepage
[ ] Button to copy entire code snippet
[ ] Minimisable sidebar sections
[ ] Cleanup styles and Tailwind config
[ ] JS Doc for Typescript API

oscartbeaumont commented 2 years ago

[ ] Generic middleware response type
[ ] Middleware func takes in impl Serialize + Type
[ ] Build impl GenericRouter to fix the Spacedrive problem of returning routers
[ ] Move operation names into Cow or trie router
[ ] mw.middleware should be shorten to mw(...) like what is done for procedures
[ ] Non-async middleware
[ ] Middleware which don't return a result?

oscartbeaumont commented 2 years ago

specta-rs / rspc