Skip to content
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.

Sign up for GitHub

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

Update mermaid graph of onigumo processing with a new approach #237

Merged
merged 7 commits into from
Aug 16, 2024
Merged

Update mermaid graph of onigumo processing with a new approach #237

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
28b2680
Update mermaid graph of onigumo processing with a new approach
nappex Aug 3, 2024
ca1c368
Switch fa icon of spider to emoji
nappex Aug 16, 2024
26d560b
Add another graph which differentiate spider and onigumo parts
nappex Aug 16, 2024
a710d41
Remove title from graph
nappex Aug 16, 2024
4ec3ee7
Fix spaces, same number of spaces everywhere
nappex Aug 16, 2024
96969a7
Move relation between operator and materializer to the end of the rel…
nappex Aug 16, 2024
30065e1
Split the crawling graph to smaller group for better legibility
nappex Aug 16, 2024
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
60 changes: 40 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,47 @@ The flowchart below illustrates the flow of data between those parts:

```mermaid
flowchart LR
start([START]) --> onigumo_operator[OPERATOR]
onigumo_operator -- <hash>.urls ---> onigumo_downloader[DOWNLOADER]
onigumo_downloader -- <hash>.raw ---> onigumo_parser[PARSER]
onigumo_parser -- <hash>.json ---> onigumo_operator

onigumo_operator <-.-> spider_operator[OPERATOR]
onigumo_parser <-.-> spider_parser[PARSER]

onigumo_operator --> spider_materialization[MATERIALIZER]

subgraph "Onigumo (kernel)"
onigumo_operator
onigumo_downloader
onigumo_parser
end

subgraph "Spider (application)"
spider_operator
spider_parser
spider_materialization
subgraph Crawling
direction BT
spider_parser(🕷️ PARSER)
spider_operator(🕷️ OPERATOR)
Comment on lines +21 to +22
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of using the emoji to get around GitHub not supporting fontawesome icons in Mermaid diagrams. 💪🏻

onigumo_downloader[DOWNLOADER]
end

start([START]) --> onigumo_feeder[FEEDER]
onigumo_feeder -- .raw --> Crawling
onigumo_feeder -- .urls --> Crawling
onigumo_feeder -- .json --> Crawling
Crawling --> spider_materializer(🕷️ MATERIALIZER)
spider_materializer --> done([END])
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
start([START]) --> onigumo_feeder[FEEDER]
onigumo_feeder -- .raw --> Crawling
onigumo_feeder -- .urls --> Crawling
onigumo_feeder -- .json --> Crawling
Crawling --> spider_materializer(🕷️ MATERIALIZER)
spider_materializer --> done([END])
start([START]) --> onigumo_feeder[FEEDER]
onigumo_feeder -- .raw --> Crawling
onigumo_feeder -- .urls --> Crawling
onigumo_feeder -- .json --> Crawling
Crawling --> spider_materializer(🕷️ MATERIALIZER)
spider_materializer --> done([END])

I‘d split this into smaller groups.


spider_operator -. "<hash>.urls" .-> onigumo_downloader
onigumo_downloader -. "<hash>.raw" .-> spider_parser
spider_parser -. "<hash>.json" .-> spider_operator
```

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were thinking about adding some title to the second diagram. But I don’t know what it should say.

```mermaid
flowchart LR
subgraph "🕷️ Spider"
direction TB
spider_parser(PARSER)
spider_operator(OPERATOR)
spider_materializer(MATERIALIZER)
end

subgraph Onigumo
onigumo_feeder[FEEDER]
onigumo_downloader[DOWNLOADER]
end

onigumo_feeder -- .json --> spider_operator
spider_operator ---> spider_materializer
onigumo_feeder -- .urls --> onigumo_downloader
onigumo_feeder -- .raw --> spider_parser

spider_parser -. "<hash>.json" .-> spider_operator
onigumo_downloader -. "<hash>.raw" .-> spider_parser
spider_operator -. "<hash>.urls" .-> onigumo_downloader
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
onigumo_feeder -- .json --> spider_operator
spider_operator ---> spider_materializer
onigumo_feeder -- .urls --> onigumo_downloader
onigumo_feeder -- .raw --> spider_parser
spider_parser -. "<hash>.json" .-> spider_operator
onigumo_downloader -. "<hash>.raw" .-> spider_parser
spider_operator -. "<hash>.urls" .-> onigumo_downloader
onigumo_feeder -- .json --> spider_operator
onigumo_feeder -- .urls --> onigumo_downloader
onigumo_feeder -- .raw --> spider_parser
spider_parser -. "<hash>.json" .-> spider_operator
onigumo_downloader -. "<hash>.raw" .-> spider_parser
spider_operator -. "<hash>.urls" .-> onigumo_downloader
spider_operator ---> spider_materializer

See my comment from my previous review. I’d push the spider_operator --→ spider_materializer relation to the bottom, so the Spider subgraph arrows are coupled together

```

### Operator ###
Expand Down
Loading