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.

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

Misleading documentation of .asis feature #15804

Closed
foolip opened this issue Mar 13, 2019 · 2 comments
Closed

Misleading documentation of .asis feature #15804

foolip opened this issue Mar 13, 2019 · 2 comments
Labels

Comments

@foolip
Copy link
Member

@foolip foolip commented Mar 13, 2019

The Tests Requiring Full Control Over The HTTP Response section in https://web-platform-tests.org/writing-tests/server-features.html says:

For full control over the request and response the server provides the ability to write .asis files; these are served as literal HTTP responses. It also provides the ability to write Python scripts that have access to request data and can manipulate the content and timing of the response. For details see the wptserve documentation.

This makes it sound like one could use .asis files to write Python scripts, which doesn't seem to be the case.

@jugglinmike FYI.

@foolip foolip added the docs label Mar 13, 2019
@jugglinmike
Copy link
Contributor

@jugglinmike jugglinmike commented Aug 9, 2019

In addition to extending that text, commit 8119bc1 inserted a paragraph break between the description of the "asis" feature and the "Python handlers" feature. The docs now read:

For full control over the request and response, the server provides the ability to write .asis files; these are served as literal HTTP responses. In other words, they are sent byte-for-byte to the server without adding an HTTP status line, headers, or anything else. This makes them suitable for testing situations where the precise bytes on the wire are static, and control over the timing is unnecessary, but the response does not conform to HTTP requirements.

The server also provides the ability to write Python "handlers"--Python scripts that have access to request data and can manipulate the content and timing of the response. Responses are also influenced by the pipe query string parameter.

@foolip do you think that will be enough to prevent confusion?

@foolip
Copy link
Member Author

@foolip foolip commented Aug 15, 2019

Yep, that resolves the confusion, thanks @jugglinmike!

@foolip foolip closed this Aug 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.