Interface Builder designable fails to compile using CocoaPods

[captainbarbosa]

Platform: iOS
Mapbox SDK version: 3.6.4

Steps to trigger behavior

1. Create a new Xcode project
2. Include the Mapbox iOS SDK via CocoaPods
3. Attempt to build application and view the resulting storyboard error:

Failed to render and update auto layout status for ViewController (BYZ-38-t0r):
The agent crashed Main.storyboard

Expected behavior

The application should compile without the IB Designables error.

Actual behavior

An IB Designables error is returned.

cc @1ec5 @friedbunny

[friedbunny]

Though annoying and disconcerting, this error is cosmetic — the designable failing to load does not affect the storyboard or the app’s eventual layout.

I think we should consider removing our designable:

• It delays Interface Builder loading any storyboard that includes our map view, because it must reach into our SDK to render/present the designable.
• It often fails to render at all.
• It just doesn’t do very much — our designable tells the user that they must sign up for a token, but doesn’t recognize when a token is set or allow the user to click on the faux-link we show.
• Does it update the position of its subviews? 🤔

[friedbunny]

Does it update the position of its subviews?

Yeah, kinda:

[frederoni]

This is a known issue in Xcode 9 (and 8?). The designable resources are stripped out of compiled frameworks. A workaround in the meantime would be to subclass MGLMapView and use that to render the designable.

[DiegoGomezDeck]

The workaround proposed by @frederoni worked for me.

[dandreiolteanu]

@frederoni that worked for me also. Thank you very much!

[friedbunny]

As reports continue to come in from users hitting this issue, I’d again put forward that we should partially revert #1184.

[DigitalLeaves]

I wouldn't like to create a subclass of MGLMapView in my project as a "workaround". I prefer a workaround to not alter the project's structure. I'll wait until there's some kind of solution to this. Is this then a Xcode issue, not Mapbox? Is there a radar filled in?

[wangela]

All that's needed is for Mapbox to add an override for init(coder aDecoder: NSCoder) to the MGLMapView class.

override init(coder aDecoder: NSCoder) {
    super.init(coder: aDecoder)
}

This is the cause for the IBDesignables agent crashing, because it overrides init(frame) without also overriding init(coder).
Source: https://stackoverflow.com/questions/31265906/ibdesignable-crashing-agent

The workaround until then is to add the MGLMapView to your ViewController programmatically instead of in Storyboard.

Once I remove the MGLMapView from my storyboard and add it programmatically, the error goes away.

[1ec5]

All that's needed is for Mapbox to add an override for init(coder aDecoder: NSCoder) to the MGLMapView class.

The iOS and macOS implementations of MGLMapView already override -[MGLMapView initWithCoder:]:

mapbox-gl-native/platform/ios/src/MGLMapView.mm

Lines 307 to 315 in 43c6f6b

	- (instancetype)initWithCoder:(nonnull NSCoder *)decoder
	{
	if (self = [super initWithCoder:decoder])
	{
	[self commonInit];
	self.styleURL = nil;
	}
	return self;
	}

mapbox-gl-native/platform/macos/src/MGLMapView.mm

Lines 234 to 239 in 43c6f6b

	- (instancetype)initWithCoder:(nonnull NSCoder *)decoder {
	if (self = [super initWithCoder:decoder]) {
	[self commonInit];
	}
	return self;
	}

[friedbunny]

This issue still exists with Xcode 9.2b2 and v3.7.0.

file:///mapbox-gl-native/platform/ios/app/Main.storyboard: error: IB Designables: Failed to render and update auto layout status for MBXEmbeddedMapViewController (Tsi-Cv-L66): dlopen(test.xctest, 1): Library not loaded: @rpath/XCTest.framework/XCTest
Referenced from: test.xctest
Reason: image not found