[IMP] website_sale: add eCommerce dashboard

This commit brings back the eCommerce dashboard for admins, providing
a quick overview of eCommerce sales performance.

- Adds the dashboard in list view.
- Implements custom search filters for relevant card data.
- Adds a dropdown with predefined time periods to view sales, average
  cart value, and conversion rate.
- Adds a new view for eCommerce orders as some extesions of main `sale`
  has no relevence in eCommerce context.

task-5153059

Author: nipl-odoo

addons/sale/models/sale_order.py

@@ -325,6 +325,11 @@ def _rec_names_search(self):
     show_update_pricelist = fields.Boolean(
         string="Has Pricelist Changed", store=False)  # True if the pricelist was changed
 
+    # filter related fields
+    is_unfulfilled = fields.Boolean(
+        string="Unfulfilled Orders", compute='_compute_is_unfulfilled', search='_search_is_unfulfilled',
+    )
+
     _date_order_id_idx = models.Index("(date_order desc, id desc)")
 
     #=== COMPUTE METHODS ===#
@@ -523,6 +528,36 @@ def _compute_amounts(self):
             order.amount_tax = tax_totals['tax_amount_currency']
             order.amount_total = tax_totals['total_amount_currency']
 
+    @api.depends(
+        'order_line.qty_delivered',
+        'order_line.product_uom_qty',
+    )
+    def _compute_is_unfulfilled(self):
+        for order in self:
+            order.is_unfulfilled = (
+                any(
+                    line.qty_delivered < line.product_uom_qty
+                    for line in order.order_line
+                )
+                and order.state == 'sale'
+            )
+
+    def _search_is_unfulfilled(self, operator, value):
+        if operator not in ('=', '!='):
+            return NotImplemented
+
+        operator = 'any' if operator == '=' else 'not any'
+
+        line_domain = Domain.custom(
+            to_sql=lambda model, alias, query: SQL(
+                '%s < %s',
+                model._field_to_sql(alias, 'qty_delivered', query),
+                model._field_to_sql(alias, 'product_uom_qty', query),
+            ),
+        )
+
+        return Domain('state', '=', 'sale') & Domain('order_line', operator, line_domain)
+
     def _add_base_lines_for_early_payment_discount(self):
         """
         When applying a payment term with an early payment discount, and when said payment term computes the tax on the

addons/website_sale/__manifest__.py

@@ -159,6 +159,8 @@
             'website_sale/static/src/js/tours/website_sale_shop.js',
             'website_sale/static/src/xml/website_sale.xml',
             'website_sale/static/src/scss/kanban_record.scss',
+            'website_sale/static/src/js/website_sale_dashboard/**/*',
+            'website_sale/static/src/views/**/*',
         ],
         'website.website_builder_assets': [
             'website_sale/static/src/js/website_sale_form_editor.js',

addons/website_sale/models/sale_order.py

@@ -9,7 +9,7 @@
 from odoo.exceptions import UserError, ValidationError
 from odoo.fields import Command, Domain
 from odoo.http import request
-from odoo.tools import float_is_zero
+from odoo.tools import float_is_zero, float_round
 
 from odoo.addons.website_sale.models.website import (
     FISCAL_POSITION_SESSION_CACHE_KEY,
@@ -892,3 +892,150 @@ def _recompute_cart(self):
         """Recompute taxes and prices for the current cart."""
         self._recompute_taxes()
         self._recompute_prices()
+
+    @api.model
+    def retrieve_dashboard(self, period):
+        """
+        Retrieve eCommerce dashboard statistics for a given period.
+
+        The data includes both period-based figures (total visitors, total sales, total orders)
+        and global order counts (to fulfill, to confirm, to invoice).
+
+        :param str period: Identifier for the selected time period.
+        :return: A dictionary containing dashboard statistics.
+        :rtype: dict
+        """
+        # Shape of the return value
+        matrix = {
+            'current_period': {
+                'total_visitors': 0,
+                'total_sales': 0.0,
+                'total_orders': 0,
+            },
+            'period_gain': {
+                'total_visitors': 0,
+                'total_sales': 0,
+                'total_orders': 0,
+            },
+            'overall': {
+                'to_fulfill': 0,
+                'to_confirm': 0,
+                'to_invoice': 0,
+            },
+        }
+
+        # Build domain for the given period
+        ecommerce_orders_domain = Domain('website_id', '!=', False) & Domain('state', '=', 'sale')
+        order_period_domain = self._get_period_domain(period, 'date_order') & ecommerce_orders_domain
+        order_previous_period_domain = self._get_previous_period_domain(period, 'date_order') & ecommerce_orders_domain
+        visitor_period_domain = self._get_period_domain(period, 'last_connection_datetime')
+        visitor_previous_period_domain = self._get_previous_period_domain(period, 'last_connection_datetime')
+
+        if order_period_domain or visitor_period_domain or order_previous_period_domain or visitor_previous_period_domain:
+            # Compute period-based figures
+            current_period_order_data = self._get_orders_period_data(order_period_domain)
+            current_period_visitor_data = self._get_visitors_period_data(visitor_period_domain)
+            matrix['current_period']['total_sales'] = current_period_order_data['total_sales']
+            matrix['current_period']['total_orders'] = current_period_order_data['total_orders']
+            matrix['current_period']['total_visitors'] = current_period_visitor_data['total_visitors']
+
+            previous_period_order_data = self._get_orders_period_data(order_previous_period_domain)
+            previous_period_visitor_data = self._get_visitors_period_data(visitor_previous_period_domain)
+            matrix['period_gain']['total_sales'] = (
+                round(
+                    (
+                        (
+                            current_period_order_data['total_sales']
+                            - previous_period_order_data['total_sales']
+                        )
+                        / previous_period_order_data['total_sales']
+                    )
+                    * 100
+                )
+                if previous_period_order_data.get('total_sales')
+                else None
+            )
+            matrix['period_gain']['total_orders'] = (
+                round(
+                    (
+                        (
+                            current_period_order_data['total_orders']
+                            - previous_period_order_data['total_orders']
+                        )
+                        / previous_period_order_data['total_orders']
+                    )
+                    * 100
+                )
+                if previous_period_order_data.get('total_orders')
+                else None
+            )
+            matrix['period_gain']['total_visitors'] = (
+                round(
+                    (
+                        (
+                            current_period_visitor_data['total_visitors']
+                            - previous_period_visitor_data['total_visitors']
+                        )
+                        / previous_period_visitor_data['total_visitors']
+                    )
+                    * 100
+                )
+                if previous_period_visitor_data.get('total_visitors')
+                else None
+            )
+
+        # Compute overall counts
+        matrix['overall']['to_fulfill'] = self.search_count(
+            Domain('is_unfulfilled', '=', True) & ecommerce_orders_domain,
+        )
+        matrix['overall']['to_confirm'] = self.search_count(
+            Domain('state', '=', 'sent') & Domain('website_id', '!=', False),
+        )
+        matrix['overall']['to_invoice'] = self.search_count(
+            Domain('invoice_status', '=', 'to invoice') & ecommerce_orders_domain,
+        )
+
+        return matrix
+
+    def _get_period_domain(self, period, field):
+        if period == 'last_7_days':
+            return Domain(field, '>', 'today -7d +1d')
+        if period == 'last_30_days':
+            return Domain(field, '>', 'today -30d +1d')
+        if period == 'last_90_days':
+            return Domain(field, '>', 'today -90d +1d')
+        if period == 'last_365_days':
+            return Domain(field, '>', 'today -365d +1d')
+
+        return False
+
+    def _get_previous_period_domain(self, period, field):
+        if period == 'last_7_days':
+            return Domain(field, '>', 'today -14d +1d') & Domain(field, '<', 'today -7d +1d')
+        if period == 'last_30_days':
+            return Domain(field, '>', 'today -60d +1d') & Domain(field, '<', 'today -30d +1d')
+        if period == 'last_90_days':
+            return Domain(field, '>', 'today -180d +1d') & Domain(field, '<', 'today -90d +1d')
+        if period == 'last_365_days':
+            return Domain(field, '>', 'today -730d +1d') & Domain(field, '<', 'today -365d +1d')
+
+        return False
+
+    def _get_orders_period_data(self, period_domain):
+        aggregated_order_data = self._read_group(
+            domain=period_domain,
+            aggregates=['amount_total:sum', '__count'],
+        )
+        total_sales, total_orders = aggregated_order_data[0]
+
+        return {
+            'total_sales': float_round(total_sales, precision_rounding=0.01),
+            'total_orders': total_orders,
+        }
+
+    def _get_visitors_period_data(self, period_domain):
+        visitor_count = self.env['website.visitor'].search_count(period_domain)
+
+        return {
+            'total_visitors': visitor_count,
+        }

addons/website_sale/static/src/js/website_sale_dashboard/date_filter_button/date_filter_button.js

@@ -0,0 +1,43 @@
+import { _t } from '@web/core/l10n/translation';
+import { Component } from '@odoo/owl';
+import { Dropdown } from '@web/core/dropdown/dropdown';
+import { DropdownItem } from '@web/core/dropdown/dropdown_item';
+
+export const DATE_OPTIONS = [
+	{
+		id: 'last_7_days',
+		label: _t("Last 7 days"),
+	},
+	{
+		id: 'last_30_days',
+		label: _t("Last 30 days"),
+	},
+	{
+		id: 'last_90_days',
+		label: _t("Last 90 days"),
+	},
+	{
+		id: 'last_365_days',
+		label: _t("Last 365 days"),
+	},
+];
+
+export class DateFilterButton extends Component {
+	static template = 'website_sale.DateFilterButton';
+	static components = { Dropdown, DropdownItem };
+	static props = {
+		selectedFilter: {
+			type: Object,
+			optional: true,
+			shape: {
+				id: String,
+				label: String,
+			},
+		},
+		update: Function,
+	};
+
+	get dateFilters() {
+		return DATE_OPTIONS;
+	}
+}

addons/website_sale/static/src/js/website_sale_dashboard/date_filter_button/date_filter_button.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates>
+    <t t-name="website_sale.DateFilterButton">
+        <Dropdown navigationOptions="{ 'shouldFocusChildInput': false }">
+            <button class="btn btn-secondary">
+                <i class="fa fa-calendar me-2"/>
+                <span t-esc="props.selectedFilter.label"/>
+            </button>
+            <t t-set-slot="content">
+                <t t-foreach="dateFilters" t-as="filter" t-key="filter.id">
+                    <DropdownItem
+                        tag="'div'"
+                        class="{ 'selected': props.selectedFilter.id === filter.id, 'd-flex justify-content-between': true }"
+                        closingMode="'none'"
+                        onSelected="() => this.props.update(filter)"
+                    >
+                        <div t-esc="filter.label"/>
+                    </DropdownItem>
+                </t>
+            </t>
+        </Dropdown>
+    </t>
+</templates>

addons/website_sale/static/src/js/website_sale_dashboard/website_sale_dashboard.js

@@ -0,0 +1,58 @@
+import { useService } from '@web/core/utils/hooks';
+import { Component, onWillStart, onWillUpdateProps, useState } from '@odoo/owl';
+import { DateFilterButton, DATE_OPTIONS } from './date_filter_button/date_filter_button';
+
+export class WebsiteSaleDashboard extends Component {
+	static template = 'website_sale.WebsiteSaleDashboard';
+	static props = { list: { type: Object, optional: true } };
+	static components = { DateFilterButton };
+
+	setup() {
+		this.state = useState({
+			eCommerceData: {},
+			selectedFilter: DATE_OPTIONS[0],
+		});
+		this.orm = useService('orm');
+
+		onWillStart(async () => {
+			await this.updateDashboardState();
+		});
+		onWillUpdateProps(async () => {
+			await this.updateDashboardState();
+		});
+	}
+
+	async updateDashboardState(filter = false) {
+		if (filter) {
+			this.state.selectedFilter = filter;
+		}
+		this.state.eCommerceData = await this.orm.call('sale.order', 'retrieve_dashboard', [
+			this.state.selectedFilter.id,
+		]);
+	}
+
+	/**
+	 * This method clears the current search query and activates
+	 * the filters found in `filter_name` attibute from card clicked
+	 */
+	setSearchContext(ev) {
+		const filter_name = ev.currentTarget.getAttribute('filter_name');
+		const filters = filter_name.split(',');
+		const searchItems = this.env.searchModel.getSearchItems((item) =>
+			filters.includes(item.name)
+		);
+		this.env.searchModel.query = [];
+		for (const item of searchItems) {
+			this.env.searchModel.toggleSearchItem(item.id);
+		}
+	}
+
+	getPeriodCardClass(dataName) {
+		if (this.state.eCommerceData['period_gain'][dataName] > 0) {
+			return 'text-success';
+		} else if (this.state.eCommerceData['period_gain'][dataName] < 0) {
+			return 'text-danger';
+		}
+		return 'text-muted';
+	}
+}