Build failure with BUILD_LIBRARY_FOR_DISTRIBUTION=YES

Question

Build failure with BUILD_LIBRARY_FOR_DISTRIBUTION=YES

chhetri-rahul opened this issue a year ago · 23 comments

When will the support for visionOS be provided, for both simulator and physical device?

We have a SDK which consumes swift-cryto as a package dependency (v 2.1.0). We are updating our codebase to support the new OS from Apple. The SDK builds for iOS and MacCatalyst on intel and M1 machines.

Right now when i build from cli with command:

xcodebuild -workspace MySDK.xcworkspace -configuration Debug -sdk xrsimulator build -derivedDataPath ./out -scheme MySDK -destination "generic/platform=visionOS Simulator,OS=latest,name=Apple Vision Pro" "ARCHS=\x86_64 \arm64

if fails with the error:

no such module 'CCryptoBoringSSL'
@_implementationOnly import CCryptoBoringSSL

Answer 1 · 2023-08-12T18:39:10.000Z

v2.1.0 is very old, it was released in April 2022. Can you update to 2.6.0 and tell me if this reproduces?

Answer 2 · 2023-08-17T10:38:50.000Z

After updating to v2.6.0 we are getting the following compilation error

Here you suggested to change the build setting BUILD_LIBRARY_FOR_DISTRIBUTION as false which is not possible in our case.

And regarding the consumption of these APIs we are already importing using the @_implementationOnly import statement.

Can you please guide on how to fix this?

Answer 3 · 2023-08-17T11:05:54.000Z

You must change the build setting for swift-crypto to disable BUILD_LIBRARY_FOR_DISTRIBUTION: we do not have a stable ABI and we don't support this build mode.

You may subsequently link this library into a different library that you own which does have a stable ABI, which is where @_implementationOnly will be helpful.

Answer 4 · 2023-08-17T11:06:21.000Z

Additionally: are you actually using _CryptoExtras? If not, you could drop the dependency.

Answer 5 · 2023-08-30T10:54:44.000Z

Changing the build setting BUILD_LIBRARY_FOR_DISTRIBUTION also didn't help and it fails with the same error

I had updated this setting for both the targets (Crypto, _CryptoExtras) like below:

Also, _CryptoExtras is required by us and cannot be removed. We use _RSA.Signing.Padding from this module.

Btw this error can be seen in a standalone project as well when we try to archive it by running cli command.

Anything else that we can try?

Answer 6 · 2023-08-30T10:59:41.000Z

Sorry, how do you reproduce this in a standalone project?

Answer 7 · 2023-08-30T11:15:02.000Z

Make a framework project from Xcode template, add the package dependency, include both Crypto and _CryptoExtras to your target.
Have one file in your target where you @_implementationOnly import module is added.
Run the following command on terminal

xcodebuild archive -configuration Release -sdk iphoneos -scheme MySwiftCryptoCheckSDK BUILD_LIBRARY_FOR_DISTRIBUTION=YES SKIP_INSTALL=NO -derivedDataPath ./gen/out -archivePath ./gen/Archive

Answer 8 · 2023-08-30T11:20:20.000Z

Btw the failure is not related to visionOS, it fails for iphoneos as well (havent checked for other destinations) .

Answer 9 · 2023-08-30T12:07:19.000Z

So I believe that BUILD_LIBRARY_FOR_DISTRIBUTION=YES may be overriding the build setting in the package. Can you provide the build log?

Answer 10 · 2023-08-31T10:31:36.000Z

archive-failed.txt

I noticed the archive commands succeeds when i remove BUILD_LIBRARY_FOR_DISTRIBUTION=YES from the command. But it is one thing we can't remove.

Answer 11 · 2023-09-04T08:06:14.000Z

Yeah, that setting is overriding your change to the Package. Why can't you change the build setting for the package?

Answer 12 · 2023-09-05T09:45:40.000Z

Renaming the issue to reflect the issue is not related to visionOS

Answer 13 · 2023-09-06T10:32:09.000Z

Yeah, that setting is overriding your change to the Package. Why can't you change the build setting for the package?

I did change the build setting for the Crypto and _CryptoExtras in my fork and used it in my code but still got the same error.

Answer 14 · 2023-09-06T12:40:31.000Z

Sorry, I meant to say: why does your project require setting BUILD_LIBRARY_FOR_DISTRIBUTION=YES on all targets in your project?

Answer 15 · 2023-09-07T06:34:56.000Z

Not all the targets in the project require this setting, just two of them.

Answer 16 · 2023-09-07T10:00:50.000Z

Is there any reason you cannot set this setting only for those two?

Answer 17 · 2023-09-11T10:44:30.000Z

@Lukasa can you help me tell how to set the build setting for individual targets?. Should i set this setting in xcode build settings ui and let terminal use the values from there or in command line i have to pass the setting to each target.

For the latter case how will the xcodebuild command look like.

Answer 18 · 2023-09-11T12:56:06.000Z

You would set this in the Xcode build settings UI for the specific targets.

Answer 19 · 2023-09-13T06:25:14.000Z

Thanks @Lukasa i will try what you suggested.

I also found this when looking for a solution. The archive command succeeds with this change.
archive-success.txt

Will removing @inlineable like in above cause any kind of problem in our code?

Answer 20 · 2023-09-13T08:19:02.000Z

It may lead to worse performance, but that’s it

Answer 21 · 2023-09-22T05:48:29.000Z

Thanks @Lukasa for being patient in answering all the questions i have and for actively replying.

The performance degrade youre saying is only during build time or when the code gets used when app is running?

Also I tried what you suggested above and it fixes the archive failure problem, the only thing i want to know now is that we have 6 targets in our workspace (framework targets, unit tests, app targets) the setting BUILD_LIBRARY_FOR_DISTRIBUTION=YES is just to be passed to the framework target right?.

We distribute xcframework so i guess only having this setting in framework target is enough but want your opinion on it.

Answer 22 · 2023-09-22T09:50:52.000Z

The performance degradation will be while the app is running.

And yes, you should only need to pass that value to the framework target.

Answer 23 · 2023-09-26T04:49:34.000Z

Okay Thank you very much @Lukasa 🤝🎉