collabSupport/utils/requester.js
jmcqueen 351f89a9a4 Initial commit: CollabFinder Webex bot
Multi-integration Webex chat/HTTP bot that unifies phone, AV, and
network status for retail store support. Consolidates data from
Webex Calling, Meraki, Workspace ONE (MDM), Atlas AMP, RED digital
signage, and OptiSigns into rich per-store status commands.

Key surfaces:
- /phonestatus, /avstatus — per-store phone & AV device reports with
  clickable Meraki deep-links and per-port detail.
- /webexhost — check/assign Webex Meetings host licenses via the
  Service App; adaptive-card confirmation flow, HTTP-API-gated.
- /offboarduser — full Webex Admin offboarding (auth revoke, device
  wipe, license removal); adaptive-card confirmation.
- /jirapoll — on-demand trigger for the hourly Jira poller.
- /bulkavstatuscsv — bulk store CSV export with concurrency limits.

Automation:
- Hourly Jira poller (node-cron) with an X.AI (Grok) ticket classifier
  that categorizes unassigned tickets as phone/av/skip, extracts store
  numbers from free-text, and enriches Jira with the same detailed
  markdown the chat commands emit (converted to Jira ADF, preserves
  bold + Meraki links). Idempotent via a `bot-enriched` Jira label.

Architecture:
- Node.js 20+, ESM, Express 5, webex-node-bot-framework.
- Layered integrations (integrations/*), services (services/*),
  commands (commands/*), utils (utils/*).
- Shared markdown renderers (services/renderers/*) feed both chat
  handlers and the Jira poller so the two surfaces stay in sync.
- Hand-rolled markdown-to-ADF converter (utils/markdownToAdf.js) —
  no new npm dependency.
- Node built-in test runner (`node --test tests/*.test.js`), 30 tests
  covering the converter, renderers, and poller ADF assembly.

Docker + docker-compose deployment. Config via .env
(see .env.example for the full option surface).
2026-07-01 16:55:03 -04:00

56 lines
2.3 KiB
JavaScript

// utils/requester.js
//
// Single source of truth for "who initiated this bot action?" — used for
// audit log lines, attribution in confirmation messages, and the requester
// snapshot stored alongside pending adaptive cards.
//
// IMPORTANT — why this file exists:
// webex-node-bot-framework does NOT expose `trigger.personEmail` or
// `trigger.personDisplayName` as top-level fields, despite a couple of
// stale references in its own JSDoc examples. The framework always
// populates `trigger.person` (the full Webex Person object, fetched via
// `webex.people.get(triggerObject.personId)` — see framework.js around
// line 697) for both `message` and `attachmentAction` triggers. The raw
// Webex `attachmentAction` payload only carries `personId`, not the
// email. So the only reliable way to attribute the requester is via
// `trigger.person.emails[0]` and `trigger.person.displayName`.
//
// HTTP-originated triggers (built in index.js's `app.get('/:command', ...)`
// adapter) carry `source: 'http'` and no `person` field — that case yields
// `email/displayName = null` and `describeRequester` renders it as
// "via HTTP API" for the audit log.
/**
* Build a structured requester record from a trigger.
*
* @param {object} trigger - webex-node-bot-framework trigger or HTTP fake
* trigger (from index.js).
* @returns {{email: string|null, displayName: string|null, source: 'webex'|'http'}}
*/
export function extractRequester(trigger) {
const isHttp = trigger?.source === 'http';
const rawEmail = trigger?.person?.emails?.[0];
return {
email: rawEmail ? String(rawEmail).toLowerCase() : null,
displayName: trigger?.person?.displayName || null,
source: isHttp ? 'http' : 'webex',
};
}
/**
* Render a requester as a human-readable string for audit log lines.
*
* Examples:
* "chat user benhumeag@ae.com"
* "via HTTP API"
* "unknown requester"
*
* @param {ReturnType<typeof extractRequester> | null | undefined} requester
* @returns {string}
*/
export function describeRequester(requester) {
if (!requester) return 'unknown requester';
if (requester.source === 'http') return 'via HTTP API';
const who = requester.email || requester.displayName || 'unknown chat user';
return `chat user ${who}`;
}