diffplug / diffplug/spotless

Protobuf/Buf Formatter Fails for Files Larger than 64KiB

Offen
#2,481 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Java
Sterne
5.7k
Forks
561
Ø Merge
1 T. 14 Std.
Gemergte PRs (30 T.)
43

Beschreibung

Test case:

1. Define a .proto files larger than 64 KiB (or your platform's pipe buffer limit). Padding with whitespace should also work.
2. Configure spotless to format said file.
3. Run spotlessApply (gradle example).

Expected behavior:

Formatting runs and passes (if valid proto file).

Actual behavior:

```
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':treatment:api:spotlessProtobufApply'.
...
Caused by: org.gradle.api.GradleException: There were 1 lint error(s), they must be fixed or suppressed.
src/...:LINE_UNDEFINED buf(java.io.IOException) Broken pipe (...)
Resolve these lints or suppress with `suppressLintsFor`
at com.diffplug.gradle.spotless.SpotlessApply.performAction(SpotlessApply.java:60)
```

`cat`-ing `/build/spotless-lints/...` shows:
```
Broken pipe
at java.base/java.io.FileOutputStream.writeBytes(Native Method)
at java.base/java.io.FileOutputStream.write(FileOutputStream.java:367)
at java.base/java.io.BufferedOutputStream.implWrite(BufferedOutputStream.java:217)
at java.base/java.io.BufferedOutputStream.write(BufferedOutputStream.java:206)
at java.base/java.io.FilterOutputStream.write(FilterOutputStream.java:110)
at com.diffplug.spotless.ProcessRunner.start(ProcessRunner.java:165)
at com.diffplug.spotless.ProcessRunner.start(ProcessRunner.java:131)
at com.diffplug.spotless.ProcessRunner.exec(ProcessRunner.java:114)
at com.diffplug.spotless.ProcessRunner.exec(ProcessRunner.java:109)
at com.diffplug.spotless.protobuf.BufStep$State.format(BufStep.java:109)
at com.diffplug.spotless.FormatterFunc$Closeable$3.apply(FormatterFunc.java:140)
at com.diffplug.spotless.FormatterStepEqualityOnStateSerialization.format(FormatterStepEqualityOnStateSerialization.java:49)
at com.diffplug.spotless.LintState.of(LintState.java:177)
at com.diffplug.spotless.LintState.of(LintState.java:134)
at com.diffplug.gradle.spotless.SpotlessTaskImpl.processInputFile(SpotlessTaskImpl.java:134)
at com.diffplug.gradle.spotless.SpotlessTaskImpl.performAction(SpotlessTaskImpl.java:117)
...
```

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Reproduziere den Fehler mit einer gültigen .proto-Datei, die größer als 64 KiB ist, und führe spotlessApply aus. Lies zunächst ProcessRunner.start und die in der Ablaufverfolgung gezeigte Aufrufstelle BufStep.java:109; abgeschlossen ist die Aufgabe, wenn die Formatierung ohne einen Broken pipe-Lint durchläuft und die generierte Ausgabe gültig bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
build-system
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.