3rd party lib code asset is bundled by Flutter build Hook with dot characters removed from file path

[tjoengCRC]

I am integrating bare libs from 3rd party Holepunch into my Flutter app.
Those bare libs have file paths including dot characters. In my build script I add those libs as code assets.
For instance, on macOS and iOS:

CodeAsset(
        package: input.packageName, 
        name: 'bare-dns.2.1.4', 
        linkMode: DynamicLoadingBundled(),
        file: input.packageRoot.resolve('src/bare/libs/darwin/arm64/bare-dns.2.1.4.framework/Versions/A/bare-dns.2.1.4'),
      )  

At runtime the app aborts, because the 3rd party logic cannot dlopen 'bare-dns.2.1.4.framework/bare-dns.2.1.4'.
In the app's Content I find that the lib is bundled as:

Frameworks/bare-dns214.framework/bare-dns214

In other words Hook bundling has removed the dot characters from the original lib file name.

Why is this and how can I configure the build process such that original filename is preserved during bundling?

P.s. I can fix the problem by manually adding the dot characters to the app's Frameworks bundle.

[dcharkes]

(This issue belongs on the Flutter repo, because it's specific to Flutters' handling of code assets. But I cannot transfer it I think. FYI @vashworth @jmagman)

This is working as intended:

https://github.com/flutter/flutter/blob/3ba0d6d76345c69383925a0934ec58f010b11adf/packages/flutter_tools/lib/src/isolated/native_assets/macos/native_assets_host.dart#L238-L255

Dot's are not valid names for xcodeframeworks. The packaging for iOS requires massaging all native code into a format accepted by the iOS and MacOS store. This includes rewrites of all dylib names and all dynamic libraries depending on other dynamic libraries.

If your third party library is also bundled as a s code asset it should have its dlopen call rewritten to to the new name.

What is your use case exactly?

[tjoengCRC]

I have integrated my Flutter app with Holepunch's open source bare-kit JavaScript runtime engine to execute Holepunch C libs that are wrapped in JavaScript node modules.
For my app prototype I have written a JavaScript that requires the Holepunch Node module 'bare-tcp'. My flutter app executes that script using the bare-kit runtime.
bare-tcp's core is C code that depends on other (Holepunch) C libs, e.g. C lib 'bare-dns'.
On JavaScript execution bare-kit will automatically load the C libs as required via dlopen.

The issue: Holepunch's C lib naming convention is: .

E.g. on Android, we have 'libbare-dns.2.1.4.so'
On macOS, it is named 'Frameworks/bare-dns.2.1.4.framework/bare-dns2.1.4'

My Hook build.dart script adds the required C libs as code assets.

On Android, the app works fine as Hook build bundles the C lib code assets using their original names.
However, on iOS and macOS the app fails, since the build removes the period chars from the C lib file paths; JavaScript execution fails, since the bare-kit engine tries to load the C libs under their original names and cannot find them (actually it SIG ABORTS).

So I am actually sandwiched between Flutter build and Holepunch: which open source should provide a fix ;-)?

My work-around for now is to manually change the Flutter-built app package such that the C libs are bundled as the bare-kit runtime expects it.

[tjoengCRC]

Flutter's intention seems more strict than Apple's framework rules:

1. Apple's rules (https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier) explicitly states that period chars are allowed.
2. Holepunch's app 'Keet' integrates the same C libs and is published successfully on the Apple platforms.

[dcharkes]

Flutter's intention seems more strict than Apple's framework rules:

1. Apple's rules (https://developer.apple.com/documentation/bundleresources/information-property-list/cfbundleidentifier) explicitly states that period chars are allowed.

👍 Great, that means we can just loosen it!

Would you like to prepare a PR on your side? You can cc me for review. (If you look at the PR that added that filtering, you can also see where tests can be added.)

[tjoengCRC]

Would you like to prepare a PR on your side? You can cc me for review. (If you look at the PR that added that filtering, you can also see where tests can be added.)

Thanks Daco for your help. I just learnt what 'PR' means 😅, so it may take me a little longer to 'prepare' 👍.

[tjoengCRC]

Hi Daco,

I have created PR #184335 for this issue.
I hope it is in order.