admin/bodyshop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feature/IO-3357-Reynolds-and-Reynolds-DMS-API-Integration - Checkpoint

Browse Source
This commit is contained in:
Dave
2025-11-04 14:19:26 -05:00
parent ccf3d7df5b
commit 5bbda89fb9
10 changed files with 532 additions and 337 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
server/rr/rr-customers.js
View File

@@ -1,6 +1,3 @@
// server/rr/rr-customers.js
// Minimal RR customer create helper (maps dmsRecKey -> custNo for callers)
const { RRClient } = require("./lib/index.cjs");
const { getRRConfigFromBodyshop } = require("./rr-config");
const RRLogger = require("./rr-logger");
@@ -35,7 +32,7 @@ function buildClientAndOpts(bodyshop) {
// minimal field extraction
function digitsOnly(s) {
return String(s || "").replace(/[^\d]/g, "");
return String(s || "").replace(/\D/g, "");
}
function buildCustomerPayloadFromJob(job, overrides = {}) {
@@ -94,15 +91,7 @@ async function createRRCustomer({ bodyshop, job, overrides = {}, socket }) {
const trx = res?.statusBlocks?.transaction;
// Primary: map dmsRecKey -> custNo
let custNo =
data?.dmsRecKey ??
// legacy fallbacks (if shapes ever change)
data?.custNo ??
data?.CustNo ??
data?.customerNo ??
data?.CustomerNo ??
data?.customer?.custNo ??
data?.Customer?.CustNo;
let custNo = data?.dmsRecKey;
if (!custNo) {
log("error", "RR insertCustomer returned no dmsRecKey/custNo", {

78
server/rr/rr-job-export.js
View File

@@ -1,28 +1,76 @@
// server/rr/rr-job-export.js
const { buildRRRepairOrderPayload } = require("./rr-job-helpers");
const { buildClientAndOpts } = require("./rr-lookup");
const { ensureRRServiceVehicle } = require("./rr-service-vehicles");
const RRLogger = require("./rr-logger");
/**
* Orchestrate an RR export (assumes custNo already resolved):
* - Ensure service vehicle (create flows)
* - Create or update the Repair Order
*/
async function exportJobToRR(args) {
const { bodyshop, job, selectedCustomer, advisorNo, existing } = args;
const { bodyshop, job, advisorNo, selectedCustomer, existing, socket } = args || {};
const log = RRLogger(socket, { ns: "rr-export" });
// Build client + opts (opts carries routing)
const { client, opts } = buildClientAndOpts(bodyshop);
const payload = buildRRRepairOrderPayload({ job, selectedCustomer, advisorNo });
let rrRes;
if (existing?.dmsRepairOrderId) {
rrRes = await client.updateRepairOrder({ ...payload, dmsRepairOrderId: existing.dmsRepairOrderId }, opts);
} else {
rrRes = await client.createRepairOrder(payload, opts);
if (!bodyshop) throw new Error("exportJobToRR: bodyshop is required");
if (!job) throw new Error("exportJobToRR: job is required");
if (advisorNo == null || String(advisorNo).trim() === "") {
throw new Error("exportJobToRR: advisorNo is required for RR");
}
// Now strictly require custNo here
const custNo =
(selectedCustomer && (selectedCustomer.custNo || selectedCustomer.CustNo || selectedCustomer.customerNo)) ||
(typeof selectedCustomer === "string" || typeof selectedCustomer === "number" ? String(selectedCustomer) : null);
if (!custNo) throw new Error("exportJobToRR: selectedCustomer.custNo is required");
const { client, opts } = buildClientAndOpts(bodyshop);
const finalOpts = {
...opts,
envelope: {
...(opts?.envelope || {}),
sender: {
...(opts?.envelope?.sender || {}),
task: "BSMRO",
referenceId: existing?.dmsRepairOrderId ? "Update" : "Insert"
}
}
};
// Ensure service vehicle for create flows (best-effort)
let svId = null;
if (!existing?.dmsRepairOrderId) {
try {
const svRes = await ensureRRServiceVehicle({ bodyshop, custNo, job, overrides: {}, socket });
svId = svRes?.svId || null;
log("info", "RR service vehicle ensured", { created: svRes?.created, svId });
} catch (e) {
log("warn", "RR ensure service vehicle failed; continuing", { error: e?.message });
}
}
const payload = buildRRRepairOrderPayload({
job,
selectedCustomer: { custNo },
advisorNo
});
const rrRes = existing?.dmsRepairOrderId
? await client.updateRepairOrder({ ...payload, dmsRepairOrderId: existing.dmsRepairOrderId }, finalOpts)
: await client.createRepairOrder(payload, finalOpts);
const data = rrRes?.data || null;
const roStatus = data?.roStatus || null;
return {
success: rrRes?.success === true,
data: rrRes?.data || null,
roStatus: rrRes?.data?.roStatus || null,
success: rrRes?.success === true || roStatus?.status === "Success",
data,
roStatus,
statusBlocks: rrRes?.statusBlocks || [],
xml: rrRes?.xml,
parsed: rrRes?.parsed
parsed: rrRes?.parsed,
custNo,
svId
};
}

44
server/rr/rr-job-helpers.js
View File

@@ -56,21 +56,49 @@ async function QueryJobData(ctx = {}, jobId) {
* Build minimal RR RO payload (keys match your RR client’s expectations).
* Uses fields that exist in your schema (v_vin, ro_number, owner fields, etc).
*/
/**
* Build minimal RR RO payload (keys match RR client expectations).
* - Requires advisorNo (maps to advNo)
* - Uses custNo (normalized) and a cleaned VIN (17 chars, A–Z/0–9)
*/
function buildRRRepairOrderPayload({ job, selectedCustomer, advisorNo }) {
const custNo =
(selectedCustomer && (selectedCustomer.custNo || selectedCustomer.customerNo)) ||
// Resolve custNo from object or primitive
const custNoRaw =
(selectedCustomer &&
(selectedCustomer.custNo ||
selectedCustomer.customerNo || // legacy alias, normalized below
selectedCustomer.CustNo)) ||
(typeof selectedCustomer === "string" || typeof selectedCustomer === "number" ? String(selectedCustomer) : null);
const custNo = custNoRaw ? String(custNoRaw).trim() : null;
if (!custNo) throw new Error("No RR customer selected (custNo missing)");
const vin = safeVin(job);
// For RR create flows, VIN is typically required; leave null allowed if you gate earlier in your flow.
// Advisor is required for RR
const advNo = advisorNo != null && String(advisorNo).trim() !== "" ? String(advisorNo).trim() : null;
if (!advNo) throw new Error("advisorNo is required for RR export");
// Clean/normalize VIN if present
const vinRaw = job?.v_vin || job?.vehicle?.vin || job?.vin;
const vin =
typeof vinRaw === "string"
? vinRaw
.replace(/[^A-Za-z0-9]/g, "")
.toUpperCase()
.slice(0, 17) || undefined
: undefined;
// Pick a stable external RO number
const ro =
job?.ro_number != null ? job.ro_number : job?.job_number != null ? job.job_number : job?.id != null ? job.id : null;
if (ro == null) throw new Error("Missing repair order identifier (ro_number/job_number/id).");
return {
repairOrderNumber: String(job?.ro_number || job?.job_number || job?.id),
repairOrderNumber: String(ro),
deptType: "B",
vin: vin || undefined,
custNo,
advNo: advisorNo || undefined
vin, // undefined if absent/empty after cleaning
custNo: String(custNo),
advNo // mapped from advisorNo
};
}

5
server/rr/rr-logger.js
View File

@@ -1,8 +1,3 @@
// server/rr/rr-logger.js
// Robust socket + server logger for RR flows (no more [object Object] in UI)
"use strict";
const util = require("util");
const appLogger = require("../utils/logger");

3
server/rr/rr-lookup.js
View File

@@ -1,6 +1,3 @@
// server/rr/rr-lookup.js
// Reynolds & Reynolds lookup helpers that adapt our bodyshop record to the RR client
const { RRClient } = require("./lib/index.cjs");
const { getRRConfigFromBodyshop } = require("./rr-config");

82
server/rr/rr-service-vehicles.js Normal file
View File

@@ -0,0 +1,82 @@
// server/rr/rr-service-vehicles.js
const { RRClient } = require("./lib/index.cjs");
const { getRRConfigFromBodyshop } = require("./rr-config");
const RRLogger = require("./rr-logger");
function buildClientAndOpts(bodyshop) {
const cfg = getRRConfigFromBodyshop(bodyshop);
const client = new RRClient({
baseUrl: cfg.baseUrl,
username: cfg.username,
password: cfg.password,
timeoutMs: cfg.timeoutMs,
retries: cfg.retries
});
const opts = {
routing: cfg.routing,
envelope: {
sender: {
component: "Rome",
task: "SV", // Service Vehicle op code; adjust if your lib expects another
referenceId: "Insert",
creator: "RCI",
senderName: "RCI"
}
}
};
return { client, opts };
}
function buildServiceVehiclePayload({ job, custNo, overrides = {} }) {
return {
custNo: String(custNo), // tie SV to customer
vin: overrides.vin ?? job?.v_vin,
year: overrides.year ?? job?.v_model_yr,
make: overrides.make ?? job?.dms_make ?? job?.v_make,
model: overrides.model ?? job?.dms_model ?? job?.v_model,
licensePlate: overrides.plate ?? job?.plate_no
// add other safe keys your RR client supports (color, mileage, etc.)
};
}
async function ensureRRServiceVehicle({ bodyshop, custNo, job, overrides = {}, socket }) {
const log = RRLogger(socket, { ns: "rr" });
const { client, opts } = buildClientAndOpts(bodyshop);
// Optional: first try a combined query by VIN to detect existing SV
try {
const queryRes = await client.combinedSearch(
{ vin: job?.v_vin, maxRecs: 1 },
{
...opts,
envelope: {
...opts.envelope,
sender: { ...opts.envelope.sender, task: "CVC", referenceId: "Query" }
}
}
);
const hasVehicle = Array.isArray(queryRes?.vehicles)
? queryRes.vehicles.length > 0
: Array.isArray(queryRes) && queryRes.length > 0;
if (hasVehicle) {
return { created: false, raw: queryRes };
}
} catch (e) {
// non-fatal, continue to insert
log("warn", "RR combined search failed before SV insert; proceeding to insert", { err: e?.message });
}
const payload = buildServiceVehiclePayload({ job, custNo, overrides });
const res = await client.insertServiceVehicle(payload, opts);
const data = res?.data ?? res;
// Normalize a simple id for later (RR often returns DMSRecKey on insert)
const svId = data?.svId ?? data?.serviceVehicleId ?? data?.dmsRecKey ?? data?.DMSRecKey;
if (!svId) {
log("error", "RR insert service vehicle returned no id", { data });
}
return { created: true, svId, raw: data };
}
module.exports = { ensureRRServiceVehicle };

113
server/web-sockets/rr-register-socket-events.js
View File

@@ -1,5 +1,3 @@
// server/rr/rr-register-socket-events.js
const RRLogger = require("../rr/rr-logger");
const { rrCombinedSearch, rrGetAdvisors, rrGetParts } = require("../rr/rr-lookup");
const { QueryJobData } = require("../rr/rr-job-helpers");
@@ -7,6 +5,7 @@ const { exportJobToRR } = require("../rr/rr-job-export");
const CdkCalculateAllocations = require("../cdk/cdk-calculate-allocations").default;
const { createRRCustomer } = require("../rr/rr-customers");
const { buildClientAndOpts } = require("../rr/rr-lookup");
const { GraphQLClient } = require("graphql-request");
const queries = require("../graphql-client/queries");
@@ -232,8 +231,9 @@ function registerRREvents({ socket, redisHelpers }) {
}
});
// Export flow
socket.on("rr-export-job", async (payload = {}) => {
const log = RRLogger(socket, { ns: "rr" });
try {
// -------- 1) Resolve job --------
let job = payload.job || payload.txEnvelope?.job;
@@ -246,44 +246,36 @@ function registerRREvents({ socket, redisHelpers }) {
// -------- 2) Resolve bodyshop (+ full row via GraphQL) --------
let bodyshopId = payload.bodyshopId || payload.bodyshopid || payload.bodyshopUUID || job?.bodyshop?.id;
if (!bodyshopId) {
const sess = await getSessionOrSocket(redisHelpers, socket);
bodyshopId = sess.bodyshopId;
}
if (!bodyshopId) throw new Error("RR export: bodyshopId required");
// Authoritative bodyshop row for RR routing (env fallback handled downstream)
let bodyshop =
const bodyshop =
job?.bodyshop && (job.bodyshop.rr_dealerid || job.bodyshop.rr_configuration)
? job.bodyshop
: await getBodyshopForSocket({ bodyshopId, socket });
// Optional FE routing override (kept minimal/safe)
const feRouting = payload.rrRouting;
if (feRouting) {
const cfg = bodyshop.rr_configuration || {};
bodyshop = {
...bodyshop,
rr_dealerid: feRouting.dealerNumber ?? bodyshop.rr_dealerid,
rr_configuration: {
...cfg,
storeNumber: feRouting.storeNumber ?? cfg.storeNumber,
branchNumber: feRouting.areaNumber ?? cfg.branchNumber,
areaNumber: feRouting.areaNumber ?? cfg.areaNumber
}
};
}
// -------- 3) Resolve selected customer (payload → tx) --------
// -------- 3) Resolve advisor number from the posting form --------
const tx = (await redisHelpers.getSessionTransactionData(socket.id)) || {};
const advisorNo = payload.advisorNo || payload.advNo || payload.txEnvelope?.advisorNo || tx.rrAdvisorNo || null;
if (!advisorNo || String(advisorNo).trim() === "") {
socket.emit("export-failed", { vendor: "rr", jobId, error: "Advisor is required (advisorNo)." });
return;
}
// Persist for subsequent steps if useful
await redisHelpers.setSessionTransactionData(socket.id, { ...tx, rrAdvisorNo: String(advisorNo) });
// -------- 4) Resolve selected customer (payload → tx) --------
let selectedCustomer = null;
// from payload
if (payload.selectedCustomer) {
if (typeof payload.selectedCustomer === "object" && payload.selectedCustomer.custNo) {
selectedCustomer = { custNo: String(payload.selectedCustomer.custNo) };
} else if (typeof payload.selectedCustomer === "string") {
} else if (typeof payload.selectedCustomer === "string" || typeof payload.selectedCustomer === "number") {
selectedCustomer = { custNo: String(payload.selectedCustomer) };
}
}
@@ -297,9 +289,11 @@ function registerRREvents({ socket, redisHelpers }) {
}
}
// Flags
const forceCreate = payload.forceCreate === true || tx.rrCreateCustomer === true;
const autoCreateOnNoMatch = payload.autoCreateOnNoMatch !== false; // default TRUE
// -------- 4) If no selection & not "forceCreate", try auto-search then ask UI to pick --------
// -------- 5) If no selection & not "forceCreate", try auto-search first --------
if (!selectedCustomer && !forceCreate) {
const customerQuery = makeCustomerSearchPayloadFromJob(job);
const vehicleQuery = makeVehicleSearchPayloadFromJob(job);
@@ -320,7 +314,7 @@ function registerRREvents({ socket, redisHelpers }) {
});
log("info", "rr-export-job:auto-selected-customer", { jobId, custNo: selectedCustomer.custNo });
} else if (candidates.length > 1) {
// emit picker data and stop; UI will call rr-selected-customer next
// multiple matches → ask UI to pick and STOP here
const table = candidates.map((c) => ({
CustomerId: c.custNo,
customerId: c.custNo,
@@ -328,28 +322,57 @@ function registerRREvents({ socket, redisHelpers }) {
}));
socket.emit("rr-select-customer", table);
socket.emit("rr-log-event", { level: "info", message: "RR: customer selection required", ts: Date.now() });
return; // wait for user selection
return;
} else {
// 0 matches → auto-create by default
if (autoCreateOnNoMatch) {
const { createRRCustomer } = require("../rr/rr-customers");
const created = await createRRCustomer({ bodyshop, job, socket });
const custNo = created?.custNo || created?.customerNo || created?.CustomerNo || created?.dmsRecKey;
if (!custNo) throw new Error("RR create customer returned no custNo");
selectedCustomer = { custNo: String(custNo) };
await redisHelpers.setSessionTransactionData(socket.id, {
...tx,
rrSelectedCustomer: selectedCustomer.custNo,
rrCreateCustomer: false
});
log("info", "rr-export-job:auto-created-customer", { jobId, custNo: selectedCustomer.custNo });
} else {
await redisHelpers.setSessionTransactionData(socket.id, { ...tx, rrCreateCustomer: true });
socket.emit("rr-customer-create-required");
socket.emit("rr-log-event", { level: "info", message: "RR: create customer required", ts: Date.now() });
return;
}
}
} else {
// no usable query → fall back to create or UI prompt
if (autoCreateOnNoMatch) {
const { createRRCustomer } = require("../rr/rr-customers");
const created = await createRRCustomer({ bodyshop, job, socket });
const custNo = created?.custNo || created?.customerNo || created?.CustomerNo || created?.dmsRecKey;
if (!custNo) throw new Error("RR create customer returned no custNo");
selectedCustomer = { custNo: String(custNo) };
await redisHelpers.setSessionTransactionData(socket.id, {
...tx,
rrSelectedCustomer: selectedCustomer.custNo,
rrCreateCustomer: false
});
log("info", "rr-export-job:auto-created-customer(no-query)", { jobId, custNo: selectedCustomer.custNo });
} else {
await redisHelpers.setSessionTransactionData(socket.id, { ...tx, rrCreateCustomer: true });
socket.emit("rr-customer-create-required");
socket.emit("rr-log-event", { level: "info", message: "RR: create customer required", ts: Date.now() });
return;
}
}
// no query or no matches → ask UI to create
if (!selectedCustomer) {
await redisHelpers.setSessionTransactionData(socket.id, { ...tx, rrCreateCustomer: true });
socket.emit("rr-customer-create-required");
socket.emit("rr-log-event", { level: "info", message: "RR: create customer required", ts: Date.now() });
return;
}
}
// -------- 5) If still not selected & creation is allowed, create now --------
if (!selectedCustomer && forceCreate) {
// -------- 6) If still not selected & creation is allowed, create now --------
if (!selectedCustomer && (forceCreate || autoCreateOnNoMatch)) {
const { createRRCustomer } = require("../rr/rr-customers");
const created = await createRRCustomer({ bodyshop, job, socket });
// fallback when API returns only DMSRecKey
const custNo = created?.custNo || created?.customerNo || created?.CustomerNo || created?.dmsRecKey;
if (!custNo) throw new Error("RR create customer returned no custNo");
selectedCustomer = { custNo: String(custNo) };
await redisHelpers.setSessionTransactionData(socket.id, {
...tx,
@@ -361,18 +384,14 @@ function registerRREvents({ socket, redisHelpers }) {
if (!selectedCustomer?.custNo) throw new Error("RR export: selected customer missing custNo");
// -------- 6) Perform export --------
const advisorNo = payload.advisorNo || payload.advNo || tx.rrAdvisorNo;
const options = payload.options || payload.txEnvelope?.options || {};
// -------- 7) Perform export (ensure SV + create/update RO) --------
const result = await exportJobToRR({
bodyshop,
job,
selectedCustomer,
advisorNo,
existing: payload.existing,
logger: log,
...options
socket
});
if (result?.success) {
@@ -393,7 +412,7 @@ function registerRREvents({ socket, redisHelpers }) {
try {
socket.emit("export-failed", { vendor: "rr", jobId, error: error.message });
} catch {
//
/* ignore */
}
}
});