google / GoogleSignIn-iOS

Enables iOS and macOS apps to sign in with Google.
https://developers.google.com/identity/sign-in/ios
Apache License 2.0
455 stars 181 forks source link

Undefined symbols when used as dependency of multiple targets (Swift Packages in Xcode) #408

Open cjwirth opened 2 months ago

cjwirth commented 2 months ago

Describe the bug When building the app, I get undefined symbol errors, saying that it can't find symbols that exist in AppAuthCore:

ld: Undefined symbols:
  _OBJC_CLASS_$_OIDAuthState, referenced from:
       in GoogleSignIn.o
  _OBJC_CLASS_$_OIDAuthorizationRequest, referenced from:
       in GoogleSignIn.o
  _OBJC_CLASS_$_OIDAuthorizationService, referenced from:
       in GoogleSignIn.o
  _OBJC_CLASS_$_OIDIDToken, referenced from:
       in GoogleSignIn.o
  _OBJC_CLASS_$_OIDServiceConfiguration, referenced from:
       in GoogleSignIn.o
  _OBJC_CLASS_$_OIDURLQueryComponent, referenced from:
       in GoogleSignIn.o
  _OIDOAuthErrorResponseErrorKey, referenced from:
      +[GIDEMMSupport handleTokenFetchEMMError:completion:] in GoogleSignIn.o
  _OIDOAuthTokenErrorDomain, referenced from:
      ___53-[GIDGoogleUser refreshTokensIfNeededWithCompletion:]_block_invoke.22 in GoogleSignIn.o
  _OIDResponseTypeCode, referenced from:
      -[GIDSignIn authenticateInteractivelyWithOptions:] in GoogleSignIn.o
clang: error: linker command failed with exit code 1 (use -v to see invocation)

This only happens if GoogleSignIn is added as a dependency of multiple targets that end up in the resulting app. If GoogleSignIn is only included into one target, it seems to be OK. But when it's included in multiple targets, I get the error above.

I have created a reproducible sample using the ObjC sample app provided by this repo.

To Reproduce Steps to reproduce the behavior:

  1. Open the sample app in Xcode
  2. Create another Framework target that the main app depends on
  3. Make the new Framework target depend on GoogleSignIn
  4. Build the app -- see the errors

Or checkout the reproducible sample that I put together and try building it.

The app is basically structured like this in terms of project and dependencies:

.
└── AppTarget
    ├── GoogleSignIn
    ├── OnboardingFramework
    │   └── GoogleSignIn
    └── LoginFramework
        └── GoogleSignIn

Expected behavior The app should build.

Screenshots [available on request, but really nothing worth sharing, I don't think?]

Environment

okuchmii commented 1 month ago

@cjwirth do you have any solution for this scenario as a workaround?

cjwirth commented 1 month ago

Unfortunately the only thing that has worked for me is to keep it in CocoaPods and not use the Package.

The only things I have issues with and need to use CocoaPods for are related to Google lol. Everything else has been fine.

cjwirth commented 1 week ago

Another workaround that I've had to do (for a different library, but another one made by Google, lol) is to abstract it out so that only the top-level app target is the one that links the library.

So let's say you have OnboardingFramework and LoginFramework, and they both depend on GoogleSignIn. Instead, rework OnboardingFramework and LoginFramework so that they don't link and import GoogleSignIn. You'll give them their own protocols for the methods that you need to call from GoogleSignIn. Then in your top-level app target, you'll create implementations of the protocols you made, passing them into the frameworks when you need it.

Yes it's boilerplate, but it works.