Merge branch '14.0' into 14.0-base-rest-pydantic-lmi

Author: lmignon

.pre-commit-config.yaml

@@ -1,8 +1,6 @@
 exclude: |
   (?x)
   # NOT INSTALLABLE ADDONS
-  ^graphql_base/|
-  ^graphql_demo/|
   # END NOT INSTALLABLE ADDONS
   # Files and folders generated by bots, to avoid loops
   ^setup/|/static/description/index\.html$|

README.md

@@ -19,23 +19,18 @@ Available addons
 ----------------
 addon | version | maintainers | summary
 --- | --- | --- | ---
-[base_rest](base_rest/) | 14.0.4.3.1 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Develop your own high level REST APIs for Odoo thanks to this addon.
+[base_rest](base_rest/) | 14.0.4.5.1 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Develop your own high level REST APIs for Odoo thanks to this addon.
 [base_rest_auth_api_key](base_rest_auth_api_key/) | 14.0.1.0.2 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Base Rest: Add support for the auth_api_key security policy into the openapi documentation
 [base_rest_auth_jwt](base_rest_auth_jwt/) | 14.0.1.1.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Base Rest: Add support for the auth_jwt security policy into the openapi documentation
-[base_rest_auth_user_service](base_rest_auth_user_service/) | 14.0.1.0.1 |  | Login/logout from session using a REST call
+[base_rest_auth_user_service](base_rest_auth_user_service/) | 14.0.1.1.0 |  | Login/logout from session using a REST call
 [base_rest_datamodel](base_rest_datamodel/) | 14.0.4.1.0 |  | Datamodel binding for base_rest
 [base_rest_demo](base_rest_demo/) | 14.0.4.1.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Demo addon for Base REST
