devops/encoach_backend_new_v2
1
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases Wiki Activity

fix(config): align Configuration pages with platform logic

Browse Source 
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
This commit is contained in:
Yamen Ahmad
2026-04-19 10:58:43 +04:00
parent 7f23127e44
commit d940db075e
11 changed files with 841 additions and 259 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
backend/custom_addons/encoach_lms_api/controllers/faq.py
View File

@@ -29,6 +29,7 @@ def _ser_item(i):
'sequence': i.sequence,
'audience': i.audience or 'all',
'is_published': i.is_published,
'video_url': i.video_url or '',
}
@@ -128,6 +129,8 @@ class FaqController(http.Controller):
vals['sequence'] = int(body['sequence'])
if body.get('audience'):
vals['audience'] = body['audience']
if body.get('video_url') is not None:
vals['video_url'] = body['video_url'] or False
rec = request.env['encoach.faq.item'].sudo().create(vals)
return _json_response(_ser_item(rec))
except Exception as e:
@@ -151,6 +154,8 @@ class FaqController(http.Controller):
vals['sequence'] = int(body['sequence'])
if 'is_published' in body:
vals['is_published'] = bool(body['is_published'])
if 'video_url' in body:
vals['video_url'] = body['video_url'] or False
if vals:
rec.write(vals)
return _json_response(_ser_item(rec))

54
backend/custom_addons/encoach_lms_api/controllers/notifications.py
View File

@@ -28,12 +28,43 @@ def _ser_rule(r):
'name': r.name or '',
'event_type': r.event_type or '',
'template': r.template or '',
'is_active': r.is_active,
# Admin UI uses `active`; legacy callers still read `is_active`.
'active': bool(r.is_active),
'is_active': bool(r.is_active),
'recipients': r.recipients or 'all',
'channels': r.channels or '',
'days_before': r.days_before or 0,
'frequency': r.frequency or 'once',
'channel': r.channel or 'in_app',
'entity_id': r.entity_id.id or None,
'entity_name': r.entity_id.name if r.entity_id else None,
}
def _apply_rule_writes(body, vals):
"""Translate the incoming JSON body into ORM write values.
Accepts both the new (`active`, `channel`, `days_before`, `frequency`)
and legacy (`is_active`, `channels`) contracts.
"""
for k in ('name', 'event_type', 'template', 'recipients', 'frequency', 'channel'):
if k in body and body[k] is not None:
vals[k] = body[k]
if 'channels' in body and body['channels'] is not None:
vals['channels'] = body['channels']
if 'days_before' in body and body['days_before'] is not None:
try:
vals['days_before'] = int(body['days_before'])
except (TypeError, ValueError):
pass
if 'entity_id' in body:
vals['entity_id'] = int(body['entity_id']) if body['entity_id'] else False
if 'active' in body:
vals['is_active'] = bool(body['active'])
elif 'is_active' in body:
vals['is_active'] = bool(body['is_active'])
return vals
class NotificationsController(http.Controller):
@http.route('/api/notifications', type='http', auth='public', methods=['GET'], csrf=False)
@@ -109,21 +140,19 @@ class NotificationsController(http.Controller):
def create_rule(self, **kw):
try:
body = _get_json_body()
if not body.get('name'):
return _error_response('name is required', 400)
if not body.get('event_type'):
return _error_response('event_type is required', 400)
vals = {
'name': body.get('name', ''),
'event_type': body.get('event_type', ''),
}
if body.get('template'):
vals['template'] = body['template']
if body.get('recipients'):
vals['recipients'] = body['recipients']
if body.get('channels'):
vals['channels'] = body['channels']
if 'is_active' in body:
vals['is_active'] = bool(body['is_active'])
_apply_rule_writes(body, vals)
rec = request.env['encoach.notification.rule'].sudo().create(vals)
return _json_response(_ser_rule(rec))
except Exception as e:
_logger.exception('create notification rule failed')
return _error_response(str(e), 500)
@http.route('/api/notification-rules/<int:rid>', type='http', auth='public', methods=['PATCH', 'PUT'], csrf=False)
@@ -135,15 +164,12 @@ class NotificationsController(http.Controller):
return _error_response('Not found', 404)
body = _get_json_body()
vals = {}
for k in ('name', 'event_type', 'template', 'recipients', 'channels'):
if k in body:
vals[k] = body[k]
if 'is_active' in body:
vals['is_active'] = bool(body['is_active'])
_apply_rule_writes(body, vals)
if vals:
rec.write(vals)
return _json_response(_ser_rule(rec))
except Exception as e:
_logger.exception('update notification rule failed')
return _error_response(str(e), 500)
@http.route('/api/notification-rules/<int:rid>', type='http', auth='public', methods=['DELETE'], csrf=False)

