Skip to content

Add Linear plugin: tasks, webhook app, MCP server - #1504

Closed
cosmicBboy wants to merge 7 commits into
mainfrom
nielsb/integrations-linear
Closed

Add Linear plugin: tasks, webhook app, MCP server#1504
cosmicBboy wants to merge 7 commits into
mainfrom
nielsb/integrations-linear

Conversation

@cosmicBboy

@cosmicBboy cosmicBboy commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

Adds plugins/linear (flyteplugins-linear), a Linear integration for Flyte 2.

What's included

Read/write from tasksLinearClient, an async GraphQL client covering teams, workflow states, issues (by TEAM-123 identifier or UUID), comments, and issue creation/updates. GraphQL errors are raised as LinearAPIError. Credentials come from a mounted flyte.Secret (LINEAR_API_KEY).

React to Linear eventsLinearAppEnvironment serves a setup/management dashboard (/) with end-to-end setup instructions (API key creation, flyte create secret commands, Linear webhook config) and status/verify endpoints, plus an HMAC-verified webhook receiver (/webhook, X-Linear-Signature) that normalizes payloads into LinearEvent objects, applies an optional team allowlist, and dispatches to on_event handlers (Issue.create, Comment.update, ...). launch_task launches runs idempotently via dedupe labels, so webhook redeliveries never launch duplicate runs.

MCP server for agents on Flyte — the read/write surface doubles as MCP tools via build_mcp_server / linear_mcp_app_env. Read-only by default; pass read_only=False for issue creation, updates, and commenting. Tool annotations come from the registry. Event ingestion is intentionally not an MCP tool — that stays with the app environment.

Tests

57 tests covering the GraphQL client (respx-mocked), webhook signature verification and event normalization, the MCP tool registry/server, dispatch idempotency, and the app dashboard/receiver endpoints.

Examples

  • examples/triage_issue.py — read/label/comment tasks
  • examples/react_to_linear_events.py — webhook app launching idempotent runs
  • examples/linear_mcp_server.py — MCP server for agents

Review pass

A follow-up commit fixes issues found while reviewing this branch.

Correctness

  • dedupe_key now folds in the entity's updatedAt. Keyed on the entity alone, every Issue.update after the first collapsed onto the first one's key and never launched a run — the dedupe check treats a succeeded run as blocking, so this was permanent.
  • team_id is resolved from the nested issue on Comment/Reaction payloads, which carry it only there. Without this the team_ids allowlist could not attribute any non-Issue event.

Robustness and security

  • ⚠️ Behavior change: the team_ids allowlist now fails closed. Events it cannot attribute to a team are skipped rather than dispatched, matching the GitHub and Slack plugins. Previously an event with no team id bypassed the allowlist entirely.
  • graphql() retries 429 with a clamped Retry-After, and logs its retries like the other plugins' clients do.
  • Signatures compare as bytes. hmac.compare_digest raises TypeError on str operands containing non-ASCII, and the signature header is attacker-controlled: ASGI servers hand Starlette raw header bytes which it decodes as latin-1, so a crafted header turned a clean 401 into a 500.

Dashboard and docs

  • The recent-events table read the 25 oldest events instead of the newest — [:25] on a deque that appends on the right — so it froze after the first 25 events.
  • Allowlist values are HTML-escaped like every other interpolated value.
  • The _dispatch module docstring said "Slack retries on non-2xx" (copy-paste from the Slack plugin).

5 new tests cover these.

Follow-up: async launching and label-only idempotency

launch_task no longer blocks the app's event loop. It and blocking_run are now async-first, wrapped with flyte's @syncify, so handlers await launch_task.aio(...). Previously the synchronous call stalled the whole event loop for the duration of two control-plane round-trips plus a launch — with every other in-flight webhook queued behind it, against sender timeouts measured in seconds. The synchronous form still works for scripts. A regression test asserts four concurrent launches overlap; against the old blocking call it measures 0.81s instead of 0.42s and fails.

Idempotency is now purely label-based. The run-name allocation is gone — it probed up to 32 candidate names via Run.get before launching under the winner. That raced with concurrent launches, silently capped how many runs one dedupe key could ever have, and treated a name as an identity it never was. Runs now carry only the dedupe=<key> label and the control plane assigns the name. run_name_for, RUN_NAME_MAX, and the prefix / run_name_base arguments are removed.

