feat(schema): add paths for schema types by johanpel · Pull Request #449 · rapidsai/quent

johanpel · 2026-07-24T11:18:17Z

Description

Add quent_schema::Path and migrate record and entity types from flat identifiers to paths. Most of the diff mechanically propagates that type change through constraints, FSMs, references, resources, and YAML lowering.

The notable behavioral changes are:

Records and entities share one type namespace, enforced by builder validation and the new DuplicateTypePaths base constraint.
Schema record/entity maps serialize as entry sequences because paths are arrays.
Foo::Memory generates sibling resource records such as Foo::MemoryUsage.
instrumentation-build temporarily rejects qualified paths.

YAML syntax remains unchanged and only produces one-segment paths.

A follow-up PR will add namespaced Rust instrumentation generation and simplify the generated runtime API.

Related Issues

Extracted from #448 to make reviewing easier. Part of #442.

Written by Codex.

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

johanpel

Self-review to help reviewers

johanpel · 2026-07-24T11:38:14Z

Records and entities share one type namespace, enforced by builder validation and the new DuplicateTypePaths base constraint.

johanpel · 2026-07-24T11:39:15Z

+    #[cfg_attr(feature = "serde", serde(with = "indexmap::map::serde_seq"))]
+    #[cfg_attr(feature = "ts", ts(as = "Vec<(Path, Entity)>"))]
+    entities: Map<Path, Entity>,
    /// The [`Record`]s of the model.
-    #[cfg_attr(feature = "ts", ts(as = "indexmap::IndexMap<Identifier, Record>"))]
-    records: Map<Identifier, Record>,
+    #[cfg_attr(feature = "serde", serde(with = "indexmap::map::serde_seq"))]
+    #[cfg_attr(feature = "ts", ts(as = "Vec<(Path, Record)>"))]
+    records: Map<Path, Record>,


Schema record/entity maps serialize as entry sequences because paths are arrays.

Luckily this was already a feature of indexmap

johanpel · 2026-07-24T11:41:13Z

+fn ensure_unqualified_type_paths(schema: &Schema) -> Result<(), GenerateError> {
+    let qualified = schema
+        .records()
+        .map(|record| record.path())
+        .chain(schema.entities().map(|entity| entity.path()))
+        .find(|path| !path.namespace().is_empty());
+
+    match qualified {
+        Some(path) => Err(GenerateError::UnsupportedTypePath { path: path.clone() }),
+        None => Ok(()),
+    }
+}


instrumentation-build temporarily rejects qualified paths

This is temporary, follow-up will change this.

johanpel · 2026-07-24T11:42:10Z

+    /// Return the default usage record path for `resource`.
+    pub fn default_usage_record_path(resource: &Path) -> Path {
+        resource.with_name(suffixed_identifier(resource.name(), "Usage"))
    }