28
backend/custom_addons/encoach_lms_api/models/faq.py
View File

@@ -1,4 +1,14 @@
from odoo import models, fields
from odoo import api, models, fields
FAQ_AUDIENCE = [
('all', 'All'),
('both', 'Both (Student + Entity)'),
('student', 'Students'),
('teacher', 'Teachers'),
('admin', 'Admins'),
('entity', 'Entity Users'),
]
class EncoachFaqCategory(models.Model):
@@ -8,16 +18,12 @@ class EncoachFaqCategory(models.Model):
name = fields.Char(required=True)
sequence = fields.Integer(default=10)
audience = fields.Selection([
('all', 'All'),
('student', 'Students'),
('teacher', 'Teachers'),
('admin', 'Admins'),
], default='all')
audience = fields.Selection(FAQ_AUDIENCE, default='all')
is_published = fields.Boolean(default=True)
item_ids = fields.One2many('encoach.faq.item', 'category_id')
item_count = fields.Integer(compute='_compute_item_count', store=True)
@api.depends('item_ids')
def _compute_item_count(self):
for rec in self:
rec.item_count = len(rec.item_ids)
@@ -32,10 +38,6 @@ class EncoachFaqItem(models.Model):
question = fields.Char(required=True)
answer = fields.Text(required=True)
sequence = fields.Integer(default=10)
audience = fields.Selection([
('all', 'All'),
('student', 'Students'),
('teacher', 'Teachers'),
('admin', 'Admins'),
], default='all')
audience = fields.Selection(FAQ_AUDIENCE, default='all')
is_published = fields.Boolean(default=True)
video_url = fields.Char(help='Optional walkthrough video URL.')

21
backend/custom_addons/encoach_lms_api/models/notification.py
View File

@@ -26,7 +26,8 @@ class EncoachNotificationRule(models.Model):
_description = 'Notification Rule'
name = fields.Char(required=True)
event_type = fields.Char(required=True)
event_type = fields.Char(required=True, help='e.g. deadline, chapter_unlock, '
'result_release, assignment, exam')
template = fields.Text()
is_active = fields.Boolean(default=True)
recipients = fields.Selection([
@@ -35,7 +36,23 @@ class EncoachNotificationRule(models.Model):
('teachers', 'Teachers Only'),
('admins', 'Admins Only'),
], default='all')
channels = fields.Char(help='Comma-separated: email,push,in_app')
channels = fields.Char(help='Legacy: comma-separated email,push,in_app. '
'New code should use `channel` instead.')
# New fields aligned with the admin Configuration UI (NotificationRules page)
days_before = fields.Integer(default=1,
help='Lead time in days before the event fires.')
frequency = fields.Selection([
('once', 'Once'),
('daily', 'Daily'),
('custom', 'Custom schedule'),
], default='once')
channel = fields.Selection([
('in_app', 'In-App'),
('email', 'Email'),
('both', 'Both'),
], default='in_app')
entity_id = fields.Many2one('encoach.entity', ondelete='set null')
class EncoachNotificationPreference(models.Model):