geldata / geldata/gel-rust

`edgedb` crate structure

Open
#259 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
231
Forks
30
PR merge metrics
No merged PRs in 30d

Description

We has always wanted to expose bindings under edgedb crate instead of the edgedb-tokio/whatever. But the structure of that is not very clear. Here is a sketch of my current thinking.

  1. Expose edgedb::model, edgedb::error, and whatever is needed for derive macros.
  2. Feature tokio: exposes edgedb::tokio
  3. Feature blocking: exposes edgedb::blocking (which probably a blocking wrapper around tokio)
  4. We might have default-tokio and default-blocking client which expose respective clients to the top-level namespace edgedb::tokio::Client -> edgedb::client, edgedb::blocking::Client -> edgedb::Client.
  5. Potentically async-std/glommio or whatever new runtime can be done via it's own crate and brought here via feature flag. Also blocking implementation that doesn't depend on tokio could be implemented in the future too.

Ideally when async traits arrive to the stable Rust here is how it should work:

  1. There is an edgedb-async crate which contains traits for executing queries
  2. Libraries (which are not end-user apps) depend on edgedb-model and edgedb-async, but not edgedb crate (it's unclear how that would work with edgedb-derive, though).
  3. When we bump major version of edgedb only app could be updated
  4. When we bump major version of edgedb-model and edgedb-async we do adapters that allow libraries using older versions to work (i.e. transform to new types, see log crate for an inspiration)

But I'm not sure whether this is practical enough, and/or when this will become practical.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by mapping the existing edgedb, edgedb-tokio, and related crates, including their public modules and feature flags. Compare the current structure with the proposed edgedb::model, edgedb::error, edgedb::tokio, and edgedb::blocking namespaces. Done requires an agreed crate and feature architecture, not just an isolated code edit.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.