Check symbols are deprecated on at least one platform before marking unconditionally deprecated (#712)

* Updates unconditional deprecation check

Checks that a symbol must be deprecated on at least one platform for the symbol to be marked unconditionally deprecated; this prevents symbols that are only marked unavailable on all known platforms from being shown as unconditionally deprecated.

* Adds a platform availability test and test bundle

Adds a test checking that unavailability in the symbol graph overrides the default platform availability set in the Info.plist. 

rdar://112197357

Author: mayaepps

Sources/SwiftDocC/Model/AvailabilityParser.swift

@@ -39,8 +39,11 @@ struct AvailabilityParser {
         }
 
         // Check if the symbol is unconditionally deprecated
-        return availability.availability
+        let isUnconditionallyDeprecated = availability.availability
             .allSatisfy { $0.isUnconditionallyDeprecated || $0.isUnconditionallyUnavailable || $0.deprecatedVersion != nil }
+            // If a symbol is unavailable on all known platforms, it should not be marked unconditionally deprecated.
+            && availability.availability.contains(where: { $0.isUnconditionallyDeprecated || $0.deprecatedVersion != nil })
+        return isUnconditionallyDeprecated
     }
 
     /// Determines a symbol's deprecation message that either applies to a given platform or that applies to all platforms.

Tests/SwiftDocCTests/Model/AvailabilityParserTests.swift

@@ -154,4 +154,52 @@ class AvailabilityParserTests: XCTestCase {
         XCTAssertTrue(compiler.isDeprecated())
         XCTAssertEqual(compiler.deprecationMessage(), "deprecated")
     }
+    
+    func testUnavailableIsNotDeprecated() throws {
+        let json = """
+        [
+            {
+                "domain": "tvOS",
+                "isUnconditionallyUnavailable" : true
+            }
+        ]
+        """
+        let availability = try JSONDecoder().decode(Availability.self, from: json.data(using: .utf8)!)
+        
+        /// Test all platforms
+        let compiler = AvailabilityParser(availability)
+        XCTAssertFalse(compiler.isDeprecated())
+    }
+    
+    func testAllPlatformsUnavailableOrDeprecatedIsMarkedDeprecated() throws {
+        let json = """
+        [
+            {
+                "domain": "tvOS",
+                "isUnconditionallyUnavailable" : true
+            },
+            {
+                "domain": "macOS",
+                "message" : "deprecated",
+                "deprecated": { "major": 10, "minor": 17 }
+            },
+            {
+                "domain": "iOS",
+                "message" : "deprecated",
+                "deprecated": { "major": 10, "minor": 17 }
+            },
+            {
+                "domain": "watchOS",
+                "message" : "deprecated",
+                "deprecated": { "major": 10, "minor": 17 }
+            }
+        ]
+        """
+        let availability = try JSONDecoder().decode(Availability.self, from: json.data(using: .utf8)!)
+        
+        /// Test all platforms
+        let compiler = AvailabilityParser(availability)
+        XCTAssertTrue(compiler.isDeprecated())
+        XCTAssertEqual(compiler.deprecationMessage(), "deprecated")
+    }
 }

Tests/SwiftDocCTests/Rendering/PlatformAvailabilityTests.swift

@@ -132,4 +132,31 @@ class PlatformAvailabilityTests: XCTestCase {
             item.name == "My Package" && item.introduced == "2.0"
         }))
     }
+    
+    // Test that the Info.plist default availability does not affect the deprecated/unavailable availabilities provided by the symbol graph.
+    func testAvailabilityParserWithInfoPlistDefaultAvailability() throws {
+        let (bundle, context) = try testBundleAndContext(named: "AvailabilityOverrideBundle")
+
+        let reference = ResolvedTopicReference(
+            bundleIdentifier: bundle.identifier,
+            path: "/documentation/MyKit/MyClass",
+            sourceLanguage: .swift
+        )
+        let symbol = try XCTUnwrap(context.entity(with: reference).semantic as? Symbol)
+        var translator = RenderNodeTranslator(
+            context: context,
+            bundle: bundle,
+            identifier: reference,
+            source: nil
+        )
+        let renderNode = try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
+        let availability = try XCTUnwrap(renderNode.metadata.platformsVariants.defaultValue)
+        XCTAssertEqual(availability.count, 4)
+        availability.forEach { platform in
+            XCTAssertTrue(platform.deprecated != nil)
+        }
+        XCTAssertFalse(availability.contains(where: { platform in
+            platform.name == "tvOS"
+        }))
+    }
 }

Tests/SwiftDocCTests/Test Bundles/AvailabilityOverrideBundle.docc/Info.plist

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDisplayName</key>
+	<string>AvailabilityBundle</string>
+	<key>CFBundleIdentifier</key>
+	<string>org.swift.docc.availability</string>
+	<key>CFBundleVersion</key>
+	<string>0.1.0</string>
+	<key>CDAppleDefaultAvailability</key>
+	<dict>
+		<key>MyKit</key>
+		<array>
+			<dict>
+				<key>name</key>
+				<string>Mac Catalyst</string>
+				<key>version</key>
+				<string>13.0</string>
+			</dict>
+			<dict>
+				<key>name</key>
+				<string>iOS</string>
+				<key>version</key>
+				<string>13.0</string>
+			</dict>
+			<dict>
+				<key>name</key>
+				<string>tvOS</string>
+				<key>version</key>
+				<string>13.0</string>
+			</dict>
+			<dict>
+				<key>name</key>
+				<string>watchOS</string>
+				<key>version</key>
+				<string>6.0</string>
+			</dict>
+			<dict>
+				<key>name</key>
+				<string>macOS</string>
+				<key>version</key>
+				<string>10.15</string>
+			</dict>
+		</array>
+	</dict>
+</dict>
+</plist>