mdcode: reject non-list frontmatter tags - #294
Open
amirhormati wants to merge 1 commit into
Open
Conversation
A JavaScript string is iterable, so `tags: a, b, c` was expanded into one Dataplex label per character rather than three labels. Throw instead, naming the file, so the author gets an error rather than silent corruption. Splitting the string on commas would be the other option, but a comma can appear inside a tag, so coercing guesses at a tag set the author did not write. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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
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.
Problem
tags:in OKF frontmatter is meant to be a list. The Documents Layout does notcheck that, and a JavaScript string is iterable, so a bare comma-separated
value is expanded into one Dataplex label per character.
tags: Stack Overflow, votes, posts, communityin a real bundle file storedthis in Knowledge Catalog:
No error, no warning. The entry looks fine locally and is corrupt in the
catalog.
Fix
parseMarkdownthrows whentagsis present and is not an array:Coercing the string by splitting on commas is the other option. I did not take
it: a comma can legitimately appear inside a tag, so coercion silently invents
a different tag set than the author wrote. An error at parse time is cheap and
points at the file.
Two supporting details:
parseMarkdowngained an optionalsourceparameter so the message can namethe file. Its only caller,
loadEntry, passes the entry path.undefined/nullcheck,so an empty-string
tagsis reported rather than skipped.Verification
tags: a, b, cthrows with the file name and the offending value.tagsat all behave exactly asbefore.
bun test ./tests/libts/scenarios.ts: 17 pass, 0 fail.Ordering
Land after #293. The eight stackoverflow bundle files fixed there are the ones
that trip this guard, so merging this first makes that bundle fail to push.