SPM external dependency of Realm fails to build

[jmbene]

Describe the bug
I’m having problems with version 2.0 of Tuist and the Realm dependency when I’m trying to add a SPM dependency in the new Dependencies.swift file. If I fetch the dependencies and then try to warm the cache I receive the following error:

$ tuist cache warm
Resolved cache profile 'Development' from Tuist's defaults
Generating workspace Tuist2.xcworkspace
Generating project Tuist2
Generating project RealmDatabase
Generating project Realm
Hashing cacheable targets
Targets to be cached: Bid, ObjectStore, Realm, Storage, SyncClient, Tuist2Kit, Tuist2UI
Filtering cacheable targets
Generating workspace Tuist2.xcworkspace
Generating project Tuist2
Generating project Realm
Generating project RealmDatabase
Building cacheable targets
** BUILD FAILED **



The following build commands failed:
	CompileC /Users/user/Library/Developer/Xcode/DerivedData/Tuist2-ghwkelueyzdckhgvykcnxryadssl/Build/Intermediates.noindex/RealmDatabase.build/Debug-iphonesimulator/Storage.build/Objects-normal/x86_64/version.o /Users/josemiguel.benedicto/Downloads/tuist2/Tuist/Dependencies/SwiftPackageManager/.build/checkouts/realm-core/src/realm/version.cpp normal x86_64 c++ com.apple.compilers.llvm.clang.1_0.compiler (in target 'Storage' from project 'RealmDatabase')
(1 failure)
[Storage] Compiling version.cpp
❌ /Users/user/Downloads/tuist2/Tuist/Dependencies/SwiftPackageManager/.build/checkouts/realm-core/src/realm/version.cpp:35:5: non-void function 'get_extra' should return a value [-Wreturn-type]
    return REALM_VERSION_EXTRA;
    ^

If I generate the project, focus in the app target and build it without warming the cache I receive the same error:

❌ /Users/user/Documents/workspace/tuist2/Tuist/Dependencies/SwiftPackageManager/.build/checkouts/realm-core/src/realm/version.cpp:35:5: non-void function 'get_extra' should return a value [-Wreturn-type]
    return REALM_VERSION_EXTRA;
    ^

The following build commands failed:
	CompileC /Users/user/Library/Developer/Xcode/DerivedData/Tuist2-ghwkelueyzdckhgvykcnxryadssl/Build/Intermediates.noindex/RealmDatabase.build/Debug-iphonesimulator/Storage.build/Objects-normal/x86_64/version.o /Users/user/Downloads/tuist2/Tuist/Dependencies/SwiftPackageManager/.build/checkouts/realm-core/src/realm/version.cpp normal x86_64 c++ com.apple.compilers.llvm.clang.1_0.compiler (in target 'Storage' from project 'RealmDatabase')
(1 failure)

To Reproduce
Steps to reproduce the behavior:

I have a super small project that includes Realm dependency to reproduce the issue:
tuist2.zip

Then follow these commands to warm the cache:

1. tuist dependency fetch
2. tuist cache warm

It is also replicable when generating and focusing the project and then building in Xcode:

1. tuist dependency fetch
2. tuist generate
3. tuist focus Tuist2
4. Run the Tuist2 target

Expected behavior
The SPM package compiles

Screenshots
N/A

Desktop (please complete the following information):

• OS: macOS
• Version 12.1
• Xcode 13.2.1

Additional context
I suspect there are some issues relate wrong C++ dialect or some flags that aren't applied property or missing build settings when compiling.

[luispadron]

@danyf90 The Realm package has a lot CXX settings the Package.swift here. Would this be the cause of the build errors?

[danieleformichelli]

They should be handled by the mapping logic. Given the error is only on REALM_VERSION_EXTRA maybe it's empty and that case is not handled properly?

[luispadron]

@danyf90 Yah that looks like it may be the case there is the possibility it's empty as the package has some logic in there to determine if it's set or not

[danieleformichelli]

You can check the generated project and see if the variable is there

[InViZz]

any update?

[adellibovi]

hi @InViZz , we believe this got fixed in #3995 feel free to use the branch to try it out.

[adellibovi]

I am going to reopen, this, there is a HEADER_SEARCH_PATH which must inherit from Realm framework to compile correctly. There is a WIP at #4002. Currently Realm on its own will compile fine, but not when imported.

[alexanderwe]

We are currently also facing the issue with Realm. When we include an external SPM dependency that relies on Realm it fails to build. I already tried out the main branch of tuist and the issue still persists in the generated project.

[Drag0ndust]

is there any workaround which I can use until this problem is solved?

[adellibovi]

@Drag0ndust a part of the fix will be included in the next version (which probably will be released today in some hours), yet there will be the need of a second fix and it won't compile yet. But you may workaround this second issue by adding the correct HEADER_SEARCH_PATH