[ci] Run Swift formatter and linter during CI formatting #5928

jmagman · 2024-01-18T19:10:03Z

Make swift-format CIPD package available on the PATH https://flutter-review.googlesource.com/c/recipes/+/54020

Run format --no-clang-format --no-java --no-kotlin --no-dart on the macOS builder so it doesn't duplicate same format call run on Linux.

Filter out generated files until flutter/flutter#141799 is done.

Also add swift-format lint call during format command. Fix the one casing issue it found in a test file.

Failing run:
https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8758535881172004177/+/u/Run_package_tests/Swift_format/stdout

Successful run:
https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8758492350529121249/+/u/Run_package_tests/Swift_format/stdout

Fixes flutter/flutter#41129

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

jmagman · 2024-01-18T19:58:03Z

.ci.yaml

+      target_file: macos_repo_checks.yaml
+      dependencies: >
+        [
+          {"dependency": "swift_format", "version": "build_id:8797338979890974865"}


The version tag is version:[email protected] which fails because the @ isn't valid in the regex ^[a-z0-9_]+$

ERROR: projects/flutter: cr-buildbucket.cfg: in "cr-buildbucket.cfg" (buckets #4 - try / swarming / builders #454 - Mac_x64 check_podspecs / caches #4): name: "packages_main_swift_format_version_2@505_chromium_2" does not match "^[a-z0-9_]+$"

https://logs.chromium.org/logs/flutter/buildbucket/cr-buildbucket/8758535881024973153/+/u/luci_validate/stdout

I don't think it's important which tag we use, build_id seems fine too.

Run `swift-format` linter/formatter on Swift files in example apps. This doesn't touch any Swift files in non-example code. Part of turning on swift-format CI formatting #5928

Run `swift-format` linter/formatter on Swift files. Part of turning on swift-format CI formatting #5928

jmagman · 2024-01-19T05:15:33Z

packages/file_selector/file_selector_macos/example/macos/RunnerTests/RunnerTests.swift

@@ -40,7 +40,7 @@ class TestViewProvider: NSObject, ViewProvider {
  var window: NSWindow? = NSWindow()
 }

-class exampleTests: XCTestCase {
+class ExampleTests: XCTestCase {


linter (not format) error:

RunnerTests.swift:43:7: warning: [TypeNamesShouldBeCapitalized] rename the class 'exampleTests' using UpperCamelCase; for example, 'ExampleTests'

No CHANGELOG or version bump needed based on #5933 (comment)

Run `swift-format` linter/formatter on Swift files. Part of turning on swift-format CI formatting #5928

Run `swift-format` linter/formatter on Swift files in example apps. This only touches Swift files in example/test code. This also doesn't format any autogenerated Swift files, which would require changed in the pigeon generator: flutter/flutter#141799 Part of turning on swift-format CI formatting #5928

stuartmorgan-g · 2024-01-19T10:55:11Z

.ci/targets/macos_repo_checks.yaml

@@ -5,6 +5,10 @@ tasks:
  - name: update pods repo
    script: .ci/scripts/update_pods.sh
    infra_step: true # Note infra steps failing prevents "always" from running.
+  - name: Swift format
+    script: script/tool_runner.sh
+    args: ["format", "--fail-on-change", "--swift", "--no-dart", "--no-clang-format", "--no-kotlin", "--no-java" ]


Now that we're turning it on in CI, let's make --swift default to true like all the other ones, and then pass --no-swift on Linux.

.ci.yaml

stuartmorgan-g · 2024-01-19T11:06:58Z

script/tool/lib/src/format_command.dart

@@ -342,6 +359,13 @@ class FormatCommand extends PackageCommand {
        (String filePath) => extensions.contains(path.extension(filePath)));
  }

+  Iterable<String> _filterGeneratedFiles(Iterable<String> files) {


Rather than filtering out generated files, we just need Pigeon to do Swift formatting in CI; this code should include Swift formatting. If we changed the default then it'll just work, otherwise we need to add --swift there.

Oh, but that's not going to work on the Linux machine where we run this.

Hm, do we have a clang-format CIPD package for macOS already? If so, we could change this to macOS instead of Linux, and adjust the dependencies in ci.yaml. If not I'll need to think more about how we can handles this sanely, and we can land with the exclusion in the meantime.

Maybe it's easier to change the Pigeon validator to check specific languages for changes instead of checking everything for changes, and then run it for different languages on different CI hosts the way we do the format check itself. I'll play with that today.

Maybe it's easier to change the Pigeon validator to check specific languages for changes instead of checking everything for changes, and then run it for different languages on different CI hosts the way we do the format check itself.

I think #5944 should make this work.

I changed my comment about removing it into a TODO. How about I land this, then you rebase #5944 onto ToT and remove the _filterGeneratedFiles in that PR?

Rather than filtering out generated files, we just need Pigeon to do Swift formatting in CI; this code should include Swift formatting.

Oops, now that swift is enabled by default, that same code will need (until my PR lands) --no-swift.

.ci.yaml

jmagman · 2024-01-19T18:52:54Z

.ci.yaml

@@ -1143,6 +1147,10 @@ targets:
        {
          "CHANNEL": "master"
        }
+      dependencies: >
+        [
+          {"dependency": "swift_format", "version": "build_id:8797338979890974865"}


The arm64 and x64 build_id numbers are different, but it's pointing to the same version.

arm: https://chrome-infra-packages.appspot.com/p/infra/3pp/tools/swift-format/mac-arm64/+/RLmOtWwcNQeEUBqiZdpqEtJVh-cdm95Bbcz0W-wC124C
x64: https://chrome-infra-packages.appspot.com/p/infra/3pp/tools/swift-format/mac-amd64/+/xG4XM0suWSr-M7wBW_zojQ83hgZRnRVO2qVYy46d2PgC

#5928 (comment)

jmagman · 2024-01-19T18:53:01Z

.ci/targets/macos_repo_checks.yaml

@@ -5,6 +5,10 @@ tasks:
  - name: update pods repo
    script: .ci/scripts/update_pods.sh
    infra_step: true # Note infra steps failing prevents "always" from running.
+  - name: Swift format
+    script: script/tool_runner.sh
+    args: ["format", "--fail-on-change", "--swift", "--no-dart", "--no-clang-format", "--no-kotlin", "--no-java" ]


jmagman · 2024-01-19T18:54:59Z

script/tool/lib/src/format_command.dart

@@ -342,6 +359,13 @@ class FormatCommand extends PackageCommand {
        (String filePath) => extensions.contains(path.extension(filePath)));
  }

+  Iterable<String> _filterGeneratedFiles(Iterable<String> files) {


I changed my comment about removing it into a TODO. How about I land this, then you rebase #5944 onto ToT and remove the _filterGeneratedFiles in that PR?

stuartmorgan-g

LGTM with nit

.ci/targets/macos_repo_checks.yaml

stuartmorgan-g · 2024-01-19T19:07:12Z

script/tool/lib/src/format_command.dart

@@ -342,6 +359,13 @@ class FormatCommand extends PackageCommand {
        (String filePath) => extensions.contains(path.extension(filePath)));
  }

+  Iterable<String> _filterGeneratedFiles(Iterable<String> files) {


auto-submit · 2024-01-19T20:07:50Z

auto label is removed for flutter/packages/5928, due to - The status or check suite Linux_android custom_package_tests master has failed. Please fix the issues identified (or deflake) before re-applying this label.

Reworks Pigeon's CI validation of generated files to support multiple hosts, rather than only Linux, with the ability to set specific languages per host, to allow us to run validation for each language on whatever host it is most convenient to set up a formatter for that language, rather than having to support all languages on Linux. See discussion in #5928 Part of flutter/flutter#41129

…tter/packages#5928)

flutter/packages@129e08c...e4cbf23 2024-01-21 [email protected] Roll Flutter from ddf60fb to 5dea6b9 (5 revisions) (flutter/packages#5951) 2024-01-21 [email protected] Update platform label rules for shared iOS/macOS (flutter/packages#5801) 2024-01-20 [email protected] [pigeon] Support other hosts in generated file CI checks (flutter/packages#5944) 2024-01-20 [email protected] [pigeon] Improve style of generated Swift code (flutter/packages#5938) 2024-01-20 [email protected] Roll Flutter from 684247a to ddf60fb (12 revisions) (flutter/packages#5949) 2024-01-20 [email protected] [camera]fix a sample buffer memory leak on pause resume recording (flutter/packages#5927) 2024-01-19 [email protected] [ci] Run Swift formatter and linter during CI formatting (flutter/packages#5928) 2024-01-19 [email protected] Manual roll Flutter from f77f824 to 684247a (39 revisions) (flutter/packages#5948) 2024-01-19 [email protected] Expose registered widget libraries and local widget library widgets. (flutter/packages#5936) 2024-01-19 49699333+dependabot[bot]@users.noreply.github.com Bump actions/upload-artifact from 4.1.0 to 4.2.0 (flutter/packages#5937) 2024-01-19 [email protected] Manual roll Flutter (stable) from ef1af02 to 67457e6 (1 revision) (flutter/packages#5932) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

jmagman self-assigned this Jan 18, 2024

jmagman commented Jan 18, 2024

View reviewed changes

This was referenced Jan 18, 2024

[various] Run swift-format on ungenerated Swift files #5929

Closed

[various] Run swift-format on example app Swift files #5931

Merged

jmagman force-pushed the repo-checks branch from 9bdf4dc to 06ae644 Compare January 19, 2024 01:54

This was referenced Jan 19, 2024

[shared_preferences_foundation] Run swift-format on Swift files #5933

Merged

[pigeon] Run swift-format on ungenerated example app Swift files #5934

Merged

[path_provider_foundation] Run swift-format on Swift files #5935

Merged

auto-submit bot pushed a commit that referenced this pull request Jan 19, 2024

[shared_preferences_foundation] Run swift-format on Swift files (#5933)

76a6fd2

Run `swift-format` linter/formatter on Swift files. Part of turning on swift-format CI formatting #5928

jmagman force-pushed the repo-checks branch from 06ae644 to 9a0de0e Compare January 19, 2024 04:59

jmagman added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Jan 19, 2024

github-actions bot added p: file_selector platform-macos labels Jan 19, 2024

jmagman commented Jan 19, 2024

View reviewed changes

jmagman changed the title ~~[ci] Run Swift formatter during CI formatting~~ [ci] Run Swift formatter and linter during CI formatting Jan 19, 2024

auto-submit bot pushed a commit that referenced this pull request Jan 19, 2024

[path_provider_foundation] Run swift-format on Swift files (#5935)

9379e4a

Run `swift-format` linter/formatter on Swift files. Part of turning on swift-format CI formatting #5928

[ci] Run Swift formatter during CI formatting

6316bd9

jmagman force-pushed the repo-checks branch from 95375f1 to 6316bd9 Compare January 19, 2024 07:03

jmagman requested a review from stuartmorgan-g January 19, 2024 07:13

jmagman marked this pull request as ready for review January 19, 2024 07:13

jmagman requested a review from cbracken as a code owner January 19, 2024 07:13

stuartmorgan-g requested changes Jan 19, 2024

View reviewed changes

stuartmorgan-g mentioned this pull request Jan 19, 2024

[pigeon] Support other hosts in generated file CI checks #5944

Merged

11 tasks

jmagman added 2 commits January 19, 2024 10:51

Review edits

8a4da67

Remove --swift

918285e

jmagman commented Jan 19, 2024

View reviewed changes

stuartmorgan-g approved these changes Jan 19, 2024

View reviewed changes

Review edits

cd50880

jmagman added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

Skip swift during pigeon generation

a5a6250

jmagman requested a review from tarrinneal as a code owner January 19, 2024 21:08

github-actions bot added the p: pigeon label Jan 19, 2024

jmagman added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 19, 2024

auto-submit bot merged commit 44ee590 into flutter:main Jan 19, 2024

jmagman deleted the repo-checks branch January 19, 2024 22:38

engine-flutter-autoroll mentioned this pull request Jan 22, 2024

Roll Packages from 129e08c1dff1 to e4cbf235ec4d (11 revisions) flutter/flutter#141962

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 22, 2024

44ee590 [ci] Run Swift formatter and linter during CI formatting (flu…

2e67f7f

…tter/packages#5928)

reidbaker mentioned this pull request Feb 19, 2024

[in_app_purchase_android] Add UserChoiceBilling mode. #6162

Merged

16 tasks

jmagman mentioned this pull request Mar 13, 2024

Build Swift files in the engine to support Swift-only APIs on iOS and macOS flutter/flutter#144791

Closed

[ci] Run Swift formatter and linter during CI formatting #5928

[ci] Run Swift formatter and linter during CI formatting #5928

Uh oh!

Conversation

jmagman commented Jan 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman Jan 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jmagman Jan 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Jan 19, 2024

Uh oh!

Uh oh!

jmagman commented Jan 18, 2024 •

edited

Loading

jmagman Jan 19, 2024 •

edited

Loading

jmagman Jan 19, 2024 •

edited

Loading