-    /// Return the default bounds record name for `resource`.
-    pub fn default_bounds_record_name(resource: &Identifier) -> Identifier {
-        suffixed_identifier(resource, "Bounds")
+    /// Return the default bounds record path for `resource`.
+    pub fn default_bounds_record_path(resource: &Path) -> Path {
+        resource.with_name(suffixed_identifier(resource.name(), "Bounds"))
    }


Foo::Memory generates sibling resource records such as Foo::MemoryUsage

johanpel · 2026-07-24T11:42:24Z

+    #[test]
+    fn generated_records_are_siblings_of_the_resource() {
+        let parts = ResourceBuilder::new(path("Foo::Memory"))
+            .with_capacity(ident("bytes"), Capacity::new(CapacityKind::Occupancy, true))
+            .build()
+            .unwrap();
+
+        assert_eq!(parts.usage.path().to_string(), "Foo::MemoryUsage");
+        assert_eq!(
+            parts.bounds.unwrap().path().to_string(),
+            "Foo::MemoryBounds"
+        );
+    }


Foo::Memory generates sibling resource records such as Foo::MemoryUsage

coderabbitai · 2026-07-24T11:48:41Z

📝 Walkthrough

Walkthrough

The schema model now uses qualified Path values for entity and record identity. Builders, lookups, references, resources, constraints, FSM diagnostics, code generation, and YAML lowering are updated accordingly. Validation also reports duplicate entity/record paths and supports qualified-path references.

Changes

Path-based schema identity

Layer / File(s)	Summary
Schema model and builders `crates/schema/src/schema/`, `crates/schema/src/builder/`	Adds validated `Path` parsing and migrates entities, records, data types, schema indexes, and builders from `Identifier` names to paths.
Constraints and references `crates/constraints/`, `crates/ref-target/`, `crates/ref-tree/*`	Adds duplicate type-path validation and migrates recursive, unresolved-reference, reference-target, and reference-tree diagnostics to `Path`.
Resources and downstream integration `crates/resource/`, `crates/fsm/`, `crates/instrumentation-build/`, `crates/yaml/`	Carries paths through resource handling, FSM diagnostics, generated identifiers, code-generation errors, YAML lowering, and related tests.

Estimated code review effort: 5 (Critical) | ~120 minutes

Possibly related PRs

rapidsai/quent#387: Introduces the resource constraint code later migrated to Path.
rapidsai/quent#399: Introduces the FSM builder code whose entity placement API is updated here.
rapidsai/quent#426: Introduces the eventless-entity constraint updated here to report paths.

Suggested labels: feature request

Suggested reviewers: dhruv9vats, mbrobbel

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately summarizes the main change: adding paths for schema types.
Description check	✅ Passed	The description covers the PR purpose, key behavior changes, and related issues, though Testing and Screenshots sections are not filled in.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

_{Comment @coderabbitai help to get the list of available commands.}

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

mbrobbel · 2026-07-24T12:50:24Z

+#[cfg_attr(feature = "serde", serde(try_from = "Vec<Identifier>"))]
+#[cfg_attr(feature = "ts", derive(ts_rs::TS))]
+#[cfg_attr(feature = "ts", ts(as = "Vec<Identifier>"))]
+pub struct Path(Vec<Identifier>);


Maybe for a follow-up; split this into name and namespace (optional). That avoids the invalid empty vec.

That turned out to simplify a few things 👍

b30c841

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

johanpel · 2026-07-24T13:25:37Z

/merge

# Description Stacked on #466. Adds qualified schema type path support to `quent-instrumentation-build`. Schema namespaces become Rust modules instead of being flattened: ```rust Foo::BarBaz → foo::BarBaz FooBar::Baz → foo_bar::Baz ``` This preserves path boundaries and allows equal leaf names such as Foo::Query and Bar::Query to coexist. Records, entities, events, references, handles, and observer storage follow the generated module hierarchy. Namespace-local AnyEvent enums compose into their parent namespace, while namespaces without events generate no aggregate. ## Related Issues Follow-up to #449. Closes #442. _Written by Codex._ Authors: - Johan Peltenburg (https://github.com/johanpel) Approvers: - Dhruv Vats (https://github.com/dhruv9vats) URL: #468

johanpel added 10 commits July 24, 2026 11:02

feat(schema): add paths for schema types

ba1a5ae

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

feat(constraints): validate schema type paths

08b60ad

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

feat(fsm): support entity paths

405995d

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

feat(ref-target): support entity paths

ce2dbf5

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

feat(ref-tree): support entity paths

1fd5a8f

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

feat(resource): support resource paths

39f6a3f

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

refactor(yaml): lower type names to paths

bd22bbc

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

refactor(instrumentation-build): reject qualified type paths

0a3716a

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

test(instrumentation-build): remove temporary path rejection test

1a4f096

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

refactor(schema): derive TypeScript path binding

325d1f5

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

johanpel commented Jul 24, 2026

View reviewed changes

johanpel marked this pull request as ready for review July 24, 2026 11:43

johanpel requested review from dhruv9vats and mbrobbel as code owners July 24, 2026 11:43

This comment was marked as resolved.

Sign in to view

docs(schema): clarify path-based APIs

41aaff1

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

This comment was marked as spam.

Sign in to view

mbrobbel approved these changes Jul 24, 2026

View reviewed changes

refactor(schema): store path name separately

b30c841

Signed-off-by: Johan Peltenburg <johan.peltenburg+code@gmail.com>

This comment was marked as spam.

Sign in to view

rapids-bot Bot merged commit 263b360 into rapidsai:main Jul 24, 2026
20 checks passed

This was referenced Jul 24, 2026

feat(instrumentation-build): generate namespaced instrumentation APIs #450

Closed

feat(instrumentation-build): generate namespaced APIs #468

Merged

coderabbitai Bot mentioned this pull request Jul 30, 2026

refactor(instrumentation-build): use generic runtime types #466

Merged

coderabbitai Bot mentioned this pull request Aug 7, 2026

feat(schema, vibe): schema explorer #451

Merged

Uh oh!

Conversation

johanpel commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Uh oh!

johanpel left a comment

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot commented Jul 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as spam.

Uh oh!

mbrobbel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

johanpel Jul 24, 2026

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

johanpel commented Jul 24, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

johanpel commented Jul 24, 2026 •

edited

Loading

coderabbitai Bot commented Jul 24, 2026 •

edited

Loading