Repository navigation
feat(integrations): warn when a hand-wired framework isn't the tested version - #474
Conversation
|
First review done: the scope matches #400. The check only warns, the ranges match pyproject's dev extra and the CI pins, it fires once per process per framework, and the tests fail without the change. A second review follows once CI finishes. Optional polish, if you have a moment:
On tests/test_google_adk.py::Paths::test_an_mcp_toolsets_tools_are_gated, which you mention fails locally on the parent commit too: we'll check it in CI's py3.12 and 3.13 jobs. |
|
Synced the branch onto current On the earlier red The macOS job also went red twice on The new head needs run approval before CI starts. Could a maintainer approve it when convenient? |
… version The five integrations built by hand (Microsoft Agent Framework, Google ADK, Haystack, LlamaIndex, Strands Agents) got no version check: a framework minor that moved a hook or changed a callback's arguments failed in ways that were hard to trace back to the version. tracekit/integrations/version_check.py holds the one check they share. It reads the installed distribution's version with the helpers autowire already has (_version(), _release()) and warns, once per process per framework, when it is outside the range Tracekit is tested with. The wording is shared with instrument()'s warning, so both say the same thing about the same fact. Never raises: an unreadable or missing version means no warning. Removes 'another version gets no warning' from the Agent Framework row in docs/limits.md and from its integration page. Fixes Cygnux-Labs#400 Signed-off-by: annasclaw <annasmazhar61@gmail.com>
ccb8ef5 to
17e1d1f
Compare
|
Two changes to the branch head since the last review, plus one thing that needs an action from you. 1. The workflow runs never started — they are waiting for approval. The three checks on this PR show So CI has not run on this branch at all yet — which is exactly the condition you said you were waiting on before reviewing. Approving the run is the unblock:
2. I dropped an unsigned merge commit from the branch. The previous head was a merge of The branch is now rebased onto The trade-off is worth naming: a merge commit was the cheap way to take upstream's movement without touching the diff, and it is also the thing that would have failed DCO. Rebasing keeps the diff identical and the history checkable, at the cost of having to resolve any upstream conflict on the branch itself. There were none here. 3. What I would like reviewed The substantive part is unchanged from
Tests for all five are in the diff ( |
|
Thanks. The runs are approved. I checked the rebase: one signed-off commit, and its changed lines match ceb7a2c exactly. Neither earlier red job comes from this change:
The second review follows once this run finishes. |
|
The second review is done. Nothing blocks the design: the ranges match pyproject and the CI pins, it only warns, it's called once at construction, and it's thread-safe. A few small fixes before merge, please:
Optional:
If the new head's diff only covers these, the re-check will be quick. |
- Tests filter recorded warnings on "is wired but untested" before counting them or reading the first one. - An empty version string means not installed, as instrument() reads it; the cannot-be-read test now covers "" too. - The limits row's Why cell and the module docstring say what the code does now. - Tidying: one import line per integration, unwrapped calls that fit, rewrapped long assertIn lines and the ragged doc paragraph. Signed-off-by: LoopGlitch26 <53336715+LoopGlitch26@users.noreply.github.com>
|
I applied the fixes from the last review so this can go in (8841cd6):
The optional tidying is in the same commit: one import line in the five integrations, the google_adk.py and strands.py calls on one line, the three long I ran this with the five frameworks installed at their tested versions. tests/test_version_check.py and the five integration test files pass (187 passed; 1 skipped, an existing MCP-version skip), and If you'd do any of these differently, say so. |
|
Merged. It ships in 1.5.1, credited in the changelog. Thanks for the work, and for keeping the branch in step with main. |
|
Thanks again for contributing to Tracekit. A request: if you use a coding agent (Claude Code, Codex, Cursor, Gemini CLI or OpenCode), would you run Tracekit on it for a week and tell us how it went? After a week, |
Fixes #400.
tracekit.instrument()warns for the frameworks it wires itself: a version outside the tested range is wired but untested. The five integrations built by hand — Microsoft Agent Framework, Google ADK, Haystack, LlamaIndex and Strands Agents — got no such warning, so a framework minor that moved a hook or changed a callback's arguments failed in ways that were hard to trace back to the version.The change
tracekit/integrations/version_check.pyholds the one check the five share. It reads the installed distribution's version with the helpersautowirealready has (_version(),_release()) rather than copying them, and warns once per process per framework when the version is outside the range Tracekit is tested with.instrument()'s warning, so both say the same thing about the same fact.autowire._untested_warning()is the single place that sentence is written;instrument()now calls it too.Tracekit(run)), with the tested range the issue names:agent-framework-core>=1.22,<1.23,google-adk>=2.12,<2.13,haystack-ai>=3.4,<3.5,llama-index-core>=0.14.25,<0.15,strands-agents>=1.61,<1.62.docs/limits.mdand from its integration page.Tests
tests/test_version_check.pycovers the helper (warns outside the range, stays quiet inside it, warns only once per process, warns once per framework, never raises when the version can't be read). Each of the five existing test files gets aVersionCheckcase that patches the version: outside the range one warning, inside it none.The one failure is
tests/test_google_adk.py::Paths::test_an_mcp_toolsets_tools_are_gated, which fails the same way on the pristine parent commit (cb453398) with the same installedgoogle-adk— it is not caused by this change.DCO: every commit carries a
Signed-off-bytrailer.