eduvia/workavia-mail-front
11
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

TF-4265 Add integration test for attachment reminder on mobile

Browse Source
This commit is contained in:
dab246
2026-01-30 16:09:38 +07:00
committed by Dat H. Pham
parent 74c0c75023
commit 2a3325ab7a
17 changed files with 781 additions and 899 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/configuration/attachment_keywords_configuration.md
+18 -65
View File
@@ -1,77 +1,30 @@
## Configuration for Attachment Keyword Detection
## Attachment Keyword Detection — Configuration
### Context
The system warns users when email content implies an attachment (e.g. "please find attached") but no file is attached.
* When a user composes an email, the system detects if the content implies an attachment (e.g., "Please find attached...") but no file is attached.
* We need a flexible way to add specific keywords (Include) or ignore specific tokens (Exclude) without modifying the source code.
### Configuration file
### How to configure
1. Configuration File Location
* The configuration is managed in the JSON file: `configurations/attachment_keywords.json`
* This file must be declared in `pubspec.yaml` under `assets`.
2. JSON Structure
The file consists of two main arrays:
`configurations/attachment_keywords.json` (must be declared in `pubspec.yaml` under `assets`):
```json
{
"includeList": [
"invoice",
"estimate",
"báo giá"
],
"excludeList": [
"signature-logo",
"no-reply",
"icon-app"
]
"includeList": ["invoice", "estimate", "báo giá"],
"excludeList": ["signature-logo", "no-reply", "icon-app"]
}
```
* `includeList`: List of keywords to **add** to the detection dictionary.
* Used when the default dictionary (hardcoded in app) is missing specific business terms.
* Matches are case-insensitive.
* Example: Adding `"cv"` will trigger the alert for "Attached is my CV".
| Field | Purpose |
|-------|---------|
| `includeList` | Add custom keywords to the built-in multi-language dictionary (case-insensitive) |
| `excludeList` | Suppress false positives — tokens matched here are ignored even if they contain a keyword |
### How it works
* `excludeList`: List of tokens to **ignore/block** from detection.
* Used to prevent false positives where a keyword exists but is part of a system string or signature.
* The filter checks the full surrounding token (e.g., if you exclude `"signature-logo"`, the text `"check signature-logo"` will be ignored even if it contains "signature").
1. On "Send", if the user already has an attachment, the check is skipped entirely.
2. Email HTML is converted to plain text (signatures, quotes, and HTML stripped).
3. `includeList` is merged with the built-in dictionary; a Unicode-aware Regex is built (cached).
4. Each match is validated against `excludeList` using full surrounding token context.
5. If keywords remain and no file is attached, a warning dialog is shown.
3. Application Logic
* **Loading:** The file is loaded lazily and cached in memory upon the first request (Singleton pattern).
* **Execution Flow:**
1. User clicks "Send".
2. App loads `includeList` and merges it with the default multi-language dictionary.
3. Regex scans the text.
4. Matches are filtered against the `excludeList`.
5. If valid keywords remain and no file is attached, a warning dialog is shown.
4. Example Customization
If you want to support a new document type called "Blueprints" and ignore a specific CSS class in the email body:
**Modify `configurations\attachment_keywords.json`:**
```json
{
"includeList": [
"blueprints",
"bản vẽ"
],
"excludeList": [
"css-class-attachment",
"div-id-file"
]
}
```
**Sync/Async:** Emails < 20,000 chars run synchronously; larger emails offload to a Dart Isolate via `compute()`.
**Cache:** Config and Regex pattern are cached in memory; both cleared on logout.