-[datamodel](datamodel/) | 14.0.3.0.4 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | This addon allows you to define simple data models supporting serialization/deserialization
+[datamodel](datamodel/) | 14.0.3.0.5 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | This addon allows you to define simple data models supporting serialization/deserialization
+[extendable](extendable/) | 14.0.1.0.0 | [![lmignon](https://github.com/lmignon.png?size=30px)](https://github.com/lmignon) | Extendable classes registry loader for Odoo
+[graphql_base](graphql_base/) | 14.0.1.0.0 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | Base GraphQL/GraphiQL controller
+[graphql_demo](graphql_demo/) | 14.0.1.0.0 | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | GraphQL Demo
 [model_serializer](model_serializer/) | 14.0.1.0.0 |  | Automatically translate Odoo models into Datamodels for (de)serialization
-[rest_log](rest_log/) | 14.0.1.0.2 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Track REST API calls into DB
-
-
-Unported addons
----------------
-addon | version | maintainers | summary
---- | --- | --- | ---
-[graphql_base](graphql_base/) | 13.0.1.0.0 (unported) | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | Base GraphQL/GraphiQL controller
-[graphql_demo](graphql_demo/) | 13.0.1.0.0 (unported) | [![sbidoul](https://github.com/sbidoul.png?size=30px)](https://github.com/sbidoul) | GraphQL Demo
+[rest_log](rest_log/) | 14.0.1.1.2 | [![simahawk](https://github.com/simahawk.png?size=30px)](https://github.com/simahawk) | Track REST API calls into DB
 
 [//]: # (end addons)
 

base_rest/__manifest__.py

@@ -6,7 +6,7 @@
     "summary": """
         Develop your own high level REST APIs for Odoo thanks to this addon.
         """,
-    "version": "14.0.4.3.1",
+    "version": "14.0.4.5.1",
     "development_status": "Beta",
     "license": "LGPL-3",
     "author": "ACSONE SA/NV, " "Odoo Community Association (OCA)",

base_rest/apispec/base_rest_service_apispec.py

@@ -29,11 +29,7 @@ def __init__(self, service_component, **params):
                 )
             },
             servers=self._get_servers(),
-            plugins=[
-                RestApiMethodRoutePlugin(self._service),
-                RestMethodParamPlugin(self._service),
-                RestMethodSecurityPlugin(self._service),
-            ],
+            plugins=self._get_plugins(),
         )
         self._params = params
 
@@ -57,6 +53,13 @@ def _get_servers(self):
             }
         ]
 
+    def _get_plugins(self):
+        return [
+            RestApiMethodRoutePlugin(self._service),
+            RestMethodParamPlugin(self._service),
+            RestMethodSecurityPlugin(self._service),
+        ]
+
     def _add_method_path(self, method):
         description = textwrap.dedent(method.__doc__ or "")
         routing = method.routing

base_rest/apispec/rest_method_security_plugin.py

@@ -9,9 +9,10 @@ class RestMethodSecurityPlugin(BasePlugin):
     APISpec plugin to generate path security from a services method
     """
 
-    def __init__(self, service):
+    def __init__(self, service, user_auths=("user",)):
         super(RestMethodSecurityPlugin, self).__init__()
         self._service = service
+        self._supported_user_auths = user_auths
 
     def init_spec(self, spec):
         super(RestMethodSecurityPlugin, self).init_spec(spec)
@@ -29,7 +30,7 @@ def operation_helper(self, path=None, operations=None, **kwargs):
         if not operations:
             return
         auth = routing.get("auth", self.spec._params.get("default_auth"))
-        if auth == "user":
+        if auth in self._supported_user_auths:
             for _method, params in operations.items():
                 security = params.setdefault("security", [])
                 security.append({"user": []})

base_rest/controllers/api_docs.py

@@ -29,7 +29,11 @@ def make_json_response(self, data, headers=None, cookies=None):
     def index(self, **params):
         self._get_api_urls()
         primary_name = params.get("urls.primaryName")
-        values = {"api_urls": self._get_api_urls(), "primary_name": primary_name}
+        swagger_settings = {
+            "urls": self._get_api_urls(),
+            "urls.primaryName": primary_name,
+        }
+        values = {"swagger_settings": swagger_settings}
         return request.render("base_rest.openapi", values)
 
     @route("/api-docs/<path:collection>/<string:service_name>.json", auth="public")
@@ -107,7 +111,3 @@ def work_on_component(self, collection_name):
     def _get_services_specs(self, path):
         services_registry = _rest_services_databases.get(request.env.cr.dbname, {})
         return services_registry["/" + path + "/"]
-
-    def _get_collection_name(self, name):
-        services_registry = _rest_services_databases.get(request.env.cr.dbname, {})
-        return services_registry["/" + name + "/"]["collection_name"]

base_rest/controllers/main.py

@@ -17,11 +17,12 @@
 
 
 class _PseudoCollection(object):
-    __slots__ = "_name", "env"
+    __slots__ = "_name", "env", "id"
 
     def __init__(self, name, env):
         self._name = name
         self.env = env
+        self.id = None
 
 
 class RestControllerType(ControllerType):

base_rest/static/src/js/swagger_ui.js

@@ -5,20 +5,17 @@ odoo.define("base_rest.swagger_ui", function (require) {
     var core = require("web.core");
 
     var SwaggerUI = core.Class.extend({
-        init: function (api_urls, primary_name) {
-            this.api_urls = api_urls;
-            this.primary_name = primary_name;
+        init: function (selector) {
+            this.selector = selector;
+            this.$el = $(this.selector);
         },
-
-        start: function (dom_id) {
-            this.ui = SwaggerUIBundle({
-                urls: this.api_urls,
-                dom_id: dom_id,
+        _swagger_bundle_settings: function () {
+            const defaults = {
+                dom_id: this.selector,
                 deepLinking: true,
                 presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
                 plugins: [SwaggerUIBundle.plugins.DownloadUrl],
                 layout: "StandaloneLayout",
-                "urls.primaryName": this.primary_name,
                 operationsSorter: function (a, b) {
                     var methodsOrder = [
                         "get",
@@ -46,7 +43,12 @@ odoo.define("base_rest.swagger_ui", function (require) {
                         $(".topbar").prepend(this.web_btn);
                     }
                 },
-            });
+            };
+            const config = this.$el.data("settings");
+            return Object.assign({}, defaults, config);
+        },
+        start: function () {
+            this.ui = SwaggerUIBundle(this._swagger_bundle_settings());
         },
     });
 

base_rest/tests/common.py

@@ -105,8 +105,19 @@ def _setup_registry(class_or_instance):
         # registered outside tests
         class_or_instance._collection_name = "base.rest.test"
 
+        BaseTestController = class_or_instance._get_test_controller(class_or_instance)
+
+        class_or_instance._BaseTestController = BaseTestController
+        class_or_instance._controller_route_method_names = {
+            "my_controller_route_without",
+            "my_controller_route_with",
+            "my_controller_route_without_auth_2",
+        }
+
+    @staticmethod
+    def _get_test_controller(class_or_instance, root_path="/test_controller/"):
         class BaseTestController(RestController):
-            _root_path = "/test_controller/"
+            _root_path = root_path
             _collection_name = class_or_instance._collection_name
             _default_auth = "public"
 
@@ -128,12 +139,7 @@ def my_controller_route_with(self):
             def my_controller_route_without_auth_2(self):
                 return {}
 
-        class_or_instance._BaseTestController = BaseTestController
-        class_or_instance._controller_route_method_names = {
-            "my_controller_route_without",
-            "my_controller_route_with",
-            "my_controller_route_without_auth_2",
-        }
+        return BaseTestController
 
     @staticmethod
     def _teardown_registry(class_or_instance):

base_rest/views/openapi_template.xml

@@ -44,16 +44,14 @@
         </t>
 
         <body>
-            <div id="swagger-ui" />
+            <div id="swagger-ui" t-att-data-settings='json.dumps(swagger_settings)' />
 
             <script>
                  odoo.define('base_rest.swagger', function (require) {
                         var SwaggerUi = require('base_rest.swagger_ui');
-                        var swagger_ui = new SwaggerUi(<t t-esc="api_urls" />, '<t
-                    t-esc="primary_name"
-                />');
+                        var swagger_ui = new SwaggerUi('#swagger-ui');
                         $(function() {
-                            swagger_ui.start('#swagger-ui');
+                            swagger_ui.start();
                         });
                         return swagger_ui;
                     });