[6.0] Fix a few issues with infinite recursions if the content contains cyclic curation #905
Conversation
This file contains 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
Contributor
d-ronnqvist
commented
Apr 29, 2024
d-ronnqvist
commented
- Explanation: This fixes two crashes and a few minor related issues that can happen in some cases when building documentation that has cyclic curation.
- Scope: Crashes (infinitely recursing until the the process runs out of stack) when building documentation with some cases of cyclic curation.
- Issue: rdar://126974763
- Risk: Low.
- Testing: Added automated tests for both crashes. Manually tested with the project where these issues were originally found.
- Reviewer: @mayaepps @patshaughnessy
- Original PR: Fix a few issues with infinite recursions if the content contains cyclic curation #898
…lic curation (apple#898) * Add functions to operate on directed graphs * Update topic graph to use sequences for graph traversal * Avoid computing full paths to determine if a symbol is manually curated * Fix an infinite recursion determining the paths to a node when there's cyclic curation rdar://126974763 * Avoid computing all paths when the caller only needs the shortest path * Avoid computing all paths when the caller only needs the roots/leaves * Avoid computing all paths when the caller only needs know if a certain node is encountered * Avoid computing all paths when the caller only needs to visit each reachable node once * Rename 'pathsTo(_:options:)' to 'finitePaths(to:options:) * Fix another infinite recursion when pages are curated in cycles rdar://126974763 * Fix correctness issue where symbol has two auto curated parents * Address code review feedback: - Rename neighbors parameter to edges for DirectedGraph initializer - Rename GraphPathIterator and move it to DirectedGraph+Paths file - Add convenience properties for topic graph directed graph "views - Elaborate on breadcrumbs path documentation and implementation comments - Elaborate on graph cycle documentation with concrete examples - Fix missing edge in directed graph test data - Use preconditionFailure for topic graph node that should always exist - Add additional graph cycle tests * Explicitly exit (trap) if trying to dump a topic graph with cyclic paths
|
@swift-ci please test |
Teapane
approved these changes
May 2, 2024
|
@swift-ci please test |
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.