NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
d551193391
documentation/content/developer/reference/frontend/services.rst
Géry Debongnie d551193391 [IMP] developer: add missing links in js doc 
and slightly improve effect registry page

closes odoo/documentation#1296

Signed-off-by: Géry Debongnie (ged) <ged@openerp.com>
2021-11-05 10:12:35 +00:00

721 lines
20 KiB
ReStructuredText
Raw Blame History

.. _frontend/services:
========
Services
========
Services are long lived pieces of code that provide a feature. They may be
imported by components (with ``useService``) or by other services. Also, they
can declare a set of dependencies. In that sense, services are basically a
DI :dfn:`dependency injection` system. For example, the ``notification`` service
provides a way to display a notification, or the ``rpc`` service is the proper
way to perform a request to the Odoo server.
The following example registers a simple service that displays a notification
every 5 seconds:
.. code-block:: javascript
import { registry } from "@web/core/registry";
const myService = {
dependencies: ["notification"],
start(env, { notification }) {
let counter = 1;
setInterval(() => {
notification.add(`Tick Tock ${counter++}`);
}, 5000);
}
};
registry.category("services").add("myService", myService);
At startup, the web client starts all services present in the `services`
registry. Note that the name used in the registry is the name of the service.
.. note::
Most code that is not a component should be *packaged* in a service, in
particular if it performs some side effect. This is very useful for testing
purposes: tests can choose which services are active, so there are less chance
for unwanted side effects interfering with the code being tested.
Defining a service
==================
A service needs to implement the following interface:
.. js:data:: dependencies
Optional list of strings. It is the list of all dependencies (other services)
that this service needs
.. js:function:: start(env, deps)
:param Environment env:
:param Object deps: all requested dependencies
:returns: value of service or Promise<value of service>
This is the main definition for the service. It can return either a value or
a promise. In that case, the service loader simply waits for the promise to
resolve to a value, which is then the value of the service.
Some services do not export any value. They may just do their work without a
need to be directly called by other code. In that case, their value will be
set to ``null`` in ``env.services``.
.. js:data:: async
Optional value. If given, it should be `true` or a list of strings.
Some services need to provide an asynchronous API. For example, the `rpc`
service is an asynchronous function, or the `orm` service provides a set of
functions to call the Odoo server.
In that case, it is possible for components that use a service to be
destroyed before the end of an asynchronous function call. Most of the time,
the asynchronous function call needs to be ignored. Doing otherwise is
potentially very risky, because the underlying component is no longer active.
The `async` flag is a way to do just that: it signals to the service creator
that all asynchronous calls coming from components should be left pending if
the component is destroyed.
Using a service
===============
A service that depends on other services and has properly declared its
``dependencies`` simply receives a reference to the corresponding services
in the second argument of the ``start`` method.
The ``useService`` hook is the proper way to use a service in a component. It
simply returns a reference to the service value, that can then be used by the
component later. For example:
.. code-block:: javascript
import { useService } from "@web/core/utils/hooks";
class MyComponent extends Component {
setup() {
const rpc = useService("rpc");
onWillStart(async () => {
this.someValue = await rpc(...);
});
}
}
Reference List
==============
.. list-table::
:widths: 25 75
:header-rows: 1
* - Technical Name
- Short Description
* - :ref:`cookie <frontend/services/cookie>`
- read or modify cookies
* - :ref:`effect <frontend/services/effect>`
- display graphical effects
* - :ref:`notification <frontend/services/notification>`
- display notifications
* - :ref:`rpc <frontend/services/rpc>`
- send requests to the server
* - :ref:`title <frontend/services/title>`
- read or modify the window title
* - :ref:`user <frontend/services/user>`
- provides some information related to the current user
.. _frontend/services/cookie:
Cookie service
--------------
Overview
~~~~~~~~
- Technical name: `cookie`
- Dependencies: none
Provides a way to manipulate cookies. For example:
.. code-block:: javascript
cookieService.setCookie("hello", "odoo");
API
~~~
.. js:data:: current
Object representing each cookie and its value if any (or empty string)
.. js:function:: setCookie(name[, value, ttl])
:param string name: the name of the cookie that should be set
:param any value: optional. If given, the cookie will be set to that value
:param number ttl: optional. the time in seconds before the cookie will be deleted (default=1 year)
Sets the cookie `name` to the value `value` with a max age of `ttl`
.. js:function:: deleteCookie(name)
:param string name: name of the cookie
Deletes the cookie `name`.
.. _frontend/services/effect:
Effect service
--------------
Overview
~~~~~~~~
* Technical name: `effect`
* Dependencies: None
Effects are graphical elements that can be temporarily displayed on top of the page, usually to provide feedback to the user that something interesting happened.
A good example would be the rainbow man:
.. image:: images/rainbow_man.png
:alt: The rainbow man effect
:width: 600
:align: center
Here's how this can be displayed:
.. code-block:: javascript
const effectService = useService("effect");
effectService.add({
type: "rainbow_man",
message: "Boom! Team record for the past 30 days.",
});
.. warning ::
The hook `useEffect` is not related to the effect service.
API
~~~
.. js:function:: effectService.add(options)
:param object options: the options for the effect. They will get passed along to the underlying effect component.
Display an effect.
The options are defined by:
.. code-block:: ts
@typedef {Object} [EffectOptions]
@property {string} [type="rainbow_man"]
// The name of the desired effect
Available effects
~~~~~~~~~~~~~~~~~
Currently, the only effect is the rainbow man.
RainbowMan
**********
.. code-block:: javascript
effectService.add({ type: "rainbow_man" });
.. list-table::
:widths: 20 40 40
:header-rows: 1
* - Name
- Type
- Description
* - `params.message`
- `string?="Well Done"`
- The message in the notice the rainbowman holds or the content of the notification if effects are disabled.
Can be a simple a string.
Can be a string representation of html (prefer component if you want interactions in the DOM).
* - `params.img_url`
- `string?=/web/static/img/smile.svg`
- The url of the image to display inside the rainbow.
* - `params.messageIsHtml`
- `boolean?=false`
- Set to true if the message encodes html, s.t. it will be correctly inserted into the DOM.
* - `params.fadeout`
- `("slow"|"medium"|"fast"|"no")?="medium"`
- Delay for rainbowman to disappear.
`"fast"` will make rainbowman dissapear quickly.
`"medium"` and 'slow' will wait little longer before disappearing (can be used when `options.message` is longer).
`"no"` will keep rainbowman on screen until user clicks anywhere outside rainbowman.
* - `params.Component`
- `owl.Component?=RainbowMan`
- Component class to instantiate (if effects aren't disabled).
* - `params.props`
- `object?={}`
- If params.Component is given, its props can be passed with this argument.
How to add an effect
~~~~~~~~~~~~~~~~~~~~
.. _frontend/services/effect_registry:
The effects are stored in a registry called `effects`.
You can add new effects by providing a name and a function.
.. code-block:: javascript
const effectRegistry = registry.category("effects");
effectRegistry.add("rainbow_man", rainbowManEffectFunction);
The function must follow this API:
.. js:function:: <newEffectFunction>(env, params)
:param Env env: the environment received by the service
:param object params: the params received from the add function on the service.
:returns: `({Component, props} | void)` A component and its props or nothing.
This function must create a component and return it. This component is mounted inside the
effect component container.
Example
~~~~~~~
Let's say we want to add an effect that add a sepia look at the page.
.. code-block:: javascript
/** @odoo-module **/
import { registry } from "@web/core/registry";
const { Component, tags } = owl;
class SepiaEffect extends Component {}
SepiaEffect.template = tags.xml`
<div style="
position: absolute;
left: 0;
top: 0;
width: 100%;
height: 100%;
pointer-events: none;
background: rgba(124,87,0, 0.4);
"></div>
`;
export function sepiaEffectProvider(env, params = {}) {
return {
Component: SepiaEffect,
};
}
const effectRegistry = registry.category("effects");
effectRegistry.add("sepia", sepiaEffectProvider);
And then, call it somewhere you want and you will see the result.
Here, it is called in webclient.js to make it visible everywhere for the example.
.. code-block:: javascript
const effectService = useService("effect");
effectService.add({ type: "sepia" });
.. image:: images/odoo_sepia.png
:alt: Odoo in sepia
:width: 600
:align: center
.. _frontend/services/notification:
Notification service
--------------------
Overview
~~~~~~~~
* Technical name: `notification`
* Dependencies: None
The `notification` service allows to display notifications on the screen.
.. code-block:: javascript
const notificationService = useService("notification");
notificationService.add("I'm a very simple notification");
API
~~~
.. js:function:: add(message[, options])
:param string message: the notification message to display
:param object options: the options of the notification
:returns: a function to close the notification
Shows a notification.
The options are defined by:
.. list-table::
:widths: 15 30 55
:header-rows: 1
* - Name
- Type
- Description
* - `title`
- string
- Add a title to the notification
* - `type`
- `warning` | `danger` | `success` | `info`
- Changes the background color according to the type
* - `sticky`
- boolean
- Whether or not the notification should stay until dismissed
* - `className`
- string
- additional css class that will be added to the notification
* - `onClose`
- function
- callback to be executed when the notification closes
* - `buttons`
- button[] (see below)
- list of button to display in the notification
The buttons are defined by:
.. list-table::
:widths: 15 30 55
:header-rows: 1
* - Name
- Type
- Description
* - `name`
- string
- The button text
* - `onClick`
- function
- callback to execute when the button is clicked
* - `primary`
- boolean
- whether the button should be styled as a primary button
Examples
~~~~~~~~
A notification for when a sale deal is made with a button to go some kind of commission page.
.. code-block:: javascript
// in setup
this.notificationService = useService("notification");
this.actionService = useService("actionService");
// later
this.notificationService.add("You closed a deal!", {
title: "Congrats",
type: "success",
buttons: [
{
name: "See your Commission",
onClick: () => {
this.actionService.doAction("commission_action");
},
},
],
});
.. image:: images/notification_service.png
:width: 600 px
:alt: Example of notification
:align: center
A notification that closes after a second:
.. code-block:: javascript
const notificationService = useService("notification");
const close = notificationService.add("I will be quickly closed");
setTimeout(close, 1000);
.. _frontend/services/rpc:
RPC service
-----------
Overview
~~~~~~~~
- Technical name: `rpc`
- Dependencies: none
The `rpc` service provides a single asynchronous function to send requests to
the server. Calling a controller is very simple: the route should be the first
argument and optionally, a ``params`` object can be given as a second argument.
.. code-block:: javascript
// in setup
this.rpc = useService("rpc");
// somewhere else, in an async function:
const result = await this.rpc("/my/route", { some: "value" });
.. note::
Note that the ``rpc`` service is considered a low-level service. It should
only be used to interact with Odoo controllers. To work with models (which
is by far the most important usecase), one should use the ``orm`` service
instead.
API
~~~
.. js:function:: rpc(route, params, settings)
:param string route: route targeted by the request
:param Object params: parameters sent to the server
:param Object settings (optional): request settings (see below)
The ``settings`` object can contain:
- ``xhr``, which should be a ``XMLHTTPRequest`` object. In that case,
the ``rpc`` method will simply use it instead of creating a new one. This
is useful when one accesses advanced features of the `XMLHTTPRequest` API.
- ``silent (boolean)`` If set to ``true``, the web client will not provide
a feedback that there is a pending rpc.
The ``rpc`` service communicates with the server by using a ``XMLHTTPRequest``
object, configured to work with the ``application/json`` content type. So clearly
the content of the request should be JSON serializable. Each request done by
this service uses the ``POST`` http method.
Server errors actually return the response with an http code 200. But the ``rpc``
service will treat them as error.
Error Handling
~~~~~~~~~~~~~~
An rpc can fail for two main reasons:
* either the odoo server returns an error (so, we call this a ``server`` error).
In that case the http request will return with an http code 200 BUT with a
response object containing an ``error`` key.
* or there is some other kind of network error
When a rpc fails, then:
* the promise representing the rpc is rejected, so the calling code will crash,
unless it handles the situation
*
an event ``RPC_ERROR`` is triggered on the main application bus. The event payload
contains a description of the cause of the error:
If it is a server error (the server code threw an exception). In that case
the event payload will be an object with the following keys:
* ``type = 'server'``
* ``message(string)``
*
``code(number)``
*
``name(string)`` (optional, used by the error service to look for an appropriate
dialog to use when handling the error)
* ``subType(string)`` (optional, often used to determine the dialog title)
* ``data(object)`` (optional object that can contain various keys among which
``debug`` : the main debug information, with the call stack)
If it is a network error, then the error description is simply an object
``{type: 'network'}``.
When a network error occurs, a :ref:`notification <frontend/services/notification>` is
displayed and the server is regularly contacted until it responds. The
notification is closed as soon as the server responds.
.. _frontend/services/title:
Title Service
-------------
Overview
~~~~~~~~
- Technical name: `title`
- Dependencies: none
The `title` service offers a simple API that allows to read/modify the document
title. For example, if the current document title is "Odoo", we can change it
to "Odoo 15 - Apple" by using the following command:
.. code-block:: javascript
// in some component setup method
const titleService = useService("title");
titleService.setParts({ odoo: "Odoo 15", fruit: "Apple" });
API
~~~
The ``title`` service manipulates the following interface:
.. code-block:: ts
interface Parts {
[key: string]: string | null;
}
Each key represents the identity of a part of the title, and each value is the
string that is displayed, or `null` if it has been removed.
Its API is:
.. js:data:: current
:noindex:
This is a string representing the current title. It is structured in the
following way: ``value_1 - ... - value_n`` where each `value_i` is a (non null)
value found in the `Parts` object (returned by the `getParts` function)
.. js:function:: getParts
:returns: Parts the current `Parts` object maintained by the title service
.. js:function:: setParts(parts)
:param Parts parts: object representing the required change
The ``setParts`` method allows to add/replace/delete several parts of the title.
Delete a part (a value) is done by setting the associated key value to `null`.
Note that one can only modify a single part without affecting the other
parts. For example, if the title is composed of the following parts:
.. code-block:: javascript
{ odoo: "Odoo", action: "Import" }
with ``current`` value being ``Odoo - Import`` , then
.. code-block:: javascript
setParts({
action: null,
});
will change the title to ``Odoo``.
.. _frontend/services/user:
User service
------------
Overview
~~~~~~~~
* Technical name: `user`
* Dependencies: `rpc`
The `user` service provides a bunch of data and a few helper functions concerning
the connected user.
API
~~~
.. list-table::
:widths: 25 25 50
:header-rows: 1
* - Name
- Type
- Description
* - ``context``
- ``Object``
- The :ref:`user context<frontend/framework/user_context>`
* - ``db``
- ``Object``
- Info about the database
* - ``home_action_id``
- ``(number | false)``
- Id of the action used as home for the user
* - ``isAdmin``
- ``boolean``
- Whether the user is an admin (group `base.group_erp_manager` or superuser)
* - ``isSystem``
- ``boolean``
- Whether the user is part of the system group (`base.group_system`)
* - ``lang``
- ``string``
- language used
* - ``name``
- ``string``
- Name of the user
* - ``partnerId``
- ``number``
- Id of the partner instance of the user
* - ``tz``
- ``string``
- The timezone of the user
* - ``userId``
- ``number``
- Id of the user
* - ``userName``
- ``string``
- Alternative nick name of the user
.. js:function:: updateContext(update)
:param object update: the object to update the context with
update the :ref:`user context<frontend/framework/user_context>` with the given object.
.. code-block:: javascript
userService.updateContext({ isFriend: true })
.. js:function:: removeFromContext(key)
:param string key: the key of the targeted attribute
remove the value with the given key from the :ref:`user context<frontend/framework/user_context>`
.. code-block:: js
userService.removeFromContext("isFriend")
.. js:function:: hasGroup(group)
:param string group: the xml_id of the group to look for
:returns: `Promise<boolean>` is the user in the group
check if the user is part of a group
.. code-block:: js
const isInSalesGroup = await userService.hasGroup("sale.group_sales")
Reference in New Issue View Git Blame Copy Permalink