Make our use of SwiftSyntax APIs more resilient to precompiled SwiftSyntax (#3694)

mbrandonw · web-flow · commit 6574de239631 · 2025-05-27T11:52:20.000-07:00
* Make our use of SwiftSyntax APIs more resilient to precompiled SwiftSyntax

* support 600 and 601"

* wip

* Make store isolation tests more resillient.
diff --git a/Package.resolved b/Package.resolved
diff --git a/Sources/ComposableArchitectureMacros/Availability.swift b/Sources/ComposableArchitectureMacros/Availability.swift
@@ -86,6 +86,8 @@ extension AttributeListSyntax.Element {
       if let availability = ifConfig.availability {
         return .ifConfigDecl(availability)
       }
+    @unknown default:
+      return nil
     }
     return nil
   }
diff --git a/Sources/ComposableArchitectureMacros/ObservableStateMacro.swift b/Sources/ComposableArchitectureMacros/ObservableStateMacro.swift
@@ -98,7 +98,8 @@ struct ObservationDiagnostic: DiagnosticMessage {
   var severity: DiagnosticSeverity
 
   init(
-    message: String, diagnosticID: SwiftDiagnostics.MessageID,
+    message: String,
+    diagnosticID: SwiftDiagnostics.MessageID,
     severity: SwiftDiagnostics.DiagnosticSeverity = .error
   ) {
     self.message = message
@@ -107,7 +108,10 @@ struct ObservationDiagnostic: DiagnosticMessage {
   }
 
   init(
-    message: String, domain: String, id: ID, severity: SwiftDiagnostics.DiagnosticSeverity = .error
+    message: String,
+    domain: String,
+    id: ID,
+    severity: SwiftDiagnostics.DiagnosticSeverity = .error
   ) {
     self.message = message
     self.diagnosticID = MessageID(domain: domain, id: id.rawValue)
@@ -117,7 +121,10 @@ struct ObservationDiagnostic: DiagnosticMessage {
 
 extension DiagnosticsError {
   init<S: SyntaxProtocol>(
-    syntax: S, message: String, domain: String = "Observation", id: ObservationDiagnostic.ID,
+    syntax: S,
+    message: String,
+    domain: String = "Observation",
+    id: ObservationDiagnostic.ID,
     severity: SwiftDiagnostics.DiagnosticSeverity = .error
   ) {
     self.init(diagnostics: [
@@ -158,8 +165,11 @@ extension TokenSyntax {
     switch tokenKind {
     case .identifier(let identifier):
       return TokenSyntax(
-        .identifier(prefix + identifier), leadingTrivia: leadingTrivia,
-        trailingTrivia: trailingTrivia, presence: presence)
+        .identifier(prefix + identifier),
+        leadingTrivia: leadingTrivia,
+        trailingTrivia: trailingTrivia,
+        presence: presence
+      )
     default:
       return self
     }
@@ -183,7 +193,8 @@ extension PatternBindingListSyntax {
           initializer: binding.initializer,
           accessorBlock: binding.accessorBlock,
           trailingComma: binding.trailingComma,
-          trailingTrivia: binding.trailingTrivia)
+          trailingTrivia: binding.trailingTrivia
+        )
 
       }
     }
@@ -202,8 +213,11 @@ extension VariableDeclSyntax {
       attributes: newAttributes,
       modifiers: modifiers.privatePrefixed(prefix),
       bindingSpecifier: TokenSyntax(
-        bindingSpecifier.tokenKind, leadingTrivia: .space, trailingTrivia: .space,
-        presence: .present),
+        bindingSpecifier.tokenKind,
+        leadingTrivia: .space,
+        trailingTrivia: .space,
+        presence: .present
+      ),
       bindings: bindings.privatePrefixed(prefix),
       trailingTrivia: trailingTrivia
     )
@@ -215,13 +229,38 @@ extension VariableDeclSyntax {
 }
 
 extension ObservableStateMacro: MemberMacro {
-  public static func expansion<
-    Declaration: DeclGroupSyntax,
-    Context: MacroExpansionContext
-  >(
+  #if canImport(SwiftSyntax601)
+    public static func expansion(
+      of node: AttributeSyntax,
+      providingMembersOf declaration: some DeclGroupSyntax,
+      conformingTo protocols: [TypeSyntax],
+      in context: some MacroExpansionContext
+    ) throws -> [DeclSyntax] {
+      try _expansion(
+        of: node,
+        providingMembersOf: declaration,
+        conformingTo: protocols,
+        in: context
+      )
+    }
+  #else
+    public static func expansion<
+      Declaration: DeclGroupSyntax,
+      Context: MacroExpansionContext
+    >(
+      of node: AttributeSyntax,
+      providingMembersOf declaration: Declaration,
+      in context: Context
+    ) throws -> [DeclSyntax] {
+      try _expansion(of: node, providingMembersOf: declaration, conformingTo: [], in: context)
+    }
+  #endif
+
+  private static func _expansion(
     of node: AttributeSyntax,
-    providingMembersOf declaration: Declaration,
-    in context: Context
+    providingMembersOf declaration: some DeclGroupSyntax,
+    conformingTo protocols: [TypeSyntax],
+    in context: some MacroExpansionContext
   ) throws -> [DeclSyntax] {
     guard !declaration.isEnum
     else {
@@ -239,20 +278,24 @@ extension ObservableStateMacro: MemberMacro {
       throw DiagnosticsError(
         syntax: node,
         message: "'@ObservableState' cannot be applied to class type '\(observableType.text)'",
-        id: .invalidApplication)
+        id: .invalidApplication
+      )
     }
     if declaration.isActor {
       // actors cannot yet be supported for their isolation
       throw DiagnosticsError(
         syntax: node,
         message: "'@ObservableState' cannot be applied to actor type '\(observableType.text)'",
-        id: .invalidApplication)
+        id: .invalidApplication
+      )
     }
 
     var declarations = [DeclSyntax]()
 
     declaration.addIfNeeded(
-      ObservableStateMacro.registrarVariable(observableType), to: &declarations)
+      ObservableStateMacro.registrarVariable(observableType),
+      to: &declarations
+    )
     declaration.addIfNeeded(ObservableStateMacro.idVariable(), to: &declarations)
     declaration.addIfNeeded(ObservableStateMacro.willModifyFunction(), to: &declarations)
 
@@ -453,14 +496,18 @@ extension ObservableStateMacro: MemberAttributeMacro {
       return [
         AttributeSyntax(
           attributeName: IdentifierTypeSyntax(
-            name: .identifier(ObservableStateMacro.ignoredMacroName)))
+            name: .identifier(ObservableStateMacro.ignoredMacroName)
+          )
+        )
       ]
     }
 
     return [
       AttributeSyntax(
         attributeName: IdentifierTypeSyntax(
-          name: .identifier(ObservableStateMacro.trackedMacroName)))
+          name: .identifier(ObservableStateMacro.trackedMacroName)
+        )
+      )
     ]
   }
 }
