Skip to content

refactor(plugins): type platform handles as PlatformClient across the plugin runtime - #2002

Draft
maxdubrinsky wants to merge 15 commits into
mainfrom
cli-plugin-runtime-typed/mdubrinsky
Draft

refactor(plugins): type platform handles as PlatformClient across the plugin runtime#2002
maxdubrinsky wants to merge 15 commits into
mainfrom
cli-plugin-runtime-typed/mdubrinsky

Conversation

@maxdubrinsky

@maxdubrinsky maxdubrinsky commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Types the platform handle plugins receive as the structural PlatformClient (from #1986) instead of the concrete Stainless NeMoPlatform class, and moves the chat TUI's streaming off the SDK's stream type, so the plugin runtime and plugin CLIs import and run without the generated SDK. No behavior change.

Rebased over #1973, which reworked nemo-agents' call sites: main's versions of those files win. What remains here for nemo-agents is the four modules #1973 left on the generated SDK (cli.py's _platform_sdk, jobs/optimize_cli.py, usage/cli.py, usage/sources/fileset.py, which only fed client_from_platform, now build a NemoClient directly) and the PlatformClient annotation on jobs/fileset_io.upload_to_fileset. That is what lets nemo agents --help pass the SDK-blocked import probe in the final flip PR.

Changes

  • nemo_platform_plugin.runtime and the plugins' sdk.py factories annotate the handle as PlatformClient and only forward it to client_from_platform.
  • nemo_platform_ext/cli/chat_tui.py: streaming reads raw SSE frames from either shape (_as_streaming_response, _LegacyStreamAdapter for the Stainless stream while it still exists).
  • jobs.watch classifies transient failures by shape (transport error or retryable HTTP status) instead of by SDK exception class.
  • nemo-optimization resolves platform agents through AgentsClient instead of the generated sdk.agents surface (that attribute does not exist on the typed client); its test serves the agent over a MockTransport instead of stubbing it.
  • Touches nemo-agents, nemo-optimization, nemo-agent-hardener, nemo-anonymizer, nemo-auditor, nemo-evaluator, nemo-safe-synthesizer and hello-world type annotations and their tests.

Stack

Part of the AIRCORE-893 series that moves the nemo CLI off the generated Stainless SDK onto the typed clients in nemo_platform_plugin (blocking AIRCORE-827). Stacked on #1986 (plumbing) but targeted at main so CI runs (the CI workflow only triggers for PRs against main/release/*). Until #1986 merges, the diff includes its commits; this PR's own change is refactor(plugins): type platform handles as PlatformClient across the plugin runtime. Review that commit, or compare against cli-typed-client-plumbing/mdubrinsky.

  1. feat(cli): typed-client plumbing for the Stainless-free CLI #1986 plumbing (typed-client seam, bootstrap, pagination and request-body helpers)
  2. In parallel on top of it: refactor(cli): rewrite workspaces, projects and iam on typed clients #1999 core groups 1 (secrets, workspaces, projects, iam), refactor(cli): rewrite files, models, adapters and inference on typed clients #2000 core groups 2 (files, models, adapters, inference), refactor(cli): host guardrail, intake and experiments in their owning packages #2001 plugin-hosted groups (guardrail, intake, experiments), refactor(plugins): type platform handles as PlatformClient across the plugin runtime #2002 plugin runtime typing, refactor(cli): run nemo setup on typed clients #2003 setup
  3. refactor(cli)!: drop the generated Stainless command tree and the CLI generator #2004 final flip: drop get_client()'s Stainless path, delete cli/commands/api/* and the CLI generator

Status: draft. Being maintained by an agent on behalf of @mdubrinsky; it re-bases on #1986 as that moves and on @ironcommit's landing plugin migrations (#1971, #1973), and picks up CI and review feedback. It will be re-cut where those PRs overlap (noted per PR below).

Type of Change

  • Code change (feature, bug fix, or refactor)
  • Code change with documentation updates
  • Documentation only
  • Contributor tooling or automation
  • CI, build, or test infrastructure

Quality Gates

  • Tests added or updated for changed behavior
  • Existing tests cover changed behavior — justification:
  • Tests not applicable — justification:
  • Documentation updated for user-visible behavior
  • Documentation not applicable — justification: no user-visible CLI change; --help output and docs/cli/reference.mdx are unchanged.

Verification

  • Pull request title follows the repository's Conventional Commit format
  • Every commit includes an appropriate Signed-off-by: trailer
  • uv run pre-commit run -a passes, or any blocked checks are identified below
  • Targeted tests pass, or tests are marked not applicable above
  • No secrets, API keys, or credentials are included

Targeted validation (on the current head, based on #1986 at 377fb4d0a):

  • uv run --frozen pytest packages/nemo_platform_ext/tests packages/nemo_platform_plugin/tests plugins/nemo-agents/tests plugins/example-plugin/tests -q --deselect packages/nemo_platform_ext/tests/cli/commands/test_services.py --deselect packages/nemo_platform_ext/tests/local/test_services.py (the two deselected files bind ports 8080/9000, which are occupied on the host): 4478 passed (ext, plugin, nemo-agents, nemo-optimization, agent-hardener, anonymizer, auditor, safe-synthesizer, hello-world, evaluator platform clients, auth bundle).
  • uv run --frozen ty check on the touched plugin packages: clean.
  • uv run ruff check and uv run ruff format --check: clean.
  • uv run pre-commit run -a: all hooks pass except uv-lock (host uv 0.9.30 vs pinned 0.9.14); uvx --from uv==0.9.14 uv lock --check passes. helm-docs and yq are not installed on the host; both hooks are CI-covered.
  • NMP_CONFIG_FILE=/tmp/nope.yaml uv run _nemo <group> --help diffed against main for every rewritten group: identical, except a trailing period on group help lines.

Adds what hand-written CLI commands need from nemo_platform_plugin:

- InferenceGatewayClient (provider/model/openai proxy routes, provider_ready,
  raw SSE streams, OpenAI model listing) with endpoint and wire tests.
- client_from_platform accepts a NemoClient or AsyncNemoClient and derives
  the typed client with from_client, so callers no longer need to know which
  platform handle they hold; PlatformClient is the runtime-checkable
  structural type for that parameter and platform_default_headers reads
  identity headers off either shape.
- models.refs holds the pure model-reference helpers; packages/models
  re-exports them so the CLI does not import the Stainless-bound package.
- filesets.transfer holds SDK-free upload/download/list/delete; FilesResource
  delegates to it and filesets no longer imports .resources eagerly.
- Bearer tokens are resolved on every HTTP attempt rather than baked into the
  PreparedRequest, so retries and later pages never replay a stale token.
- A 409 on a create sent with exist_ok is no longer retried before send()
  resolves it by fetching the existing entity.
- Query-param TypedDicts and request models for files, iam, virtual models
  and workspaces gain the fields the CLI exposes; GuardrailConfig.data is
  optional to match the server entity.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
…ands

Additive plumbing so command groups can be rewritten on the typed clients
one PR at a time while the generated commands keep working:

- client/bootstrap.py resolves config, OIDC discovery and token providers
  without the generated SDK and builds NemoClient/AsyncNemoClient with the
  same retry policy, TLS verification and 5 s connect cap the SDK used;
  factory.py layers the NeMoPlatform constructors on top of it.
- CLIContext.typed_client(XClient) / async_typed_client derive a service
  client that shares the platform client's transport and auth; get_workspace
  exposes the configured default.
- pagination gains collect_offset_pages / collect_cursor_pages for typed
  paginated responses, carrying the server's envelope fields (sort, filter,
  grouped_by) into JSON output; fetch_all_pages stays for generated commands.
- errors maps typed-client and pydantic errors alongside the SDK ones
  (validation and unknown --input-data keys exit 2), and recognises every
  unresolved-workspace message.
- stdin_utils.build_request_body validates --input-data into a request
  model and rejects unknown keys instead of dropping them.
- code_generator renders typed-client snippets (request models as
  constructor calls, SecretStr masked, RootModel positional); generated
  commands are routed to legacy_code_generator until they are replaced.
- waiters accept either platform handle, poll with a monotonic clock and
  normalise str-enum statuses; formatters unwrap NemoResponse; the version
  flag reads distribution metadata; command groups no longer advertise
  shell completion (the root app owns it).

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
…p calls it

The new test endpoint stubs raise NotImplementedError like their siblings
instead of an ellipsis body, which ty rejects as an implicit None return.
The auth-idp CLI refresh contract test patches discover_nmp_config on
client.bootstrap, where the CLI now resolves OIDC settings.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
AllPagesResponse and OffsetPageResponse emit the server envelope fields,
but callers that build them without an envelope (fetch_all_pages behind
the generated list commands, and nemo jobs list --all-pages) lost the
sort key that list output has always carried. sort is now always present,
null when the server did not echo one, and a real envelope keeps its own
field order.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
- Narrow the platform handle from object to PlatformClient in
  client_from_platform and platform_default_headers (adapter.py) and the
  nemo.sdk resource-factory owner in NemoPluginSDKResources (sdk.py), so
  the typed-client boundary stops erasing the type where plugins are built.
- build_request_body reports each field's accepted input alias in the
  unknown-input hint (schema, not the internal schema_) so the advertised
  key is one pydantic actually accepts.
- with_options now clears a clone's cached nemo.sdk plugin resources,
  which were built against the original client's transport, so typed
  clients accessed on the clone bind to its headers/retry/timeout.
- Drop the always-false _PLATFORM_JOB_LIFECYCLE watch exclusions from the
  legacy code generator's lifecycle helpers.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
Brings in the auth-off-Stainless SDK removal, customization typed-client
migration, and sandbox forward merges. Resolves conflicts in adapter.py and
client.py by combining both sides: keep main's _owns_http lifecycle
(owns_http_client=False) and _platform_default_headers header resolution,
and keep the PlatformClient narrowing plus the with_options cached-resource
clearing added for review.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
The main merge kept the typed resource factories on PlatformClient but took
main's __all__ which no longer re-exports NeMoPlatform/AsyncNeMoPlatform, so
the import became dead and tripped the ruff pre-commit hook (lint-python-style).

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
Plugins (nemo-evaluator among others) import the generated NeMoPlatform /
AsyncNeMoPlatform classes from nemo_platform_plugin.sdk. My earlier drop of
that import broke them with an ImportError. Re-export lazily through a module
__getattr__ so plugin discovery still imports this module without requiring
the generated SDK at load time.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
Brings in guardrails typed-client (#1966) and other main changes. Resolved
guardrail/types.py to main's landed GuardrailConfig.data shape (RailsConfig,
typed) per the layered-merge rule, and took main's add/add
tests/guardrail/test_endpoints.py. Also fixes the sdk.py re-export regression
in the same push.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch from 70dc8eb to bb241f5 Compare September 11, 2026 18:37
@maxdubrinsky
maxdubrinsky changed the base branch from cli-typed-client-plumbing/mdubrinsky to main September 11, 2026 18:50
@maxdubrinsky maxdubrinsky reopened this Sep 11, 2026
@github-actions

github-actions Bot commented Sep 11, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 44597/56551 78.9% 62.6%
Integration Tests 27682/53809 51.4% 22.6%

…bing-merge

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>

# Conflicts:
#	packages/nemo_platform_ext/src/nemo_platform_ext/cli/core/errors.py
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch from bb241f5 to 7629994 Compare September 11, 2026 20:17
…bing-merge

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch from 7629994 to 1be1dcf Compare September 11, 2026 20:41
…bing-merge

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch from 1be1dcf to fe37d9d Compare September 11, 2026 20:53
…bing-merge

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>

# Conflicts:
#	packages/nemo_platform_plugin/tests/client/test_adapter.py
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch 2 times, most recently from f79b942 to 8cd956a Compare September 11, 2026 21:12
…bing-merge

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
… plugin runtime

Plugin discovery, the scheduler, seed jobs, job result plumbing, the job
API factory and the plugins that build on them (nemo-agents,
nemo-optimization, nemo-agent-hardener, anonymizer, auditor, evaluator,
safe-synthesizer, hello-world) annotated the platform handle they receive
as the generated NeMoPlatform / AsyncNeMoPlatform classes even though they
only forward it to client_from_platform. They now use the structural
PlatformClient type, so the plugin runtime and nemo-agents import without
the generated SDK installed. nemo_platform_plugin.sdk keeps re-exporting
the generated classes for plugins that still import them from there.

jobs.watch classifies transient failures by shape (transport error or
retryable HTTP status) instead of by SDK exception class.

chat_tui decodes SSE itself and consumes typed BinaryContent streams; the
generated SDK's streaming context manager is adapted until nemo chat moves
over. The agent-hardener CLI builds a NemoClient directly.

Rebased over #1973, which reworked nemo-agents' call sites: main's versions
of those files win. This PR keeps the three nemo-agents modules #1973 left
on the generated SDK (optimize_cli, usage/cli, usage/sources/fileset) plus
the other plugins. nemo-optimization resolves platform agents through
AgentsClient instead of the generated sdk.agents surface, since that
attribute does not exist on the typed client; the test serves the agent
over a MockTransport instead of stubbing it.

Signed-off-by: Max Dubrinsky <mdubrinsky@nvidia.com>
@maxdubrinsky
maxdubrinsky force-pushed the cli-plugin-runtime-typed/mdubrinsky branch from 8cd956a to 3fcc785 Compare September 11, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant