tursodatabase/libsql

Auto generate bindings when `libsql-sqlite3` is changed

Open

#1,039 opened on Feb 16, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (16,744 stars) (490 forks)batch import
good first issue

Description

Whenever there is a change in libsql-sqlite3, we need to generate the sqlite header files and bindings. These commands to be run:

# this updates libsql-ffi and also libsql-sys
cargo xtask build-bundled 
# this updates bindings required for sqlite3-mc
cargo build --features multiple-ciphers

This is a manual step and easy to miss. It happened in #1027 which was fixed later by #1037

We should automate this, as part of the build process. We should also move multiple-ciphers build within build-bundled, so that there is only one command to run

Contributor guide

Tech stack
rustcshell
Domain
build systemdevopstooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rustcargo build systemC bindingsxtask
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the current build process in the xtask directory, specifically the build bundled command. Understand how libsql sqlite3 changes are detected (e.g., file modification timestamps). Consider integrating the multiple ciphers build into the same command. Look at PRs #1027 and #1037 for context on the manual step that was missed. Propose a solution that runs both commands automatically when libsql sqlite3 source files change.