collabSupport/integrations/meraki/devices.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

191 lines
No EOL
5.9 KiB
JavaScript

// src/integrations/meraki/devices.js
import { merakiAxios } from './client.js';
import { logger } from '../../utils/logger.js';
/**
* Get simple list of all devices in a Meraki network (switches + APs)
*/
export async function getAllMerakiDevices(networkId) {
if (!networkId) return [];
try {
const res = await merakiAxios.get(`/networks/${networkId}/devices`);
return res.data || [];
} catch (err) {
logger('meraki:devices', `Failed to fetch device list for network ${networkId}: ${err.message}`, 'warn');
return [];
}
}
/**
* Get full details for a single Meraki device (switch or AP)
*/
export async function getMerakiDeviceDetail(serial) {
try {
const res = await merakiAxios.get(`/devices/${serial}`);
return res.data;
} catch (err) {
logger('meraki:devices', `Failed to get detail for device ${serial}: ${err.message}`, 'warn');
return { serial, error: err.message };
}
}
/**
* Get wireless status for an AP (Tx power, channels, client counts, etc.)
* Returns null gracefully for non-AP devices (switches)
*/
export async function getMerakiWirelessStatus(serial) {
try {
const res = await merakiAxios.get(`/devices/${serial}/wireless/status`);
return res.data;
} catch (err) {
// 404 is expected for switches — treat as normal
if (err.response?.status === 404) {
return null;
}
logger('meraki:devices', `Wireless status failed for ${serial}: ${err.message}`, 'debug');
return null;
}
}
/**
* Enrich a set of referenced Meraki devices
* Returns map: serial → full device object + wirelessStatus (for APs)
*/
export async function enrichMerakiDevices(networkId, referencedSerials) {
if (!networkId || !referencedSerials?.size) return {};
const detailsMap = {};
logger('meraki:devices', `Enriching ${referencedSerials.size} Meraki devices with full details + wireless status`);
for (const serial of referencedSerials) {
try {
const [basicRes, wirelessRes] = await Promise.allSettled([
getMerakiDeviceDetail(serial),
getMerakiWirelessStatus(serial)
]);
const fullDevice = basicRes.status === 'fulfilled' ? basicRes.value : { serial };
if (wirelessRes.status === 'fulfilled' && wirelessRes.value) {
fullDevice.wirelessStatus = wirelessRes.value;
}
detailsMap[serial] = fullDevice;
} catch (err) {
logger('meraki:devices', `Failed enriching device ${serial}: ${err.message}`, 'warn');
detailsMap[serial] = { serial, error: err.message };
}
}
return detailsMap;
}
/**
* Get recent signal quality (RSSI + SNR) for a wireless client
* Uses the exact endpoint and parameters you provided (1-hour resolution)
*/
export async function getWirelessClientSignalQuality(networkId, clientId) {
if (!networkId || !clientId) return { rssi: null, snr: null };
try {
const timespan = 3600; // 1 hour for near-realtime
const url = `/networks/${networkId}/wireless/signalQualityHistory?clientId=${clientId}&timespan=${timespan}&perPage=1&resolution=3600`;
const response = await merakiAxios.get(url);
const history = response.data || [];
const latest = history.length > 0 ? history[history.length - 1] : null;
return {
rssi: latest?.rssi ?? null, // e.g. -45
snr: latest?.snr ?? null // e.g. 50
};
} catch (err) {
logger('meraki:devices', `Signal quality failed for client ${clientId}: ${err.message}`, 'debug');
return { rssi: null, snr: null };
}
}
/**
* Get recent average latency for a wireless client
*/
export async function getWirelessClientLatency(networkId, clientId) {
if (!networkId || !clientId) return { avgLatencyMs: null };
try {
const timespan = 3600; // 1 hour
const url = `/networks/${networkId}/wireless/latencyHistory?clientId=${clientId}&timespan=${timespan}&perPage=1&resolution=3600`;
const response = await merakiAxios.get(url);
const history = response.data || [];
const latest = history.length > 0 ? history[history.length - 1] : null;
return {
avgLatencyMs: latest?.avgLatencyMs ?? null
};
} catch (err) {
logger('meraki:devices', `Latency history failed for client ${clientId}: ${err.message}`, 'debug');
return { avgLatencyMs: null };
}
}
/**
* Get failed connection attempts for a client (last 7 days)
* Returns empty array if none
*/
export async function getWirelessClientFailedConnections(networkId, clientId) {
if (!networkId || !clientId) return [];
try {
const timespan = 604800; // 7 days
const url = `/networks/${networkId}/wireless/failedConnections?clientId=${clientId}&timespan=${timespan}`;
const response = await merakiAxios.get(url);
return response.data || [];
} catch (err) {
logger('meraki:devices', `Failed connections query failed for client ${clientId}: ${err.message}`, 'debug');
return [];
}
}
/**
* Get Link Layer Topology for the network
* This is the endpoint that returns nodes + links suitable for Mermaid diagrams
*/
export async function getMerakiTopology(networkId) {
if (!networkId) {
return { nodes: [], links: [], errors: ["No networkId provided"] };
}
try {
logger('meraki:topology', `Fetching linkLayer topology for network ${networkId}`);
const response = await merakiAxios.get(`/networks/${networkId}/topology/linkLayer`);
const topology = response.data || { nodes: [], links: [], errors: [] };
logger('meraki:topology',
`Received ${topology.nodes?.length || 0} nodes and ${topology.links?.length || 0} links`);
return topology;
} catch (err) {
logger('meraki:topology', `Failed to fetch topology for ${networkId}: ${err.message}`, 'warn');
return {
nodes: [],
links: [],
errors: [err.message]
};
}
}
export default {
getAllMerakiDevices,
getMerakiDeviceDetail,
getMerakiWirelessStatus,
enrichMerakiDevices,
getWirelessClientSignalQuality,
getWirelessClientLatency,
getWirelessClientFailedConnections,
getMerakiTopology
};