GoogleMaps SPM integration: Error: module 'GoogleMaps' not found

[FrankWuoO]

Environment details

1. GitHub Action
2. Xcode 14.2
3. iOS-maps-sdk 8.4.0 via SPM

4. fastlane gym 2.219.0
5. build simulator iPhoneOS16.2.sdk

Steps to reproduce

1. Execute Fastlane on GitHub Action

    build_app(
      scheme: "APP_Scheme",
      configuration: "APP_Configuration",
      clean: true,
      skip_archive: true,
      skip_package_ipa: true
    )

2. It will show ** BUILD FAILED **

Screenshot

[wangela]

If you would like to upvote the priority of this issue, please comment below or react on the original post above with 👍 so we can see what is popular when we triage.

@FrankWuoO Thank you for opening this issue. 🙏
Please check out these other resources that might help you get to a resolution in the meantime:

• Check the issue tracker - bugs and feature requests for Google Maps Platform APIs and SDKs
• Open a support case - Get 1:1 support in Cloud Console.
• Discord - chat with other developers
• StackOverflow - use the google-maps tag

This is an automated message, feel free to ignore.

[dogahe]

Can you please clean build folder, clean, and build from Xcode first and let us know if you can successfully build and run your app on Xcode first?

[FrankWuoO]

Sure, it was successful building on Xcode 15.1 locally.
Now, I'd like to attempt building on the same Xcode version (14.1) as GitHub Actions, but I can't due to MacOS Sonoma not allowing its installation. 😢

[dogahe]

I just verified with both Xcode 14.0.1 and 14.2 that the Swift package for GoogleMaps works properly. Please make sure you follow the steps from https://developers.google.com/maps/documentation/ios-sdk/config#swift-package-manager and let me know what's the error that you are encountering?

[jeffbadorek]

We use xcode 15 locally, but Xcode 14.2 on CI (azure)....on the server, it is now failing consistently. It used to work every once in a while (failing more times than not) but now, since I changed the SPM cache key, which is forcing a rebuild of all SPM packages, it fails every time. I feel like the builds that were succeeding may have been picking up the binary from cocoapods cache. Just a theory.

I even tried pinning to 8.3.1...same error

[GoogleMapsCoreTarget] Compiling GMSEmpty.m
❌ /Users/runner/work/1/s/ios/SPM/checkouts/ios-maps-sdk/Core/GMSEmpty.m:17:9: module 'GoogleMaps' not found
@import GoogleMaps;
 ~~~~~~~^~~~~~~~~~

We can't quite switch to xcode 15 on CI because of ongoing performance issues with xcode and running tests.

I feel like "@import GoogleMaps" in the dummy files is causing this issue. And I'm not entirely convinced it's needed.

[icecoffin]

We experience the same issue. Ended up making a fork and replacing GMSEmpty.m with GMSEmpty.swift and removing the GoogleMaps import (so the files are completely empty).

[vashworth]

Flutter is experiencing the same issue: flutter/packages#6639 (comment)

So I believe this is a race condition, which is why it doesn't always occur. This applies to GoogleMapsCoreTarget, GoogleMapsBaseTarget, and GoogleMapsM4BTarget, but let's look at GoogleMapsCoreTarget as an example.

If you look at GoogleMapsCoreTarget, it uses the GoogleMaps module:

ios-maps-sdk/Core/GMSEmpty.m

Line 17 in bd392d7

@import GoogleMaps;

However, it does not have a dependency on the GoogleMaps or GoogleMapsTarget target:

ios-maps-sdk/Package.swift

Lines 64 to 70 in bd392d7

	.target(
	name: "GoogleMapsCoreTarget",
	dependencies: ["GoogleMapsCore"],
	path: "Core",
	sources: ["GMSEmpty.m"],
	publicHeadersPath: "Sources"
	),

Therefore, Swift Package Manager/Xcode may possibly compile sources from GoogleMapsCoreTarget before the GoogleMaps.xcframework is done processing, which can cause the module 'GoogleMaps' not found error

FYI: You can view the build timeline like above screenshot in Xcode via Editor > Assistant

I believe solution would be to add either GoogleMapsCoreTarget or GoogleMaps as dependency of GoogleMapsCoreTarget, GoogleMapsBaseTarget, and GoogleMapsM4BTarget.

[wangela]

@vashworth @FrankWuoO Is this still occurring for you with Maps SDK for iOS v9.x? When upgrading versions, note the special instructions about removing the GoogleMapsBase, GoogleMapsCore, and GoogleMapsM4B frameworks.

[icecoffin]

@wangela I haven't tested it yet (because it would take a lot of time to test all of this and then revert it back), but I'm not sure how using v9.x would've solved it?

GoogleMapsTarget has a dependency on GoogleMaps (binary target), GoogleMapsBaseTarget (regular target), and GoogleMapsCoreTarget (regular target).
Both GoogleMapsBaseTarget and GoogleMapsCoreTarget contain GMSEmpty.h with the @import GoogleMaps statement. However, neither GoogleMapsBaseTarget nor GoogleMapsCoreTarget has a dependency on GoogleMaps or GoogleMapsTarget, so how can they import it? It's still the same issue described in the comment above: #10 (comment).

[FrankWuoO]

@wangela Sorry for the late reply. I switched to the native MapKit, so I haven’t tested it since then.