Skip to content

Support generating Encodable types #728

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Support generating Encodable types #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c26256f
add type validation for when deserializing
gsabran Aug 12, 2025
2719419
fix
gsabran Aug 12, 2025
18cd657
wip validate / decode
gsabran Aug 13, 2025
f9fbc47
clean up
gsabran Aug 13, 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
13 changes: 13 additions & 0 deletions .../ApolloCodegenTests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplateTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class SelectionSetTemplateTests: XCTestCase {
subject = SelectionSetTemplate(
definition: self.operation.irObject,
generateInitializers: false,
generateDecodableTypes: false,
config: config,
nonFatalErrorRecorder: .init(),
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down Expand Up @@ -3333,6 +3334,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3411,6 +3413,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3499,6 +3502,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3587,6 +3591,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3675,6 +3680,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3768,6 +3774,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3867,6 +3874,7 @@ class SelectionSetTemplateTests: XCTestCase {
let basicFragmentSubject = SelectionSetTemplate(
definition: allAnimals_basicFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -3959,6 +3967,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -4051,6 +4060,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -9684,6 +9694,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_asDog_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -9769,6 +9780,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentSubject = SelectionSetTemplate(
definition: allAnimals_animalFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down Expand Up @@ -11940,6 +11952,7 @@ class SelectionSetTemplateTests: XCTestCase {
let fragmentTemplate = SelectionSetTemplate(
definition: detailsFragment.fragment,
generateInitializers: false,
generateDecodableTypes: false,
config: self.subject.config,
nonFatalErrorRecorder: .init(),
renderAccessControl: self.subject.renderAccessControl()
Expand Down
2 changes: 2 additions & 0 deletions ...ests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplate_ErrorHandling_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ class SelectionSetTemplate_ErrorHandling_Tests: XCTestCase {
subject = SelectionSetTemplate(
definition: self.operation.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: ApolloCodegen.ConfigurationContext(config: config),
nonFatalErrorRecorder: errorRecorder,
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand All @@ -79,6 +80,7 @@ class SelectionSetTemplate_ErrorHandling_Tests: XCTestCase {
subject = SelectionSetTemplate(
definition: fragment.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: ApolloCodegen.ConfigurationContext(config: config),
nonFatalErrorRecorder: errorRecorder,
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down
1 change: 1 addition & 0 deletions ...Tests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplate_FieldMerging_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class SelectionSetTemplate_FieldMerging_Tests: XCTestCase {
subject = SelectionSetTemplate(
definition: self.operation.irObject,
generateInitializers: selectionSetInitializers,
generateDecodableTypes: false,
config: config,
nonFatalErrorRecorder: .init(),
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down
2 changes: 2 additions & 0 deletions ...Tests/CodeGeneration/Templates/SelectionSet/SelectionSetTemplate_Initializers_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ class SelectionSetTemplate_Initializers_Tests: XCTestCase {
subject = SelectionSetTemplate(
definition: self.operation.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: ApolloCodegen.ConfigurationContext(config: config),
nonFatalErrorRecorder: .init(),
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down Expand Up @@ -77,6 +78,7 @@ class SelectionSetTemplate_Initializers_Tests: XCTestCase {
subject = SelectionSetTemplate(
definition: fragment.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: ApolloCodegen.ConfigurationContext(config: config),
nonFatalErrorRecorder: .init(),
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down
1 change: 1 addition & 0 deletions ...CodeGeneration/Templates/SelectionSet/SelectionSetTemplate_LocalCacheMutation_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class SelectionSetTemplate_LocalCacheMutationTests: XCTestCase {
subject = SelectionSetTemplate(
definition: self.operation.irObject,
generateInitializers: false,
generateDecodableTypes: false,
config: config,
nonFatalErrorRecorder: .init(),
renderAccessControl: mockTemplateRenderer.accessControlModifier(for: .member)
Expand Down
2 changes: 2 additions & 0 deletions ...ApolloCodegenTests/CodeGeneration/Templates/TemplateString_DeprecationMessage_Tests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ final class TemplateString_DeprecationMessage_Tests: XCTestCase {
let subject = SelectionSetTemplate(
definition: operation.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: config,
nonFatalErrorRecorder: .init(),
renderAccessControl: { "does not matter" }()
Expand Down Expand Up @@ -403,6 +404,7 @@ final class TemplateString_DeprecationMessage_Tests: XCTestCase {
let subject = SelectionSetTemplate(
definition: operation.irObject,
generateInitializers: true,
generateDecodableTypes: false,
config: config,
nonFatalErrorRecorder: .init(),
renderAccessControl: { "does not matter" }()
Expand Down
161 changes: 161 additions & 0 deletions Tests/ApolloTests/DataDictTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
import XCTest
@testable import Apollo
import ApolloAPI
import ApolloInternalTestHelpers
import Nimble

class DataDictTests: XCTestCase {

class Data: MockSelectionSet {
class Animal: MockSelectionSet {
class Predator: MockSelectionSet { }
}
}

func test__encoding_simpleDataStructure_works() throws {
// given
let subject = DataDict(
data: [
"__typename": "Animal",
"name": "Dog"
],
fulfilledFragments: [],
deferredFragments: []
)

// then
expect(
try JSONEncoder().encode(subject).jsonString()
).to(match("""
{
"__typename": "Animal",
"name": "Dog"
}
"""))
}

func test__encoding_nestedDataStructure_works() throws {
// given
let subject = DataDict(
data: [
"animals": [
DataDict(
data: [
"__typename": "Animal",
"name": "Dog"
],
fulfilledFragments: [
ObjectIdentifier(Data.Animal.self),
],
deferredFragments: [
ObjectIdentifier(Data.Animal.Predator.self)
]
),
DataDict(
data: [
"__typename": "Animal",
"name": "Cat"
],
fulfilledFragments: [
ObjectIdentifier(Data.Animal.self),
],
deferredFragments: [
ObjectIdentifier(Data.Animal.Predator.self)
]
)
]
],
fulfilledFragments: [
ObjectIdentifier(Data.self),
]
)

// then
expect(
try JSONEncoder().encode(subject).jsonString()
).to(match("""
{
"animals": [
{
"__typename": "Animal",
"name": "Dog"
}, {
"__typename": "Animal",
"name": "Cat"
}
]
}
"""))
}

func test__encoding_dataStructureWithArrayProperties_works() throws {
// givens
let subject = DataDict(
data: [
"animals": [
DataDict(
data: [
"__typename": "Animal",
"name": "Dog"
],
fulfilledFragments: [],
deferredFragments: []
),
DataDict(
data: [
"__typename": "Animal",
"name": "Cat"
],
fulfilledFragments: [],
deferredFragments: []
)
],
"coordinates": [[1.0, 2.0], [3.0, 4.0], DataDict._NullValue],
],
fulfilledFragments: []
)

// then
expect(
try JSONEncoder().encode(subject).jsonString()
).to(match("""
{
"animals": [
{
"__typename": "Animal",
"name": "Dog"
}, {
"__typename": "Animal",
"name": "Cat"
}
],
"coordinates": [
[1.0, 2.0],
[3.0, 4.0],
null
]
}
"""))
}


}

extension Data {
public func jsonString(ignoring ignoredKeys: [String] = []) throws -> String {
var object = try JSONSerialization.jsonObject(with: self, options: [])
if !ignoredKeys.isEmpty {
object = (object as? [String: Any?])?
.filter { !ignoredKeys.contains($0.key) } as Any
}
let data = try JSONSerialization.data(withJSONObject: object, options: [.prettyPrinted, .sortedKeys])
return String(data: data, encoding: .utf8)!
}
}

func match(_ expectedValue: String) -> Matcher<String> {
let expectedData = Data(expectedValue.utf8)

let expectedString = try! expectedData.jsonString()
return equal(expectedString)
}
Loading