docs(agents): add entity display name rules for workflows#4665
Open
mmabrouk wants to merge 4 commits into
Open
docs(agents): add entity display name rules for workflows#4665mmabrouk wants to merge 4 commits into
mmabrouk wants to merge 4 commits into
Conversation
…er101 docs: add unfitcoder101 as a contributor for bug
dosubot
Bot
added
the
size:S
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds a documentation section to ChangesEntity display names documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Comment on lines
+286
to
+301
| - The entity display name lives on the workflow ARTIFACT: `artifact.name`, falling back | ||
| to its slug. Use `workflowMolecule.selectors.artifactName(entityId)`; it accepts a | ||
| revision id or a workflow id. | ||
| - A variant label comes from the VARIANT: `variant.name`, then `variant.slug`. Resolve it | ||
| through the variants list by `workflow_variant_id`. Never label a variant from a | ||
| revision's fields. | ||
| - `revision.name` is dead for display. Never read it as a label and never write entity | ||
| names into it. Revisions contribute only `version` (the vN tag) and `message`. Reason: | ||
| UI-created revisions carry the variant name ("default") and SDK-created revisions carry | ||
| no name at all. | ||
| - Pick the label by entity kind. Evaluators and other entities that do not use variants | ||
| display artifact name + version. Applications in comparison or evaluation contexts | ||
| display the variant label + version. | ||
| - Review blocker: any `.name` read off a revision entity (e.g. `selectors.data(id)?.name` | ||
| or a revision row's `name`) used as a display label. Point to the sanctioned selectors | ||
| above instead. |
There was a problem hiding this comment.
Reword this as a migration rule, not current state.
The new text says revision.name is dead for display, but the provided code still renders it in EntityEvaluatorSelector and in the revision selection relation. As written, this will read like the codebase already complies when it does not yet.
dosubot
Bot
added
size:M
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
Workflows, variants, and revisions all carry a
namecolumn, and we keep shipping bugs by reading the wrong one: evaluators showing "default" instead of their real name (#4634, #4662), and SDK-created apps showing "--" or hex slugs. The frontend conventions file had no rule for which field is the display name.What this adds
A new "Entity display names (workflows, variants, revisions)" section in
web/AGENTS.mdthat establishes:workflowMolecule.selectors.artifactName(entityId).variant.namethenvariant.slug, resolved through the variants list, never from a revision's fields.revision.nameis dead for display: never read it as a label, never write entity names into it; revisions contribute onlyversionandmessage..nameread off a revision entity used as a display label is a review blocker.This encodes the decisions made while fixing the evaluator-name bug series so the same class of bug does not regress through review.