Skip to content

Allow passing a custom HTTP client via AppOptions#416

Merged
heyitsaamir merged 6 commits into
mainfrom
aamirj/configurable-http-client
Apr 30, 2026
Merged

Allow passing a custom HTTP client via AppOptions#416
heyitsaamir merged 6 commits into
mainfrom
aamirj/configurable-http-client

Conversation

@heyitsaamir

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a client option to AppOptions accepting Client or ClientOptions
  • App always injects its User-Agent header (clones if instance, merges if options)
  • Mirrors the teams.ts SDK pattern

Test plan

  • Two new tests: one for ClientOptions, one for Client instance
  • All 246 existing tests pass
  • pyright clean

Adds a `client` option to `AppOptions` that accepts a `Client` instance or `ClientOptions`.
The app always injects its User-Agent header regardless of what's provided.
Mirrors the teams.ts SDK pattern.

Co-Authored-By: Claude <[email protected]>
Copilot AI review requested due to automatic review settings April 30, 2026 17:33
Uses clone() for the ClientOptions path too so _merge_headers
concatenates User-Agent values instead of overwriting.

Co-Authored-By: Claude <[email protected]>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds support for supplying a custom HTTP client (or client options) via AppOptions, while ensuring the SDK’s User-Agent is always injected/merged.

Changes:

  • Adds client: Client | ClientOptions to AppOptions / InternalAppOptions.
  • Initializes App.http_client from the provided client/options and injects the SDK User-Agent via cloning.
  • Adds tests covering both ClientOptions and Client instance scenarios.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
packages/apps/src/microsoft_teams/apps/options.py Extends app configuration types to accept a custom HTTP client or client options.
packages/apps/src/microsoft_teams/apps/app.py Initializes http_client from options and injects/merges the SDK User-Agent.
packages/apps/tests/test_app.py Adds tests validating behavior for both ClientOptions and Client instance inputs.

Comment thread packages/apps/src/microsoft_teams/apps/app.py
Comment thread packages/apps/src/microsoft_teams/apps/app.py
Comment thread packages/apps/tests/test_app.py Outdated
heyitsaamir and others added 3 commits April 30, 2026 11:17
- Test that initialize() enables send() (before/after behavior)
- Test that plugin init failure emits error event and propagates

Co-Authored-By: Claude <[email protected]>
The TypedDict already enforces the type at the static analysis level.

Co-Authored-By: Claude <[email protected]>
Assert on real HTTP request URL and headers instead of private _options.

Co-Authored-By: Claude <[email protected]>
@heyitsaamir
heyitsaamir merged commit 9d05fee into main Apr 30, 2026
7 checks passed
@heyitsaamir
heyitsaamir deleted the aamirj/configurable-http-client branch April 30, 2026 19:12
corinagum added a commit that referenced this pull request May 27, 2026
## Summary

Brings `origin/main` into `release` for the **2.0.12** release. **No
carve-outs this time** — Quoted Replies (PR #321) is included.

`version.json`: `2.0.11` → `2.0.12`.

Aligns with teams.ts/teams.net cadence.

## What's in this release (delta from 2.0.11)

**Features**
- Quoted Replies & new quotes features (#321) — previously held back
- SuggestedActionSubmitActivity for `suggestedAction/submit` invoke
(#434)
- Default targeted replies for targeted inbound messages (#439)
- Reactions API marked GA (#427) — already shipped in 2.0.11 actually,
ignore if duplicate
- Prompt Preview support (#397)
- Sample: opt targeted-messages into slash commands (#430)
- Sample: a2a-in-teams (#401)
- Sample: proactive message update (#405)
- Allow custom HTTP client via `AppOptions` (#416)

**Security & fixes**
- Lock JsonWebToken trust-boundary contract (#432)
- Bump starlette 1.0.0 -> 1.1.0 for PYSEC-2026-161 / BadHost (#441)
- warn when bot starts without credentials (#435)
- fix(apps): support AAD v1 issuers in Entra token validation (#422)
- fix(apps): log inbound activities at info, warn on missing
Authorization (#425)
- fix(http-stream): wait for in-flight flush before sending final close
(#419)
- Mark reactions API as GA and fix sample remove flow (#427)
- Revert serviceUrl allowlist (ADO 5310460) (#415)
- Route `app.get_app_graph` + `ctx.*_graph` to sovereign endpoints via
`cloud.graph_scope` (#402)

**Deprecations / package changes**
- Remove ai, openai, mcpplugin, a2a, and devtools packages (#413)
- Restore and deprecate devtools package (#410)
- Deprecate ai, openai, mcpplugin, a2a packages (#406)
- Add agent framework example, remove chatprompt/mcp client samples
(#386)

**Dependency bumps**
- urllib3 2.6.3 → 2.7.0 (#426)
- python-multipart 0.0.26 → 0.0.27 (#424)
- microsoft-kiota-http 1.9.7 → 1.9.9 (#423)
- idna 3.11 → 3.15 (#431)
- starlette 1.0.0 → 1.1.0 (#441, security)
- /examples/tab/Web: qs, postcss, uuid, follow-redirects bumps

## Quoted Replies inclusion notes

- Teams client rendering is in-sync with the wire format as of
2026-05-06.
- APX QR rollout completed: Public 2026-04-10, GCCH/DoD/Gallatin
2026-04-14.
- Builder methods (`prepend_quote()`, `add_quote()`), `ctx.quote()`, and
the quote-aware `ctx.reply()` behavior are all present in this release.
- `examples/quoting` is included.

## Conflict resolution

The 2.0.11 release branch had the QR-removed shape for four files; took
`main`'s (QR-included) version for all of them:
- `examples/targeted-messages/src/main.py`
- `packages/api/src/microsoft_teams/api/activities/message/message.py`
- `packages/apps/src/microsoft_teams/apps/routing/activity_context.py`
- `packages/apps/tests/test_activity_context.py`

`version.json` conflict resolved to `2.0.12`.

## Test plan

- [x] `uv sync` clean
- [x] `poe check` (ruff format + lint) — clean
- [x] `poe test` — 609 passed
- [x] `pyright` — 0 errors, 0 warnings
- [ ] Pipeline build + test stages green on `release` after merge
- [ ] Publish pipeline run with **Public** → ESRP approval → PyPI
- [ ] `pip install microsoft-teams-apps==2.0.12` smoke install

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Aamir Jawaid <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
Co-authored-by: Shanmathi Mayuram Krithivasan <[email protected]>
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.

3 participants