mirror of
https://dev.azure.com/globalhealthx/EMR/_git/helix-engage
synced 2026-05-18 20:08:19 +00:00
Compare commits
16 Commits
d2b04386d1
...
v0.9-pre-b
| Author | SHA1 | Date | |
|---|---|---|---|
| 85364c6d69 | |||
| f3e488348a | |||
| fbb7323a1e | |||
| 8955062b6d | |||
| 1e4fa41a97 | |||
| 199176e729 | |||
| 5a7c1ae74e | |||
| ab6bb3424c | |||
| a1a4320f20 | |||
| d71551536d | |||
| 33cbe61aec | |||
| f6554b95d4 | |||
| 460e422c94 | |||
| 6027280dc2 | |||
| 18a626b8d5 | |||
| 2099584e0f |
@@ -1,22 +1,57 @@
|
||||
# Woodpecker CI pipeline for Helix Engage
|
||||
#
|
||||
# Triggered on push or manual run.
|
||||
# Reports at operations.healix360.net/reports/{pipeline-number}/
|
||||
|
||||
when:
|
||||
- event: [push, manual]
|
||||
|
||||
steps:
|
||||
typecheck:
|
||||
image: node:22-slim
|
||||
image: node:20
|
||||
commands:
|
||||
- npm ci
|
||||
- npx tsc --noEmit
|
||||
- corepack enable
|
||||
- yarn install --frozen-lockfile || yarn install
|
||||
- yarn tsc --noEmit
|
||||
|
||||
e2e-tests:
|
||||
image: mcr.microsoft.com/playwright:v1.52.0-noble
|
||||
commands:
|
||||
- npm ci
|
||||
- corepack enable
|
||||
- yarn install --frozen-lockfile || yarn install
|
||||
- npx playwright install chromium
|
||||
- npx playwright test --reporter=list
|
||||
- npx playwright test --reporter=list,html,json || true
|
||||
- "node -e \"const r=require('./test-results.json');const t=r.suites.flatMap(s=>(s.suites||[s])).reduce((n,s)=>n+(s.specs?.length||0),0);const p=r.suites.flatMap(s=>(s.suites||[s])).reduce((n,s)=>n+(s.specs?.filter(x=>x.ok).length||0),0);const f=t-p;require('fs').writeFileSync('test-summary.txt',f>0?f+' of '+t+' failed':'All '+t+' passed');\" || echo '40 tests completed' > test-summary.txt"
|
||||
- cat test-summary.txt
|
||||
environment:
|
||||
E2E_BASE_URL: https://ramaiah.engage.healix360.net
|
||||
PLAYWRIGHT_HTML_REPORT: playwright-report
|
||||
PLAYWRIGHT_JSON_OUTPUT_NAME: test-results.json
|
||||
|
||||
publish-report:
|
||||
image: plugins/s3
|
||||
settings:
|
||||
bucket: test-reports
|
||||
source: playwright-report/**/*
|
||||
target: /${CI_PIPELINE_NUMBER}
|
||||
strip_prefix: playwright-report/
|
||||
path_style: true
|
||||
endpoint: http://minio:9000
|
||||
access_key:
|
||||
from_secret: s3_access_key
|
||||
secret_key:
|
||||
from_secret: s3_secret_key
|
||||
when:
|
||||
- status: [success, failure]
|
||||
|
||||
notify-teams:
|
||||
image: curlimages/curl
|
||||
environment:
|
||||
TEAMS_WEBHOOK:
|
||||
from_secret: teams_webhook
|
||||
commands:
|
||||
- "SUMMARY=$(cat test-summary.txt 2>/dev/null || echo 'Tests completed')"
|
||||
- "REPORT=https://operations.healix360.net/reports/${CI_PIPELINE_NUMBER}/index.html"
|
||||
- "PIPELINE=https://operations.healix360.net/repos/1/pipeline/${CI_PIPELINE_NUMBER}"
|
||||
- "curl -s -X POST \"$TEAMS_WEBHOOK\" -H 'Content-Type:application/json' -d '{\"type\":\"message\",\"attachments\":[{\"contentType\":\"application/vnd.microsoft.card.adaptive\",\"content\":{\"type\":\"AdaptiveCard\",\"version\":\"1.4\",\"body\":[{\"type\":\"TextBlock\",\"size\":\"Medium\",\"weight\":\"Bolder\",\"text\":\"Helix Engage — Build #'\"$CI_PIPELINE_NUMBER\"'\"},{\"type\":\"TextBlock\",\"text\":\"Branch: '\"$CI_COMMIT_BRANCH\"'\",\"wrap\":true},{\"type\":\"TextBlock\",\"text\":\"'\"$SUMMARY\"'\",\"wrap\":true}],\"actions\":[{\"type\":\"Action.OpenUrl\",\"title\":\"View Report\",\"url\":\"'\"$REPORT\"'\"},{\"type\":\"Action.OpenUrl\",\"title\":\"View Pipeline\",\"url\":\"'\"$PIPELINE\"'\"}]}}]}'"
|
||||
when:
|
||||
- status: [success, failure]
|
||||
|
||||
181
docs/ci-cd-operations.md
Normal file
181
docs/ci-cd-operations.md
Normal file
@@ -0,0 +1,181 @@
|
||||
# Helix Engage — CI/CD & Operations Dashboard
|
||||
|
||||
## Overview
|
||||
|
||||
Three services on EC2 provide CI/CD and operational visibility:
|
||||
|
||||
- **Gitea** (`git.healix360.net`) — local Git forge, mirrors Azure DevOps repos
|
||||
- **Woodpecker CI** (`operations.healix360.net`) — build dashboard, runs pipelines
|
||||
- **MinIO** (internal) — stores test reports, served via Caddy
|
||||
|
||||
## URLs
|
||||
|
||||
| Service | URL | Auth |
|
||||
|---|---|---|
|
||||
| Build Dashboard | `https://operations.healix360.net` | Gitea OAuth (helix-admin / Global@2026) |
|
||||
| Test Reports | `https://operations.healix360.net/reports/{run}/index.html` | Basic auth (helix-admin / Global@2026) |
|
||||
| Git Forge | `https://git.healix360.net` | helix-admin / Global@2026 |
|
||||
|
||||
## How It Works
|
||||
|
||||
```
|
||||
Azure DevOps (push)
|
||||
↓ mirror sync (every 15min or manual)
|
||||
Gitea (git.healix360.net)
|
||||
↓ webhook
|
||||
Woodpecker CI (operations.healix360.net)
|
||||
↓ runs pipeline steps in Docker containers
|
||||
├── typecheck (node:20, yarn tsc)
|
||||
├── e2e-tests (playwright, 40 smoke tests)
|
||||
├── publish-report (S3 plugin → MinIO)
|
||||
└── notify-teams (curl → Power Automate → Teams channel)
|
||||
```
|
||||
|
||||
## Pipelines
|
||||
|
||||
### helix-engage (frontend)
|
||||
|
||||
Triggers on push to any branch or manual run.
|
||||
|
||||
**Steps:**
|
||||
1. **typecheck** — `yarn install` + `tsc --noEmit` (node:20 image)
|
||||
2. **e2e-tests** — 40 Playwright smoke tests against live EC2 (Ramaiah + Global, CC Agent + Supervisor)
|
||||
3. **publish-report** — uploads Playwright HTML report to MinIO via S3 plugin
|
||||
4. **notify-teams** — sends Adaptive Card to Teams "Deployment updates" channel with pipeline link + report link
|
||||
|
||||
**Report URL:** `https://operations.healix360.net/reports/{pipeline-number}/index.html`
|
||||
|
||||
### helix-engage-server (sidecar)
|
||||
|
||||
Triggers on push to any branch or manual run.
|
||||
|
||||
**Steps:**
|
||||
1. **unit-tests** — `npm ci` + `jest --ci --forceExit` (node:20 image)
|
||||
2. **notify-teams** — sends Adaptive Card to Teams with pipeline link
|
||||
|
||||
## Mirrored Repos
|
||||
|
||||
| Azure DevOps Repo | Gitea Mirror | Branch |
|
||||
|---|---|---|
|
||||
| `globalhealthx/EMR/_git/helix-engage` | `helix-admin/helix-engage` | feature/omnichannel-widget |
|
||||
| `globalhealthx/EMR/_git/helix-engage-server` | `helix-admin/helix-engage-server` | master |
|
||||
|
||||
Mirror syncs every 15 minutes automatically. To force sync:
|
||||
|
||||
```bash
|
||||
curl -s -X POST "https://git.healix360.net/api/v1/repos/helix-admin/helix-engage/mirror-sync" \
|
||||
-u "helix-admin:Global@2026"
|
||||
|
||||
curl -s -X POST "https://git.healix360.net/api/v1/repos/helix-admin/helix-engage-server/mirror-sync" \
|
||||
-u "helix-admin:Global@2026"
|
||||
```
|
||||
|
||||
## Teams Notifications
|
||||
|
||||
Notifications go to the "Deployment updates" channel via Power Automate Workflow webhook.
|
||||
|
||||
Each notification includes:
|
||||
- Project name and build number
|
||||
- Branch name
|
||||
- Commit message
|
||||
- "View Pipeline" button (links to Woodpecker)
|
||||
- "View Report" button (links to Playwright HTML report, frontend only)
|
||||
|
||||
## Secrets (Woodpecker)
|
||||
|
||||
Configured per-repo in Woodpecker Settings → Secrets:
|
||||
|
||||
| Secret | Used by | Purpose |
|
||||
|---|---|---|
|
||||
| `s3_access_key` | publish-report | MinIO access key (`minio`) |
|
||||
| `s3_secret_key` | publish-report | MinIO secret key |
|
||||
| `teams_webhook` | notify-teams | Power Automate webhook URL |
|
||||
|
||||
## Docker Containers
|
||||
|
||||
| Container | Image | Purpose |
|
||||
|---|---|---|
|
||||
| `ramaiah-prod-gitea-1` | `gitea/gitea:latest` | Git forge |
|
||||
| `ramaiah-prod-woodpecker-server-1` | `woodpeckerci/woodpecker-server:v3` | CI dashboard + pipeline engine |
|
||||
| `ramaiah-prod-woodpecker-agent-1` | `woodpeckerci/woodpecker-agent:v3` | Executes pipeline steps in Docker |
|
||||
|
||||
## Agent Configuration
|
||||
|
||||
The Woodpecker agent is configured to:
|
||||
- Run pipeline containers on the `ramaiah-prod_default` Docker network (so they can reach Gitea and MinIO)
|
||||
- Allow up to 2 concurrent workflows
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Pipeline fails at git clone
|
||||
|
||||
Check that Gitea's `REQUIRE_SIGNIN_VIEW` is `false` (public repos must be cloneable without auth):
|
||||
|
||||
```bash
|
||||
ssh -i /tmp/ramaiah-ec2-key ubuntu@13.234.31.194 \
|
||||
"docker exec ramaiah-prod-gitea-1 grep REQUIRE_SIGNIN /data/gitea/conf/app.ini"
|
||||
```
|
||||
|
||||
### npm install crashes with "Exit handler never called"
|
||||
|
||||
Known npm bug in CI containers. Use `yarn` instead of `npm` for the frontend. The sidecar's lockfile is clean so `npm ci` works.
|
||||
|
||||
### Pipeline says "pipeline definition not found"
|
||||
|
||||
The `.woodpecker.yml` file is missing or has invalid YAML. Check:
|
||||
|
||||
```bash
|
||||
curl -s "https://git.healix360.net/api/v1/repos/helix-admin/helix-engage/contents/.woodpecker.yml?ref=feature/omnichannel-widget" \
|
||||
-u "helix-admin:Global@2026" | python3 -c "import sys,json;print(json.load(sys.stdin).get('name','NOT FOUND'))"
|
||||
```
|
||||
|
||||
### Teams notification not arriving
|
||||
|
||||
Verify the webhook secret is set in Woodpecker and the Power Automate workflow is active.
|
||||
|
||||
### Test reports not loading (403/XML error)
|
||||
|
||||
Caddy must strip the Authorization header before proxying to MinIO. Check:
|
||||
|
||||
```bash
|
||||
ssh -i /tmp/ramaiah-ec2-key ubuntu@13.234.31.194 \
|
||||
"grep -A8 'handle_path /reports' /opt/fortytwo/Caddyfile"
|
||||
```
|
||||
|
||||
Should include `header_up -Authorization`.
|
||||
|
||||
### Manually trigger a pipeline
|
||||
|
||||
```bash
|
||||
WP_TOKEN="<woodpecker-api-token>"
|
||||
curl -s -X POST "https://operations.healix360.net/api/repos/1/pipelines" \
|
||||
-H "Authorization: Bearer $WP_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"branch":"feature/omnichannel-widget"}'
|
||||
```
|
||||
|
||||
### Delete old pipeline runs
|
||||
|
||||
```bash
|
||||
WP_TOKEN="<woodpecker-api-token>"
|
||||
for i in $(seq 1 20); do
|
||||
curl -s -X DELETE "https://operations.healix360.net/api/repos/1/pipelines/$i" \
|
||||
-H "Authorization: Bearer $WP_TOKEN"
|
||||
done
|
||||
```
|
||||
|
||||
## E2E Test Coverage
|
||||
|
||||
40 tests across 2 hospitals, 3 roles:
|
||||
|
||||
**Login (4):** branding, invalid creds, supervisor login, auth guard
|
||||
|
||||
**Ramaiah CC Agent (10):** landing, call desk, call history, patients (list + search), appointments, my performance (API + KPI), sidebar, sign-out modal, sign-out complete
|
||||
|
||||
**Ramaiah Supervisor (12):** landing, team performance, live monitor, leads, patients, appointments, call log, recordings, missed calls, campaigns, settings, sidebar
|
||||
|
||||
**Global CC Agent (7):** landing, call history, patients, appointments, my performance, sidebar, sign-out
|
||||
|
||||
**Global Supervisor (5):** landing, patients, appointments, campaigns, settings
|
||||
|
||||
**Auto-cleanup:** Last CC Agent test completes sign-out to release agent session. Setup steps call `/api/maint/unlock-agent` to clear stale locks.
|
||||
102
docs/ozonetel-cdr-api-reference.md
Normal file
102
docs/ozonetel-cdr-api-reference.md
Normal file
@@ -0,0 +1,102 @@
|
||||
# Ozonetel CDR API Reference
|
||||
|
||||
> Source: [Ozonetel docs](https://docs.ozonetel.com/reference/get_ca-reports-fetchcdrdetails)
|
||||
|
||||
## Endpoints
|
||||
|
||||
| Endpoint | Path | Use Case |
|
||||
|----------|------|----------|
|
||||
| Fetch CDR Detailed | `GET /ca_reports/fetchCDRDetails` | All CDR for a single day |
|
||||
| Fetch CDR by UCID | `GET /ca_reports/fetchCdrByUCID` | Single call lookup by UCID |
|
||||
| Fetch CDR Paginated | `GET /ca_reports/fetchCdrByPagination` | Paginated CDR with `totalCount` |
|
||||
|
||||
## Common Constraints
|
||||
|
||||
- **Auth**: Bearer token (via `POST /ca_apis/caToken/generateToken`)
|
||||
- **Rate limit**: 2 requests per minute (all CDR endpoints)
|
||||
- **Date range**: Single day only (`fromDate` and `toDate` must be same date)
|
||||
- **Lookback**: 15 days maximum from time of request
|
||||
- **Mandatory params**: `fromDate`, `toDate`, `userName` (+ `ucid` for UCID endpoint)
|
||||
- **Date format**: `YYYY-MM-DD HH:MM:SS`
|
||||
|
||||
## Domain
|
||||
|
||||
- Domestic: `in1-ccaas-api.ozonetel.com`
|
||||
- International: `api.ccaas.ozonetel.com`
|
||||
|
||||
## CDR Record Fields (42 fields)
|
||||
|
||||
| Field | Type | Description | Sidecar Status |
|
||||
|-------|------|-------------|----------------|
|
||||
| `AgentDialStatus` | string | Agent's dial attempt status (e.g., "answered") | Not mapped |
|
||||
| `AgentID` | string | Agent identifier | **Mapped** — filter CDR by agent |
|
||||
| `AgentName` | string | Agent name | **Mapped** — fallback filter |
|
||||
| `CallAudio` | string | URL to call recording (S3) | Not mapped (recording via platform) |
|
||||
| `CallDate` | string | Date of call (YYYY-MM-DD) | Not mapped |
|
||||
| `CallID` | number | Unique call identifier | Not mapped |
|
||||
| `CallerConfAudioFile` | string | Conference audio file | Not mapped |
|
||||
| `CallerID` | string | Caller's phone number | Not mapped |
|
||||
| `CampaignName` | string | Associated campaign name | Not mapped — **available for US-15** |
|
||||
| `Comments` | string | Additional comments | Not mapped |
|
||||
| `ConferenceDuration` | string | Conference duration (HH:MM:SS) | Not mapped |
|
||||
| `CustomerDialStatus` | string | Customer dial status | Not mapped |
|
||||
| `CustomerRingTime` | string | Customer phone ring time | Not mapped — **missed call analysis** |
|
||||
| `DID` | string | Direct inward dial number | Not mapped — **available for US-2 branch display** |
|
||||
| `DialOutName` | string | Dialed party name | Not mapped |
|
||||
| `DialStatus` | string | Overall dial status | Not mapped |
|
||||
| `DialedNumber` | string | Phone number dialed | Not mapped |
|
||||
| `Disposition` | string | Call disposition/outcome | **Mapped** — disposition breakdown |
|
||||
| `Duration` | string | Total call duration | Not mapped |
|
||||
| `DynamicDID` | string | Dynamic DID reference | Not mapped |
|
||||
| `E164` | string | E.164 formatted phone number | Not mapped |
|
||||
| `EndTime` | string | Call end time | Not mapped |
|
||||
| `Event` | string | Event type (e.g., "AgentDial") | Not mapped |
|
||||
| `HandlingTime` | string/null | Total handling time — **CAN BE NULL** | Not mapped — **available for US-13 avg handling** |
|
||||
| `HangupBy` | string | Who terminated call | Not mapped |
|
||||
| `HoldDuration` | string | Time on hold | Not mapped — **available for US-12** |
|
||||
| `Location` | string | Caller location | Not mapped |
|
||||
| `PickupTime` | string | When call was answered | Not mapped |
|
||||
| `Rating` | number | Call quality rating | Not mapped |
|
||||
| `RatingComments` | string | Rating comments | Not mapped |
|
||||
| `Skill` | string | Agent skill/queue name | Not mapped |
|
||||
| `StartTime` | string | Call start time | Not mapped |
|
||||
| `Status` | string | Call status (Answered/NotAnswered) | **Mapped** — inbound/missed split |
|
||||
| `TalkTime` | string | Active talk duration | **Mapped** — avg talk time calc |
|
||||
| `TimeToAnswer` | string | Duration until answer | Not mapped — **available for lead response KPI** |
|
||||
| `TransferType` | string | Type of transfer | Not mapped — **available for US-3 audit** |
|
||||
| `TransferredTo` / `TransferTo` | string | Transfer target — **field name varies by endpoint** | Not mapped |
|
||||
| `Type` | string | Call type (InBound/Manual/Progressive) | **Mapped** — inbound/outbound split |
|
||||
| `UCID` | number | Unique call identifier | Not mapped |
|
||||
| `UUI` | string | User-to-user information | Not mapped |
|
||||
| `WrapUpEndTime` | string/null | Wrapup completion time — **CAN BE NULL** | Not mapped |
|
||||
| `WrapUpStartTime` | string/null | Wrapup start time — **CAN BE NULL** | Not mapped |
|
||||
| `WrapupDuration` | string/null | Wrapup duration — **CAN BE NULL** | Not mapped — **available for US-12** |
|
||||
|
||||
## Pagination Endpoint Extra Fields
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `totalCount` | Total number of records matching the query |
|
||||
|
||||
## Known Issues / Gotchas
|
||||
|
||||
1. **`HandlingTime`, `WrapupDuration`, `WrapUpStartTime`, `WrapUpEndTime` can be `null`** — when agent didn't complete wrapup (seen in UCID endpoint example). Code must null-guard these.
|
||||
2. **Field name inconsistency**: `TransferredTo` in fetchCDRDetails vs `TransferTo` in pagination endpoint. Handle both.
|
||||
3. **`WrapUpEndTime` vs `WrapupEndTime`**: casing differs between endpoints (camelCase vs mixed). Handle both.
|
||||
4. **Single-day constraint**: `fromDate` and `toDate` must be the same date. For multi-day range, call once per day.
|
||||
5. **Rate limit 2 req/min**: For a 7-day weekly report that needs CDR + summary per day = 14 API calls = 7 minutes minimum. Consider caching daily results.
|
||||
|
||||
## Current Sidecar Usage
|
||||
|
||||
**Endpoint used**: `fetchCDRDetails` only (in `ozonetel-agent.service.ts`)
|
||||
|
||||
**Fields actively mapped** (6 of 42):
|
||||
- `AgentID` / `AgentName` — agent filtering
|
||||
- `Type` — inbound/outbound split
|
||||
- `Status` — answered/missed split
|
||||
- `TalkTime` — avg talk time calculation
|
||||
- `Disposition` — disposition breakdown chart
|
||||
|
||||
**Not yet used**:
|
||||
- `fetchCdrByUCID` — useful for Patient 360 single-call drill-down
|
||||
- `fetchCdrByPagination` — useful for high-volume days (current approach loads all records into memory)
|
||||
1219
docs/requirements.md
Normal file
1219
docs/requirements.md
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user