ffi plugin template ffigen command doesn't work on Windows

[dcharkes]

Seen behavior

lib\hello_bindings_generated.dart contains no bindings.

Expected behavior

lib\hello_bindings_generated.dart contains bindings for sum and sum_long_running.

Steps to reproduce

On Windows:

1. flutter create --template plugin_ffi hello
2. cd hello
3. flutter pub run ffigen --config ffigen.yaml

Root cause

Path separator on Windows not converted to backslash:

• Bindings are not generated for files declared under "include-directives:" dart-lang/native#239

Fix

Bump package:ffigen to a new version after landing:

• Fix include-directives on Windows dart-archive/ffigen#397

Testing

We should possibly also add a test exercising the run of the bindings generator on the bots, but this requires having libclang available.

On the package:ffigen bots we use GitHub workflows.

      - name: Install libclang-10-dev
        run: sudo apt-get install libclang-10-dev

https://github.com/dart-lang/ffigen/blob/master/.github/workflows/test-package.yml#L51-L52

@stuartmorgan Do we have libclang on the Flutter bots? Can we have this on the bots?

[stuartmorgan-g]

@stuartmorgan Do we have libclang on the Flutter bots? Can we have this on the bots?

I have no idea if it's currently there; adding it if not would involve an infra ticket to create a new dependency package, then adding it to the bot configs.

[danagbemava-nc]

Issue is reproducible on stable and master using the steps outlined in #105513 (comment)

hello_bindings_generated.dart

// ignore_for_file: always_specify_types
// ignore_for_file: camel_case_types
// ignore_for_file: non_constant_identifier_names

// AUTO GENERATED FILE, DO NOT EDIT.
//
// Generated by `package:ffigen`.

flutter doctor -v

[√] Flutter (Channel stable, 3.0.1, on Microsoft Windows [Version 10.0.19043.1706], locale en-GH)
    • Flutter version 3.0.1 at c:\src\sdks\stable\flutter
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision fb57da5f94 (3 weeks ago), 2022-05-19 15:50:29 -0700
    • Engine revision caaafc5604
    • Dart version 2.17.1
    • DevTools version 2.12.2

[√] Android toolchain - develop for Android devices (Android SDK version 32.1.0-rc1)
    • Android SDK at C:\Users\Deana\AppData\Local\Android\sdk
    • Platform android-32, build-tools 32.1.0-rc1
    • Java binary at: C:\Program Files\Android\Android Studio\jre\bin\java
    • Java version OpenJDK Runtime Environment (build 11.0.12+7-b1504.28-7817840)
    • All Android licenses accepted.

[√] Chrome - develop for the web
    • Chrome at C:\Program Files\Google\Chrome\Application\chrome.exe

[√] Visual Studio - develop for Windows (Visual Studio Community 2022 17.1.4)
    • Visual Studio at C:\Program Files\Microsoft Visual Studio\2022\Community
    • Visual Studio Community 2022 version 17.1.32407.343
    • Windows 10 SDK version 10.0.22000.0

[√] Android Studio (version 2021.2)
    • Android Studio at C:\Program Files\Android\Android Studio
    • Flutter plugin can be installed from:
       https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
       https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 11.0.12+7-b1504.28-7817840)

[√] VS Code (version 1.67.2)
    • VS Code at C:\Users\Deana\AppData\Local\Programs\Microsoft VS Code
    • Flutter extension version 3.42.0

[√] Connected device (4 available)
    • M2007J20CG (mobile) • 5dd3be00 • android-arm64  • Android 11 (API 30)
    • Windows (desktop)   • windows  • windows-x64    • Microsoft Windows [Version 10.0.19043.1706]
    • Chrome (web)        • chrome   • web-javascript • Google Chrome 102.0.5005.63
    • Edge (web)          • edge     • web-javascript • Microsoft Edge 102.0.1245.33

[√] HTTP Host Availability
    • All required HTTP hosts are available

• No issues found!

[√] Flutter (Channel master, 3.1.0-0.0.pre.1142, on Microsoft Windows [Version 10.0.19043.1706], locale en-GH)
    • Flutter version 3.1.0-0.0.pre.1142 at c:\src\sdks\master\flutter
    • Upstream repository https://github.com/flutter/flutter.git
    • Framework revision be0c1bd0f0 (5 hours ago), 2022-06-07 05:18:06 -0400
    • Engine revision 0968438071
    • Dart version 2.18.0 (build 2.18.0-170.0.dev)
    • DevTools version 2.14.0

[√] Android toolchain - develop for Android devices (Android SDK version 32.1.0-rc1)
    • Android SDK at C:\Users\Deana\AppData\Local\Android\sdk
    • Platform android-32, build-tools 32.1.0-rc1
    • Java binary at: C:\Program Files\Android\Android Studio\jre\bin\java
    • Java version OpenJDK Runtime Environment (build 11.0.12+7-b1504.28-7817840)
    • All Android licenses accepted.

[√] Chrome - develop for the web
    • Chrome at C:\Program Files\Google\Chrome\Application\chrome.exe

[√] Visual Studio - develop for Windows (Visual Studio Community 2022 17.1.4)
    • Visual Studio at C:\Program Files\Microsoft Visual Studio\2022\Community
    • Visual Studio Community 2022 version 17.1.32407.343
    • Windows 10 SDK version 10.0.22000.0

[√] Android Studio (version 2021.2)
    • Android Studio at C:\Program Files\Android\Android Studio
    • Flutter plugin can be installed from:
       https://plugins.jetbrains.com/plugin/9212-flutter
    • Dart plugin can be installed from:
       https://plugins.jetbrains.com/plugin/6351-dart
    • Java version OpenJDK Runtime Environment (build 11.0.12+7-b1504.28-7817840)

[√] VS Code (version 1.67.2)
    • VS Code at C:\Users\Deana\AppData\Local\Programs\Microsoft VS Code
    • Flutter extension version 3.42.0

[√] Connected device (4 available)
    • M2007J20CG (mobile) • 5dd3be00 • android-arm64  • Android 11 (API 30)
    • Windows (desktop)   • windows  • windows-x64    • Microsoft Windows [Version 10.0.19043.1706]
    • Chrome (web)        • chrome   • web-javascript • Google Chrome 102.0.5005.63
    • Edge (web)          • edge     • web-javascript • Microsoft Edge 102.0.1245.33

[√] HTTP Host Availability
    • All required HTTP hosts are available

• No issues found!

[christopherfujino]

cc @zanderso

[zanderso]

@dcharkes Could you also test this using your existing GitHub workflow (where you know you have libclang) by also doing a checkout of Flutter there?

[dcharkes]

@dcharkes Could you also test this using your existing GitHub workflow (where you know you have libclang) by also doing a checkout of Flutter there?

We don't currently cover Windows there, so we wouldn't have caught this issue. I've filed an issue to address that.

• Run Windows CI dart-lang/native#240

Running it there would mean we run something on the CI there that is not the main branch of the package. (We could force the main branch, but then we would start to get rolling issues if the generated code changes slightly.) And if we break something here in flutter_tools, the build of package:ffigen would be broken. Both are undeseriable, so running it on the Flutter bots would be better.

Or did you mean adding such a GitHub workflow to the Flutter repository? edit: I just realized that even using a flutter-latest on a GitHub workflow would use the last published build, not the PR being submitted. So, we would get the failure on a later commit/PR, which is undeseriable.