docs: Outline the basic workflow. #2974
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SLaks
suggested changes
Apr 13, 2018
docs/intro/03-how-it-works.md
Outdated
|
|
||
| Here is roughly how Karma works: | ||
|
|
||
| After starting up, Karma loads plugings and the configuration file, then starts its local web server which listened for connections. |
docs/intro/03-how-it-works.md
Outdated
| Here is roughly how Karma works: | ||
|
|
||
| After starting up, Karma loads plugings and the configuration file, then starts its local web server which listened for connections. | ||
| Any browser already watching the web address (localhost:9876 by default) will reconnect immediately. Karma also starts reporters |
There was a problem hiding this comment.
Can you clarify that "already watching" means (I assume) already have that page loaded from an earlier run?
There was a problem hiding this comment.
Actually I think this is base on the websocket from the client page reconnecting. Changed the text.
docs/intro/03-how-it-works.md
Outdated
|
|
||
| After starting up, Karma loads plugings and the configuration file, then starts its local web server which listened for connections. | ||
| Any browser already watching the web address (localhost:9876 by default) will reconnect immediately. Karma also starts reporters | ||
| which register for 'browser' events. |
There was a problem hiding this comment.
What do you mean?
This sounds like it's saying that it starts those reporters immediately on server startup, whereas I assume you mean that it starts them on (re-)connections.
There was a problem hiding this comment.
Its part of loading the plugins; clarified.
docs/intro/03-how-it-works.md
Outdated
|
|
||
| Once the server sees the websocket connection, it instructs the client -- over the websocket -- to execute tests. The client page opens an iframe with a 'context.html' page from the server. The server generates this context.html page using the configuration. This page includes the test framework adapter, the code to be tested, and the test code. | ||
|
|
||
| When the browser loads this context page, the onload event handler connect the context page to the client page via post-message. The framework adapter is in charge at this point: it runs the test, reporting errors or success by messaging through the client page. |
This short narative also helps introduce 'client' and 'context' terminology.
dignifiedquire
approved these changes
Apr 22, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This short narative also helps introduce 'client' and 'context' terminology.