Skip to content

Use availability item platform name to compute default availability information. #1208

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

Merged
merged 3 commits into from
May 2, 2025
Merged

Use availability item platform name to compute default availability information. #1208

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
913a7af
Use availability item platform name to compute default availability i…
sofiaromorales Apr 24, 2025
11e6360
Update license header year.
sofiaromorales Apr 24, 2025
62727a3
Merge branch 'main' into r146774862/invalid-introduced-version
sofiaromorales May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
Copyright (c) 2021-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
Expand Down Expand Up @@ -317,9 +317,10 @@ struct SymbolGraphLoader {

// Fill introduced versions when missing.
availability.availability = availability.availability.map {
$0.fillingMissingIntroducedVersion(
let availabilityPlatformName = $0.domain.map { PlatformName(operatingSystemName: $0.rawValue) } ?? platformName
return $0.fillingMissingIntroducedVersion(
from: defaultAvailabilityVersionByPlatform,
fallbackPlatform: DefaultAvailability.fallbackPlatforms[platformName]?.rawValue
fallbackPlatform: DefaultAvailability.fallbackPlatforms[availabilityPlatformName]?.rawValue
)
}
// Add the module availability information to each of the symbols availability mixin.
Expand Down
35 changes: 32 additions & 3 deletions Tests/SwiftDocCTests/Rendering/SymbolAvailabilityTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
This source file is part of the Swift.org open source project

Copyright (c) 2024 Apple Inc. and the Swift project authors
Copyright (c) 2024-2025 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
Expand Down Expand Up @@ -45,6 +45,7 @@ class SymbolAvailabilityTests: XCTestCase {
private func renderNodeAvailability(
defaultAvailability: [DefaultAvailability.ModuleAvailability] = [],
symbolGraphOperatingSystemPlatformName: String,
symbolGraphEnvironmentName: String? = nil,
symbols: [SymbolGraph.Symbol],
symbolName: String
) throws -> [AvailabilityRenderItem] {
Expand All @@ -56,7 +57,7 @@ class SymbolAvailabilityTests: XCTestCase {
]),
JSONFile(name: "ModuleName.symbols.json", content: makeSymbolGraph(
moduleName: "ModuleName",
platform: SymbolGraph.Platform(architecture: nil, vendor: nil, operatingSystem: SymbolGraph.OperatingSystem(name: symbolGraphOperatingSystemPlatformName), environment: nil),
platform: SymbolGraph.Platform(architecture: nil, vendor: nil, operatingSystem: SymbolGraph.OperatingSystem(name: symbolGraphOperatingSystemPlatformName), environment: symbolGraphEnvironmentName),
symbols: symbols,
relationships: []
)),
Expand All @@ -71,7 +72,7 @@ class SymbolAvailabilityTests: XCTestCase {

func testSymbolGraphSymbolWithoutDeprecatedVersionAndIntroducedVersion() throws {

let availability = try renderNodeAvailability(
var availability = try renderNodeAvailability(
defaultAvailability: [],
symbolGraphOperatingSystemPlatformName: "ios",
symbols: [
Expand All @@ -91,6 +92,34 @@ class SymbolAvailabilityTests: XCTestCase {
"iPadOS <nil> - 1.2.3",
"Mac Catalyst <nil> - 1.2.3",
])

availability = try renderNodeAvailability(
defaultAvailability: [
DefaultAvailability.ModuleAvailability(platformName: PlatformName(operatingSystemName: "iOS"), platformVersion: "1.2.3")
],
symbolGraphOperatingSystemPlatformName: "ios",
symbolGraphEnvironmentName: "macabi",
symbols: [
makeSymbol(
id: "platform-1-symbol",
kind: .class,
pathComponents: ["SymbolName"],
availability: [
makeAvailabilityItem(domainName: "iOS", deprecated: SymbolGraph.SemanticVersion(string: "1.2.3")),
makeAvailabilityItem(domainName: "visionOS", deprecated: SymbolGraph.SemanticVersion(string: "1.0.0"))
]
)
],
symbolName: "SymbolName"
)

XCTAssertEqual(availability.map { "\($0.name ?? "<nil>") \($0.introduced ?? "<nil>") - \($0.deprecated ?? "<nil>")" }, [
// The default availability for iOS shouldnt be copied to visionOS.
"iOS 1.2.3 - 1.2.3",
"iPadOS 1.2.3 - <nil>",
"Mac Catalyst 1.2.3 - 1.2.3",
"visionOS <nil> - 1.0",
])
}

func testSymbolGraphSymbolWithObsoleteVersion() throws {
Expand Down