Support SelectionSet to receive [String: Any] for initialization when create mock object #102

Cookiezby · 2023-10-25T14:08:58Z

Relate to issue apollographql/apollo-ios#3264

If the data object which has type [String: AnyHashable] includes nested dictionary object, the compile will throw error, but it is fine to define the object with [String: Any], however, the DataDict only accept [String: AnyHashable] so there need a type conversion from [String: Any] to [String: AnyHashable]

I am not sure if it is better to add new convenience init method for DataDict type, so I only provide an extension as a help method

calvincestari · 2023-10-25T16:50:38Z

apollo-ios/Sources/Apollo/Dictionary+Helpers.swift

@@ -3,3 +3,18 @@ public extension Dictionary {
    lhs.merge(rhs) { (_, new) in new }
  }
 }
+
+public extension Dictionary where Key == String, Value == Any {


Thanks @Cookiezby, I'm not sure how the rest of the team feels about adding this yet but this is probably something that should live in ApolloTestSupport (here) rather than the main Apollo iOS package.

AnthonyMDev · 2023-10-25T20:49:03Z

Thanks for much for the contribution @Cookiezby!

I think that this issue might be a little more complicated than this PR addresses though!

For what you are doing, you should actually be using the special json initializer we have in RootSelectionSet+JSONInitializer.swift. Because nested selections sets and custom scalars aren’t going to be properly transformed if you just initialize the DataDict with your own JSON data.

The example in our docs here should probably be updated to use that as well. However the issue #3264 won't be addressed by that alone, as it still takes in a [String: AnyHashable] dictionary.

We should probably add another method there that takes in a [String: Any] json dict and does a conversion of that internally. Rather than the proposed .asAnyHashable being public as this PR suggests.

We also should include the utility requested in this issue to convert the selection sets back into raw JSON.

If you would like to take a stab at making the suggested changes, please let me know, and feel free to update this PR.

AnthonyMDev · 2023-10-25T21:12:38Z

It's worth noting that we already have AnyHashableConvertible as a protocol in ApolloAPI that could likely be used for this purpose as well (under the hood of the function implementation).

Cookiezby · 2023-10-25T22:09:32Z

@calvincestari @AnthonyMDev Hi, thanks for your reviews, I am willing to update my PR for the suggested change, will check the detail about the RootSelectionSet+JSONInitializer.swift.

We should probably add another method there that takes in a [String: Any] json dict and does a conversion of that internally. Rather than the proposed .asAnyHashable being public as this PR suggests

Cookiezby · 2023-10-25T23:31:09Z

@AnthonyMDev Hi, can you help to confirm if I totally understand your suggestions

For what you are doing, you should actually be using the special json initializer we have in RootSelectionSet+JSONInitializer.swift. Because nested selections sets and custom scalars aren’t going to be properly transformed if you just initialize the DataDict with your own JSON data.

Suppose I have a generated data structure

struct Document: SelectionSet {
   //.......
}

Do you mean we should init the Document by using the initialization method defined in SelectionSet+JSONInitializer.swift instead of passing a DataDict to initialize the data

// ✅ 
let jsonObject: JSONObject = [:]
let mockDocument = Document(data: jsonObject)

// ❌
let dict: [String: AnyHashable] = [:]
let mockDocument = Document(dataDict: DataDict(dict))

And because the JSONObject is still equal to [String: AnyHashable] so the next step I need to do is to add another initialization method for SelectionSet so that it can takes [String: Any] type of data for initialization, and in the method we would convert [String: Any] to JSONObject internally

AnthonyMDev · 2023-10-25T23:52:59Z

Yes, that's right!

Cookiezby · 2023-10-26T00:19:36Z

apollo-ios/Sources/ApolloTestSupport/SelectionSet+DictionaryIntializer.swift

@@ -0,0 +1,38 @@
+#if !COCOAPODS


I put the new initialization method in ApolloTestSupport target to make sure this method is only used for mock purpose

Cookiezby · 2023-10-26T00:29:12Z

@AnthonyMDev Thanks for your confirmation! I just update the code, could you help to check it?

bdbergeron · 2023-11-01T01:26:49Z

As I mentioned in this comment in the apollo-ios repo, this is just a Swift compiler issue and can be solved by adding as [String: AnyHashable] to the nested dictionaries. I question whether it makes sense to add another initializer that allows for passing [String: Any] since internally Apollo needs the values to be AnyHashable.

AnthonyMDev · 2023-11-01T17:20:54Z

As I mentioned in this comment in the apollo-ios repo, this is just a Swift compiler issue and can be solved by adding as [String: AnyHashable] to the nested dictionaries. I question whether it makes sense to add another initializer that allows for passing [String: Any] since internally Apollo needs the values to be AnyHashable.

Thanks for the feedback. While that is possible, I don't see any harm in adding the helper method here to make people's lives easier working with this.

AnthonyMDev

I actually think we should include this right alongside the other initializer in RootSelectionSet+JSONInitializer.swift. We should probably put @_disfavoredOverload on it, to prevent ambiguity issues also.

It should also have the parameter named data just like the other initializer.

Lastly, I'm wondering if we also need to do conversions of arrays (or arrays of dictionaries ([[String: Any]]) as well.

@Cookiezby Can you test this with some data with arrays in it and add array conversion if its needed?

bdbergeron · 2023-11-01T19:12:39Z

As I mentioned in this comment in the apollo-ios repo, this is just a Swift compiler issue and can be solved by adding as [String: AnyHashable] to the nested dictionaries. I question whether it makes sense to add another initializer that allows for passing [String: Any] since internally Apollo needs the values to be AnyHashable.

Thanks for the feedback. While that is possible, I don't see any harm in adding the helper method here to make people's lives easier working with this.

My primary concern is that this initializer swallows any non-Hashable objects a developer may pass to it, without indicating it's doing so. At a minimum I think this new initializer should throw if a value in the dictionary cannot be converted to AnyHashable.

AnthonyMDev · 2023-11-01T19:55:41Z

Oh yes! That's a great point, and one I missed. I 100% agree with that.

AnthonyMDev

Sorry if I wasn't clear about this! I think we should just move this method into the SelectionSet+JSONInitializer.swift` file that already exists.

Also, this implementation currently only will handle 1 dimensional arrays of objects. We need it to handle more arrays. As this is getting more complex, I'm thinking we might want to add some tests for this as well so we can verify we are handling all the different ways of doing this.

@Cookiezby Do you feel like you're still willing to work through these complications?

AnthonyMDev · 2023-11-02T19:48:59Z

docs/source/testing/test-mocks.mdx

@@ -36,7 +38,7 @@ let data: [String: AnyHashable] = [
    ]
 ]

