Merge pull request #3095 from SwiftPackageIndex/stable-doc-paths-tweaks

Two small tweaks into the "Current" documentation PR before some bigger changes

Author: finestructure

Sources/App/Controllers/PackageController+routes.swift

@@ -121,19 +121,11 @@ enum PackageController {
             .init(archive: $0, isCurrent: $0.name == route.archive)
         }
 
-        let canonicalUrl: String? = {
-            guard let canonicalOwner = documentationMetadata.owner,
-                  let canonicalRepository = documentationMetadata.repository,
-                  let canonicalTarget = documentationMetadata.canonicalTarget
-            else { return nil }
-
-            return Self.canonicalDocumentationUrl(from: "\(req.url)",
-                                                  owner: canonicalOwner,
-                                                  repository: canonicalRepository,
-                                                  docVersion: route.docVersion,
-                                                  toTarget: canonicalTarget)
-        }()
-
+        let canonicalUrl = Self.canonicalDocumentationUrl(from: "\(req.url)",
+                                                          owner: documentationMetadata.owner,
+                                                          repository: documentationMetadata.repository,
+                                                          docVersion: route.docVersion,
+                                                          toTarget: documentationMetadata.canonicalTarget)
 
         // Try and parse the page and add our header, but fall back to the unprocessed page if it fails.
         guard let body = awsResponse.body,
@@ -463,10 +455,12 @@ extension PackageController {
 
 extension PackageController {
     static func canonicalDocumentationUrl(from url: String,
-                                          owner: String,
-                                          repository: String,
+                                          owner: String?,
+                                          repository: String?,
                                           docVersion: DocVersion,
-                                          toTarget target: DocumentationTarget) -> String? {
+                                          toTarget target: DocumentationTarget?) -> String? {
+        guard let owner, let repository, let target else { return nil }
+
         // It's important to use `docVersion.reference` here to make sure we match with true reference urls and not ~
         let urlPrefix = "/\(owner)/\(repository)/\(docVersion.reference.pathEncoded)/"
         if case let .internal(canonicalReference, _) = target,

Sources/App/Views/DocumentationPageProcessor.swift

@@ -82,9 +82,9 @@ struct DocumentationPageProcessor {
             try document.head()?.append(self.stylesheetLink)
             if let canonicalUrl = self.canonicalUrl {
                 try document.head()?.append(
-                    // We should not use `url` here as some of the DocC JavaScript lowercases
-                    // both the `og:url` and `twitter:url` properties, if present. It is better
-                    // to have no `og:url` and `twitter:url` properties than incorrect ones.
+                    // We should not use Plot's `url` helper here as some of the DocC JavaScript
+                    // lowercases both the `og:url` and `twitter:url` properties, if present. It's
+                    // better to have no `og:url` and `twitter:url` properties than incorrect ones.
                     Plot.Node.link(
                         .rel(.canonical),
                         .href(canonicalUrl)