feat: add delete_event_type() to sync and async clients (ERA-12656) by JoshuaVulcan · Pull Request #30 · PADAS/er-client

JoshuaVulcan · 2026-02-10T23:57:35Z

Summary

Adds delete_event_type(value, version) method to both ERClient (sync) and AsyncERClient (async), targeting the v2.0 activity/eventtypes/{slug} endpoint by default.
Adds event_type_delete_path() helper to api_paths.py for centralized path resolution.
Adds base_url parameter to both sync and async _delete() methods to support versioned endpoints, plus 409 Conflict handling for the server's dependency-check response.

Motivation

The das server's EventTypesViewSet supports a destroy() action (v2.0) that returns 204 on success or 409 Conflict when the event type has associated events or alert rules. The er-client was missing this capability entirely.

Jira: ERA-12656

Test plan

9 async tests covering success (v2 default, explicit v2, v1 fallback, alias), 404, 403, 409 (two conflict variants), 500
10 sync tests covering the same scenarios plus base URL assembly
4 api_paths unit tests for the new event_type_delete_path() helper
Full test suite passes: 177 tests, 0 failures

Note

This branch builds on top of the API versioning infrastructure from PR #23 (cd/support-api-versions), which was merged locally. Once that PR lands in main, this PR should merge cleanly.

…ia _call + 204 - Remove .cursor/plans/purely_async_er2er_f2b9c60a.plan.md (IDE artifact) - Add .cursor/ to .gitignore to prevent recurrence - Async _delete: delegate to _call() with 204 and DELETE 409 handling in _call - Update async test for 500 to accept ERClientInternalError message Co-authored-by: Cursor <cursoragent@cursor.com>

…R2Er event sharing)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…RClient

Implements the v2 event type DELETE endpoint for both ERClient and AsyncERClient. The method defaults to v2.0 (activity/eventtypes/{slug}) since the destroy action is primarily supported on the v2 viewset. Changes: - Add event_type_delete_path() helper to api_paths.py - Add base_url parameter to sync _delete() for versioned endpoints - Add base_url parameter to async _delete() for versioned endpoints - Add 409 Conflict handling in both sync/async _delete() methods - Add delete_event_type() to ERClient (sync) - Add delete_event_type() to AsyncERClient (async) - Add comprehensive tests: 9 async, 10 sync, 4 api_paths (23 new tests) All 177 tests pass. Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

…n message Client raises ERClientInternalError with 'Internal Server Error' in the message, not 'Failed to delete'. Update pytest.raises match regex accordingly. Co-authored-by: Cursor <cursoragent@cursor.com>

Co-authored-by: Cursor <cursoragent@cursor.com>

Copilot

Pull request overview

Adds client support for deleting Event Types via the ER API (defaulting to v2.0), including centralized path generation and comprehensive sync/async tests.

Changes:

Introduces delete_event_type(value, version) on both ERClient and AsyncERClient (default v2.0).
Adds event_type_delete_path() to erclient/api_paths.py for version-aware delete endpoint construction.
Adds new unit tests for the path helper and new sync/async delete behavior across success and error scenarios.

Reviewed changes

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

Show a summary per file

File	Description
`erclient/api_paths.py`	Adds `event_type_delete_path()` to build versioned delete paths.
`erclient/client.py`	Adds `delete_event_type()` to sync/async clients; updates sync `_delete()` to accept `base_url` + handle 409 conflicts.
`tests/test_api_paths.py`	Adds unit tests for the new delete-path helper across versions/aliases/error.
`tests/sync_client/test_delete_event_type.py`	Adds sync delete_event_type tests for v2 default, v1, alias, and error handling.
`tests/async_client/test_delete_event_type.py`	Adds async delete_event_type tests for v2 default, v1, alias, and error handling.
`.cursor/plans/purely_async_er2er_f2b9c60a.plan.md`	Adds a Cursor plan document (non-runtime artifact).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

erclient/client.py

+        self.logger.debug('Deleting event type: %s (version %s)', value, version)
+        path = event_type_delete_path(version, value)
+        base_url = self._api_root(version)
+        result = await self._delete(path, base_url=base_url)


erclient/client.py

+    async def delete_event_type(self, value, version=VERSION_2_0):
+        """
+        Delete an event type by its slug (value).
+
+        The das server returns 204 No Content on success, or 409 Conflict if
+        the event type has associated events or alert rules.
+
+        :param value: The event type slug/value (e.g. "immobility_rep").
+        :param version: API version segment. Defaults to v2.0 because the
+            destroy action is primarily supported on the v2 endpoint.
+        :returns: True on successful deletion.
+        :raises ERClientNotFound: If the event type does not exist.
+        :raises ERClientException: If the server returns 409 Conflict (event
+            type is in use) or another error.
+        """
+        self.logger.debug('Deleting event type: %s (version %s)', value, version)
+        path = event_type_delete_path(version, value)
+        base_url = self._api_root(version)
+        result = await self._delete(path, base_url=base_url)
+        self.logger.debug('Result of event type delete: %s', result)
+        return result
+


