clockworklabs / clockworklabs/SpacetimeDB
TypeScript client SDK codegen: skip and warn on ill-typed indexes
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
In the TypeScript client SDK, it should be possible to spacetime generate bindings for a module with an index whose types are not filterable. The resulting bindings should compile and run without error, but should not contain the ill-typed index. That is, spacetime generate for the TypeScript client SDK should skip indexes with non-filterable key types. A warning should be printed to the console when skipping such an index during spacetime generate.
This should be unreachable after #2494 and #2495 , but I expect we'll encounter modules that bypass those restrictions in various ways.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the spacetime generate entry point and the TypeScript client SDK index-generation code. Reproduce a module with an index whose key type is not filterable, then verify that generated bindings compile and run, omit that index, and print a warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, typescript
- Domain
- api, cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100