clockworklabs / clockworklabs/SpacetimeDB

Smoketests: remove interface for using a module source string; always require a precompiled module

Open
#5,653 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
25.2k
Forks
1.1k
Avg merge
2d 7h
Merged PRs (30d)
46

Description

Smoketests which use precompiled modules have better performance characteristics than those that use modules with source strings (mostly because our CI can be smarter about them), so we want to require that all smoketests use precompiled modules. Currently, we have a few smoketests which use non-precompiled modules specifically because they assert that the compilation will fail. We should rewrite those tests so that they either call spacetime build explicitly or use a separate, purpose-built abstraction, rather than calling a normal Smoketest constructor and asserting that it fails. Then, we should remove the Smoketest constructor that accepts a source string, so that all smoketests have to use precompiled modules.

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 locating the Smoketest constructor that accepts a source string and all smoketests using it. Review the existing compilation-failure cases, then confirm that they use an explicit build or separate abstraction and that every remaining Smoketest uses a precompiled module; the constructor should no longer accept source strings.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
testing-qa
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.