-let model = HeroAndFriendsQuery.Data(data: DataDict(data))
+let model = HeroAndFriendsQuery.Data(dict: data)


Suggested change

let model = HeroAndFriendsQuery.Data(dict: data)

let model = try HeroAndFriendsQuery.Data(data: data)

AnthonyMDev · 2023-11-02T19:49:23Z

apollo-ios/Sources/Apollo/SelectionSet+DictionaryIntializer.swift

+  ///                the given JSON response data.
+  @_disfavoredOverload
+  public init(
+    dict: [String: Any],


Suggested change

dict: [String: Any],

data: [String: Any],

AnthonyMDev · 2023-11-02T19:52:56Z

apollo-ios/Sources/Apollo/SelectionSet+DictionaryIntializer.swift

+  /// Convert dictionary type [String: Any] to JSONObject
+  /// - Parameter dict: dictionary value
+  /// - Returns: converted JSONObject
+  static func convertDictToJSONObject(dict: [String: Any]) throws -> JSONObject {


Suggested change

static func convertDictToJSONObject(dict: [String: Any]) throws -> JSONObject {

private static func convertDictToJSONObject(dict: [String: Any]) throws -> JSONObject {

AnthonyMDev · 2023-11-02T19:53:17Z

apollo-ios/Sources/Apollo/SelectionSet+DictionaryIntializer.swift

+  // Initializes a `SelectionSet` with a raw Dictionary.
+  ///
+  /// We could pass dictionary object to create a mock object for GraphQL object.
+  ///
+  /// - Parameters:
+  ///   - dict: A dictionary representing a dictionary response for a GraphQL object.
+  ///   - variables: [Optional] The operation variables that would be used to obtain
+  ///                the given JSON response data.


Suggested change

// Initializes a `SelectionSet` with a raw Dictionary.

///

/// We could pass dictionary object to create a mock object for GraphQL object.

///

/// - Parameters:

/// - dict: A dictionary representing a dictionary response for a GraphQL object.

/// - variables: [Optional] The operation variables that would be used to obtain

/// the given JSON response data.

/// Initializes a `SelectionSet` with a raw JSON response object.

///

/// The process of converting a JSON response into `SelectionSetData` is done by using a

/// `GraphQLExecutor` with a`GraphQLSelectionSetMapper` to parse, validate, and transform

/// the JSON response data into the format expected by `SelectionSet`.

///

/// - Parameters:

/// - data: A dictionary representing a JSON response object for a GraphQL object.

/// - variables: [Optional] The operation variables that would be used to obtain

/// the given JSON response data.

Cookiezby · 2023-11-03T01:42:44Z

@AnthonyMDev Yes, I am willing to help with that, for the one dimensional object, I will add tests for that, and when I check the test case in the SelectionSetTests I found the nested array in some test cases, is this the more arrays that you mentions in here?

Also, this implementation currently only will handle 1 dimensional arrays of objects. We need it to handle more arrays

 let expected = try! Hero(
      data: [
        "__typename": "Human",
        "nestedList": [[]]
      ],
      variables: nil
)

…ble]

…: Any] type for mock object

Cookiezby · 2023-11-04T08:15:26Z

@AnthonyMDev Hi, I have added the implementation for handling the array (including nested array) when initialize the SelectionSet with dictionary object, and I also added some test cases for the new initializer, can you help to review it?

AnthonyMDev

This looks great to me! Thank you so much @Cookiezby for making this one happen!

… create mock object (#102)

… create mock object (apollographql/apollo-ios-dev#102)

f0c7e8e Support SelectionSet to receive [String: Any] for initialization when create mock object (#102) git-subtree-dir: apollo-ios git-subtree-split: f0c7e8e

calvincestari reviewed Oct 25, 2023

View reviewed changes

Cookiezby changed the title ~~feat: add extension for [String: Any] to transform to [String: AnyHashable]~~ Support SelectionSet to receive [String: Any] for initialization when create mock object Oct 26, 2023

Cookiezby commented Oct 26, 2023

View reviewed changes

AnthonyMDev requested changes Nov 1, 2023

View reviewed changes

AnthonyMDev requested changes Nov 2, 2023

View reviewed changes

Cookiezby added 13 commits November 4, 2023 17:04

feat: add extension for [String: Any] to convert to [String: AnyHasha…

fe4f027

…ble]

feat: update documentation for mock with dict object

26fc567

feat: add new initalization method for SelectionSet to accept [String…

5225430

…: Any] type for mock object

revert dictionary extension and update documentation

6592815

fix: add missing import for documentation

4bd5a78

fix: typo

e984cde

move dictionary init extension file

1680d65

feat: add throw error when the dictionary has non-hashable value

6595ea2

feat: add convert dict array value

566c4da

fix: selectionset dict initialization handle array value

2acb316

fix: set help method to private

f37430c

feat: add test case for dicitonary intializer

cda809d

feat: update test mock sample code

31e36b0

Cookiezby force-pushed the fix/convert-json-dict branch from 29a8786 to 31e36b0 Compare November 4, 2023 08:05

Cookiezby added 2 commits November 4, 2023 17:10

fix: remove unnecessary import in sample code

a93b6b4

fix: nested list test case

54b7997

fix: rename the parameter name in convertToAnyHashableArray

ff06742

AnthonyMDev approved these changes Nov 8, 2023

View reviewed changes

AnthonyMDev merged commit 0c88e7a into apollographql:main Nov 8, 2023
11 checks passed

BobaFetters pushed a commit that referenced this pull request Nov 8, 2023

Support SelectionSet to receive [String: Any] for initialization when…

e1bb21b

… create mock object (#102)

BobaFetters pushed a commit to apollographql/apollo-ios that referenced this pull request Nov 8, 2023

Support SelectionSet to receive [String: Any] for initialization when…

f0c7e8e

… create mock object (apollographql/apollo-ios-dev#102)

AnthonyMDev mentioned this pull request Nov 10, 2023

Mock object with [String: AnyHashable] data doesn't compile apollographql/apollo-ios#3264

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support SelectionSet to receive [String: Any] for initialization when create mock object #102

Support SelectionSet to receive [String: Any] for initialization when create mock object #102

Cookiezby commented Oct 25, 2023 •

edited

calvincestari Oct 25, 2023

AnthonyMDev commented Oct 25, 2023

AnthonyMDev commented Oct 25, 2023

Cookiezby commented Oct 25, 2023 •

edited

Cookiezby commented Oct 25, 2023 •

edited

AnthonyMDev commented Oct 25, 2023

Cookiezby Oct 26, 2023

Cookiezby commented Oct 26, 2023

bdbergeron commented Nov 1, 2023

AnthonyMDev commented Nov 1, 2023

AnthonyMDev left a comment

bdbergeron commented Nov 1, 2023 •

edited

AnthonyMDev commented Nov 1, 2023

AnthonyMDev left a comment

AnthonyMDev Nov 2, 2023

AnthonyMDev Nov 2, 2023

AnthonyMDev Nov 2, 2023

AnthonyMDev Nov 2, 2023

Cookiezby commented Nov 3, 2023

Cookiezby commented Nov 4, 2023

AnthonyMDev left a comment

	let model = HeroAndFriendsQuery.Data(dict: data)
	let model = try HeroAndFriendsQuery.Data(data: data)

	static func convertDictToJSONObject(dict: [String: Any]) throws -> JSONObject {
	private static func convertDictToJSONObject(dict: [String: Any]) throws -> JSONObject {

Support SelectionSet to receive [String: Any] for initialization when create mock object #102

Support SelectionSet to receive [String: Any] for initialization when create mock object #102

Conversation

Cookiezby commented Oct 25, 2023 • edited

calvincestari Oct 25, 2023

Choose a reason for hiding this comment

AnthonyMDev commented Oct 25, 2023

AnthonyMDev commented Oct 25, 2023

Cookiezby commented Oct 25, 2023 • edited

Cookiezby commented Oct 25, 2023 • edited

AnthonyMDev commented Oct 25, 2023

Cookiezby Oct 26, 2023

Choose a reason for hiding this comment

Cookiezby commented Oct 26, 2023

bdbergeron commented Nov 1, 2023

AnthonyMDev commented Nov 1, 2023

AnthonyMDev left a comment

Choose a reason for hiding this comment

bdbergeron commented Nov 1, 2023 • edited

AnthonyMDev commented Nov 1, 2023

AnthonyMDev left a comment

Choose a reason for hiding this comment

AnthonyMDev Nov 2, 2023

Choose a reason for hiding this comment

AnthonyMDev Nov 2, 2023

Choose a reason for hiding this comment

AnthonyMDev Nov 2, 2023

Choose a reason for hiding this comment

AnthonyMDev Nov 2, 2023

Choose a reason for hiding this comment

Cookiezby commented Nov 3, 2023

Cookiezby commented Nov 4, 2023

AnthonyMDev left a comment

Choose a reason for hiding this comment

Cookiezby commented Oct 25, 2023 •

edited

Cookiezby commented Oct 25, 2023 •

edited

Cookiezby commented Oct 25, 2023 •

edited

bdbergeron commented Nov 1, 2023 •

edited