netanalyzer/services/siw.js
Joseph McQueen b3c37bd7df feat: st command suite, Webex phone + Atlas AV integrations, dockerized remote agent
Rebrand NetAnalyzer -> StoreHealthAnalyzer and consolidate the store
reporting surface into a single `st [number]` command with focused
sub-modes.

Commands
- st [number]                - general info (SIW + brands + Meraki net link)
- st [number] network        - switches, APs, store server
- st [number] pos            - registers, payment terminals, customer display
- st [number] ios            - MDM-tracked iOS hardware
- st [number] phone          - wired 78xx + DECT basestations/handsets with
                               registration state, extensions and main DID
- st [number] av             - Atlas AMPs + MDM-tracked Apple TVs, video
                               walls, music players, LED displays
- Removed `analyze` in favor of the unified `st` surface

Integrations
- integrations/webex: Service App OAuth with rotating refresh tokens,
  seed + cleanup scripts, tokens/ storage (git-ignored)
- integrations/atlas: Xyte client + cached device discovery keyed on
  zero-padded 6-digit store numbers, cold-cache failure -> unavailable
  banner instead of a misleading empty result
- services/webexPhone, services/webexService, services/avService: shape
  raw upstream data into the report layer's contract
- utils/merakiMatcher: FQDN hostname extraction so payment terminals
  match Meraki descriptions; case-insensitive lookup
- utils/chunkReport: split long markdown replies at 7000-char boundaries

Reliability / ops
- server.js: awaited framework.stop() + 8s hard-kill timer so nodemon /
  Docker restarts don't leak WDM device registrations ("excessive device
  registrations")
- nodemon.json: SIGINT so the graceful path always runs
- scripts/cleanupWebexDevices.js: one-shot WDM cleanup utility
- Group-space routing: hears() regexes tolerate the leading @BotName
  prefix Webex prepends to mentions
- Replaced HTML-unsafe <number> placeholders with [number] in all help
  strings

Remote agent containerization
- docker/remote-agent/: multi-stage node:22-alpine image, non-root user,
  tini for signal handling, minimal deps (ws/axios/dotenv)
- docker/remote-agent/package.sh: docker buildx build defaulting to
  linux/amd64 (with override), saves image + assembles deploy/ + writes
  SHA256 + zips for offline transfer
- docker/remote-agent/deploy/: runtime docker-compose.yml, install.sh
  with platform sanity check, remote-host README
- .dockerignore + .gitignore updates for build artifacts and dist bundles
- npm run agent:package convenience script

Cleanup
- Dropped storeHealth.js / HealthReport.js and their tests/mocks in favor
  of the shared storeDetail pipeline
- Store model handles null SIW records gracefully; toSummary always
  ends with a newline so the Meraki link sits on its own line

Tests
- 144 tests across 14 suites passing; new coverage for atlasClient,
  atlasDevices, avService, avCategory classification, webexPhone,
  webexServiceAppAuth, storeDetail integration, siw, chunkReport and
  the updated meraki matcher

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-06 09:54:41 -04:00

100 lines
3.2 KiB
JavaScript

const config = require('../config');
const { proxyRequest } = require('./websocket');
const { parseStoreNumber } = require('../utils/validate');
const logger = require('../utils/logger');
function getSiwAuthHeaders() {
const { username, password } = config.siw;
if (!username || !password) {
throw new Error('SIW credentials are not configured (SIW_USERNAME / SIW_PASSWORD)');
}
const authString = Buffer.from(`${username}:${password}`).toString('base64');
return { Authorization: `Basic ${authString}` };
}
function buildSiwRequest(path) {
if (!config.siw.baseUrl) {
throw new Error('SIW_BASE_URL is not configured');
}
return {
method: 'GET',
url: `${config.siw.baseUrl}${path}`,
headers: getSiwAuthHeaders(),
};
}
/**
* Perform a SIW request and gracefully degrade when the remote agent isn't
* connected. Returns `fallback` (default: null) so downstream code can keep
* rendering Meraki/MDM sections without crashing.
*
* Any other error is propagated so the integration layer can decide whether
* to swallow or surface it.
*/
async function siwGet(path, { fallback = null, storeNumber } = {}) {
try {
const result = await proxyRequest(buildSiwRequest(path));
return result?.data ?? fallback;
} catch (err) {
if (err.code === 'AGENT_NOT_CONNECTED') {
logger.warn('SIW request skipped — remote agent not connected', { path, storeNumber });
return fallback;
}
throw err;
}
}
async function getStoreLocation(storeNumber) {
const normalized = parseStoreNumber(storeNumber);
if (!normalized) throw new Error('Invalid store number');
const data = await siwGet(`/StoreLocation/${normalized}`, { storeNumber: normalized });
if (!data) {
logger.warn('SIW returned no location record', { storeNumber: normalized });
}
return data;
}
/**
* /StoreGeneral/{n} returns brand info, environment, POS type, status,
* open/close dates, etc. Distinct from /StoreLocation which is the address.
*/
async function getStoreGeneral(storeNumber) {
const normalized = parseStoreNumber(storeNumber);
if (!normalized) throw new Error('Invalid store number');
const data = await siwGet(`/StoreGeneral/${normalized}`, { storeNumber: normalized });
if (!data) {
logger.warn('SIW returned no general record', { storeNumber: normalized });
}
return data;
}
async function getStoreRegisters(storeNumber) {
const normalized = parseStoreNumber(storeNumber);
if (!normalized) throw new Error('Invalid store number');
return siwGet(`/StoreRegister/${normalized}`, { fallback: [], storeNumber: normalized });
}
async function getStorePrinters(storeNumber) {
const normalized = parseStoreNumber(storeNumber);
if (!normalized) throw new Error('Invalid store number');
return siwGet(`/StorePrinter/${normalized}`, { fallback: [], storeNumber: normalized });
}
async function getStorePaymentTerminals(storeNumber) {
const normalized = parseStoreNumber(storeNumber);
if (!normalized) throw new Error('Invalid store number');
return siwGet(`/StorePayment/${normalized}`, { fallback: [], storeNumber: normalized });
}
module.exports = {
getStoreLocation,
getStoreGeneral,
getStoreRegisters,
getStorePrinters,
getStorePaymentTerminals,
};