Apollo v2.0 | Codegen CLI compile issue: '@_spi' properties need to be public

[f-gonzalez]

Summary

Just updated to v2.0 and was following the migration guide.
When running the Codegen CLI tool, I am getting this compile error: "Internal property cannot be declared '@_spi' because only public and open declarations can be '@_spi'"

For context (not sure if relevant): it's a modularized App. Apollo is imported and used in different modules/frameworks. Not just the main target app.

Version

2.0

Steps to reproduce the behavior

Just running the CLI.

Before with v1.16.1

let __data: DataDict
init(_dataDict: DataDict) { __data = _dataDict }

Now with v2.0

@_spi(Unsafe) let __data: DataDict
@_spi(Unsafe) init(_dataDict: DataDict) { __data = _dataDict }

If I manually add public it compiles just fine.

Logs

Anything else?

No response

[f-gonzalez]

More compile issues I am founding from the generated files on 2.0:

[calvincestari]

Hi @f-gonzalez, I believe both of these are covered in the migration guide; see the SPI Usage and Custom Scalar Types sections.

• To build the codegen source into your own project I think you'll need to use @_spi(Unsafe) import ApolloCodegenLib. The DataDict property and initializer should not be marked public because they are not intended for public use. By using the @_spi(Unsafe) annotation you're explicitly opting in to use unsafe internal functions.
• Pre-existing custom scalar files are not modified during code generation, so you'll need to manually update the import statement to @_spi(Execution) @_spi(Internal) import ApolloAPI. If you are generating new custom scalar files that did not exist before and are still getting this build error then that might be a bug.

[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]

@calvincestari is right on the second issue here. The first one I'm not totally clear on. Where is that compile error coming from? The only generated models you should need to fix manually are Custom Scalars. But if response models are having that compile error, it might be an issue on our side. Are you using the AccessModifier.internal setting? I'm wondering if that's a bug we missed!

[athasach]

I'm having the same issue as the original poster. In my apollo-codegen-config.json I have "accessModifier": "internal" and that causes the compilation error. If I switch to "accessModifier": "public", the issue goes away as indicated by the OP. The same error occurs if I omit accessModifier since it seems to default to internal.

The compilation error feels correct, because the only time you need to specify @_spi is when the symbol is public. If the symbol is not public, the consuming code won't have access to the member. So I think the output should be the following

• If "accessModifier": "internal", then

let __data: DataDict
init(_dataDict: DataDict) { __data = _dataDict }

• If "accessModifier": "public", then

@_spi(Unsafe) public let __data: DataDict
@_spi(Unsafe) public init(_dataDict: DataDict) { __data = _dataDict }

[athasach]

@AnthonyMDev, should I open a new issue for the above?

[AnthonyMDev]

I'm looking into this right now and just came to the same conclusion as you @athasach. I'm reopening this issue and will get that sorted out ASAP!

[AnthonyMDev]

Fix for this is up in apollographql/apollo-ios-dev#796. I'll get a patch release with this out tomorrow morning!

[f-gonzalez]

Fix for this is up in apollographql/apollo-ios-dev#796. I'll get a patch release with this out tomorrow morning!

Thanks @AnthonyMDev 🥇