From bcf03a65f9ebafc34f35e066f7d09cca40397534 Mon Sep 17 00:00:00 2001 From: robbond Date: Mon, 23 Mar 2026 11:47:18 +0000 Subject: [PATCH] TASK22211: normalize form and publication endpoint contracts --- .../endpoint/getbasicpartsaveddetails_api.js | 77 ++++-- pages/api/endpoint/getdnslist_api.js | 46 ++-- pages/api/endpoint/getformdata_api.js | 44 ++-- pages/api/endpoint/getispublishedbyid_api.js | 55 ++--- pages/api/endpoint/getsipsevents_api.js | 44 ++-- .../endpoint-handler-contract.test.cjs | 221 ++++++++++++++++++ 6 files changed, 380 insertions(+), 107 deletions(-) diff --git a/pages/api/endpoint/getbasicpartsaveddetails_api.js b/pages/api/endpoint/getbasicpartsaveddetails_api.js index 537a76d9..47ced874 100644 --- a/pages/api/endpoint/getbasicpartsaveddetails_api.js +++ b/pages/api/endpoint/getbasicpartsaveddetails_api.js @@ -1,41 +1,72 @@ import axios from "axios"; -import CryptoJS from "crypto-js"; import { azureHeadersNoOdata } from "../../../actions/core/headers"; +import { consoleLogger } from "../../../actions/core/logger"; import { getToken } from "../../../actions/core/token"; import { hashAPIPath } from "../../../actions/core/hash"; +import { respondError, respondSuccess } from "../middleware/apiResponse"; const WEBAPI_URL = process.env.RELAY_ROOT || "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/"; export default async function ApiProxy(req, res) { - var appealTypeName = req.query.appealTypeName; - var primaryIdAttribute = req.query.primaryIdAttribute; - var incidentID = req.query.incidentID; - var token = await getToken(); + const appealTypeName = req.query.appealTypeName; + const primaryIdAttribute = req.query.primaryIdAttribute; + const incidentID = req.query.incidentID; - var queryUrl = - appealTypeName + - "?$filter=_" + - primaryIdAttribute + - "s_value eq " + - incidentID + - "&$count=true"; + if ( + typeof appealTypeName !== "string" || + appealTypeName.trim().length === 0 + ) { + return respondError(res, { + status: 400, + code: "APPEAL_TYPE_NAME_REQUIRED", + message: "appealTypeName is required" + }); + } - queryUrl = queryUrl; //+ getSelectQuery(appealTypeName); + if ( + typeof primaryIdAttribute !== "string" || + primaryIdAttribute.trim().length === 0 + ) { + return respondError(res, { + status: 400, + code: "PRIMARY_ID_ATTRIBUTE_REQUIRED", + message: "primaryIdAttribute is required" + }); + } - //console.log("///////////\nquery: ", queryUrl, "<<< { - res.status(200).json(data); - }) - .catch((error) => { - consoleLogger(error); - res.status(400).json(error); + ); + + return respondSuccess(res, data); + } catch (error) { + consoleLogger(error); + return respondError(res, { + status: 400, + code: "BASIC_PART_SAVED_DETAILS_FETCH_FAILED", + message: "Failed to fetch basic part-saved details" }); + } } diff --git a/pages/api/endpoint/getdnslist_api.js b/pages/api/endpoint/getdnslist_api.js index 2b555deb..14251a39 100644 --- a/pages/api/endpoint/getdnslist_api.js +++ b/pages/api/endpoint/getdnslist_api.js @@ -1,44 +1,40 @@ import axios from "axios"; -import CryptoJS from "crypto-js"; import _ from "lodash"; import { azureHeaders } from "../../../actions/core/headers"; import { consoleLogger } from "../../../actions/core/logger"; import { getToken } from "../../../actions/core/token"; import { hashAPIPath } from "../../../actions/core/hash"; +import { respondError, respondSuccess } from "../middleware/apiResponse"; const WEBAPI_URL = process.env.RELAY_ROOT || "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/"; export default async function ApiProxy(req, res) { - var token = await getToken(); + try { + const token = await getToken(); - var queryUrl = - "incidents?$select=pinswg_environmentalstatementlocation,pinswg_appealcasetype,_customerid_value,_pinswg_associatedlpa_value,_ownerid_value,statuscode,ticketnumber,title &$filter=(pinswg_appealcasetype eq 846040011 or pinswg_appealcasetype eq 846040002) and pinswg_publishtoweb eq true&$orderby=createdon desc&$count=true"; + const queryUrl = + "incidents?$select=pinswg_environmentalstatementlocation,pinswg_appealcasetype,_customerid_value,_pinswg_associatedlpa_value,_ownerid_value,statuscode,ticketnumber,title &$filter=(pinswg_appealcasetype eq 846040011 or pinswg_appealcasetype eq 846040002) and pinswg_publishtoweb eq true&$orderby=createdon desc&$count=true"; - function renameJsonKey(jsonObj, oldKey, newKey) { - if (jsonObj.hasOwnProperty(oldKey)) { - jsonObj[newKey] = jsonObj[oldKey]; // Add new key with the same value - delete jsonObj[oldKey]; // Delete old key - } - return jsonObj; - } - - return axios - .get( + const { data } = await axios.get( WEBAPI_URL + queryUrl + hashAPIPath(queryUrl), azureHeaders(token.access_token) - ) - .then(({ data }) => { - var dataStr; + ); - _.has(data, "@odata.nextLink") == true && - ((dataStr = JSON.stringify(data["@odata.nextLink"])), - (data["@odata.nextLink"] = dataStr.split("/v8.2/")[1])); - res.status(200).json(data); - }) - .catch((error) => { - consoleLogger(error); - res.status(400).json(error); + let dataStr; + + _.has(data, "@odata.nextLink") === true && + ((dataStr = JSON.stringify(data["@odata.nextLink"])), + (data["@odata.nextLink"] = dataStr.split("/v8.2/")[1])); + + return respondSuccess(res, data); + } catch (error) { + consoleLogger(error); + return respondError(res, { + status: 400, + code: "DNS_LIST_FETCH_FAILED", + message: "Failed to fetch DNS list" }); + } } diff --git a/pages/api/endpoint/getformdata_api.js b/pages/api/endpoint/getformdata_api.js index acea3b3c..39ac3034 100644 --- a/pages/api/endpoint/getformdata_api.js +++ b/pages/api/endpoint/getformdata_api.js @@ -1,33 +1,45 @@ import axios from "axios"; -import CryptoJS from "crypto-js"; import { azureHeaders } from "../../../actions/core/headers"; import { consoleLogger } from "../../../actions/core/logger"; import { getToken } from "../../../actions/core/token"; import { hashAPIPath } from "../../../actions/core/hash"; +import { respondError, respondSuccess } from "../middleware/apiResponse"; const WEBAPI_URL = process.env.RELAY_ROOT || "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/"; export default async function ApiProxy(req, res) { - var whichForm = req.query.whichForm; - var token = await getToken(); + const whichForm = req.query.whichForm; - var queryUrl = - "systemforms?$select=formid,name,formxml,type,objecttypecode&$filter=(objecttypecode eq 'pinswg_" + - whichForm + - "' and type eq 2)&$count=true&$top=201"; + if (typeof whichForm !== "string" || whichForm.trim().length === 0) { + return respondError(res, { + status: 400, + code: "WHICH_FORM_REQUIRED", + message: "whichForm is required" + }); + } - return axios - .get( + try { + const token = await getToken(); + + const queryUrl = + "systemforms?$select=formid,name,formxml,type,objecttypecode&$filter=(objecttypecode eq 'pinswg_" + + whichForm + + "' and type eq 2)&$count=true&$top=201"; + + const { data } = await axios.get( WEBAPI_URL + queryUrl + hashAPIPath(queryUrl), azureHeaders(token.access_token) - ) - .then(({ data }) => { - res.status(200).json(data); - }) - .catch((error) => { - consoleLogger(error); - res.status(400).json(error); + ); + + return respondSuccess(res, data); + } catch (error) { + consoleLogger(error); + return respondError(res, { + status: 400, + code: "FORM_DATA_FETCH_FAILED", + message: "Failed to fetch form data" }); + } } diff --git a/pages/api/endpoint/getispublishedbyid_api.js b/pages/api/endpoint/getispublishedbyid_api.js index 00318960..f434dac0 100644 --- a/pages/api/endpoint/getispublishedbyid_api.js +++ b/pages/api/endpoint/getispublishedbyid_api.js @@ -16,48 +16,49 @@ */ import axios from "axios"; -import CryptoJS from "crypto-js"; import { azureHeaders } from "../../../actions/core/headers"; import { consoleLogger } from "../../../actions/core/logger"; import { getToken } from "../../../actions/core/token"; import { hashAPIPath } from "../../../actions/core/hash"; +import { respondError, respondSuccess } from "../middleware/apiResponse"; const WEBAPI_URL = process.env.RELAY_ROOT || "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/"; export default async function ApiProxy(req, res) { - var searchString = req.query.searchString; - var token = await getToken(); + const searchString = req.query.searchString; - searchString = searchString.replace(/\'/g, "''"); + if (typeof searchString !== "string" || searchString.trim().length === 0) { + return respondError(res, { + status: 400, + code: "SEARCH_STRING_REQUIRED", + message: "searchString is required" + }); + } - var queryUrl = - "incidents?$select=pinswg_environmentalstatementlocation,pinswg_publishtoweb,ticketnumber,title, _primarycontactid_value&$filter=incidentid eq " + - searchString + - " and pinswg_appealcasetype ne null &$orderby=createdon desc&$count=true"; + try { + const token = await getToken(); - console.log( - "\n==========================================\n", - "basic search: " + queryUrl, - "\n\n", - "basic search relay link: " + - WEBAPI_URL + - queryUrl + - hashAPIPath(queryUrl), - "\n==========================================\n" - ); + const escapedSearchString = searchString.split("'").join("''"); - return axios - .get( + const queryUrl = + "incidents?$select=pinswg_environmentalstatementlocation,pinswg_publishtoweb,ticketnumber,title, _primarycontactid_value&$filter=incidentid eq " + + escapedSearchString + + " and pinswg_appealcasetype ne null &$orderby=createdon desc&$count=true"; + + const { data } = await axios.get( WEBAPI_URL + queryUrl + hashAPIPath(queryUrl), azureHeaders(token.access_token) - ) - .then(({ data }) => { - res.status(200).json(data); - }) - .catch((error) => { - consoleLogger(error); - res.status(400).json(error); + ); + + return respondSuccess(res, data); + } catch (error) { + consoleLogger(error); + return respondError(res, { + status: 400, + code: "IS_PUBLISHED_FETCH_FAILED", + message: "Failed to fetch published state" }); + } } diff --git a/pages/api/endpoint/getsipsevents_api.js b/pages/api/endpoint/getsipsevents_api.js index 42d4eb8f..b4087ded 100644 --- a/pages/api/endpoint/getsipsevents_api.js +++ b/pages/api/endpoint/getsipsevents_api.js @@ -1,33 +1,45 @@ import axios from "axios"; -import CryptoJS from "crypto-js"; import { azureHeaders } from "../../../actions/core/headers"; import { consoleLogger } from "../../../actions/core/logger"; import { getToken } from "../../../actions/core/token"; import { hashAPIPath } from "../../../actions/core/hash"; +import { respondError, respondSuccess } from "../middleware/apiResponse"; const WEBAPI_URL = process.env.RELAY_ROOT || "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/"; export default async function ApiProxy(req, res) { - var caseid = req.query.caseid; - var token = await getToken(); + const caseid = req.query.caseid; - var queryUrl = - "pinswg_sipsevents?$filter=_pinswg_sipseventsid_value eq " + - caseid + - "&$count=true"; + if (typeof caseid !== "string" || caseid.trim().length === 0) { + return respondError(res, { + status: 400, + code: "CASE_ID_REQUIRED", + message: "caseid is required" + }); + } - return axios - .get( + try { + const token = await getToken(); + + const queryUrl = + "pinswg_sipsevents?$filter=_pinswg_sipseventsid_value eq " + + caseid + + "&$count=true"; + + const { data } = await axios.get( WEBAPI_URL + queryUrl + hashAPIPath(queryUrl), azureHeaders(token.access_token) - ) - .then(({ data }) => { - res.status(200).json(data); - }) - .catch((error) => { - consoleLogger(error); - res.status(400).json(error); + ); + + return respondSuccess(res, data); + } catch (error) { + consoleLogger(error); + return respondError(res, { + status: 400, + code: "SIPS_EVENTS_FETCH_FAILED", + message: "Failed to fetch SIPS events" }); + } } diff --git a/tests/phase21/endpoint-handler-contract.test.cjs b/tests/phase21/endpoint-handler-contract.test.cjs index 3d73406c..a4b5a174 100644 --- a/tests/phase21/endpoint-handler-contract.test.cjs +++ b/tests/phase21/endpoint-handler-contract.test.cjs @@ -2732,6 +2732,227 @@ test("getlinkedcases catch path returns LINKED_CASES_FETCH_FAILED", async () => ); }); +test("getformdata returns WHICH_FORM_REQUIRED when whichForm missing", async () => { + const mod = loadModule("pages/api/endpoint/getformdata_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { get: async () => ({ data: { value: [] } }) }, + consoleLogger: () => {} + }); + + const req = { query: {} }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual(res.state.jsonBody.error.code, "WHICH_FORM_REQUIRED"); +}); + +test("getformdata catch path returns FORM_DATA_FETCH_FAILED", async () => { + const mod = loadModule("pages/api/endpoint/getformdata_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { + get: async () => { + throw new Error("relay failed"); + } + }, + consoleLogger: () => {} + }); + + const req = { query: { whichForm: "planningappeals78" } }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual(res.state.jsonBody.error.code, "FORM_DATA_FETCH_FAILED"); +}); + +test("getispublishedbyid returns SEARCH_STRING_REQUIRED when searchString missing", async () => { + const mod = loadModule("pages/api/endpoint/getispublishedbyid_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { get: async () => ({ data: { value: [] } }) }, + consoleLogger: () => {} + }); + + const req = { query: {} }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual(res.state.jsonBody.error.code, "SEARCH_STRING_REQUIRED"); +}); + +test("getispublishedbyid catch path returns IS_PUBLISHED_FETCH_FAILED", async () => { + const mod = loadModule("pages/api/endpoint/getispublishedbyid_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { + get: async () => { + throw new Error("relay failed"); + } + }, + consoleLogger: () => {} + }); + + const req = { query: { searchString: "incident-guid" } }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual( + res.state.jsonBody.error.code, + "IS_PUBLISHED_FETCH_FAILED" + ); +}); + +test("getdnslist catch path returns DNS_LIST_FETCH_FAILED", async () => { + const mod = loadModule("pages/api/endpoint/getdnslist_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { + get: async () => { + throw new Error("relay failed"); + } + }, + consoleLogger: () => {}, + _: { has: () => false } + }); + + const req = { query: {} }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual(res.state.jsonBody.error.code, "DNS_LIST_FETCH_FAILED"); +}); + +test("getsipsevents returns CASE_ID_REQUIRED when caseid missing", async () => { + const mod = loadModule("pages/api/endpoint/getsipsevents_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { get: async () => ({ data: { value: [] } }) }, + consoleLogger: () => {} + }); + + const req = { query: {} }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual(res.state.jsonBody.error.code, "CASE_ID_REQUIRED"); +}); + +test("getsipsevents catch path returns SIPS_EVENTS_FETCH_FAILED", async () => { + const mod = loadModule("pages/api/endpoint/getsipsevents_api.js", { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeaders: () => ({}), + axios: { + get: async () => { + throw new Error("relay failed"); + } + }, + consoleLogger: () => {} + }); + + const req = { query: { caseid: "case-guid" } }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual( + res.state.jsonBody.error.code, + "SIPS_EVENTS_FETCH_FAILED" + ); +}); + +test("getbasicpartsaveddetails returns APPEAL_TYPE_NAME_REQUIRED when appealTypeName missing", async () => { + const mod = loadModule( + "pages/api/endpoint/getbasicpartsaveddetails_api.js", + { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeadersNoOdata: () => ({}), + axios: { get: async () => ({ data: { value: [] } }) }, + consoleLogger: () => {} + } + ); + + const req = { + query: { + primaryIdAttribute: "pinswg_planningappeals78id", + incidentID: "i1" + } + }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual( + res.state.jsonBody.error.code, + "APPEAL_TYPE_NAME_REQUIRED" + ); +}); + +test("getbasicpartsaveddetails catch path returns BASIC_PART_SAVED_DETAILS_FETCH_FAILED", async () => { + const mod = loadModule( + "pages/api/endpoint/getbasicpartsaveddetails_api.js", + { + respondError: respondErrorMock, + respondSuccess: respondSuccessMock, + getToken: async () => ({ access_token: "token" }), + hashAPIPath: () => "&hash=expected", + azureHeadersNoOdata: () => ({}), + axios: { + get: async () => { + throw new Error("relay failed"); + } + }, + consoleLogger: () => {} + } + ); + + const req = { + query: { + appealTypeName: "pinswg_planningappeals78s", + primaryIdAttribute: "pinswg_planningappeals78id", + incidentID: "i1" + } + }; + const res = createRes(); + await mod.default(req, res); + + assert.strictEqual(res.state.statusCode, 400); + assert.strictEqual( + res.state.jsonBody.error.code, + "BASIC_PART_SAVED_DETAILS_FETCH_FAILED" + ); +}); + const run = async () => { let passed = 0; for (const currentTest of tests) {