Keep long fallback reasons from invalidating warnings
This commit is contained in:
@@ -1,11 +1,27 @@
|
||||
package pipeline
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"unicode/utf8"
|
||||
|
||||
"gitea.maximumdirect.net/eric/notarius/internal/core/source"
|
||||
"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
|
||||
frameworkdiagnostics "gitea.maximumdirect.net/eric/notarius/internal/framework/diagnostics"
|
||||
)
|
||||
|
||||
// boundedDiagnosticMessage is for framework-authored samples only. Module
|
||||
// diagnostics still pass through ordinary contract validation unchanged.
|
||||
func boundedDiagnosticMessage(message string) string {
|
||||
message = strings.ToValidUTF8(message, "<22>")
|
||||
if len(message) > contracts.MaxDiagnosticMessageBytes {
|
||||
message = message[:contracts.MaxDiagnosticMessageBytes]
|
||||
for !utf8.ValidString(message) {
|
||||
message = message[:len(message)-1]
|
||||
}
|
||||
}
|
||||
return message
|
||||
}
|
||||
|
||||
func promoteProducerDiagnostics(diagnostics []contracts.ProducerDiagnostic, origin contracts.DiagnosticOrigin, chunk *source.Chunk) ([]contracts.DiagnosticGroup, error) {
|
||||
if err := contracts.ValidateProducerDiagnostics(diagnostics); err != nil {
|
||||
return nil, err
|
||||
|
||||
37
internal/framework/pipeline/fallback_diagnostic_test.go
Normal file
37
internal/framework/pipeline/fallback_diagnostic_test.go
Normal file
@@ -0,0 +1,37 @@
|
||||
package pipeline
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
"unicode/utf8"
|
||||
|
||||
"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
|
||||
)
|
||||
|
||||
func TestFallbackDiagnosticBoundsOnlyThePresentedReason(t *testing.T) {
|
||||
for _, reason := range []string{
|
||||
strings.Repeat("a", contracts.MaxDiagnosticMessageBytes-1) + "界界",
|
||||
"provider error: " + string([]byte{0xff}) + strings.Repeat("x", contracts.MaxDiagnosticMessageBytes),
|
||||
} {
|
||||
outcome := contracts.ProducerOutcome{Disposition: contracts.ProducerFallback, FallbackReason: reason}
|
||||
groups, err := operationDiagnosticGroups(nil, nil, contracts.CandidateAssessment{}, outcome, contracts.DiagnosticOrigin{Stage: "extract", ModuleKey: "test"}, nil)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if len(groups) != 1 || len(groups[0].Samples) != 1 {
|
||||
t.Fatalf("missing fallback warning: %#v", groups)
|
||||
}
|
||||
message := groups[0].Samples[0].Message
|
||||
if strings.TrimSpace(message) == "" || len(message) > contracts.MaxDiagnosticMessageBytes || !utf8.ValidString(message) {
|
||||
t.Fatalf("invalid warning sample: %q", message)
|
||||
}
|
||||
if outcome.FallbackReason != reason {
|
||||
t.Fatal("original failure reason was changed")
|
||||
}
|
||||
invalid := []contracts.ProducerDiagnostic{{Disposition: contracts.DiagnosticDispositionWarning, Category: contracts.DiagnosticCategoryFallback,
|
||||
ReasonCode: "module_warning", OccurrenceCount: 1, Samples: []contracts.DiagnosticSample{{Scope: "test", Message: reason}}}}
|
||||
if _, err := operationDiagnosticGroups(invalid, nil, contracts.CandidateAssessment{}, outcome, contracts.DiagnosticOrigin{Stage: "extract", ModuleKey: "test"}, nil); err == nil {
|
||||
t.Fatal("invalid module diagnostic was silently repaired")
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -3,8 +3,6 @@ package pipeline
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strings"
|
||||
"unicode/utf8"
|
||||
|
||||
"gitea.maximumdirect.net/eric/notarius/internal/core/source"
|
||||
"gitea.maximumdirect.net/eric/notarius/internal/framework/contracts"
|
||||
@@ -47,13 +45,7 @@ func producerCacheObserver(input RunInput, origin contracts.DiagnosticOrigin, ch
|
||||
observation.ChunkID, observation.ChunkIndex = chunk.ID, &chunkIndex
|
||||
}
|
||||
if observation.Err != nil {
|
||||
message := strings.ToValidUTF8(fmt.Sprintf("Artifact cache %s: %v", observation.Decision, observation.Err), "<22>")
|
||||
if len(message) > contracts.MaxDiagnosticMessageBytes {
|
||||
message = message[:contracts.MaxDiagnosticMessageBytes]
|
||||
for !utf8.ValidString(message) {
|
||||
message = message[:len(message)-1]
|
||||
}
|
||||
}
|
||||
message := boundedDiagnosticMessage(fmt.Sprintf("Artifact cache %s: %v", observation.Decision, observation.Err))
|
||||
*warnings = append(*warnings, contracts.ProducerDiagnostic{
|
||||
Disposition: contracts.DiagnosticDispositionWarning, Category: contracts.DiagnosticCategoryDegradation,
|
||||
ReasonCode: "cache_" + observation.Decision, OccurrenceCount: 1,
|
||||
|
||||
@@ -52,7 +52,7 @@ func operationDiagnosticGroups(diagnostics, cacheDiagnostics []contracts.Produce
|
||||
warning := contracts.ProducerDiagnostic{
|
||||
Disposition: contracts.DiagnosticDispositionWarning, Category: contracts.DiagnosticCategoryFallback,
|
||||
ReasonCode: "producer_fallback", OccurrenceCount: 1,
|
||||
Samples: []contracts.DiagnosticSample{{Scope: origin.ModuleKey, Message: outcome.FallbackReason}},
|
||||
Samples: []contracts.DiagnosticSample{{Scope: origin.ModuleKey, Message: boundedDiagnosticMessage(outcome.FallbackReason)}},
|
||||
}
|
||||
fallbackGroups, err := promoteProducerDiagnostics([]contracts.ProducerDiagnostic{warning}, origin, chunk)
|
||||
return append(groups, fallbackGroups...), err
|
||||
|
||||
Reference in New Issue
Block a user