Skip to content

patchwork: support configurable user agent - #436

Open
OllieinCanada wants to merge 2 commits into
sashiko-dev:mainfrom
OllieinCanada:agent/patchwork-user-agent
Open

patchwork: support configurable user agent#436
OllieinCanada wants to merge 2 commits into
sashiko-dev:mainfrom
OllieinCanada:agent/patchwork-user-agent

Conversation

@OllieinCanada

Copy link
Copy Markdown
Contributor

Fixes #282

Summary

Allow each Patchwork API policy to configure an identifiable HTTP
User-Agent.

Why

Some Patchwork deployments use automated-client protections and may reject
requests that do not identify a real service contact. Sashiko previously
provided no way to set that header, so operators could not follow an
instance's client-identification policy without changing the code.

Changes

  • add optional patchwork.user_agent email-policy configuration
  • resolve the setting at outbox delivery time alongside the API token
  • send it on both the message-ID lookup and check creation requests
  • document the setting and add it to the example policy

No default identity is hard-coded; each deployment controls the value it
publishes.

Validation

  • deterministic localhost test captures the real lookup and check requests
    and verifies their User-Agent and authorization headers
  • cargo fmt --all -- --check passes
  • git diff --check passes
  • local Rust compilation is blocked before Sashiko builds because aws-lc-sys
    rejects the installed GCC 9.4 compiler; GitHub CI provides the authoritative
    clippy and unit-test results

Oliver Slapinski added 2 commits August 15, 2026 16:43
Some Patchwork instances may reject unidentified API clients. Allow
each API policy to provide a User-Agent and send it on both lookup and
check requests.

Cover the transport behavior with a deterministic localhost test.

Signed-off-by: Oliver Slapinski <olliefromcanada@gmail.com>
Signed-off-by: Oliver Slapinski <olliefromcanada@gmail.com>
@OllieinCanada
OllieinCanada marked this pull request as ready for review August 15, 2026 20:51
@derekbarbosa

Copy link
Copy Markdown
Collaborator

Hi Ollie, could you please fix those commits? IOW - have the SOBs and authorship match the account in which you are submitting this PR with? I'll review once that happens :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Check Patchwork API protection

2 participants