.cursor/plans/purely_async_er2er_f2b9c60a.plan.md

+---
+name: Purely async er2er
+overview: "Remove the sync fallback so the connector uses only the async path: require AsyncERClient, drop asyncio.to_thread for client build and run_sync, and optionally remove now-unused sync-only code from er2er_syncher."
+todos: []
+isProject: false
+---
+
+# Purely async er2er
+
+## Current flow
+
+```mermaid
+flowchart LR
+  subgraph main [er2er_main extract]
+    A{ASYNC_ER_CLIENT_AVAILABLE?}
+    A -->|yes| B[build_async_er_clients]
+    A -->|no| C[asyncio.to_thread build_er_clients]
+    B --> D[async_run_sync]
+    C --> D
+    D --> E{Both AsyncERClient?}
+    E -->|yes| F[_async_run_sync_impl]
+    E -->|no| G[asyncio.to_thread run_sync]
+  end
+```
+
+
+
+After the change: only the top/left path (async clients + `_async_run_sync_impl`). No `to_thread`, no sync fallback.
+
+## 1. Require AsyncERClient in [er2er_main.py](cdip-integrations/er2er/er2er_main.py)
+
+- **Remove** the `else` branch (lines 91–99) that calls `asyncio.to_thread(build_er_clients, ...)`.
+- **Require async:** When `ASYNC_ER_CLIENT_AVAILABLE` is false, raise a clear error before building clients (e.g. `ER2ERSync_ConfigError` or `RuntimeError`) with a message that AsyncERClient is required (e.g. "er-client async support is required; AsyncERClient could not be imported").
+- **Remove** the `build_er_clients` import from `er2er_syncher`.
+- **Keep** the `if ASYNC_ER_CLIENT_AVAILABLE:` block but change it to: always call `build_async_er_clients`; if the flag is false, raise instead of falling back.
+
+Result: connector only builds async clients and fails fast if async is unavailable.
+
+## 2. Require AsyncERClient in [er2er_syncher.py](cdip-integrations/er2er/er2er_syncher.py) `async_run_sync`
+
+- **Remove** the fallback that runs `run_sync` via `asyncio.to_thread` (lines 1500–1508).


JoshuaVulcan requested review from chrisdoehring and chrisj-er February 10, 2026 23:57

JoshuaVulcan added autoreviewing PR is currently being auto-reviewed and removed autoreviewing PR is currently being auto-reviewed labels Feb 11, 2026

vgarcia13 and others added 25 commits February 11, 2026 10:16

v1.8.1: Add required logic to support the new ER v2 Events API (for E…

95a489f

…R2Er event sharing)

Update client.py

91a8dd0

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

v1.8.1: Some refactors

95f9b70

Update erclient/client.py

e108784

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

v1.8.1: Unit tests

9b1057c

feat: add API version arguments.

2c67583

make autopep8 happy.

be6840c

add constants for API versions.

ddf73e1

add module exports.

60ea6b8

refactor: add function to AsyncERClient.

584944e

reafactor: update recent unit tests for new api-path feature.

dbc14a0

Add workflow for unit tests

3c805f5

Rename README.MD to README.md

6a61ffa

fix: remove unsupported arg in get_file for async.

5395bb0

remove unused fixture

1e93de2

refactor: update test error logging to use full request URL in AsyncE…

1040f5a

…RClient

fix: coding error in api_paths module.

5bd1e32

refactor: guard against various version values.

d96261c

refactor: guard against non-standard service root.

3c1d6c3

fix: more path normalization guards.

7209894

fix: add guards for str use of Event Ids.

8c3c2cc

chore: add test coverage, deprecate post_report_attachment

a448578

add get_event() function.

6f77762

chore: use canonical async _delete (remove duplicate implementation)

1565e44

Co-authored-by: Cursor <cursoragent@cursor.com>

JoshuaVulcan force-pushed the ERA-12656/v2-event-type-delete branch from a603ea0 to 1565e44 Compare February 11, 2026 18:17

Fix test_delete_event_type_server_error_raises: match actual exceptio…

d8fdf89

…n message Client raises ERClientInternalError with 'Internal Server Error' in the message, not 'Failed to delete'. Update pytest.raises match regex accordingly. Co-authored-by: Cursor <cursoragent@cursor.com>

JoshuaVulcan requested a review from a team as a code owner February 11, 2026 22:20

Merge main into ERA-12656/v2-event-type-delete

eebf573

Co-authored-by: Cursor <cursoragent@cursor.com>

chrisdoehring requested a review from Copilot March 13, 2026 18:42

Copilot started reviewing on behalf of chrisdoehring March 13, 2026 18:42 View session

Copilot AI reviewed Mar 13, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add delete_event_type() to sync and async clients (ERA-12656)#30

feat: add delete_event_type() to sync and async clients (ERA-12656)#30
JoshuaVulcan wants to merge 27 commits intomainfrom
ERA-12656/v2-event-type-delete

JoshuaVulcan commented Feb 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

JoshuaVulcan commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Test plan

Note

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

JoshuaVulcan commented Feb 10, 2026 •

edited

Loading