pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
64f2b8aebbf18d3381845fc43d9fcd00a77e5990
odoo_source/odoo/addons/test_http/tests/test_echo_reply.py
T
Julien Castiaux da8def8e41 [IMP] core, web: Delegate delivery of static files 
Rationnals
----------

Web servers can serve some resources (e.g. static files) right away
without any interaction with the web application. The network model of
most web servers makes them capable of handling thousands of
simultaneous requests when it comes to intensive IO operations such as
streaming data from a file. The network model of Odoo is different: it
is capable of a lot of processing power but can only serve a handful of
requests at a time, i.e. Odoo (with some help from postgres) is
optimized for CPU operations, not IO.

Some users don't configure their web server, they use a basic
configuration that relay all requests to Odoo. The result is that many
Odoo HTTP Workers can be busy streaming static files instead of
processing other requests. This can lead to a worker starvation, i.e.
all workers are busy streaming files and cannot process new requests.

X-Sendfile
----------

In this work, we add the support for the [X-Sendfile] header family,
they are multiples http headers that can be used by the web application
to communicate with the web server in order to delegate the delivery of
files stored on the file system. Odoo still receives the request but it
does no more stream the file content from within its HTTP worker,
instead it skips the response body altogether and sets the `X-Sendfile`
special header with the path of the file on the filesystem. The web
server intercepts that special header, open the file and stream it.

Using those headers, we can use the best of both the web application and
the web server. The web application is still responsible to locate the
resource and verify the access rights, the web server is still
responsible of streaming the content.

Using X-Sendfile is opt-in via the `--x-sendfile` CLI flag. We set both
`X-Sendfile` (apache) and `X-Accel-Redirect` (nginx). If you are using
apache, make sure `mod_xsendfile` is enabled. If you are using NGINX
you have to add the following location block:

    location /web/filestore {  # custom path, hardcoded within Odoo
        # Prevent access from the outside world, i.e. makes this
        # route only accessible via X-Accel. MANDATORY!!!
        internal;

        # Give access to the filestore using this server's
        # permissions. Odoo is in charge of verifying the access
        # rights.
        alias /path/to/odoo/data-dir/filestore;
    }

The Odoo [deployment documentation] has been updated accordingly.

[X-Sendfile]: https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/
[deployment documentation]: https://www.odoo.com/documentation/master/administration/install/deploy.html#serving-static-files-and-attachments

Changes to the API
------------------

To benefit most from X-Sendfile, all APIs related to streaming content
over HTTP has to be adapted. They are: (1) `request._serve_static`,
(2) `ir.http._serve_fallback`, (3) `/web/content` and (4) `/web/image`.

Each used it own way to deliver content: (1) `_serve_static` was using
`send_file` (flask's send_file that as been vendored with odoo 10
years ago and not maintenained since then), (2) _serve_fallback was
handcrafting a `werkzeug.wrappers.Response`, (3) /web/content-image were
using the "binary server" `ir.http.binary_content` API.

I has been decided to remove all 3 APIs and to merge the code inside of
the new `http.Stream` object and the `ir.binary` helper model.

A Stream wraps what is going to be sent to the browser, it can be a path
to a file on the locale filesystem, a blob of raw data or an URL to an
external resource. The Stream also holds various metadata that are
mainly used for caching. The preferred way to create a Stream is via one
of its three factories so that all the metadata are set. The factories
are: `from_path`, `from_attachment` and `from_binary_field`. A stream
instance exposes a single method `get_response()` used to create the
corresponding HTTP response object out of the stream.

Inside of `ir.http` were a few methods that were not related to the http
routing and formed what was called the "binary server". All those
methods have been removed and the feature have been refactored inside of
the new `ir.binary` model. The removed methods are:

- `_xmlid_to_obj`
- `_get_record_and_check`
- `_binary_ir_attachment_redirect_content`
- `_binary_record_content`
- `_binary_set_headers`
- `binary_content`
- `_response_by_status`
- `_get_content_common`
- `_content_image`
- `_content_image_get_response`
- `_placeholder_image_get_response`

