- Implemented ReopenScreen for managing the reopen policy, including admin-only access and editing capabilities. - Added MenuRow for navigating to the Reopen policy settings in the SettingsHubScreen. - Created unit tests for the ReopenPolicy model, covering JSON serialization and validation logic. - Introduced BusinessCalendar model and tests for business hours functionality. - Updated phone viewport tests to include scenarios for the reopen policy screen.
128 lines
4.8 KiB
Dart
128 lines
4.8 KiB
Dart
/// Whether a customer's reply brings a closed ticket back.
|
|
///
|
|
/// One row per org, four fields, plus three 30-day metrics the settings screen
|
|
/// draws. The whole question is what number goes in the window, and the only
|
|
/// thing that answers it is how customers actually behave, which is what the
|
|
/// metrics are for.
|
|
library;
|
|
|
|
/// `ReopenPolicySerializer.NON_TERMINAL_STATUSES`. A ticket reopened into a
|
|
/// terminal status would close again on arrival, so only these three.
|
|
const List<String> reopenToStatuses = ['New', 'Assigned', 'Pending'];
|
|
|
|
/// `validate_reopen_window_days`.
|
|
const int reopenWindowMin = 1;
|
|
const int reopenWindowMax = 365;
|
|
|
|
class ReopenPolicy {
|
|
const ReopenPolicy({
|
|
this.isEnabled = true,
|
|
this.windowDays = 7,
|
|
this.reopenToStatus = 'Pending',
|
|
this.notifyAssigned = true,
|
|
this.reopenedLast30d = 0,
|
|
this.repliesAfterWindow30d = 0,
|
|
this.medianDaysToReply = 0,
|
|
});
|
|
|
|
final bool isEnabled;
|
|
final int windowDays;
|
|
final String reopenToStatus;
|
|
final bool notifyAssigned;
|
|
|
|
/// One REOPENED activity per reopen. Honest history even when the policy has
|
|
/// since been turned off.
|
|
final int reopenedLast30d;
|
|
|
|
/// Replies that landed too late to reopen anything. **Only counted while the
|
|
/// policy is on**: see [missedWindowIsMeasured].
|
|
final int repliesAfterWindow30d;
|
|
|
|
/// Days from close to reply, across every post-close external reply that can
|
|
/// be dated.
|
|
final int medianDaysToReply;
|
|
|
|
/// Whether [repliesAfterWindow30d] is a measurement or a zero by
|
|
/// construction.
|
|
///
|
|
/// `cases/signals.py::_evaluate_reopen` returns `None` on
|
|
/// `if not policy["is_enabled"]`, **before** it ever compares the window, and
|
|
/// the `out_of_reopen_window` flag the metric counts is written only for the
|
|
/// `"out_of_window"` return. So with the policy off nothing is ever flagged
|
|
/// and the count is always zero, in exactly the state where every reply to a
|
|
/// closed ticket reopens nothing. A card reading "0 replies missed the
|
|
/// window" there is reassurance about the one thing that is certainly
|
|
/// happening.
|
|
bool get missedWindowIsMeasured => isEnabled;
|
|
|
|
factory ReopenPolicy.fromJson(Map<String, dynamic> json) => ReopenPolicy(
|
|
isEnabled: json['is_enabled'] as bool? ?? true,
|
|
windowDays: _int(json['reopen_window_days'], 7),
|
|
reopenToStatus: json['reopen_to_status']?.toString() ?? 'Pending',
|
|
notifyAssigned: json['notify_assigned'] as bool? ?? true,
|
|
reopenedLast30d: _int(json['reopened_last_30d'], 0),
|
|
repliesAfterWindow30d: _int(json['replies_after_window_30d'], 0),
|
|
medianDaysToReply: _int(json['median_days_to_reply'], 0),
|
|
);
|
|
}
|
|
|
|
int _int(dynamic value, int fallback) {
|
|
if (value is int) return value;
|
|
if (value is num) return value.round();
|
|
if (value is String) return int.tryParse(value) ?? fallback;
|
|
return fallback;
|
|
}
|
|
|
|
/// The body for `PUT /cases/reopen-policy/`.
|
|
///
|
|
/// All four fields go every time. The endpoint is `partial=True` and would
|
|
/// accept a subset, but the form edits all four at once and a partial body
|
|
/// makes "switched off" and "not sent" the same thing for the two booleans.
|
|
Map<String, dynamic> reopenPolicyPayload({
|
|
required bool isEnabled,
|
|
required int windowDays,
|
|
required String reopenToStatus,
|
|
required bool notifyAssigned,
|
|
}) => {
|
|
'is_enabled': isEnabled,
|
|
'reopen_window_days': windowDays,
|
|
'reopen_to_status': reopenToStatus,
|
|
'notify_assigned': notifyAssigned,
|
|
};
|
|
|
|
/// What a reopen save has to fix before it is worth sending, or `null`.
|
|
///
|
|
/// Both rules are `ReopenPolicySerializer`'s, which is the authority. These
|
|
/// exist so a typo answers immediately rather than after a round trip.
|
|
String? reopenPolicyProblem({
|
|
required int? windowDays,
|
|
required String reopenToStatus,
|
|
}) {
|
|
if (windowDays == null ||
|
|
windowDays < reopenWindowMin ||
|
|
windowDays > reopenWindowMax) {
|
|
return 'The window has to be a whole number of days between '
|
|
'$reopenWindowMin and $reopenWindowMax.';
|
|
}
|
|
if (!reopenToStatuses.contains(reopenToStatus)) {
|
|
return 'A reopened ticket has to come back as New, Assigned or Pending.';
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/// What the policy does, in one sentence.
|
|
String reopenSummary(ReopenPolicy policy) => policy.isEnabled
|
|
? 'A reply within ${policy.windowDays} days brings a closed ticket back as '
|
|
'${policy.reopenToStatus}.'
|
|
: 'Closed tickets stay closed. A reply is filed on the ticket and nothing '
|
|
'else happens.';
|
|
|
|
/// The note that has to sit under the missed-window figure when the policy is
|
|
/// off, or `null`.
|
|
String? missedWindowCaveat(ReopenPolicy policy) {
|
|
if (policy.missedWindowIsMeasured) return null;
|
|
return 'Not counted while reopening is off. Replies to closed tickets are '
|
|
'filed and nothing else happens, so none of them are recorded as having '
|
|
'missed anything. This is a zero because nothing is measured, not '
|
|
'because nothing is being lost.';
|
|
}
|