Standardizing platform Name variances. (#834)

Fix the bug causing DocC to display repeated platforms due to variations in platform names between multiple SGFs and the info.plist.

This change unifies platform name variations into their canonical form during symbol graph loading.

rdar://116399438

Author: sofiaromorales

Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift

@@ -362,30 +362,35 @@ extension SymbolGraph.Symbol.Availability.AvailabilityItem {
         guard let domain = self.domain else {
             return self
         }
+        
+        var newValue = self
+        // To ensure the uniformity of platform availability names derived from SGFs,
+        // we replace the original domain value with a value from the platform's name
+        // since the platform name maps aliases to the canonical name.
+        let platformName = PlatformName(operatingSystemName: domain.rawValue)
+        newValue.domain = SymbolGraph.Symbol.Availability.Domain(rawValue: platformName.rawValue)
 
         // If a symbol is unconditionally unavailable for a given domain,
         // don't add an introduced version here as it may cause it to
         // incorrectly display availability information
         guard !isUnconditionallyUnavailable else {
-            return self
+            return newValue
         }
 
         // If this had an explicit introduced version from source, don't replace it.
         guard introducedVersion == nil else {
-            return self
+            return newValue
         }
 
-        let platformName = PlatformName(operatingSystemName: domain.rawValue)
         let fallbackPlatformName = fallbackPlatform.map(PlatformName.init(operatingSystemName:))
 
         // Try to find a default version string for this availability
         // item's platform (a.k.a. domain)
         guard let platformVersion = defaults[platformName] ??
             fallbackPlatformName.flatMap({ defaults[$0] }) else {
-            return self
+            return newValue
         }
 
-        var newValue = self
         newValue.introducedVersion = platformVersion
         return newValue
     }

Sources/SwiftDocCTestUtilities/SymbolGraphCreation.swift

@@ -29,7 +29,7 @@ extension XCTestCase {
         )
     }
 
-    public func makeSymbolGraphString(moduleName: String, symbols: String = "", relationships: String = "") -> String {
+    public func makeSymbolGraphString(moduleName: String, symbols: String = "", relationships: String = "", patform: String = "") -> String {
         return """
         {
           "metadata": {
@@ -42,7 +42,7 @@ extension XCTestCase {
           },
           "module": {
               "name": "\(moduleName)",
-              "platform": { }
+              "platform": { \(patform) }
           },
           "relationships" : [
             \(relationships)

Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift

@@ -381,6 +381,140 @@ class SymbolGraphLoaderTests: XCTestCase {
         )
     }
 
+    func testCanonicalPlatformNameUniformity() throws {
+        
+        let testBundle = Folder(name: "TestBundle.docc", content: [
+            TextFile(name: "Info.plist", utf8Content: """
+            <plist version="1.0">
+            <dict>
+                <key>CFBundleDisplayName</key>
+                <string>MyModule</string>
+                <key>CFBundleIdentifier</key>
+                <string>com.apple.MyModule</string>
+                <key>CFBundleVersion</key>
+                <string>0.1.0</string>
+                <key>CDAppleDefaultAvailability</key>
+                <dict>
+                    <key>MyModule</key>
+                    <array>
+                        <dict>
+                            <key>name</key>
+                            <string>Mac Catalyst</string>
+                            <key>version</key>
+                            <string>1.0</string>
+                        </dict>
+                    </array>
+                </dict>
+            </dict>
+            </plist>
+            """),
+            Folder(name: "Symbols", content: [
+                TextFile(name: "MyModule-tvos-objc.symbols.json", utf8Content: makeSymbolGraphString(
+                    moduleName: "MyModule",
+                   symbols: """
+                  {
+                    "accessLevel" : "public",
+                    "availability" : [
+                        {
+                          "domain" : "tvos",
+                          "introduced" : {
+                            "major" : 15,
+                            "minor" : 2,
+                            "patch" : 0
+                          }
+                        },
+                    ],
+                    "declarationFragments" : [],
+                    "functionSignature" : {
+                      "parameters" : [],
+                      "returns" : []
+                    },
+                    "identifier" : {
+                      "interfaceLanguage" : "objective-c",
+                      "precise" : "c:@F@A"
+                    },
+                    "kind" : {
+                        "displayName" : "Instance Property",
+                        "identifier" : "objective-c.property"
+                    },
+                    "names" : {
+                      "subHeading" : [],
+                      "title" : "A"
+                    },
+                    "pathComponents" : ["A"]
+                  }
+                """,
+                patform: """
+                 "operatingSystem" : {
+                   "minimumVersion" : {
+                     "major" : 12,
+                     "minor" : 0,
+                     "patch" : 0
+                   },
+                   "name" : "tvos"
+                 }
+                """
+                )),
+                TextFile(name: "MyModule-catalyst-objc.symbols.json", utf8Content: makeSymbolGraphString(moduleName: "MyModule", symbols: """
+                  {
+                    "accessLevel" : "public",
+                    "availability" : [
+                        {
+                          "domain" : "maccatalyst",
+                          "introduced" : {
+                            "major" : 15,
+                            "minor" : 2,
+                            "patch" : 0
+                          }
+                        },
+                    ],
+                    "declarationFragments" : [],
+                    "functionSignature" : {
+                      "parameters" : [],
+                      "returns" : []
+                    },
+                    "identifier" : {
+                      "interfaceLanguage" : "objective-c",
+                      "precise" : "c:@F@A"
+                    },
+                    "kind" : {
+                        "displayName" : "Instance Property",
+                        "identifier" : "objective-c.property"
+                    },
+                    "names" : {
+                      "subHeading" : [],
+                      "title" : "A"
+                    },
+                    "pathComponents" : ["A"]
+                  }
+                """,
+                 patform: """
+                 "operatingSystem" : {
+                   "minimumVersion" : {
+                     "major" : 12,
+                     "minor" : 0,
+                     "patch" : 0
+                   },
+                   "name" : "ios"
+                 }
+                 """)),
+            ]),
+        ])
+        let tempURL = try createTemporaryDirectory()
+        let bundleURL = try testBundle.write(inside: tempURL)
+        let (_, _, context) = try loadBundle(from: bundleURL)
+        guard let availability = (context.documentationCache["c:@F@A"]?.semantic as? Symbol)?.availability?.availability else {
+            XCTFail("Did not find availability for symbol 'c:@F@A'")
+            return
+        }
+        // Verify we use one canonical platform name 'macCatalyst' for both
+        // 'Mac Catalyst' (info.plist) and 'maccatalyst' (SGF).
+        XCTAssertTrue(availability.count == 2)
+        XCTAssertTrue(availability.filter({ $0.domain?.rawValue == "macCatalyst" }).count == 1)
+        XCTAssertTrue(availability.filter({ $0.domain?.rawValue == "maccatalyst" }).count == 0)
+        
+    }
+    
     // MARK: - Helpers
 
     private func makeSymbolGraphLoader(