The new `ir.binary` abstract model exposes the following utilities:

**`_find_record`**

Find an attachment or a record with a binary-field out of an xmlid or
out of a pair record-model/record-id. Check the access rights and the
access token.

**`_get_stream_from`**

Create a Stream from an attachment or a record with a binary-field.

**`_get_image_stream_from`**

Same as `_get_stream_from` but adapted for images. It sets a sensible
ETag on the stream and has image resizing support.

**`_placeholder`**

Get the image placeholder blob.

Testing
-------

It is possible to test the web server configuration using the
`test_http` module. Install the module then run the unittest using the
`webserver` test-tag. By default it attempts to connect to a web-server
running on `http://localhost:80`, you can change this URL by setting the
`WEB_SERVER_URL` environment variable.

    odoo-bin -i test_http --stop-after-init
    WEB_SERVER_URL='http://localhost:80' odoo-bin --test-tags webserver --stop-after-init

closes odoo/odoo#88134

Task: 2801675
Related: odoo/documentation#2083
Related: odoo/enterprise#26191
Signed-off-by: Julien Castiaux <juc@odoo.com>
2022-06-01 02:53:59 +02:00

174 lines
7.0 KiB
Python
Raw Blame History

# Part of Odoo. See LICENSE file for full copyright and licensing details.
import json
from urllib.parse import urlparse
from odoo.http import Request
from odoo.tests import tagged
from odoo.tests.common import new_test_user
from odoo.tools import mute_logger
from odoo.addons.test_http.controllers import CT_JSON
from .test_common import TestHttpBase
@tagged('post_install', '-at_install')
class TestHttpEchoReplyHttpNoDB(TestHttpBase):
def test_echohttp0_get_qs_nodb(self):
res = self.nodb_url_open('/test_http/echo-http-get?race=Asgard')
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, "{'race': 'Asgard'}")
def test_echohttp1_get_form_nodb(self):
res = self.nodb_url_open('/test_http/echo-http-get', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 405)
def test_echohttp2_post_qs_nodb(self):
res = self.nodb_url_open('/test_http/echo-http-post?race=Asgard')
self.assertEqual(res.status_code, 405)
def test_echohttp3_post_qs_form_nodb(self):
res = self.nodb_url_open('/test_http/echo-http-post?race=Asgard', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, "{'race': 'Asgard', 'commander': 'Thor'}")
@mute_logger('odoo.http')
def test_echohttp4_post_json_nodb(self):
payload = json.dumps({'commander': 'Thor'})
res = self.nodb_url_open('/test_http/echo-http-post', data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, '{}')
def test_echohttp5_post_csrf(self):
res = self.nodb_url_open('/test_http/echo-http-csrf?race=Asgard', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 303)
self.assertEqual(urlparse(res.headers.get('Location', '')).path, '/web/database/selector')
def test_echohttp6_json_over_http(self):
payload = json.dumps({'commander': 'Thor'})
res = self.nodb_url_open('/test_http/echo-json-over-http', data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, payload)
mimetype = res.headers['Content-Type'].partition(';')[0]
self.assertEqual(mimetype, 'application/json')
@tagged('post_install', '-at_install')
class TestHttpEchoReplyJsonNoDB(TestHttpBase):
def test_echojson0_qs_json_nodb(self):
payload = json.dumps({
'jsonrpc': '2.0',
'id': 1234,
'params': {
'commander': 'Thor',
},
})
res = self.nodb_url_open("/test_http/echo-json?race=Asgard", data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, '{"jsonrpc": "2.0", "id": 1234, "result": {"commander": "Thor"}}')
def test_echojson1_http_get_nodb(self):
res = self.nodb_url_open('/test_http/echo-json') # GET
self.assertEqual(res.status_code, 405)
@mute_logger('odoo.http')
def test_echojson2_http_post_nodb(self):
res = self.nodb_url_open('/test_http/echo-json', data={'race': 'Asgard'}) # POST
self.assertIn("Bad Request", res.text)
@tagged('post_install', '-at_install')
class TestHttpEchoReplyHttpWithDB(TestHttpBase):
def setUp(self):
super().setUp()
self.jackoneill = new_test_user(self.env, 'jackoneill', context={'lang': 'en_US'})
self.authenticate('jackoneill', 'jackoneill')
def test_echohttp0_get_qs_db(self):
res = self.db_url_open('/test_http/echo-http-get?race=Asgard')
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, "{'race': 'Asgard'}")
def test_echohttp1_get_form_db(self):
res = self.db_url_open('/test_http/echo-http-get', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 405)
def test_echohttp2_post_qs_db(self):
res = self.db_url_open('/test_http/echo-http-post?race=Asgard')
self.assertEqual(res.status_code, 405)
def test_echohttp3_post_qs_form_db(self):
res = self.db_url_open('/test_http/echo-http-post?race=Asgard', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, "{'race': 'Asgard', 'commander': 'Thor'}")
@mute_logger('odoo.http')
def test_echohttp4_post_json_db(self):
payload = json.dumps({'commander': 'Thor'})
res = self.db_url_open('/test_http/echo-http-post', data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, '{}')
@mute_logger('odoo.http')
def test_echohttp5_post_no_csrf(self):
res = self.db_url_open('/test_http/echo-http-csrf?race=Asgard', data={'commander': 'Thor'})
self.assertEqual(res.status_code, 400)
self.assertIn("Session expired (invalid CSRF token)", res.text)
@mute_logger('odoo.http')
def test_echohttp6_post_bad_csrf(self):
res = self.db_url_open('/test_http/echo-http-csrf?race=Asgard', data={'commander': 'Thor', 'csrf_token': 'bad token'})
self.assertEqual(res.status_code, 400)
self.assertIn("Session expired (invalid CSRF token)", res.text)
@mute_logger('odoo.http')
def test_echohttp7_post_good_csrf(self):
res = self.db_url_open('/test_http/echo-http-csrf?race=Asgard', data={'commander': 'Thor', 'csrf_token': Request.csrf_token(self)})
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, "{'race': 'Asgard', 'commander': 'Thor'}")
@tagged('post_install', '-at_install')
class TestHttpEchoReplyJsonWithDB(TestHttpBase):
def setUp(self):
super().setUp()
self.jackoneill = new_test_user(self.env, 'jackoneill', context={'lang': 'en_US'})
self.authenticate('jackoneill', 'jackoneill')
def test_echojson0_qs_json_db(self):
payload = json.dumps({
'jsonrpc': '2.0',
'id': 1234,
'params': {
'commander': 'Thor',
},
})
res = self.db_url_open('/test_http/echo-json?race=Asgard', data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, '{"jsonrpc": "2.0", "id": 1234, "result": {"commander": "Thor"}}')
def test_echojson1_http_get_db(self):
res = self.db_url_open('/test_http/echo-json') # GET
self.assertEqual(res.status_code, 405)
@mute_logger('odoo.http')
def test_echojson2_http_post_db(self):
res = self.db_url_open('/test_http/echo-json', data={'race': 'Asgard'}) # POST
self.assertIn("Bad Request", res.text)
def test_echojson3_context_db(self):
payload = json.dumps({
"jsonrpc": "2.0",
"id": 0,
"params": {
"context": {
"name": "Thor"
},
"race": "Asgard",
},
})
res = self.db_url_open("/test_http/echo-json-context", data=payload, headers=CT_JSON)
self.assertEqual(res.status_code, 200)
self.assertEqual(res.text, '{"jsonrpc": "2.0", "id": 0, "result": {"name": "Thor"}}')
Reference in New Issue View Git Blame Copy Permalink