@@ -606,7 +653,8 @@ extension ObservationStateTrackedMacro: PeerMacro {
     }
 
     let storage = DeclSyntax(
-      property.privatePrefixed("_", addingAttribute: ObservableStateMacro.ignoredAttribute))
+      property.privatePrefixed("_", addingAttribute: ObservableStateMacro.ignoredAttribute)
+    )
     return [storage]
   }
 }
diff --git a/Sources/ComposableArchitectureMacros/PresentsMacro.swift b/Sources/ComposableArchitectureMacros/PresentsMacro.swift
@@ -99,7 +99,8 @@ extension VariableDeclSyntax {
       attributes: newAttributes,
       modifiers: modifiers.privatePrefixed("_"),
       bindingSpecifier: TokenSyntax(
-        bindingSpecifier.tokenKind, trailingTrivia: .space,
+        bindingSpecifier.tokenKind,
+        trailingTrivia: .space,
         presence: .present
       ),
       bindings: bindings.privateWrapped,
@@ -112,7 +113,8 @@ extension VariableDeclSyntax {
       leadingTrivia: leadingTrivia,
       modifiers: modifiers,
       bindingSpecifier: TokenSyntax(
-        bindingSpecifier.tokenKind, trailingTrivia: .space,
+        bindingSpecifier.tokenKind,
+        trailingTrivia: .space,
         presence: .present
       ),
       bindings: bindings.projected,
@@ -211,18 +213,34 @@ extension PatternBindingListSyntax {
 
 extension TypeSyntax {
   fileprivate var presentationWrapped: GenericSpecializationExprSyntax {
-    GenericSpecializationExprSyntax(
-      expression: MemberAccessExprSyntax(
-        base: DeclReferenceExprSyntax(baseName: "ComposableArchitecture"),
-        name: "PresentationState"
-      ),
-      genericArgumentClause: GenericArgumentClauseSyntax(
-        arguments: [
-          GenericArgumentSyntax(
-            argument: self
-          )
-        ]
+    #if canImport(SwiftSyntax601)
+      GenericSpecializationExprSyntax(
+        expression: MemberAccessExprSyntax(
+          base: DeclReferenceExprSyntax(baseName: "ComposableArchitecture"),
+          name: "PresentationState"
+        ),
+        genericArgumentClause: GenericArgumentClauseSyntax(
+          arguments: [
+            GenericArgumentSyntax(
+              argument: GenericArgumentSyntax.Argument(self)
+            )
+          ]
+        )
       )
-    )
+    #else
+      GenericSpecializationExprSyntax(
+        expression: MemberAccessExprSyntax(
+          base: DeclReferenceExprSyntax(baseName: "ComposableArchitecture"),
+          name: "PresentationState"
+        ),
+        genericArgumentClause: GenericArgumentClauseSyntax(
+          arguments: [
+            GenericArgumentSyntax(
+              argument: self
+            )
+          ]
+        )
+      )
+    #endif
   }
 }
diff --git a/Sources/ComposableArchitectureMacros/ReducerMacro.swift b/Sources/ComposableArchitectureMacros/ReducerMacro.swift
@@ -189,10 +189,28 @@ extension IdentifierTypeSyntax {
 }
 
 extension ReducerMacro: MemberMacro {
+  public static func expansion(
+    of node: AttributeSyntax,
+    providingMembersOf declaration: some DeclGroupSyntax,
+    conformingTo protocols: [TypeSyntax],
+    in context: some MacroExpansionContext
+  ) throws -> [DeclSyntax] {
+    try _expansion(of: node, providingMembersOf: declaration, conformingTo: protocols, in: context)
+  }
+
   public static func expansion<D: DeclGroupSyntax, C: MacroExpansionContext>(
     of node: AttributeSyntax,
     providingMembersOf declaration: D,
     in context: C
+  ) throws -> [DeclSyntax] {
+    try _expansion(of: node, providingMembersOf: declaration, conformingTo: [], in: context)
+  }
+
+  private static func _expansion(
+    of node: AttributeSyntax,
+    providingMembersOf declaration: some DeclGroupSyntax,
+    conformingTo protocols: [TypeSyntax],
+    in context: some MacroExpansionContext
   ) throws -> [DeclSyntax] {
     let access = declaration.modifiers.first {
       [.keyword(.public), .keyword(.package)].contains($0.name.tokenKind)
diff --git a/Tests/ComposableArchitectureTests/CurrentValueRelayTests.swift b/Tests/ComposableArchitectureTests/CurrentValueRelayTests.swift
@@ -5,7 +5,7 @@
 
   final class CurrentValueRelayTests: BaseTCATestCase {
     func testConcurrentSend() async {
-      nonisolated(unsafe) let subject = CurrentValueRelay(0)
+      let subject = CurrentValueRelay(0)
       let values = LockIsolated<Set<Int>>([])
       let cancellable = subject.sink { (value: Int) in
         values.withValue {
@@ -28,7 +28,7 @@
 
     @available(macOS 12.0, iOS 15.0, tvOS 15.0, watchOS 8.0, *)
     func testConcurrentSendAndReceive() async {
-      nonisolated(unsafe) let subject = CurrentValueRelay(0)
+      let subject = CurrentValueRelay(0)
       let values = LockIsolated<Set<Int>>([])
       let cancellable = subject.sink { (value: Int) in
         values.withValue {
diff --git a/Tests/ComposableArchitectureTests/StoreTests.swift b/Tests/ComposableArchitectureTests/StoreTests.swift

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,8 @@ extension AttributeListSyntax.Element {`
`86`	`86`	`if let availability = ifConfig.availability {`
`87`	`87`	`return .ifConfigDecl(availability)`
`88`	`88`	`}`
	`89`	`+ @unknown default:`
	`90`	`+ return nil`
`89`	`91`	`}`
`90`	`92`	`return nil`
`91`	`93`	`}`