The dedupe key is explicitly caller-supplied. dedupe_key() is a sensible default, not a requirement — any string chooses a different idempotency scope.

The module docstring is also honest about the residual race: the label check is a read followed by a launch, so two simultaneous deliveries of one event can both launch. Redeliveries are seconds to minutes apart and dedupe reliably; closing the concurrent case needs a compare-and-set the control plane does not expose.

Follow-up: sync and async call forms on LinearClient

The 10 client methods are wrapped with flyte's @syncify, so each has two call forms — matching how the SDK itself exposes Run.listall, flyte.run, and flyte.serve:

# async: in `async def` tasks, webhook handlers, MCP tools
async with LinearClient() as client:
    result = await client.some_method.aio(...)

# blocking: in plain `def` tasks and scripts
with LinearClient() as client:          # note: `with`, not `async with`
    result = client.some_method(...)

__enter__/__exit__ were added so the blocking form is usable at all. They run __aenter__/__aexit__ on syncify's background loop — the same loop the syncified methods run on — so the httpx.AsyncClient is created and used on a single loop rather than straddling two.

Two call sites had to move to .aio() for correctness, not just style. Internal self. calls would otherwise deadlock, since syncify raises on a blocking call made from its own loop thread. And the MCP tool bridge (await getattr(client, name)(...)) would raise TypeError: object dict can't be used in 'await' expression on the returned value — and, had it not raised, would have stalled the MCP server's event loop for the duration of every tool call. Measured: 0 event-loop ticks during one blocking call.

The dynamic sync_*-method alternative was rejected: it works at runtime but both mypy and ty report "LinearClient" has no attribute "sync_..." and fall back to Any, so every typed caller breaks. @syncify in place resolves to SyncFunction[[...], ...] in both checkers. The package's mypy error count is unchanged at 12, all pre-existing, none in _client.py.

Tests, examples, and READMEs use .aio() on async paths and document both forms, including when not to reach for the blocking one.

Follow-up: typed event constants

on_event no longer needs hand-copied strings:

from flyteplugins.linear import events

@app_env.on_event(events.Issue.CREATE)
async def handle(event): ...

flyteplugins.linear.events adds 8 classes / 32 constants, following the ActionPhase pattern in flyte.modelsstr enums grouped by event type, so a member drops in wherever a pattern string is accepted and a typo fails at import rather than by silently never matching. events.Issue.ANY matches every action on the entity; events.Issue.CREATE matches one. Raw strings still work, for events the constants do not cover yet.

The enum base pins __str__/__format__ to str's. Without that, Python 3.11+ renders members as Class.MEMBER rather than the wire value — which would have leaked enum names into the dashboard and /api/status, since handler patterns flow into both.

