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.

Sign up for GitHub

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

Jump to bottom

SwiftDocC: use "portable" paths for file names #668

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

SwiftDocC: use "portable" paths for file names #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion Sources/SwiftDocC/Infrastructure/NodeURLGenerator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,13 @@ public struct NodeURLGenerator {
isURLModified = true
name = "'\(name)"
}


let components = name.components(separatedBy: ["<", ">", ":", "\"", "/", "\\", "|", "?", "*"])
if components.count > 1 {
isURLModified = true
name = components.joined(separator: "_")
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should always append a hashed identifier to the name here to ensure that the file names don't collide.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that appending the hashed identifier seems reasonable. Definitely would avoid any possible conflicts. Would we do that for any case where isURLModified is true?

Copy link
Contributor

Choose a reason for hiding this comment

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

The code already mostly does that when modifying the URL, although if it's a specific path component that's longer than what a file name is allowed to be, then it shortens that path component and appends the hash to that component instead of later in the URL.

}

// Shorten path components that are too long.
// Take the first 240 chars and append a checksum on the *complete* string.
if name.count >= pathComponentLengthLimit {
Expand Down
2 changes: 1 addition & 1 deletion Tests/SwiftDocCTests/Indexing/NavigatorIndexTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -891,7 +891,7 @@ Root
XCTAssertEqual(navigatorIndex.path(for: 4), "/tutorials/testoverview")
XCTAssertEqual(navigatorIndex.path(for: 9), "/documentation/fillintroduced/maccatalystonlydeprecated()")
XCTAssertEqual(navigatorIndex.path(for: 10), "/documentation/fillintroduced/maccatalystonlyintroduced()")
XCTAssertEqual(navigatorIndex.path(for: 21), "/documentation/mykit/globalfunction(_:considering:)")
XCTAssertEqual(navigatorIndex.path(for: 21), "/documentation/mykit/globalfunction(__considering_)")
XCTAssertEqual(navigatorIndex.path(for: 23), "/documentation/sidekit/uncuratedclass/angle")

assertUniqueIDs(node: navigatorIndex.navigatorTree.root)
Expand Down
6 changes: 3 additions & 3 deletions Tests/SwiftDocCTests/Indexing/RenderIndexTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ final class RenderIndexTests: XCTestCase {
"type": "groupMarker"
},
{
"path": "/documentation/mixedlanguageframework/bar/mystringfunction(_:)",
"path": "/documentation/mixedlanguageframework/bar/mystringfunction(__)",
Copy link
Contributor

Choose a reason for hiding this comment

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

@ethan-kusters do you remember if this value represents the path of the web URL or the file path within the documentation archive? I thought that this is the path that the browser would load to access this page.

"title": "myStringFunction:error: (navigator title)",
"type": "method",
"children": [
Expand Down Expand Up @@ -327,7 +327,7 @@ final class RenderIndexTests: XCTestCase {
},
{
"title": "class func myStringFunction(String) throws -> String",
"path": "/documentation/mixedlanguageframework/bar/mystringfunction(_:)",
"path": "/documentation/mixedlanguageframework/bar/mystringfunction(__)",
"type": "method"
}
]
Expand Down Expand Up @@ -488,7 +488,7 @@ final class RenderIndexTests: XCTestCase {
"type": "groupMarker"
},
{
"path": "\/documentation\/mixedlanguageframework\/foo-swift.struct\/init(rawvalue:)",
"path": "\/documentation\/mixedlanguageframework\/foo-swift.struct\/init(rawvalue_)",
"title": "init(rawValue: UInt)",
"type": "init"
},
Expand Down
8 changes: 4 additions & 4 deletions Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ class DocumentationContextTests: XCTestCase {
Folder(name: "Resources", content: [
// This whitespace and punctuation in this *file name* will be replaced by dashes in its identifier.
// No content in this file result in identifiers.
TextFile(name: "Technology file: with - whitespace, and_punctuation.tutorial", utf8Content: """
TextFile(name: "Technology file_ with - whitespace, and_punctuation.tutorial", utf8Content: """
@Tutorials(name: "Technology Name") {
@Intro(title: "Intro Title") {
@Video(source: introvideo.mp4, poster: introposter.png)
Expand Down Expand Up @@ -510,10 +510,10 @@ class DocumentationContextTests: XCTestCase {
let identifierPaths = context.knownIdentifiers.map { $0.path }.sorted(by: { lhs, rhs in lhs.count < rhs.count })
XCTAssertEqual(identifierPaths, [
// From the two file names
"/tutorials/Technology-file:-with---whitespace,-and_punctuation",
"/tutorials/Technology-file_-with---whitespace,-and_punctuation",
// From the volume's title and the chapter's names, appended to their technology's identifier
"/tutorials/Technology-file:-with---whitespace,-and_punctuation/Volume_Section-Title:-with---various!-whitespace,-and/punctuation",
"/tutorials/Technology-file:-with---whitespace,-and_punctuation/Volume_Section-Title:-with---various!-whitespace,-and/punctuation/Chapter_Title:-with---various!-whitespace,-and/punctuation"
"/tutorials/Technology-file_-with---whitespace,-and_punctuation/Volume_Section-Title:-with---various!-whitespace,-and/punctuation",
"/tutorials/Technology-file_-with---whitespace,-and_punctuation/Volume_Section-Title:-with---various!-whitespace,-and/punctuation/Chapter_Title:-with---various!-whitespace,-and/punctuation"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it expected that the : towards the end of this string ("Chapter_Title:") isn't replaced with _?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

No, that isn't expected, but how did the test pass 🤯. : is a ADS (alternate data stream, think of it as macOS file forks) separator, the file would just be truncated to the : and the rest would be the name of the stream.

])
}

Expand Down
4 changes: 2 additions & 2 deletions Tests/SwiftDocCTests/LinkTargets/LinkDestinationSummaryTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "globalFunction(_:considering:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/globalfunction(_:considering:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mykit/globalfunction(__considering_)")
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this value should change. It represents the relative URL for this page. As far as I understood the URL would still contain the characters that aren't allowed in the file names.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Right, the URLs can contain the view, but the file paths would be replaced. I believe that the replativePresentationURL is still referencing the file path?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, this is meant to refer to the web URL relative to where this documentation is hosted.

This API is used to bridge with other documentation systems which aren't expected to have access to the doccarchive directly. Those systems are expected to use the summary information to create links that navigate the reader to the hosted documentation.

Copy link
Contributor

Choose a reason for hiding this comment

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

It can also refer to a landmark on a page which wouldn't have its own file in the documentation archive.

XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.docc.example/documentation/MyKit/globalFunction(_:considering:)")
XCTAssertEqual(summary.language, .swift)
XCTAssertEqual(summary.kind, .function)
Expand Down Expand Up @@ -508,7 +508,7 @@ class ExternalLinkableTests: XCTestCase {
let summary = node.externallyLinkableElementSummaries(context: context, renderNode: renderNode)[0]

XCTAssertEqual(summary.title, "myStringFunction(_:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar/mystringfunction(_:)")
XCTAssertEqual(summary.relativePresentationURL.absoluteString, "/documentation/mixedlanguageframework/bar/mystringfunction(__)")
XCTAssertEqual(summary.referenceURL.absoluteString, "doc://org.swift.MixedLanguageFramework/documentation/MixedLanguageFramework/Bar/myStringFunction(_:)")
XCTAssertEqual(summary.language, .swift)
XCTAssertEqual(summary.kind, .typeMethod)
Expand Down
4 changes: 2 additions & 2 deletions Tests/SwiftDocCTests/Test Resources/TestBundle-RenderIndex.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@
"type" : "groupMarker"
},
{
"path" : "\/documentation\/mykit\/globalfunction(_:considering:)",
"path" : "\/documentation\/mykit\/globalfunction(__considering_)",
"title" : "func globalFunction(Data, considering: Int)",
"type" : "func"
},
Expand All @@ -638,7 +638,7 @@
"type" : "groupMarker"
},
{
"path" : "\/documentation\/sidekit\/sideclass\/value(_:)",
"path" : "\/documentation\/sidekit\/sideclass\/value(__)",
"title" : "case Value(Int)",
"type" : "case"
},
Expand Down
2 changes: 1 addition & 1 deletion Tests/SwiftDocCUtilitiesTests/ConvertActionTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ class ConvertActionTests: XCTestCase {
"/output/data/documentation/mykit/myclass/init()-3743d.json",
"/output/data/documentation/mykit/myclass/myfunction().json",
"/output/data/documentation/mykit/myprotocol.json",
"/output/data/documentation/mykit/globalfunction(_:considering:).json",
"/output/data/documentation/mykit/globalfunction(__considering_).json",
].sorted())

let myKitNodeData = try XCTUnwrap(outputData["/output/data/documentation/mykit.json"])
Expand Down