collabSupport/integrations/webex/XapiClient.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

79 lines
No EOL
2.7 KiB
JavaScript

// src/integrations/webex/XapiClient.js
import webex from './WebexClient.js'; // reuse the main client for auth (xapi calls now delegate to it for consistency + retry)
import { logger } from '../../utils/logger.js';
class XapiClient {
static #instance = null;
constructor() {
if (XapiClient.#instance) {
return XapiClient.#instance;
}
XapiClient.#instance = this;
logger('webex:xapi', 'XapiClient initialized (delegates xapi to WebexClient.request)');
}
async xCommand(command, payload = {}) {
// Delegate to webex.request (same pattern used by vcProvision for all xapi/command/* calls).
// Benefits: automatic 401 retry + token handling + consistent error surfacing.
try {
const data = await webex.request('POST', `xapi/command/${command}`, payload);
logger('webex:xapi', `xCommand ${command} succeeded`);
return data;
} catch (err) {
const errorDetail = err.response?.data?.message || err.response?.data || err.message;
logger('webex:xapi', `xCommand ${command} failed: ${errorDetail}`, 'error');
throw err;
}
}
async xConfiguration(deviceId, path, value) {
logger('webex:xapi', `Setting configuration: ${path} = ${value} on device ${deviceId}`);
return this.xCommand('xConfiguration', {
deviceId,
arguments: { Path: path, Value: value }
});
}
/**
* Execute an xCommand on a device (e.g. Logging.ExtendedLogging.Start).
* Convenience wrapper: pass deviceId + flat arguments object.
*/
async xCommandWithDevice(commandKey, deviceId, argumentsObj = {}) {
return this.xCommand(commandKey, {
deviceId,
arguments: argumentsObj
});
}
/**
* Query xStatus on a device (subtree).
* Example: xStatus(deviceId, 'Logging.ExtendedLogging')
*
* Per cloud xAPI (and vcProvision xapi call patterns):
* GET /v1/xapi/status?deviceId=...&name=Logging.ExtendedLogging
* Response shape: { deviceId, result: { Logging: { ExtendedLogging: { Mode, PacketDump, ... } } } }
* Uses webex.request for 401-retry consistency with other xapi/* calls in the project.
*/
async xStatus(deviceId, name = '') {
const params = { deviceId };
if (name) {
params.name = name; // e.g. "Logging.ExtendedLogging" or "Logging.ExtendedLogging.Mode" (dot notation)
}
try {
const data = await webex.request('GET', 'xapi/status', null, params);
logger('webex:xapi', `xStatus ${name || '(root)'} succeeded for device`);
return data;
} catch (err) {
const errorDetail = err.response?.data?.message || err.response?.data || err.message;
logger('webex:xapi', `xStatus ${name} failed: ${errorDetail}`, 'error');
throw err;
}
}
}
// Export singleton instance
export default new XapiClient();