Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

only use the last file component when deciding decoding strategy #665

Merged
merged 3 commits into from
Jul 21, 2023

Conversation

QuietMisdreavus
Copy link
Contributor

Bug/issue #, if applicable: rdar://112664398

Summary

Swift CI has started failing on Swift-DocC's tests, because its workspace folder includes an @ sign. This confuses the SymbolGraphLoader into thinking that there are no base-module symbol graphs, and thus refusing to use the concurrentlyAllFiles decoding strategy. This PR updates that logic to only inspect the last path component instead of the full file path, allowing these @ sign directories to successfully detect base-module and extension symbol graphs.

Dependencies

None

Testing

Steps:

  1. Generate symbol graphs for multiple modules (or copy out two symbol graphs from the "Test Resources" directory) into a directory whose name contains @.
  2. Run docc convert in a debugger and ensure that SymbolGraphLoader correctly uses the concurrentlyAllFiles decoding strategy to load symbol graph files in parallel.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • [ n/a ] Updated documentation if necessary

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

Copy link
Contributor

@ethan-kusters ethan-kusters left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! This is making me question are file-path-name-based logic here in general but we would address that separately from this PR.

Thanks for jumping on this.

Co-authored-by: Ethan Kusters <[email protected]>
@QuietMisdreavus
Copy link
Contributor Author

@swift-ci Please test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants