-
Notifications
You must be signed in to change notification settings - Fork 94
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add ClientFromContext examples for both pgx + dbsql #656
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| package river_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "database/sql" | ||
| "errors" | ||
| "fmt" | ||
| "log/slog" | ||
| "time" | ||
|
|
||
| _ "github.com/jackc/pgx/v5/stdlib" | ||
|
|
||
| "github.com/riverqueue/river" | ||
| "github.com/riverqueue/river/internal/riverinternaltest" | ||
| "github.com/riverqueue/river/riverdriver/riverdatabasesql" | ||
| "github.com/riverqueue/river/rivershared/util/slogutil" | ||
| ) | ||
|
|
||
| type ContextClientSQLArgs struct{} | ||
|
|
||
| func (args ContextClientSQLArgs) Kind() string { return "ContextClientSQLWorker" } | ||
|
|
||
| type ContextClientSQLWorker struct { | ||
| river.WorkerDefaults[ContextClientSQLArgs] | ||
| } | ||
|
|
||
| func (w *ContextClientSQLWorker) Work(ctx context.Context, job *river.Job[ContextClientSQLArgs]) error { | ||
| client := river.ClientFromContext[*sql.Tx](ctx) | ||
| if client == nil { | ||
| fmt.Println("client not found in context") | ||
| return errors.New("client not found in context") | ||
| } | ||
|
|
||
| fmt.Printf("client found in context, id=%s\n", client.ID()) | ||
| return nil | ||
| } | ||
|
|
||
| // ExampleClientFromContext_databaseSQL demonstrates how to extract the River | ||
| // client from the worker context when using the [database/sql] driver. | ||
| // ([github.com/riverqueue/river/riverdriver/riverdatabasesql]) | ||
| func ExampleClientFromContext_databaseSQL() { | ||
| ctx := context.Background() | ||
|
|
||
| config := riverinternaltest.DatabaseConfig("river_test_example") | ||
| db, err := sql.Open("pgx", config.ConnString()) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| defer db.Close() | ||
|
|
||
| workers := river.NewWorkers() | ||
| river.AddWorker(workers, &ContextClientSQLWorker{}) | ||
|
|
||
| riverClient, err := river.NewClient(riverdatabasesql.New(db), &river.Config{ | ||
| ID: "ClientFromContextClientSQL", | ||
| Logger: slog.New(&slogutil.SlogMessageOnlyHandler{Level: slog.LevelWarn}), | ||
| Queues: map[string]river.QueueConfig{ | ||
| river.QueueDefault: {MaxWorkers: 10}, | ||
| }, | ||
| FetchCooldown: 10 * time.Millisecond, | ||
| FetchPollInterval: 10 * time.Millisecond, | ||
| TestOnly: true, // suitable only for use in tests; remove for live environments | ||
| Workers: workers, | ||
| }) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Not strictly needed, but used to help this test wait until job is worked. | ||
| subscribeChan, subscribeCancel := riverClient.Subscribe(river.EventKindJobCompleted) | ||
| defer subscribeCancel() | ||
|
|
||
| if err := riverClient.Start(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
| if _, err := riverClient.Insert(ctx, ContextClientSQLArgs{}, nil); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| waitForNJobs(subscribeChan, 1) | ||
|
|
||
| if err := riverClient.Stop(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Output: | ||
| // client found in context, id=ClientFromContextClientSQL | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package river_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "log/slog" | ||
|
|
||
| "github.com/jackc/pgx/v5" | ||
| "github.com/jackc/pgx/v5/pgxpool" | ||
|
|
||
| "github.com/riverqueue/river" | ||
| "github.com/riverqueue/river/internal/riverinternaltest" | ||
| "github.com/riverqueue/river/riverdriver/riverpgxv5" | ||
| "github.com/riverqueue/river/rivershared/util/slogutil" | ||
| ) | ||
|
|
||
| type ContextClientArgs struct{} | ||
|
|
||
| func (args ContextClientArgs) Kind() string { return "ContextClientWorker" } | ||
|
|
||
| type ContextClientWorker struct { | ||
| river.WorkerDefaults[ContextClientArgs] | ||
| } | ||
|
|
||
| func (w *ContextClientWorker) Work(ctx context.Context, job *river.Job[ContextClientArgs]) error { | ||
| client := river.ClientFromContext[pgx.Tx](ctx) | ||
| if client == nil { | ||
| fmt.Println("client not found in context") | ||
| return errors.New("client not found in context") | ||
| } | ||
|
|
||
| fmt.Printf("client found in context, id=%s\n", client.ID()) | ||
| return nil | ||
| } | ||
|
|
||
| // ExampleClientFromContext_pgx demonstrates how to extract the River client | ||
| // from the worker context when using the pgx/v5 driver. | ||
| // ([github.com/riverqueue/river/riverdriver/riverpgxv5]) | ||
| func ExampleClientFromContext_pgx() { | ||
| ctx := context.Background() | ||
|
|
||
| dbPool, err := pgxpool.NewWithConfig(ctx, riverinternaltest.DatabaseConfig("river_test_example")) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| defer dbPool.Close() | ||
|
|
||
| // Required for the purpose of this test, but not necessary in real usage. | ||
| if err := riverinternaltest.TruncateRiverTables(ctx, dbPool); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| workers := river.NewWorkers() | ||
| river.AddWorker(workers, &ContextClientWorker{}) | ||
|
|
||
| riverClient, err := river.NewClient(riverpgxv5.New(dbPool), &river.Config{ | ||
| ID: "ClientFromContextClient", | ||
| Logger: slog.New(&slogutil.SlogMessageOnlyHandler{Level: slog.LevelWarn}), | ||
| Queues: map[string]river.QueueConfig{ | ||
| river.QueueDefault: {MaxWorkers: 10}, | ||
| }, | ||
| TestOnly: true, // suitable only for use in tests; remove for live environments | ||
| Workers: workers, | ||
| }) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Not strictly needed, but used to help this test wait until job is worked. | ||
| subscribeChan, subscribeCancel := riverClient.Subscribe(river.EventKindJobCompleted) | ||
| defer subscribeCancel() | ||
|
|
||
| if err := riverClient.Start(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
| if _, err = riverClient.Insert(ctx, ContextClientArgs{}, nil); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| waitForNJobs(subscribeChan, 1) | ||
|
|
||
| if err := riverClient.Stop(ctx); err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // Output: | ||
| // client found in context, id=ClientFromContextClient | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These examples are named so that they can be correctly associated with the
ClientFromContextfunction. The pkgsite docs will group them together underneath the function's documentation.https://pkg.go.dev/github.com/fluhus/godoc-tricks#Examples