Implement translations from E2DR to DR2E #60

gasperzgonec · 2025-08-19T13:50:34Z

Added isEventType function from devrev-adaas-typescript.
Added a function for event type translation and added mapping from old names to the new ones.

Summary

Migrated event type names from old E2DR to DR2E naming convention.
Added a simple function for easier translation and migration.

Connected Issues

#ISS-131089

Craftsmanship, Integrity, and Devil’s Advocacy

Testing: Negative test cases: null or default values, crash and fault injection tests
Testing: Boundary conditions: rolling upgrades, denial-of-service, etc.
Testing: Fixing a few existing — flaky or permanently-broken — test cases
Observing: Detailed error codes so machines can understand
Observing: Adding superior metrics for future debugging
Observing: Tracing the hairiest pathways for field serviceability
Training: KnowledgeOps update? So AI always works.

Story of the craft

src/common/helpers.ts

src/tests/timeout-handling/timeout-3a.test.ts

patricijabrecko

@GasperSenk we need to wait for changes in the snap-in manager before we can promote this right?

src/common/helpers.ts

src/types/extraction.ts

src/common/helpers.ts

gasperzgonec · 2025-10-28T09:12:41Z

There's some backward-incompatible changes due to changes inside of the enum values.
These cannot be fixed, as the point of this change was changing these values, so this test will fail intentionally.

…d names to the new ones.

…mount of changes needed on snap-in side.

gasperzgonec · 2025-10-28T09:56:34Z

These changes have been tested against a snap-in and show no regressions.
Backward tests show no errors (aside the aforementioned issues with the enum values).
Tests pass.

Copilot

Pull Request Overview

This PR migrates event type naming from the old E2DR (Extraction-to-DevRev) convention to the new DR2E (DevRev-to-Extraction) convention. The changes introduce a translation function to handle backward compatibility with legacy event type names while updating all enum values to the new naming scheme.

Key Changes:

Added getEventType() translation function with mapping table for old-to-new event type names
Updated all EventType and ExtractorEventType enum values to new DR2E naming convention
Applied translation at spawn entry point to convert incoming events to new format

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

