Instabug crashes the debugger

[arturgrigor]

Integrating the Instabug framework will crash the debugger so whenever you want to just print the description of a variable the debugger will respond with "Couldn't IRGen expression, no additional error".

I filled a bug report on Swift's JIRA (https://bugs.swift.org/browse/SR-12783) to ask for a better error reporting when this problem happens but meanwhile there's a reply from one of the developers which explains what the problem is and how to fix it.

Here's the reply:

LLDB could clearly do a better job of surfacing the error — I had to dig it out of the types log:
SwiftASTContext("Instabug")::GetASTContext() – failed to initialize ClangImporter: error: virtual filesystem overlay file '/Users/khaledElMorabea/Library/Developer/Xcode/DerivedData/Instabug-ccnahiryvffhsohhjpovgyeazflu/Build/Intermediates.noindex/ArchiveIntermediates/Instabug/IntermediateBuildFilesPath/Instabug.build/Release-iphonesimulator/Instabug.build/all-product-headers.yaml' not found
The problem here is with the binary Instabug framework that you are using. The .dSYM files that are generated from Swift code are not (yet) as portable as the ones generated from Clang code. The binary Swift module encode a hardcoded path to a yaml file that only exists on the original developer's machine. You should let them know that they need to compile their binary framework with -no-serialize-debugging-options if they are planning to distribute them to another machine.

There is also a sample project attached to that ticket in which you can reproduce the problem.

[Kmohamed]

Thanks a lot, for reporting this. Let me check it and get back to you.

[Kmohamed]

@arturgrigor I am sorry but I am not aware of this flag -no-serialize-debugging-options. do you have any documentation for this flag?

[arturgrigor]

@Kmohamed I don't but maybe you can get in touch with the Swift developer in the comments section from this ticket https://bugs.swift.org/browse/SR-12783

[Kmohamed]

Thanks 🙏.
I will try it and check if it works fine or not

[Kmohamed]

@arturgrigor I tried the solution on the sample project and works fine for me.
Could you check this custom build and confirm that it works fine?

[arturgrigor]

I tried it with the demo project attached to this ticket (https://bugs.swift.org/browse/SR-12783) and with the app that I'm working on and it still doesn't work.

[Kmohamed]

This is weird. What’s your Xcode version?

[Kmohamed]

Also, did you clear the build folder and clear the derived data

[arturgrigor]

I'm using the latest version, Xcode 11.4.1 (11E503a) and cleaned the project and also deleted the Derived Data. Have you tried it with the demo project from that ticket?

[Kmohamed]

Yes.

[arturgrigor]

Can you double check that you sent me the right framework, the one that you used in that demo project?

[arturgrigor]

Or maybe can you send me a ZIP with the working demo project and I’ll copy the framework from there into the project that I’m working on?

[Kmohamed]

Sure, you can download it from here.

[arturgrigor]

It's working! Both the demo project and the app that I'm working on with the framework from the demo project included now works.

Thank you!

[Kmohamed]

So I sent the wrong framework. Sorry 😐.