feat(integrations): Update example integration for api pipeline by evanpurkhiser · Pull Request #113350 · getsentry/sentry

evanpurkhiser · 2026-04-17T20:11:06Z

No description provided.

github-actions · 2026-04-17T20:17:40Z

Backend Test Failures

Failures on fa2a8af in this run:

tests/sentry/integrations/web/test_organization_integration_setup.py::OrganizationIntegrationSetupTest::test_allow_integration_with_all_features_disabled_but_one_unregistered

— log

[gw0] linux -- Python 3.13.1 /home/runner/work/sentry/sentry/.venv/bin/python3
tests/sentry/integrations/web/test_organization_integration_setup.py:71: in test_allow_integration_with_all_features_disabled_but_one_unregistered
    self.test_basic_flow()
tests/sentry/integrations/web/test_organization_integration_setup.py:34: in test_basic_flow
    resp = self.client.get(self.path)
.venv/lib/python3.13/site-packages/django/test/client.py:1124: in get
    response = super().get(
.venv/lib/python3.13/site-packages/django/test/client.py:475: in get
    return self.generic(
.venv/lib/python3.13/site-packages/django/test/client.py:671: in generic
    return self.request(**r)
.venv/lib/python3.13/site-packages/django/test/client.py:1087: in request
    self.check_exception(response)
.venv/lib/python3.13/site-packages/django/test/client.py:802: in check_exception
    raise exc_value
.venv/lib/python3.13/site-packages/django/core/handlers/exception.py:55: in inner
    response = get_response(request)
.venv/lib/python3.13/site-packages/django/core/handlers/base.py:197: in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
.venv/lib/python3.13/site-packages/django/views/generic/base.py:105: in view
    return self.dispatch(request, *args, **kwargs)
src/sentry/silo/base.py:157: in override
    return original_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/utils/decorators.py:48: in _wrapper
    return bound_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/views/decorators/csrf.py:65: in _view_wrapper
    return view_func(request, *args, **kwargs)
src/sentry/web/frontend/base.py:475: in dispatch
    return self.handle(request, *args, **kwargs)
src/sentry/integrations/web/organization_integration_setup.py:29: in handle
    return pipeline.current_step()
src/sentry/pipeline/base.py:184: in current_step
    return self.finish_pipeline()
src/sentry/integrations/pipeline.py:234: in finish_pipeline
    data = self.provider.build_integration(self.state.data)
src/sentry/integrations/example/integration.py:264: in build_integration
    return {"external_id": state["name"]}
E   KeyError: 'name'

tests/sentry/integrations/web/test_organization_integration_setup.py::OrganizationIntegrationSetupTest::test_regular_provider_unaffected_by_requires_feature_flag_check

— log

[gw0] linux -- Python 3.13.1 /home/runner/work/sentry/sentry/.venv/bin/python3
tests/sentry/integrations/web/test_organization_integration_setup.py:96: in test_regular_provider_unaffected_by_requires_feature_flag_check
    resp = self.client.get(self.path)
.venv/lib/python3.13/site-packages/django/test/client.py:1124: in get
    response = super().get(
.venv/lib/python3.13/site-packages/django/test/client.py:475: in get
    return self.generic(
.venv/lib/python3.13/site-packages/django/test/client.py:671: in generic
    return self.request(**r)
.venv/lib/python3.13/site-packages/django/test/client.py:1087: in request
    self.check_exception(response)
.venv/lib/python3.13/site-packages/django/test/client.py:802: in check_exception
    raise exc_value
.venv/lib/python3.13/site-packages/django/core/handlers/exception.py:55: in inner
    response = get_response(request)
.venv/lib/python3.13/site-packages/django/core/handlers/base.py:197: in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
.venv/lib/python3.13/site-packages/django/views/generic/base.py:105: in view
    return self.dispatch(request, *args, **kwargs)
src/sentry/silo/base.py:157: in override
    return original_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/utils/decorators.py:48: in _wrapper
    return bound_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/views/decorators/csrf.py:65: in _view_wrapper
    return view_func(request, *args, **kwargs)
src/sentry/web/frontend/base.py:475: in dispatch
    return self.handle(request, *args, **kwargs)
src/sentry/integrations/web/organization_integration_setup.py:29: in handle
    return pipeline.current_step()
src/sentry/pipeline/base.py:184: in current_step
    return self.finish_pipeline()
src/sentry/integrations/pipeline.py:234: in finish_pipeline
    data = self.provider.build_integration(self.state.data)
src/sentry/integrations/example/integration.py:264: in build_integration
    return {"external_id": state["name"]}
E   KeyError: 'name'

tests/sentry/integrations/web/test_organization_integration_setup.py::OrganizationIntegrationSetupTest::test_allow_integration_with_all_features_enabled

— log

[gw0] linux -- Python 3.13.1 /home/runner/work/sentry/sentry/.venv/bin/python3
tests/sentry/integrations/web/test_organization_integration_setup.py:51: in test_allow_integration_with_all_features_enabled
    self.test_basic_flow()
tests/sentry/integrations/web/test_organization_integration_setup.py:34: in test_basic_flow
    resp = self.client.get(self.path)
.venv/lib/python3.13/site-packages/django/test/client.py:1124: in get
    response = super().get(
.venv/lib/python3.13/site-packages/django/test/client.py:475: in get
    return self.generic(
.venv/lib/python3.13/site-packages/django/test/client.py:671: in generic
    return self.request(**r)
.venv/lib/python3.13/site-packages/django/test/client.py:1087: in request
    self.check_exception(response)
.venv/lib/python3.13/site-packages/django/test/client.py:802: in check_exception
    raise exc_value
.venv/lib/python3.13/site-packages/django/core/handlers/exception.py:55: in inner
    response = get_response(request)
.venv/lib/python3.13/site-packages/django/core/handlers/base.py:197: in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
.venv/lib/python3.13/site-packages/django/views/generic/base.py:105: in view
    return self.dispatch(request, *args, **kwargs)
src/sentry/silo/base.py:157: in override
    return original_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/utils/decorators.py:48: in _wrapper
    return bound_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/views/decorators/csrf.py:65: in _view_wrapper
    return view_func(request, *args, **kwargs)
src/sentry/web/frontend/base.py:475: in dispatch
    return self.handle(request, *args, **kwargs)
src/sentry/integrations/web/organization_integration_setup.py:29: in handle
    return pipeline.current_step()
src/sentry/pipeline/base.py:184: in current_step
    return self.finish_pipeline()
src/sentry/integrations/pipeline.py:234: in finish_pipeline
    data = self.provider.build_integration(self.state.data)
src/sentry/integrations/example/integration.py:264: in build_integration
    return {"external_id": state["name"]}
E   KeyError: 'name'

tests/sentry/integrations/web/test_organization_integration_setup.py::OrganizationIntegrationSetupTest::test_allow_integration_with_one_feature_enabled

— log

[gw0] linux -- Python 3.13.1 /home/runner/work/sentry/sentry/.venv/bin/python3
tests/sentry/integrations/web/test_organization_integration_setup.py:60: in test_allow_integration_with_one_feature_enabled
    self.test_basic_flow()
tests/sentry/integrations/web/test_organization_integration_setup.py:34: in test_basic_flow
    resp = self.client.get(self.path)
.venv/lib/python3.13/site-packages/django/test/client.py:1124: in get
    response = super().get(
.venv/lib/python3.13/site-packages/django/test/client.py:475: in get
    return self.generic(
.venv/lib/python3.13/site-packages/django/test/client.py:671: in generic
    return self.request(**r)
.venv/lib/python3.13/site-packages/django/test/client.py:1087: in request
    self.check_exception(response)
.venv/lib/python3.13/site-packages/django/test/client.py:802: in check_exception
    raise exc_value
.venv/lib/python3.13/site-packages/django/core/handlers/exception.py:55: in inner
    response = get_response(request)
.venv/lib/python3.13/site-packages/django/core/handlers/base.py:197: in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
.venv/lib/python3.13/site-packages/django/views/generic/base.py:105: in view
    return self.dispatch(request, *args, **kwargs)
src/sentry/silo/base.py:157: in override
    return original_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/utils/decorators.py:48: in _wrapper
    return bound_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/views/decorators/csrf.py:65: in _view_wrapper
    return view_func(request, *args, **kwargs)
src/sentry/web/frontend/base.py:475: in dispatch
    return self.handle(request, *args, **kwargs)
src/sentry/integrations/web/organization_integration_setup.py:29: in handle
    return pipeline.current_step()
src/sentry/pipeline/base.py:184: in current_step
    return self.finish_pipeline()
src/sentry/integrations/pipeline.py:234: in finish_pipeline
    data = self.provider.build_integration(self.state.data)
src/sentry/integrations/example/integration.py:264: in build_integration
    return {"external_id": state["name"]}
E   KeyError: 'name'

tests/sentry/integrations/web/test_organization_integration_setup.py::OrganizationIntegrationSetupTest::test_basic_flow — log

[gw0] linux -- Python 3.13.1 /home/runner/work/sentry/sentry/.venv/bin/python3
tests/sentry/integrations/web/test_organization_integration_setup.py:34: in test_basic_flow
    resp = self.client.get(self.path)
.venv/lib/python3.13/site-packages/django/test/client.py:1124: in get
    response = super().get(
.venv/lib/python3.13/site-packages/django/test/client.py:475: in get
    return self.generic(
.venv/lib/python3.13/site-packages/django/test/client.py:671: in generic
    return self.request(**r)
.venv/lib/python3.13/site-packages/django/test/client.py:1087: in request
    self.check_exception(response)
.venv/lib/python3.13/site-packages/django/test/client.py:802: in check_exception
    raise exc_value
.venv/lib/python3.13/site-packages/django/core/handlers/exception.py:55: in inner
    response = get_response(request)
.venv/lib/python3.13/site-packages/django/core/handlers/base.py:197: in _get_response
    response = wrapped_callback(request, *callback_args, **callback_kwargs)
.venv/lib/python3.13/site-packages/django/views/generic/base.py:105: in view
    return self.dispatch(request, *args, **kwargs)
src/sentry/silo/base.py:157: in override
    return original_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/utils/decorators.py:48: in _wrapper
    return bound_method(*args, **kwargs)
.venv/lib/python3.13/site-packages/django/views/decorators/csrf.py:65: in _view_wrapper
    return view_func(request, *args, **kwargs)
src/sentry/web/frontend/base.py:475: in dispatch
    return self.handle(request, *args, **kwargs)
src/sentry/integrations/web/organization_integration_setup.py:29: in handle
    return pipeline.current_step()
src/sentry/pipeline/base.py:184: in current_step
    return self.finish_pipeline()
src/sentry/integrations/pipeline.py:234: in finish_pipeline
    data = self.provider.build_integration(self.state.data)
src/sentry/integrations/example/integration.py:264: in build_integration
    return {"external_id": state["name"]}
E   KeyError: 'name'

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 20a4328. Configure here.}

cursor · 2026-04-20T15:56:05Z


    def build_integration(self, state: Mapping[str, Any]) -> IntegrationData:
-        return {"external_id": state["name"]}
+        return {"external_id": state.get("name", "example")}


Silent default masks missing pipeline state errors

Low Severity

The combination of get_pipeline_views() returning [] and build_integration using state.get("name", "example") means the legacy HTML setup path now silently auto-installs an integration with external_id="example" on any GET request — no user input required. Previously, the pipeline showed a form and state["name"] would fail-fast with a KeyError if the name wasn't bound. The silent fallback could mask real pipeline state binding failures in the API flow too, creating integrations with a hardcoded "example" external_id instead of surfacing the error.

Additional Locations (1)

src/sentry/integrations/example/integration.py#L244-L246

^{Reviewed by Cursor Bugbot for commit 20a4328. Configure here.}

evanpurkhiser requested review from a team as code owners April 17, 2026 20:11

evanpurkhiser requested review from a team and removed request for a team April 17, 2026 20:11

github-actions Bot added the Scope: Backend Automatically applied to PRs that change backend components label Apr 17, 2026

vercel Bot deployed to Preview April 17, 2026 20:12 View deployment

wedamija approved these changes Apr 17, 2026

View reviewed changes

evanpurkhiser force-pushed the evanpurkhiser/feat-integrations-update-example-integration-for-api-pipeline branch from bec3dfa to 5fe974e Compare April 20, 2026 15:45

vercel Bot deployed to Preview April 20, 2026 15:47 View deployment

evanpurkhiser force-pushed the evanpurkhiser/feat-integrations-update-example-integration-for-api-pipeline branch from 5fe974e to 20a4328 Compare April 20, 2026 15:49

vercel Bot deployed to Preview April 20, 2026 15:50 View deployment

sentry Bot reviewed Apr 20, 2026

View reviewed changes

Comment thread src/sentry/integrations/example/integration.py

cursor Bot reviewed Apr 20, 2026

View reviewed changes

feat(integrations): Update example integration for api pipeline

5e6a694

evanpurkhiser force-pushed the evanpurkhiser/feat-integrations-update-example-integration-for-api-pipeline branch from 20a4328 to 5e6a694 Compare April 21, 2026 13:52

vercel Bot deployed to Preview April 21, 2026 13:54 View deployment

evanpurkhiser merged commit b755e96 into master Apr 21, 2026
57 checks passed

evanpurkhiser deleted the evanpurkhiser/feat-integrations-update-example-integration-for-api-pipeline branch April 21, 2026 19:39

sentry-release-bot Bot mentioned this pull request Apr 22, 2026

publish: getsentry/sentry@26.4.1 getsentry/publish#7907

Closed

3 tasks

github-actions Bot locked and limited conversation to collaborators May 7, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(integrations): Update example integration for api pipeline#113350

feat(integrations): Update example integration for api pipeline#113350
evanpurkhiser merged 1 commit into
masterfrom
evanpurkhiser/feat-integrations-update-example-integration-for-api-pipeline

evanpurkhiser commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026 •

edited

Loading

Uh oh!

Uh oh!

cursor Bot left a comment

Uh oh!

cursor Bot Apr 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

evanpurkhiser commented Apr 17, 2026

Uh oh!

github-actions Bot commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Backend Test Failures

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor Bot Apr 20, 2026

Choose a reason for hiding this comment

Silent default masks missing pipeline state errors

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Apr 17, 2026 •

edited

Loading