code generation creates a mock object using an inaccessible initializer for a default value

[akoslowski]

Summary

Hello everyone,

we are in the migration to version 2.0.2 and noticed an issue with code generation in test mocks. We receive error: no exact matches in call to initializer when a required field is using a custom scalar type. The generated default value in init cannot access .init(_jsonValue:).

17 | public extension Mock where O == Viewer {
18 |   convenience init(
19 |     imageURL: Demo.URL = try! .init(_jsonValue: "")
   |                                `- error: no exact matches in call to initializer
20 |   ) {
21 |     self.init()

Thanks for looking into this. Keep up the good work.

Version

2.0.2

Steps to reproduce the behavior

We tried to isolate the issue as much as possible in a small example project. The included schema is using the same custom scalar for URL we have in our production schema:

https://github.com/akoslowski/apollo-mock-codegen-issue

An observation: we saw that adding @_spi(Internal) to the generated mock makes the initializer available.

index a0defbc..3787741 100644
--- a/Tests/GraphQLMocks/Viewer+Mock.graphql.swift
+++ b/Tests/GraphQLMocks/Viewer+Mock.graphql.swift
@@ -1,7 +1,7 @@
 // @generated
 // This file was automatically generated and should not be edited.

-import ApolloTestSupport
+@_spi(Internal) import ApolloTestSupport
 @testable import Demo

 public final class Viewer: MockObject {
@@ -15,7 +15,7 @@ public final class Viewer: MockObject {
 }

 public extension Mock where O == Viewer {
-  convenience init(
+    @_spi(Internal) convenience init(
     imageURL: Demo.URL = try! .init(_jsonValue: "")
   ) {
     self.init()

Logs

Anything else?

No response

[AnthonyMDev]

Thank you for the report @akoslowski! This looks like an oversight on our end. We'll look into this and get it resolved in a new patch version as soon as we can!

[sallychung]

Hi @AnthonyMDev, appreciate your help and looking forward to the patch for this soon. My team are currently blocked from upgrading to Apollo v2 due to this similar issue.

[AnthonyMDev]

Sorry I haven't gotten to this yet. I got COVID and was out for the last two weeks. Currently going through a few urgent bugs to get a patch out. This one is included in that list.

[sallychung]

Sorry to hear that you were unwell @AnthonyMDev but happy to hear that you're on the mend . Appreciate you getting that PR up already 🙏🏼

[github-actions]

Do you have any feedback for the maintainers? Please tell us by taking a one-minute survey. Your responses will help us understand Apollo iOS usage and allow us to serve you better.

[AnthonyMDev]

We'll be releasing 2.0.3 with the fix for this today!

[akoslowski]

Hello @AnthonyMDev,

thanks for taking care of the issue. I just tried the new version and I cannot make it work. The generated code does not change to the newly added default value.

What I did:

Updated the Apollo version in https://github.com/akoslowski/apollo-mock-codegen-issue to 2.0.3 and ran the following:

$ swift package --allow-writing-to-package-directory apollo-cli-install
Plugin ‘Install CLI’ wants permission to allow all network connections on all ports.
Stated reason: “Downloads the Apollo iOS CLI executable from the GitHub Release.”.
Allow this plugin to allow all network connections on all ports? (yes/no) yes
x apollo-ios-cli

$ ./apollo-ios-cli --version
2.0.3

$ ./apollo-ios-cli generate

Do you have an idea what I'm could be doing wrong?

@sallychung did you try the version already?