File	Description
src/common/helpers.ts	Implements translation function and mapping table for event type migration
src/types/extraction.ts	Updates enum values from E2DR to DR2E naming convention, adds UnknownEventType
src/workers/spawn.ts	Applies event type translation at spawn entry point
src/tests/timeout-handling/*.test.ts	Updates test expectations to use enum constants instead of string literals

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

src/workers/spawn.ts

src/common/helpers.ts

GasperSenk · 2025-10-28T13:37:47Z

Lets write down from which version of the SDK, the SDK will accept new event types.

It can start returning new event types now as the gateway is already translating them.

radovanjorgic · 2025-11-03T18:00:49Z

src/workers/spawn.ts

  initialDomainMapping,
  options,
 }: SpawnFactoryInterface<ConnectorState>): Promise<void> {
+  event.payload.event_type = getEventType(event.payload.event_type);


Did you check if this is the only place where we need to do this translation?
Also, do you think it is worth creating some transform/translateEvent function which transforms the whole event in new event with some fields edited or structure changed a bit (in case we need it in future)?

Let's also mark with comment (or add TODO) that this is temporary change and will be removed once SIM starts sending and receiving only new event types.

radovanjorgic · 2025-11-03T18:14:10Z

src/common/helpers.ts

+ *   2) Valid DR2E names are returned as-is
+ *   3) Unknown values return `UnknownEventType`
+ */
+export function getEventType(eventType: string): EventType {


I would rename this to sth like transform/translateEventType, since we already have event type but need to translate it to the new one.

radovanjorgic · 2025-11-03T18:20:10Z

src/types/extraction.ts

+  ExtractionExternalSyncUnitsStart = 'START_EXTRACTING_EXTERNAL_SYNC_UNITS',
+  ExtractionMetadataStart = 'START_EXTRACTING_METADATA',
+  ExtractionDataStart = 'START_EXTRACTING_DATA',
+  ExtractionDataContinue = 'CONTINUE_EXTRACTING_DATA',
+  ExtractionDataDelete = 'START_DELETING_EXTRACTOR_STATE',
+  ExtractionAttachmentsStart = 'START_EXTRACTING_ATTACHMENTS',
+  ExtractionAttachmentsContinue = 'CONTINUE_EXTRACTING_ATTACHMENTS',
+  ExtractionAttachmentsDelete = 'START_DELETING_EXTRACTOR_ATTACHMENTS_STATE',

  // Loading
  StartLoadingData = 'START_LOADING_DATA',
  ContinueLoadingData = 'CONTINUE_LOADING_DATA',
  StartLoadingAttachments = 'START_LOADING_ATTACHMENTS',
  ContinueLoadingAttachments = 'CONTINUE_LOADING_ATTACHMENTS',
  StartDeletingLoaderState = 'START_DELETING_LOADER_STATE',
  StartDeletingLoaderAttachmentState = 'START_DELETING_LOADER_ATTACHMENT_STATE',
+
+  // Unknown
+  UnknownEventType = 'UNKNOWN_EVENT_TYPE',
 }

 /**
 * ExtractorEventType is an enum that defines the different types of events that can be sent from the external extractor to ADaaS.
 * The external extractor can use these events to inform ADaaS about the progress of the extraction process.
 */
 export enum ExtractorEventType {
  // Extraction
-  ExtractionExternalSyncUnitsDone = 'EXTRACTION_EXTERNAL_SYNC_UNITS_DONE',
-  ExtractionExternalSyncUnitsError = 'EXTRACTION_EXTERNAL_SYNC_UNITS_ERROR',
-  ExtractionMetadataDone = 'EXTRACTION_METADATA_DONE',
-  ExtractionMetadataError = 'EXTRACTION_METADATA_ERROR',
-  ExtractionDataProgress = 'EXTRACTION_DATA_PROGRESS',
-  ExtractionDataDelay = 'EXTRACTION_DATA_DELAY',
-  ExtractionDataDone = 'EXTRACTION_DATA_DONE',
-  ExtractionDataError = 'EXTRACTION_DATA_ERROR',
-  ExtractionDataDeleteDone = 'EXTRACTION_DATA_DELETE_DONE',
-  ExtractionDataDeleteError = 'EXTRACTION_DATA_DELETE_ERROR',
-  ExtractionAttachmentsProgress = 'EXTRACTION_ATTACHMENTS_PROGRESS',
-  ExtractionAttachmentsDelay = 'EXTRACTION_ATTACHMENTS_DELAY',
-  ExtractionAttachmentsDone = 'EXTRACTION_ATTACHMENTS_DONE',
-  ExtractionAttachmentsError = 'EXTRACTION_ATTACHMENTS_ERROR',
-  ExtractionAttachmentsDeleteDone = 'EXTRACTION_ATTACHMENTS_DELETE_DONE',
-  ExtractionAttachmentsDeleteError = 'EXTRACTION_ATTACHMENTS_DELETE_ERROR',
+  ExtractionExternalSyncUnitsDone = 'EXTERNAL_SYNC_UNIT_EXTRACTION_DONE',
+  ExtractionExternalSyncUnitsError = 'EXTERNAL_SYNC_UNIT_EXTRACTION_ERROR',
+  ExtractionMetadataDone = 'METADATA_EXTRACTION_DONE',
+  ExtractionMetadataError = 'METADATA_EXTRACTION_ERROR',
+  ExtractionDataProgress = 'DATA_EXTRACTION_PROGRESS',
+  ExtractionDataDelay = 'DATA_EXTRACTION_DELAYED',
+  ExtractionDataDone = 'DATA_EXTRACTION_DONE',
+  ExtractionDataError = 'DATA_EXTRACTION_ERROR',
+  ExtractionDataDeleteDone = 'EXTRACTOR_STATE_DELETION_DONE',
+  ExtractionDataDeleteError = 'EXTRACTOR_STATE_DELETION_ERROR',
+  ExtractionAttachmentsProgress = 'ATTACHMENT_EXTRACTION_PROGRESS',
+  ExtractionAttachmentsDelay = 'ATTACHMENT_EXTRACTION_DELAYED',
+  ExtractionAttachmentsDone = 'ATTACHMENT_EXTRACTION_DONE',
+  ExtractionAttachmentsError = 'ATTACHMENT_EXTRACTION_ERROR',
+  ExtractionAttachmentsDeleteDone = 'EXTRACTOR_ATTACHMENTS_STATE_DELETION_DONE',
+  ExtractionAttachmentsDeleteError = 'EXTRACTOR_ATTACHMENTS_STATE_DELETION_ERROR',


Did you carefully (really carefully!!) verified all these names with ones in airdrop-snapin-manager?

Also, is this renaming a breaking change? I know interface stayed the same but we are exporting this stuff, so what if someone relied on actual string values? I am thinking if we should rather create ExtractorEventTypeV2 and EventTypeV2, work with them and mark these as deprecated?

gasperzgonec requested review from a team, patricijabrecko and radovanjorgic as code owners August 19, 2025 13:50

gasperzgonec force-pushed the gasperz/ISS-131089 branch from 7777ab8 to bd84e89 Compare August 19, 2025 13:51

gasperzgonec requested a review from GasperSenk August 19, 2025 13:52

GasperSenk reviewed Aug 20, 2025

View reviewed changes

src/common/helpers.ts Outdated Show resolved Hide resolved

src/common/helpers.ts Outdated Show resolved Hide resolved

src/common/helpers.ts Outdated Show resolved Hide resolved

src/tests/timeout-handling/timeout-3a.test.ts Outdated Show resolved Hide resolved

patricijabrecko reviewed Aug 21, 2025

View reviewed changes

src/common/helpers.ts Outdated Show resolved Hide resolved

src/common/helpers.ts Outdated Show resolved Hide resolved

GasperSenk reviewed Aug 21, 2025

View reviewed changes

src/types/extraction.ts Show resolved Hide resolved

radovanjorgic marked this pull request as draft August 22, 2025 07:15

radovanjorgic requested changes Oct 3, 2025

View reviewed changes

src/common/helpers.ts Outdated Show resolved Hide resolved

gasperzgonec force-pushed the gasperz/ISS-131089 branch from 7d0c9ad to b02e9db Compare October 7, 2025 07:38

gasperzgonec requested a review from radovanjorgic October 16, 2025 13:46

gasperzgonec force-pushed the gasperz/ISS-131089 branch from b02e9db to 6fc6691 Compare October 28, 2025 08:19

gasperzgonec added 11 commits October 28, 2025 10:54

Added isEventType function from devrev-adaas-typescript.

b148700

Added a function for event type translation and added mapping from ol…

4067e44

…d names to the new ones.

Fixed hardcoded texts in tests.

6bac2d2

Updated enum values and now returning unknown event type.

96383a0

Renamed to camelCase and removed isEventType function to lessen the a…

b991c7d

…mount of changes needed on snap-in side.

Fixed test issue with isEventType.

25dc71f

Reverted the enum order.

cc8313c

Started using 'getEventType'.

a631c9e

Fixed a lapsus in the comparison logic.

5549e06

Fixed backward-incompatible changes.

11cf484

Prettier

1c8b9e6

gasperzgonec force-pushed the gasperz/ISS-131089 branch from 9ec0f35 to 1c8b9e6 Compare October 28, 2025 09:55

gasperzgonec requested a review from Copilot October 28, 2025 09:56

gasperzgonec marked this pull request as ready for review October 28, 2025 09:57

Copilot AI reviewed Oct 28, 2025

View reviewed changes

src/workers/spawn.ts Show resolved Hide resolved

src/common/helpers.ts Show resolved Hide resolved

Updated new function documentation

c4a1ca1

GasperSenk approved these changes Oct 28, 2025

View reviewed changes

Merge branch 'main' into gasperz/ISS-131089

f964f4d

radovanjorgic reviewed Nov 3, 2025

View reviewed changes

Implement translations from E2DR to DR2E #60

Are you sure you want to change the base?

Implement translations from E2DR to DR2E #60

Uh oh!

Conversation

gasperzgonec commented Aug 19, 2025

Summary

Connected Issues

Craftsmanship, Integrity, and Devil’s Advocacy

Story of the craft

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

patricijabrecko left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gasperzgonec commented Oct 28, 2025

Uh oh!

gasperzgonec commented Oct 28, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

GasperSenk commented Oct 28, 2025

Uh oh!

radovanjorgic Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

radovanjorgic Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

radovanjorgic Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

radovanjorgic Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

radovanjorgic Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants