submission.go RawHistoryFolder

1// SPDX-License-Identifier: AGPL-3.0-or-later
2
3package domain
4
5import (
6	"errors"
7	"fmt"
8	"time"
9)
10
11// ErrSubmissionRefused is matched by every refusal of an anonymous issue
12// submission, whatever the class. Unknown or closed repositories answer
13// ErrNotFound instead, and a text that breaks the rules a *TextError.
14var ErrSubmissionRefused = errors.New("submission refused")
15
16var (
17	// ErrSubmissionRateLimited means the client submitted too often; the
18	// error is a *SubmissionRetryError that says when to retry.
19	ErrSubmissionRateLimited = fmt.Errorf("%w: rate limited", ErrSubmissionRefused)
20	// ErrSubmissionsPaused means too many submissions await moderation (or
21	// the server cannot track more challenges): nobody may submit for now.
22	ErrSubmissionsPaused = fmt.Errorf("%w: submissions paused", ErrSubmissionRefused)
23	// ErrSubmissionInvalid covers every bot, token, proof-of-work, timing and
24	// honeypot failure. It is deliberately one error: it must not tell a bot
25	// which check it failed.
26	ErrSubmissionInvalid = fmt.Errorf("%w: invalid submission", ErrSubmissionRefused)
27)
28
29// SubmissionRetryError is the ErrSubmissionRateLimited of a client that may
30// try again after the given delay.
31type SubmissionRetryError struct {
32	After time.Duration
33}
34
35// Error implements error.
36func (e *SubmissionRetryError) Error() string {
37	return fmt.Sprintf("%v: retry after %s", ErrSubmissionRateLimited, e.After.Round(time.Second))
38}
39
40// Unwrap makes errors.Is match ErrSubmissionRateLimited and
41// ErrSubmissionRefused.
42func (e *SubmissionRetryError) Unwrap() error { return ErrSubmissionRateLimited }