Tests assert the constants equal what the parser actually produces (through the app's own _matches), that every ANY is the bare type its actions prefix, and that no value appears in two classes.

Follow-up: an end-to-end Testing guide

The README now ends with a numbered walkthrough against a real account, ordered so each step fails in isolation — exercise the client standalone before involving the platform, deploy the launched task before the app that looks it up, run it directly before any webhook is in play. Then wire up the provider, trigger a real event, and check the four places evidence lands: the provider's delivery log, /api/events, flyte get runs, and the resource itself. It ends with a troubleshooting table mapping each symptom to its cause, since 401, 503, and "200 but no run" are three different failures.

It also walks through the idempotency behaviour by hand, which is the part unit tests can only simulate.

Verified mechanically rather than by eye: every referenced example path resolves, every flyte create secret name matches the actual _config.py default, every flyte deploy <file> <env> names a real TaskEnvironment, every flyte run task is defined, and every example file still executes.

Adds plugins/linear (flyteplugins-linear), a Linear integration for Flyte:

- LinearClient: async GraphQL client covering teams, workflow states,
  issues (by identifier or UUID), comments, and issue creation/updates.
- LinearAppEnvironment: setup/management dashboard plus an HMAC-verified
  webhook receiver (X-Linear-Signature) that normalizes events and
  dispatches to handlers with a team allowlist.
- launch_task: idempotent event-driven run launching with dedupe labels.
- MCP server builder exposing the read/write surface to agents on Flyte
  (read-only by default).

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
- dedupe_key now folds in the entity's updatedAt. Keyed on the entity alone,
  every Issue.update after the first collapsed onto the first one's key and
  never launched a run.
- team_id is resolved from the nested issue on Comment/Reaction payloads,
  which carry it only there. Without this the team_ids allowlist could not
  attribute any non-Issue event.
- The team_ids allowlist now fails closed: events it cannot attribute to a
  team are skipped rather than dispatched, matching the github/slack plugins.
- graphql() retries 429 with Retry-After (clamped) and logs its retries.
- Signatures compare as bytes: a non-ASCII signature header made
  compare_digest raise TypeError, turning a 401 into a 500.
- The dashboard's recent-events table read the 25 oldest events, not the
  newest, so it froze after 25 events; allowlist values are now escaped.
- _dispatch docstring said "Slack retries" (copy-paste).
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
- launch_task and blocking_run are now async-first, wrapped with flyte's
  @Syncify. Handlers await launch_task.aio(...), so a launch no longer blocks
  the app's event loop while every other in-flight request waits behind it.
  The synchronous form still works for scripts.
- Idempotency is now entirely label-based. The run-name allocation (probe up
  to 32 candidate names via Run.get, then launch under the winner) is gone,
  along with run_name_for/RUN_NAME_MAX and the prefix and run_name_base
  arguments. Names race, cap how many runs one key can ever have, and were
  never identity — the control plane assigns them now.
- The dedupe key is documented as caller-supplied: dedupe_key() is a default,
  not a requirement.
- Examples and READMEs use the await form.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Wraps the 10 client methods with flyte's @Syncify, matching how the SDK
itself exposes Run.listall, flyte.run and flyte.serve. Each method now has
two forms: `client.foo(...)` blocks, `await client.foo.aio(...)` does not.

- Adds __enter__/__exit__ so the blocking form is actually usable. They run
  __aenter__/__aexit__ on syncify's background loop -- the same loop the
  syncified methods run on -- so the httpx.AsyncClient is created and used
  on a single loop.
- Internal self-calls use .aio(). The blocking form would deadlock when
  called from syncify's own loop thread.
- The MCP tool bridge uses .aio(). `await getattr(client, name)(...)` would
  otherwise raise TypeError on the returned value, and would stall the MCP
  server's event loop for the duration of every tool call.
- Tests, examples and READMEs use .aio() on async paths, and document both
  forms plus when not to reach for the blocking one.

The syncified client type-checks clean: mypy resolves methods to
SyncFunction[...] and the error count on the package is unchanged.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
The class docstring still demonstrated the pre-syncify async call, which no
longer works as written. It now shows the async form with .aio() and the
blocking form under a plain `with`, and says which belongs where.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
@cosmicBboy
cosmicBboy force-pushed the nielsb/integrations-linear branch from 5b653cc to daba26f Compare September 1, 2026 13:31
Adds flyteplugins.linear.events, so handlers register against constants
instead of hand-copied strings:

    @app_env.on_event(events.Issue.CREATE)

Follows the ActionPhase pattern in flyte.models: `str` enums grouped by
event type, so a member is drop-in wherever a pattern string is accepted and
a typo fails at import rather than by silently never matching. Raw strings
still work, for events the constants do not cover yet.

- The enum base pins __str__/__format__ to str's. Python 3.11+ would
  otherwise render members as "Class.MEMBER" rather than the wire value,
  which would corrupt the dashboard and /api/status output.
- Tests assert the constants equal what the parsers actually produce, that
  ANY is the bare event type every action shares as a prefix, and that no
  value appears in two classes.
- Examples, READMEs, module docstrings and the on_event docstring use them.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
A step-by-step pass a human can follow against a real account: create the
credentials, verify the client standalone, deploy the task the receiver
launches, run it directly, deploy the app, wire the provider up, trigger a
real event, and confirm idempotency. Ends with a troubleshooting table
mapping each failure mode to its cause.

Ordered so each step fails in isolation: the client is exercised before the
platform, and the launched task is deployed before the app that looks it up.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VKZrTNjjWVzTZUxDFbn4Nk

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
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.

1 participant