feat: introduce request-scoped background tasks & async mail sending #2126
Conversation
This file contains hidden or 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
* Add background worker disabled by default (`GOTRUE_WORKER_ENABLED`) * Worker pool runs N workers (`runtime.NumCPU() * GOTRUE_WORKER_COUNT_PER_CPU`) * Graceful shutdown drains tasks during `GOTRUE_WORKER_SHUTDOWN_DURATION` * Enqueue slow I/O (initially mail) instead of blocking inside transactions
Pull Request Test Coverage Report for Build 17275121624Details
💛 - Coveralls |
cemalkilic
reviewed
Aug 22, 2025
added 2 commits
August 23, 2025 11:49
Introduce a new `apitask` package for running background tasks within the lifecycle of an API request. We then use this feature in the mailer client to send emails in the background when `GOTRUE_MAILER_EMAIL_BACKGROUND_SENDING` is set to true. Before the request returns to the caller we first wait for all in-flight tasks to exit. This is the smallest possible step I could come up with to remove blocking email sending calls from the request path. Summary: * Define a `Task` interface for light background work. * Add `Run(ctx, task)` to schedule tasks asynchronously when supported, or fall back to synchronous execution otherwise. * Add `Wait(ctx)` to block until all request-scoped tasks finish * Add `Middleware` to wrap HTTP handlers, attaching a request-scoped worker to the context and ensuring all tasks complete before returning a response. * Add a check for `EmailBackgroundSending` in mailer package, when present wrap the mail client in a `backgroundMailClient`. When `Mail` is called it will send a `mailer.Task` to `apitasks.Run` to send the email in the background using the wrapped `MailClient`.
cstockton
force-pushed
the
cs/feat-background-workers
branch
from
c8fd310 to
070fa36
Compare
cstockton
changed the title
hf
approved these changes
Aug 27, 2025
| return context.WithValue(ctx, ctxKey, wrk) | ||
| } | ||
|
|
||
| var ctxKey = new(int) |
hf
pushed a commit
that referenced
this pull request
Aug 28, 2025
🤖 I have created a release *beep* *boop* --- ## [2.179.0](v2.178.0...v2.179.0) (2025-08-28) ### Features * add oauth2 client support ([#2098](#2098)) ([8fae015](8fae015)) * experimental own linking domains per provider ([#2119](#2119)) ([747bf3b](747bf3b)) * fetch email from snapchat oauth provider if available for consistency ([#2110](#2110)) ([7507822](7507822)) * implement link identity with oidc / native sign in ([#2108](#2108)) ([5f0ec87](5f0ec87)) * implements email-less accounts with oauth ([#2105](#2105)) ([9a61dae](9a61dae)) * introduce request-scoped background tasks & async mail sending ([#2126](#2126)) ([2c8ea61](2c8ea61)) * refactor mailer client wiring and add validation wrapper ([#2130](#2130)) ([68c40a6](68c40a6)) * support multiple `aud` for the external providers ([#2117](#2117)) ([ca5792e](ca5792e)) * use `slices.Contains` instead of for loops ([#2111](#2111)) ([9f22682](9f22682)) ### Bug Fixes * add `id-token` permission to ci ([#2143](#2143)) ([79209c0](79209c0)) * add missing param ([#2125](#2125)) ([c0b75f6](c0b75f6)) * change s3 artifact upload role ([#2145](#2145)) ([767e371](767e371)) * remove requirement of empty content-type on 204 ([#2128](#2128)) ([ecc97e0](ecc97e0)) * run release-please again ([#2144](#2144)) ([2560f14](2560f14)) * stripped binary now includes version ([#2147](#2147)) ([609f169](609f169)) * update copyright year in LICENSE ([#2142](#2142)) ([67fe0b0](67fe0b0)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Introduce a new
apitaskpackage for running background tasks within the lifecycle of an API request. We then use this feature in the mailer client to send emails in the background. Before the request returns to the caller we first wait for all in-flight tasks to exit.Summary:
Taskinterface for light background work.Run(ctx, task)to schedule tasks asynchronously when supported, or fall back to synchronous execution otherwise.Wait(ctx)to block until all request-scoped tasks finishMiddlewareto wrap HTTP handlers, attaching a request-scoped worker to the context and ensuring all tasks complete before returning a response.EmailBackgroundSendingin mailer package, when present wrap the mail client in abackgroundMailClient. WhenMailis called it will send amailer.Tasktoapitasks.Runto send the email in the background using the wrappedMailClient.GOTRUE_MAILER_EMAIL_BACKGROUND_SENDING(deffalse) - on/off switch.I will follow up with unit tests once the team has had an opportunity to review.
Done: #2146