Architecture overview #132

DanielMSchmidt · 2017-05-19T11:05:35Z

Hey there, just added a bit of docs on how detox works under the hood, I hope it helps 👍👍

rotemmiz · 2017-05-24T21:21:18Z

docs/img-src/action-sequence.mmd

+  %% Note over mocha,Detox Server: Runs on your computer
+  %% Note over Detox Client,Earl Grey: Runs on the device
+
+  mocha->>Detox Server: element(by.label('Click Me')).tap();


detox is unopinionated re test runner, change mocha to "test runner"
Detox server is actually something else. detox-server is a different module that runs a web socket server, letting both tester (detox logic inside a test runner) and testee (detox code inside a device) communicate with each other. Both tester and testee are websocket clients

Thanks for explaining 👍

rotemmiz · 2017-05-24T21:24:35Z

docs/img-src/build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh


I may be too picky, but the img output is not pretty enough. I imagine something slicker :)

Do you know a better alternative for mermaid? I would love to have something with a source code, because it makes the whole thing extensible to other developers. (in contrast to a PS file or something)

Mermeid might be a good solution, but we need to either restructure the diagram, or at least remove the arrows going from one end point to itself, it makes the diagram much clearer IMO.

ok, I will try a few more ways and link them here so we can discuss it on a visual basis

The new way is much nicer!

rotemmiz · 2017-05-24T21:27:15Z

docs/img-src/architecture.mmd

@@ -0,0 +1,11 @@
+%% Ca( for flowchart below


This diagram doesn't make much sense, what's the addition on top of the bigger diagram ?
I think its a bit confusing

For me it helped my understand which parts of the system even exist in detox and what their responsibilities are, but I can remove it if you don't like it

rotemmiz · 2017-05-25T09:56:28Z

docs/img-src/build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh


Mermeid might be a good solution, but we need to either restructure the diagram, or at least remove the arrows going from one end point to itself, it makes the diagram much clearer IMO.

DanielMSchmidt · 2017-06-05T09:05:47Z

@rotemmiz I redid the diagram and move a lot of its complexity to text so it is more extensible. I hope to extend it in the future with other kinds of interactions like assertions or device rotation or other things.

rotemmiz · 2017-06-11T12:54:58Z

docs/Guide.Architecture.md

+The sequence diagram below shows the general communication scheme between the components in Detox.
+![architecture overview](img/action-sequence.mmd.png)
+
+To understand this topic more thoroughly we need to have a look at an example action in detail. The numbers in the listing below corelate with the ones in the diagram.


rotemmiz · 2017-06-11T12:57:49Z

docs/img-src/action-sequence.mmd

@@ -0,0 +1,19 @@
+sequenceDiagram
+  participant Test Runner(1)
+  participant Detox(3)


rotemmiz · 2017-06-11T12:57:57Z

docs/img-src/action-sequence.mmd

+  participant Test Runner(1)
+  participant Detox(3)
+  participant Detox Server(5)
+  participant Detox Client(7)


rotemmiz · 2017-06-11T13:10:53Z

docs/Guide.Architecture.md

@@ -0,0 +1,17 @@
+# Architecture Deep Dive


This is less of an architecture overview and more of a "How Detox Works" document, it is also not really a guide.
After going through the docs again, I think it best fits as a subsection/example in Introduction.HowDetoxWorks.md

rotemmiz · 2017-06-11T13:11:36Z

docs/img-src/build.sh

@@ -0,0 +1,3 @@
+#!/bin/sh


The new way is much nicer!

rotemmiz · 2017-06-11T13:12:34Z

docs/img-src/action-sequence.mmd

+  %% Note over Detox Client(7),Earl Grey(9): Runs on the device
+
+  Test Runner(1)->>Detox(3): assertion / action (2)
+  Detox(3)->>Detox Server(5): native code as JSON (4)


I think we should only number the actions, not the participants.

Can you explain that a bit? would you name Test Runner, Detox, etc only in the text? I would find that a bit confusing if you try to get a general overview of what exactly is happening 👍

rotemmiz · 2017-06-11T13:14:58Z

docs/Guide.Contributing.md

@@ -94,4 +93,8 @@ To run the e2e tests, after the application was built.
 npm run e2e
 ```

+### Architecture
+
+For more details on how Detox works under the hood, please see [our Architecture Guide](Guide.Architecture.md)


This relates to "How Detox Works", not a part of Contributing

DanielMSchmidt · 2017-06-13T18:14:29Z

@rotemmiz Pushed the next iteration, hope it is better suited for merge than the previous one ;)

DanielMSchmidt · 2017-06-18T20:48:33Z

🎉

rotemmiz reviewed May 24, 2017

View reviewed changes

rotemmiz requested changes May 25, 2017

View reviewed changes

DanielMSchmidt force-pushed the docs/diagrams branch 3 times, most recently from ce89ba9 to 8524ac9 Compare June 5, 2017 09:01

LeoNatan added the documentation label Jun 6, 2017

rotemmiz requested changes Jun 11, 2017

View reviewed changes

DanielMSchmidt force-pushed the docs/diagrams branch from 8524ac9 to abccac8 Compare June 13, 2017 17:58

docs: architecture deep dive

344d59e

DanielMSchmidt force-pushed the docs/diagrams branch from abccac8 to 344d59e Compare June 13, 2017 18:14

rotemmiz approved these changes Jun 18, 2017

View reviewed changes

rotemmiz merged commit e2a3cc9 into wix:master Jun 18, 2017

DanielMSchmidt deleted the docs/diagrams branch June 18, 2017 20:48

wix locked and limited conversation to collaborators Jul 23, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Architecture overview #132

Architecture overview #132

DanielMSchmidt commented May 19, 2017 •

edited

Loading

rotemmiz May 24, 2017

DanielMSchmidt May 25, 2017

rotemmiz May 24, 2017

DanielMSchmidt May 25, 2017

rotemmiz May 25, 2017

DanielMSchmidt May 25, 2017

rotemmiz Jun 11, 2017

rotemmiz May 24, 2017

DanielMSchmidt May 25, 2017

rotemmiz May 25, 2017

DanielMSchmidt commented Jun 5, 2017

rotemmiz Jun 11, 2017

rotemmiz Jun 11, 2017

rotemmiz Jun 11, 2017

rotemmiz Jun 11, 2017

rotemmiz Jun 11, 2017

rotemmiz Jun 11, 2017

DanielMSchmidt Jun 13, 2017

rotemmiz Jun 11, 2017

DanielMSchmidt commented Jun 13, 2017

DanielMSchmidt commented Jun 18, 2017

Architecture overview #132

Architecture overview #132

Conversation

DanielMSchmidt commented May 19, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielMSchmidt commented Jun 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielMSchmidt commented Jun 13, 2017

DanielMSchmidt commented Jun 18, 2017

DanielMSchmidt commented May 19, 2017 •

edited

Loading