Repository navigation
docs: YAML limits, contractId resolution and the seed guard (forge-cli #725) - #154
Merged
Merged
Conversation
…i #725) validate.md gets a YAML limits section: the size and alias-count caps FLUID contracts already had, the new depth and alias-expansion caps, the messages each prints, and the ODCS/ODPS readers now behind the same guard. production-troubleshooting.md, where contract_load_failed links, gets a row for those messages. odps.md documents how a port's contractId is resolved, the new rule that a probed file must declare the contractId as its id, malformed contractIds as unresolved, and how a directory bundle treats a file it cannot read. odcs.md and forge.md note the limits, the --report parse pass and the seed guard catching a dropped expose.
1 of 3 tasks
This branch was previously deployed
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.
Summary
These are the docs for forge-cli #725, the untrusted-input guards for the YAML loader, the
contractIdresolver and the seed guard. Merge after #725. Every new statement is marked (unreleased, forge-cli #725).docs/cli/validate.mdcontract_load_failedand names the ODCS/ODPS commands now behind the same guard.docs/advanced/production-troubleshooting.mdcontract_load_failedlinks to, for the five limit messages.docs/cli/odps.mdcontractIdis resolved section, covering:• the lookup order (directory-bundle index, probes beside the product document and in
contracts/, then HTTP under--allow-remote);• the new rule that a probed file must declare the
contractIdas itsid;• malformed
contractIds (NUL byte, non-string, too long, unparsable URL) treated as unresolved.A sub-section covers how a directory bundle treats a file it cannot read, with the error it prints.
docs/cli/odcs.md--reportrecords a failedparsepass. A note thatvalidate/importuse the YAML limits and read an upper-case.YAMLsuffix as YAML.docs/cli/forge.mdcontractIdresolution.No page moves and no existing anchor changes. The new anchors are
#yaml-limits,#how-a-port-s-contractid-is-resolvedand#files-a-directory-bundle-cannot-read.Related CLI PR
Areas Updated
Checklist
npm run docs:devor built it withnpm run docs:buildVerified against the code
fluid_build/util/safe_yaml.pyon #725 (MAX_YAML_BYTES,MAX_YAML_ALIASES,MAX_YAML_DEPTH,MAX_YAML_ALIAS_EXPANSION,MAX_YAML_ALIAS_EXPANSION_CHARS).contract_load_failedexample, the bundle error and the exit codes: copied from runs of the #725 branch.fluid odps import/validate,fluid odcs validate/importandfluid odps-bitol validateeach exit 1 on a refused file.ContractResolver.resolveandDEFAULT_SUBDIRS/DEFAULT_EXTENSIONSinproviders/odps_standard/resolver.py.vuepress build docsbuilds all 236 pages, with no link-check warnings on the edited pages. The cross-page anchors resolve in the built HTML.