Skip to content

ADaaS revision #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions fern/docs/img/adaas/adaas-architecture.mmd

This file was deleted.

1 change: 0 additions & 1 deletion fern/docs/img/adaas/adaas-architecture.svg

This file was deleted.

53 changes: 0 additions & 53 deletions fern/docs/img/adaas/adaas-extraction-phases.mmd

This file was deleted.

1 change: 0 additions & 1 deletion fern/docs/img/adaas/adaas-extraction-phases.svg

This file was deleted.

63 changes: 58 additions & 5 deletions fern/docs/pages/adaas/extraction-phases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,75 @@ the external system, that would be another sync run.
Each sync run is comprised out of phases. Phases follow sequentially, and each can consist of one or more invocations
of the snap-in.

![ADaaS extraction phases](../../img/adaas/adaas-extraction-phases.svg)
```mermaid
sequenceDiagram
%%{init: { "fontFamily": "Segoe UI" } }%%
actor user as User
participant gw as REST API Gateway
participant ad as Airdrop components
participant ee as External extractor

note over gw,ad: Extract External Sync Units
user ->> gw: Select import connection
gw ->> ad: Start External Sync Unit extraction
ad ->> ee: Start External Sync Unit extraction
ee -->> gw: List of External Sync Units
gw ->> ad: List of External Sync Units
ad ->> gw: List of External Sync Units
gw -->> user: Show available External Sync Units


note over gw,ad: Extract Metadata
ad ->> ee: Start Metadata extraction
ee -->> gw: List of extracted metadata artifacts
gw ->> ad: List of extracted metadata artifacts

note over gw,ad: Extract data
ad ->> ee: Start data extraction
ee -->> gw: List of extracted data artifacts
gw ->> ad: List of extracted data artifacts

note over ad: Transform and import data into DevRev

note over gw,ad: Extract attachments
ad ->> ee: Start attachment extraction
ee -->> gw: List of extracted attachments
gw ->> ad: List of extracted attachments

ad -->> gw: Finished import
gw -->> user: Show finished import and report

note over gw,ad: Delete data
user ->> gw: Delete import
gw ->> ad: Delete import
ad ->> ee: Delete data
ee -->> gw: Finished deleting data
gw ->> ad: Finished deleting data

note over gw,ad: Delete attachments
ad ->> ee: Delete attachments
ee -->> gw: Finished deleting attachments
gw ->> ad: Finished deleting attachments
note over ad: Deletes internal data
ad -->> gw: Finished deleting import
gw -->> user: Import deleted
```

## Sync modes

### Initial import

An _initial import_ is the first import of data from the external system to DevRev.
It is triggered manually by the end user in DevRev's Imports UI.
It is triggered manually by the end user in DevRev's **Imports** UI.

An _initial import_ consists of the following phases:
1. External sync units extraction
2. Metadata extraction
3. Data extraction
4. Attachments extraction

## 1-way sync

### 1-way sync

A _1-way sync_ refers to any extraction after the initial import has been successfully completed.
An extractor extracts data that was created and/or updated in the external system
Expand All @@ -35,10 +88,10 @@ A 1-way sync consists of the following phases:
2. Data extraction
3. Attachments extraction

A 1-way sync extracts only the domain objects updated and/or created since the previous successful sync run.
A 1-way sync extracts only the domain objects updated or created since the previous successful sync run.


## Deletion mode
### Deletion mode

A _deletion_ consists of the following phases:
1. Data deletion
Expand Down
Loading
Loading