fileinfo: fix not detecting 'unix' files to be OS specific #1554

sluongng · 2023-05-31T11:22:24Z

The build file generation logic works like this today:

GenerateRules()
  package.go->*goTarget.addFiles
  package.go->getPlatformStringsAddFunction()
  fileinfo.go->isOSArchSpecific()

Depending on whether the file has special Go build directives, Gazelle
would use a different logic to include/exclude the file into the 'srcs'
attribute of the Go targets.

In #1512, we added support for 'unix' build directive but did not tell
Gazelle to treat files with 'unix' file as OS specific file. This caused
Gazelle to mismatch the OS in a later stage and exclude the needed file
instead.

Fix that logic and provide some additional tests to reinforce the
fileinfo logic.

Also added a small knob to print stdout of Gazelle when it's run under
go_repository with debug_mode attribute set to True. Most Gazelle's
logs are printed to stdout and not stderr.

What type of PR is this?

Bug fix

What package or component does this PR mostly affect?

language/go

go_repository

What does this PR do? Why is it needed?

Which issues(s) does this PR fix?

Replaces #1551

Fix #1512

Other notes for review

The build file generation logic works like this today: ``` GenerateRules() package.go->*goTarget.addFiles package.go->getPlatformStringsAddFunction() fileinfo.go->isOSArchSpecific() ``` Depending on whether the file has special Go build directives, Gazelle would use a different logic to include/exclude the file into the 'srcs' attribute of the Go targets. In bazelbuild#1512, we added support for 'unix' build directive but did not tell Gazelle to treat files with 'unix' file as OS specific file. This caused Gazelle to mismatch the OS in a later stage and exclude the needed file instead. Fix that logic and provide some additional tests to reinforce the fileinfo logic. Also added a small knob to print stdout of Gazelle when it's run under go_repository with `debug_mode` attribute set to True. Most Gazelle's logs are printed to stdout and not stderr.

sluongng · 2023-05-31T13:59:39Z

cc @connyay @fmeum

fmeum

Great, thanks for the detective work!

connyay · 2023-05-31T15:10:36Z

👍 This patch is working for my usage - sorry for the fire drill!

sluongng · 2023-06-02T16:16:48Z

@fmeum could we do a v0.31.1 release with this PR to provide folks with a saner default?

The error is pretty hard to track down for newer folks.

fmeum · 2023-06-02T17:31:18Z

CC @linzhp

sluongng · 2023-06-09T07:03:51Z

another ping to request for a minor release

linzhp · 2023-06-09T15:11:50Z

No objection for minor release, but this weekend is fully booked for me. Can @fmeum or @achew22 do it?

linzhp · 2023-06-13T03:11:01Z

Released: https://github.com/bazelbuild/bazel-gazelle/releases/tag/v0.31.1

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bazel_gazelle](https://togithub.com/bazelbuild/bazel-gazelle) | http_archive | patch | `v0.31.0` -> `v0.31.1` | --- ### ⚠ Dependency Lookup Warnings ⚠ Warnings were logged while processing this repo. Please check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>bazelbuild/bazel-gazelle</summary> ### [`v0.31.1`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.31.1) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.31.0...v0.31.1) #### What's Changed - point sync.Once in walkConfig by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1532 - add copylock vet to nogo by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1534 - bzlmod: Remove deprecated override attributes on `go_deps.module` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1548 - Add default directives for github.com/envoyproxy/protoc-gen-validate by [@mortenmj](https://togithub.com/mortenmj) in [bazelbuild/bazel-gazelle#1553 - cmd/gazelle: do not use the epoch as timestamp in diff output by [@siddharthab](https://togithub.com/siddharthab) in [bazelbuild/bazel-gazelle#1552 - fileinfo: fix not detecting 'unix' files to be OS specific by [@sluongng](https://togithub.com/sluongng) in [bazelbuild/bazel-gazelle#1554 - language/go: Emit apparent repo name of rules_go in select keys by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1555 - Let `bazel_dep`s replace Go deps by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1526 #### New Contributors - [@mortenmj](https://togithub.com/mortenmj) made their first contribution in [bazelbuild/bazel-gazelle#1553 **Full Changelog**: bazelbuild/bazel-gazelle@v0.31.0...v0.31.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/kreempuff/rules_unreal_engine).

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bazel_gazelle](https://togithub.com/bazelbuild/bazel-gazelle) | http_archive | patch | `v0.31.0` -> `v0.31.1` | --- ### Release Notes <details> <summary>bazelbuild/bazel-gazelle</summary> ### [`v0.31.1`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.31.1) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.31.0...v0.31.1) #### What's Changed - point sync.Once in walkConfig by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1532 - add copylock vet to nogo by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1534 - bzlmod: Remove deprecated override attributes on `go_deps.module` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1548 - Add default directives for github.com/envoyproxy/protoc-gen-validate by [@mortenmj](https://togithub.com/mortenmj) in [bazelbuild/bazel-gazelle#1553 - cmd/gazelle: do not use the epoch as timestamp in diff output by [@siddharthab](https://togithub.com/siddharthab) in [bazelbuild/bazel-gazelle#1552 - fileinfo: fix not detecting 'unix' files to be OS specific by [@sluongng](https://togithub.com/sluongng) in [bazelbuild/bazel-gazelle#1554 - language/go: Emit apparent repo name of rules_go in select keys by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1555 - Let `bazel_dep`s replace Go deps by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1526 #### New Contributors - [@mortenmj](https://togithub.com/mortenmj) made their first contribution in [bazelbuild/bazel-gazelle#1553 **Full Changelog**: bazelbuild/bazel-gazelle@v0.31.0...v0.31.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/cgrindel/rules_swift_package_manager).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [bazel_gazelle](https://togithub.com/bazelbuild/bazel-gazelle) | http_archive | patch | `v0.31.0` -> `v0.31.1` | --- ### Release Notes <details> <summary>bazelbuild/bazel-gazelle</summary> ### [`v0.31.1`](https://togithub.com/bazelbuild/bazel-gazelle/releases/tag/v0.31.1) [Compare Source](https://togithub.com/bazelbuild/bazel-gazelle/compare/v0.31.0...v0.31.1) #### What's Changed - point sync.Once in walkConfig by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1532 - add copylock vet to nogo by [@jmhodges](https://togithub.com/jmhodges) in [bazelbuild/bazel-gazelle#1534 - bzlmod: Remove deprecated override attributes on `go_deps.module` by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1548 - Add default directives for github.com/envoyproxy/protoc-gen-validate by [@mortenmj](https://togithub.com/mortenmj) in [bazelbuild/bazel-gazelle#1553 - cmd/gazelle: do not use the epoch as timestamp in diff output by [@siddharthab](https://togithub.com/siddharthab) in [bazelbuild/bazel-gazelle#1552 - fileinfo: fix not detecting 'unix' files to be OS specific by [@sluongng](https://togithub.com/sluongng) in [bazelbuild/bazel-gazelle#1554 - language/go: Emit apparent repo name of rules_go in select keys by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1555 - Let `bazel_dep`s replace Go deps by [@fmeum](https://togithub.com/fmeum) in [bazelbuild/bazel-gazelle#1526 #### New Contributors - [@mortenmj](https://togithub.com/mortenmj) made their first contribution in [bazelbuild/bazel-gazelle#1553 **Full Changelog**: bazelbuild/bazel-gazelle@v0.31.0...v0.31.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/cgrindel/bazel-starlib).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

sluongng force-pushed the sluongng/fix-unix branch 2 times, most recently from 358806b to 1d43efc Compare May 31, 2023 11:31

sluongng force-pushed the sluongng/fix-unix branch from 1d43efc to 01dcee8 Compare May 31, 2023 11:34

Merge branch 'master' into sluongng/fix-unix

36bde40

fmeum approved these changes May 31, 2023

View reviewed changes

fmeum merged commit e770d46 into bazelbuild:master May 31, 2023
10 checks passed

fmeum mentioned this pull request May 31, 2023

language/go: Add unix as ignored tag. #1551

Closed

sluongng mentioned this pull request May 31, 2023

gazelle: upgrade to v0.31.0 buildbuddy-io/buildbuddy#4072

Merged

This comment was marked as resolved.

Sign in to view

sluongng deleted the sluongng/fix-unix branch June 2, 2023 16:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fileinfo: fix not detecting 'unix' files to be OS specific #1554

fileinfo: fix not detecting 'unix' files to be OS specific #1554

sluongng commented May 31, 2023

sluongng commented May 31, 2023

fmeum left a comment

connyay commented May 31, 2023

This comment was marked as resolved.

sluongng commented Jun 2, 2023

fmeum commented Jun 2, 2023

sluongng commented Jun 9, 2023

linzhp commented Jun 9, 2023

linzhp commented Jun 13, 2023

fileinfo: fix not detecting 'unix' files to be OS specific #1554

fileinfo: fix not detecting 'unix' files to be OS specific #1554

Conversation

sluongng commented May 31, 2023

sluongng commented May 31, 2023

fmeum left a comment

Choose a reason for hiding this comment

connyay commented May 31, 2023

This comment was marked as resolved.

sluongng commented Jun 2, 2023

fmeum commented Jun 2, 2023

sluongng commented Jun 9, 2023

linzhp commented Jun 9, 2023

linzhp commented Jun 13, 2023