Data Connect Swift Generation Struct Property Name Conflict

[mschwerz-bitrip]

[REQUIRED] Environment info

firebase-tools:15.14.0

Platform:macOS

[REQUIRED] Test case

Starting with the codelab for iOS: https://firebase.google.com/codelabs/firebase-dataconnect-ios#0

[REQUIRED] Steps to reproduce

1. Modify the Review table to have another property that is also a User:

# Reviews is a join table between User and Movie.
# It has a composite primary keys `userUid` and `movieId`.
# A user can leave reviews for many movies. A movie can have reviews from many users.
# User  <-> Review is a one-to-many relationship
# Movie <-> Review is a one-to-many relationship
# Movie <-> User is a many-to-many relationship
type Review @table(name: "Reviews", key: ["movie", "user"]) {
  user: User!
  otherUser: User!
  # The user field adds the following foreign key field. Feel free to uncomment and customize it.
  #  userUid: String!
  movie: Movie!
  # The movie field adds the following foreign key field. Feel free to uncomment and customize it.
  #  movieId: UUID!
  rating: Int
  reviewText: String
  reviewDate: Date! @default(expr: "request.time")
}

and correct the AddReview query:

mutation AddReview($movieId: UUID!, $rating: Int!, $reviewText: String!)
@auth(level: USER) {
  review_upsert(
    data: {
      userId_expr: "auth.uid"
      otherUserId_expr: "auth.uid"
      movieId: $movieId
      rating: $rating
      reviewText: $reviewText
      # reviewDate defaults to today in the schema. No need to set it manually.
    }
  )
}

2. Create the following query:

query ListReviewsRepro @auth(level: PUBLIC) {
  reviews {                                                                                                                 
    rating
    reviewText                                                                                                              
    user        { id username }
    otherUser { id username }
  }
}   

3. Generate the sdk for swift

[REQUIRED] Expected behavior

The User structs underneath the ListReviewsReproQuery class should have unique names like generating for Android creates:

        @kotlinx.serialization.Serializable
  public data class User(
  
    val id: String,
    val username: String
  ) {
    
    
  }
      
        @kotlinx.serialization.Serializable
  public data class OtherUser(
  
    val id: String,
    val username: String
  ) {
    
    
  }

[REQUIRED] Actual behavior

The same name is given to struct for both the user and other user properties with the ListReviewsReproQuery. This prevents the iOS code from being able to build

[mschwerz-bitrip]

Here is the generated code for swift:

public class ListReviewsReproQuery{

  let dataConnect: DataConnect

  init(dataConnect: DataConnect) {
    self.dataConnect = dataConnect
  }

  public static let OperationName = "ListReviewsRepro"

  public typealias Ref = QueryRefObservation<ListReviewsReproQuery.Data,ListReviewsReproQuery.Variables>

  public struct Variables: OperationVariable {

    
    
  }

  public struct Data: Decodable, Sendable {




public struct Review: Decodable, Sendable  {
  


public var 
rating: Int?



public var 
reviewText: String?





public struct User: Decodable, Sendable ,Hashable, Equatable, Identifiable {
  


public var 
id: String



public var 
username: String


  
  public var userKey: UserKey {
    return UserKey(
      
      id: id
    )
  }

  
public func hash(into hasher: inout Hasher) {
  
  hasher.combine(id)
  
}
public static func == (lhs: User, rhs: User) -> Bool {
    
    return lhs.id == rhs.id 
        
  }

  

  
  enum CodingKeys: String, CodingKey {
    
    case id
    
    case username
    
  }

  public init(from decoder: any Decoder) throws {
    var container = try decoder.container(keyedBy: CodingKeys.self)
    let codecHelper = CodecHelper<CodingKeys>()

    
    
    self.id = try codecHelper.decode(String.self, forKey: .id, container: &container)
    
    
    
    self.username = try codecHelper.decode(String.self, forKey: .username, container: &container)
    
    
  }
}
public var 
user: User





public struct User: Decodable, Sendable ,Hashable, Equatable, Identifiable {
  


public var 
id: String



public var 
username: String


  
  public var userKey: UserKey {
    return UserKey(
      
      id: id
    )
  }

  
public func hash(into hasher: inout Hasher) {
  
  hasher.combine(id)
  
}
public static func == (lhs: User, rhs: User) -> Bool {
    
    return lhs.id == rhs.id 
        
  }

  

  
  enum CodingKeys: String, CodingKey {
    
    case id
    
    case username
    
  }

  public init(from decoder: any Decoder) throws {
    var container = try decoder.container(keyedBy: CodingKeys.self)
    let codecHelper = CodecHelper<CodingKeys>()

    
    
    self.id = try codecHelper.decode(String.self, forKey: .id, container: &container)
    
    
    
    self.username = try codecHelper.decode(String.self, forKey: .username, container: &container)
    
    
  }
}
public var 
otherUser: User


  

  
  enum CodingKeys: String, CodingKey {
    
    case rating
    
    case reviewText
    
    case user
    
    case otherUser
    
  }

  public init(from decoder: any Decoder) throws {
    var container = try decoder.container(keyedBy: CodingKeys.self)
    let codecHelper = CodecHelper<CodingKeys>()

    
    
    self.rating = try codecHelper.decode(Int?.self, forKey: .rating, container: &container)
    
    
    
    self.reviewText = try codecHelper.decode(String?.self, forKey: .reviewText, container: &container)
    
    
    
    self.user = try codecHelper.decode(User.self, forKey: .user, container: &container)
    
    
    
    self.otherUser = try codecHelper.decode(User.self, forKey: .otherUser, container: &container)
    
    
  }
}
public var 
reviews: [Review]

  }

  public func ref(
        
        ) -> QueryRefObservation<ListReviewsReproQuery.Data,ListReviewsReproQuery.Variables>  {
        var variables = ListReviewsReproQuery.Variables()
        

        let ref = dataConnect.query(name: "ListReviewsRepro", variables: variables, resultsDataType:ListReviewsReproQuery.Data.self, publisher: .observableMacro)
        return ref as! QueryRefObservation<ListReviewsReproQuery.Data,ListReviewsReproQuery.Variables>
   }

  @MainActor
   public func execute( fetchPolicy: QueryFetchPolicy = .preferCache,  
        
        ) async throws -> OperationResult<ListReviewsReproQuery.Data> {
        var variables = ListReviewsReproQuery.Variables()
        

        let ref = dataConnect.query(name: "ListReviewsRepro", variables: variables, resultsDataType:ListReviewsReproQuery.Data.self, publisher: .observableMacro)
        
        let refCast = ref as! QueryRefObservation<ListReviewsReproQuery.Data,ListReviewsReproQuery.Variables>
        return try await refCast.execute(fetchPolicy: fetchPolicy)
        
   }
}

[aalej]

Hey @mschwerz-bitrip, thank you for the detailed report! I was able to reproduce the error. This has been escalated to our engineering team for further investigation. Will mark this issue as reproducible.

[aashishpatil-g]

This is a known issue with Swift code generation. If you have the option, can you alias the the two user fields. That will generate unique types in Swift.

Something like this should work.

query ListReviewsRepro @auth(level: PUBLIC) {
  reviews {                                                                                                                 
    rating
    reviewText                                                                                                              
    author: user        { id username }
    reviewer: otherUser { id username }
  }
}   

Since its a breaking change for codegen (types change), we will fix it in an upcoming major release.

[aashishpatil-g]

Aliases should still work fine with Android (Kotlin) codegen too.