Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions client.go
Original file line number Diff line number Diff line change
Expand Up @@ -485,14 +485,14 @@ func (c *Config) validate() error {
if c.Workers != nil {
for _, workerInfo := range c.Workers.workersMap {
kind := workerInfo.jobArgs.Kind()
if !jobKindRE.MatchString(kind) {
if !rivercommon.UserSpecifiedIDOrKindRE.MatchString(kind) {
if c.SkipJobKindValidation {
c.Logger.Warn("job kind should match regex; this will be an error in future versions",
slog.String("kind", kind),
slog.String("regex", jobKindRE.String()),
slog.String("regex", rivercommon.UserSpecifiedIDOrKindRE.String()),
)
} else {
return fmt.Errorf("job kind %q should match regex %q", kind, jobKindRE.String())
return fmt.Errorf("job kind %q should match regex %s", kind, rivercommon.UserSpecifiedIDOrKindRE.String())
}
}
}
Expand Down Expand Up @@ -828,13 +828,18 @@ func NewClient[TTx any](driver riverdriver.Driver[TTx], config *Config) (*Client
}

{
periodicJobEnqueuer := maintenance.NewPeriodicJobEnqueuer(archetype, &maintenance.PeriodicJobEnqueuerConfig{
periodicJobEnqueuer, err := maintenance.NewPeriodicJobEnqueuer(archetype, &maintenance.PeriodicJobEnqueuerConfig{
AdvisoryLockPrefix: config.AdvisoryLockPrefix,
Insert: func(ctx context.Context, execTx riverdriver.ExecutorTx, insertParams []*rivertype.JobInsertParams) error {
_, err := client.insertMany(ctx, execTx, insertParams)
return err
},
Pilot: client.pilot,
Schema: config.Schema,
}, driver.GetExecutor())
if err != nil {
return nil, err
}
maintenanceServices = append(maintenanceServices, periodicJobEnqueuer)
client.testSignals.periodicJobEnqueuer = &periodicJobEnqueuer.TestSignals

Expand Down Expand Up @@ -2521,11 +2526,6 @@ func (b *QueueBundle) Add(queueName string, queueConfig QueueConfig) error {
return nil
}

// Regular expression to which the format of job kinds must comply. Mainly,
// minimal special characters, and excluding spaces and commas which are
// problematic for the search UI.
var jobKindRE = regexp.MustCompile(`\A[\w][\w\-\[\]<>\/.·:+]+\z`)

// Generates a default client ID using the current hostname and time.
func defaultClientID(startedAt time.Time) string {
host, _ := os.Hostname()
Expand Down
22 changes: 1 addition & 21 deletions client_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6892,7 +6892,7 @@ func Test_NewClient_Validations(t *testing.T) {
configFunc: func(config *Config) {
AddWorker(config.Workers, &invalidKindWorker{})
},
wantErr: fmt.Errorf("job kind %q should match regex %q", "this kind is invalid", jobKindRE.String()),
wantErr: fmt.Errorf("job kind %q should match regex %s", "this kind is invalid", rivercommon.UserSpecifiedIDOrKindRE.String()),
},
{
name: "Job kind validation skipped with SkipJobKindValidation",
Expand Down Expand Up @@ -7606,23 +7606,3 @@ func TestDefaultClientIDWithHost(t *testing.T) {
require.Equal(t, strings.Repeat("a", 60)+"_2024_03_07T04_39_12_123456", defaultClientIDWithHost(startedAt, strings.Repeat("a", 60)))
require.Equal(t, strings.Repeat("a", 60)+"_2024_03_07T04_39_12_123456", defaultClientIDWithHost(startedAt, strings.Repeat("a", 61)))
}

func TestJobKindRE(t *testing.T) {
t.Parallel()

require.Regexp(t, jobKindRE, "kind")
require.Regexp(t, jobKindRE, "kind123")
require.Regexp(t, jobKindRE, "with.dot")
require.Regexp(t, jobKindRE, "with:colon")
require.Regexp(t, jobKindRE, "with+plus")
require.Regexp(t, jobKindRE, "with-hyphen")
require.Regexp(t, jobKindRE, "with_underscore")
require.Regexp(t, jobKindRE, "with[brackets]")
require.Regexp(t, jobKindRE, "with<triangle_brackets>")
require.Regexp(t, jobKindRE, "with/slash")
require.Regexp(t, jobKindRE, "JobArgsReflectKind[github.com/riverqueue/river.JobArgs·12]")

require.NotRegexp(t, jobKindRE, "with space")
require.NotRegexp(t, jobKindRE, "with,comma")
require.NotRegexp(t, jobKindRE, ":no_leading_special_characters")
}
Loading
Loading