Indexes 3: Adds flatbuffers schema and SolverPackageSpec for indexes to spk by dcookspi · Pull Request #1338 · spkenv/spk

dcookspi · 2026-03-19T22:20:07Z

Note: for info on benefits of indexing for spk solves see #1340 (5 of 5). Maybe start there and work back down to this PR if you prefer to review PRs top down.

This adds a new spk-proto crate to spk, and a new v0 package implementation: SolverPackageSpec. spk-proto contains a flatbuffers schema for index package, version, build, options, and global variables data. The flatbuffers schema is designed for solver use. It only stores data needed for solving with the packages. It is not a complete replacement for all package operations. It does not have enough data to build or test packages.

SolverPackageSpec is a package implementation backed by a flatbuffer. Those packages will be produced from an index by changes added in a subsequent PR (#1339, 4 of 5). The functions for converting spk schema objects into and out of flatbuffer objects are contained in fb_converter.rs.

This is one of the changes that supports adding indexes and index based packages to Spk repositories.

This is 3 of 5 chained PRs for adding indexes to spk solves:

dcookspi · 2026-03-19T22:27:05Z

crates/spk-proto/schema/spk.fbs

@@ -0,0 +1,327 @@
+// Copyright (c) Contributors to the SPK project.


This flatbuffer schema does not match the rust spk schema objects one-to-one. The focus is on in making an index that is useful for spk solvers. There is not enough data in the index schema to build or run tests on any of the packages. There is only enough to run solves on them.

Some of the tables have the same name as their rust counterparts, others do not. Some are flatbuffer specific. Some do not store all the fields of their rust counter part. The ones not stored are noted as 'ignored' in comments. Some of the objects have been flattened down to include pieces of intermediate or more deeply nested rust objects. Those should also be noted in comments.

crates/spk-schema/src/v0/solver_package_spec.rs

crates/spk-schema/src/v0/indexed_package.rs

crates/spk-schema/src/fb_converter.rs

codecov · 2026-03-19T23:17:03Z

Codecov Report

❌ Patch coverage is 2.27273% with 1247 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
crates/spk-schema/src/fb_converter.rs	0.00%	931 Missing ⚠️
crates/spk-schema/src/v0/indexed_package.rs	0.00%	286 Missing ⚠️
crates/spk-schema/src/spec.rs	25.00%	27 Missing ⚠️
crates/spk-storage/src/storage/spfs.rs	0.00%	2 Missing ⚠️
crates/spk-proto/build.rs	94.11%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

crates/spk-proto/schema/spk.fbs

crates/spk-proto/Cargo.toml

crates/spk-schema/src/v0/indexed_package.rs

crates/spk-schema/src/fb_converter.rs

crates/spk-schema/src/v0/indexed_package.rs

jrray · 2026-04-02T20:59:58Z

crates/spk-schema/src/spec.rs

 #[derive(Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd, Serialize)]
 #[serde(tag = "api")]
 #[enum_dispatch(Deprecate, DeprecateMut)]
+#[allow(clippy::large_enum_variant)]


Maybe I missed this before, but we don't want to allow this. You can avoid it by Boxing the IndexedPackage.

I've done this. I had to box both of the entries because of the size differences between them and the Boxed object itself.

…kage data. Adds v0 SolverPackageSpec as a package implementation backed by a flatbuffer. Adds fb_converter functions for converting spk schema objects into and out of flatbuffer objects. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

schema. Moves flatc-rust to workspace Cargo.toml for spk and spfs. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

package list to the index. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

…kage Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

…cated check during index generation. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

differences, removes some unnecessary unsafe keywords. Signed-off-by: David Gilligan-Cook <dcook@imageworks.com>

dcookspi self-assigned this Mar 19, 2026

dcookspi added enhancement New feature or request SPI AOI Area of interest for SPI pr-chain This PR doesn't target the main branch, don't merge! labels Mar 19, 2026