Files
encoach_backend_v4/custom_addons/encoach_exam_template/models/approval.py
Yamen Ahmad 96f419d653 fix(config): align Configuration pages with platform logic
Audit of the admin Configuration section (FAQ Manager, Notification Rules,
Approval Config) surfaced three contract mismatches and one missing schema.

FAQ
  * Backend `encoach.faq.category.audience` / `encoach.faq.item.audience`
    rejected the `both` and `entity` values emitted by the FAQ Manager
    UI. Widened the Selection so the UI's full vocabulary round-trips.
  * FAQ item `video_url` was already accepted by the UI but silently
    dropped by the controller; now persisted via a new `video_url`
    field on `encoach.faq.item` and serialized on list/get responses.

Notification Rules
  * Added `days_before`, `frequency`, `channel`, `entity_id` to
    `encoach.notification.rule`. These are the exact fields the admin
    form collects; prior to this change they were serialized into the
    JSON body, ignored by the controller, and omitted from responses,
    leaving the Active switch permanently off and the table columns
    blank.
  * Controller now translates `active` <-> `is_active` both ways so the
    new frontend contract and legacy callers coexist. Missing required
    fields return HTTP 400 instead of 500.

Approval Workflows
  * The controller had been hand-rolling raw SQL against three tables
    (`encoach_approval_workflow`, `_stage`, `_request`) that no Odoo
    model declared, so the tables never existed. List() was guarded and
    returned empty; create() would 500 with "relation does not exist".
  * Introduced real ORM models in `encoach_exam_template/models/approval.py`
    plus access rights, which auto-provision the tables on -u.
  * Rewrote the controller to use ORM, added PATCH, and emitted both
    `items` and `results` in the list envelope so the frontend's
    PaginatedResponse reader and legacy callers both work. Step
    payloads now carry `max_days`, `auto_escalate`, and
    `notification_email` end to end.
  * Frontend `approvalsService` and `ApprovalWorkflowConfig` updated to
    send the full stage shape + `allow_bypass`, tolerate both envelope
    keys, and validate at least one approver before submit.

Schema delta applied via `./run.sh -u encoach_exam_template,encoach_lms_api`.
Verified with new `test_config_flows.py`: 24/24 passing. Regression runs
on `test_support_flows.py` (29/29) and `test_training_flows.py` (26/26)
remain green.

Made-with: Cursor
2026-04-19 10:58:43 +04:00

96 lines
3.7 KiB
Python

"""Approval workflow models.
Powers the admin "Approval Config" page (`/admin/approval-config`) and the
per-record approval requests exposed by `ApprovalWorkflowController`.
Prior to this module the controller hand-rolled raw SQL against tables that
were never created. These ORM models now own the schema so Odoo can create
the tables on install/update and the controller can use a standard API.
"""
from odoo import api, fields, models
STATUS_SELECTION = [
('draft', 'Draft'),
('active', 'Active'),
('archived', 'Archived'),
]
REQUEST_STATE = [
('draft', 'Draft'),
('in_progress', 'In Progress'),
('approved', 'Approved'),
('rejected', 'Rejected'),
('bypassed', 'Bypassed'),
]
STAGE_STATUS = [
('pending', 'Pending'),
('approved', 'Approved'),
('rejected', 'Rejected'),
('skipped', 'Skipped'),
]
class EncoachApprovalWorkflow(models.Model):
_name = 'encoach.approval.workflow'
_description = 'Approval Workflow'
_order = 'create_date desc'
name = fields.Char(required=True)
type = fields.Char(default='custom',
help='Categorical tag e.g. leave, purchase, content, custom.')
status = fields.Selection(STATUS_SELECTION, default='draft', required=True,
help='Draft = not yet routable. Active = available to new requests.')
allow_bypass = fields.Boolean(
default=False,
help='If true, a bypass reason allows the workflow to be skipped.')
entity_id = fields.Many2one('encoach.entity', ondelete='set null')
stage_ids = fields.One2many('encoach.approval.stage', 'workflow_id',
copy=True)
request_ids = fields.One2many('encoach.approval.request', 'workflow_id')
stage_count = fields.Integer(compute='_compute_counts')
request_count = fields.Integer(compute='_compute_counts')
@api.depends('stage_ids', 'request_ids')
def _compute_counts(self):
for rec in self:
rec.stage_count = len(rec.stage_ids)
rec.request_count = len(rec.request_ids)
class EncoachApprovalStage(models.Model):
_name = 'encoach.approval.stage'
_description = 'Approval Workflow Stage'
_order = 'sequence, id'
workflow_id = fields.Many2one('encoach.approval.workflow',
required=True, ondelete='cascade', index=True)
sequence = fields.Integer(default=10, required=True,
help='Stored order; the admin UI speaks `order`.')
approver_id = fields.Many2one('res.users', required=True, ondelete='restrict')
max_days = fields.Integer(default=3,
help='SLA before auto-escalation can fire.')
auto_escalate = fields.Boolean(default=False)
notification_email = fields.Char(
help='Optional CC address; falls back to approver_id.email otherwise.')
status = fields.Selection(STAGE_STATUS, default='pending')
comment = fields.Text()
acted_at = fields.Datetime()
class EncoachApprovalRequest(models.Model):
_name = 'encoach.approval.request'
_description = 'Approval Request'
_order = 'create_date desc'
workflow_id = fields.Many2one('encoach.approval.workflow',
required=True, ondelete='cascade', index=True)
res_model = fields.Char(help='Optional target model (e.g. op.student.leave).')
res_id = fields.Integer(help='Optional target record id inside res_model.')
state = fields.Selection(REQUEST_STATE, default='draft', required=True)
requester_id = fields.Many2one('res.users', ondelete='set null')
current_stage_id = fields.Many2one('encoach.approval.stage', ondelete='set null')
bypass_reason = fields.Text()
created_at = fields.Datetime(default=fields.Datetime.now)