refactor(api): migrate batch 8 endpoints to relayGet

memory-bank/change-log.md

@@ -939,3 +939,38 @@ Validation:
 Follow-ups:
 
 - Continue with next bounded P2-S2 batch from remaining legacy GET endpoints (e.g., advanced/basic paged search-detail clusters and related non-migrated proxies).
+
+---
+
+### CL-025: TASK22229 P2-S2 Batch 8 (basic search details + DNS details relay GET cluster)
+
+date: 2026-03-24
+author: Cline
+scope: `pages/api/endpoint/{getbasicsearchpaged_api,getbasicsearchdetails_api,getbasicsearchdetailspaged_api,getbasicdnssearchdetails_api,getbasicdnssearchdetailspaged_api}.js`, `tests/phase21/endpoint-handler-contract.test.cjs`
+type: change
+rationale: Continue the P2-S2 relay migration using bounded commits by moving the remaining basic-search-details and DNS-details GET handlers to shared `relayGet`, preserving existing guards and response contracts.
+impact: Reduced duplicated relay plumbing and more consistent forwarding behavior across search-detail handlers; no intended API contract changes.
+status: completed
+
+Summary:
+
+- Migrated Batch 8 endpoints to shared `relayGet`:
+    - `getbasicsearchpaged_api.js`
+    - `getbasicsearchdetails_api.js`
+    - `getbasicsearchdetailspaged_api.js`
+    - `getbasicdnssearchdetails_api.js`
+    - `getbasicdnssearchdetailspaged_api.js`
+- Preserved existing validation guards and error contracts.
+- Preserved existing endpoint-specific transforms:
+    - `@odata.nextLink` normalization in paged responses
+    - flattened ticketnumber enrichment for search detail handlers
+- Updated phase21 endpoint contract tests to inject `relayGet` mocks for migrated handlers in validation and catch-path tests.
+
+Validation:
+
+- `node tests/phase21/endpoint-handler-contract.test.cjs` -> pass (152/152)
+- `npm run lint` -> warnings only (pre-existing `react-hooks/exhaustive-deps`; no new lint errors)
+
+Follow-ups:
+
+- Continue P2-S2 with next bounded batch from remaining legacy GET endpoints (currently: `createwatchedcases_api`, `deletewatchedcasesproxy_api`, `getadvancedsearch_api`, `getadvancedsearchpaged_api`, `getappealid_api`, `getbasicdnssearchpaged_api`, `getbasicpartsaveddetails_api`, `getbasicsearch_by_address_api`, `getbasicsearch_by_lparref_api`, `getdnscoords_api`, `getdnslist_api`, `getmylpacases_api`, `getportallogin_api`).

pages/api/endpoint/getbasicdnssearchdetails_api.js

@@ -10,18 +10,10 @@
  *         description: Success
  */
 
-import axios from "axios";
-import _ from "lodash";
 import { azureHeaders } from "../../../actions/core/headers";
-import { consoleLogger } from "../../../actions/core/logger";
-import { getToken } from "../../../actions/core/token";
 import { getSelectQuery } from "../../../actions/selectQueryTypes";
-import { hashAPIPath } from "../../../actions/core/hash";
+import { respondError } from "../middleware/apiResponse";
-import { respondError, respondSuccess } from "../middleware/apiResponse";
+import { relayGet } from "../middleware/relayForwarding";
-
-const WEBAPI_URL =
-    process.env.RELAY_ROOT ||
-    "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/";
 
 export default async function ApiProxy(req, res) {
     const caseReference = req.query.caseReference;
@@ -37,9 +29,6 @@ export default async function ApiProxy(req, res) {
         });
     }
 
-    try {
-        const token = await getToken();
-
     let queryUrl =
         "pinswg_dnses?$filter=pinswg_name eq '" +
         caseReference +
@@ -47,18 +36,14 @@ export default async function ApiProxy(req, res) {
 
     queryUrl = queryUrl + getSelectQuery("pinswg_dnses");
 
-        const { data } = await axios.get(
+    return relayGet({
-            WEBAPI_URL + queryUrl + hashAPIPath(queryUrl),
+        queryUrl,
-            azureHeaders(token.access_token)
+        res,
-        );
+        requestOptionsBuilder: (accessToken) => azureHeaders(accessToken),
-
+        errorResponse: {
-        return respondSuccess(res, data);
-    } catch (error) {
-        consoleLogger(error);
-        return respondError(res, {
             status: 400,
             code: "BASIC_DNS_SEARCH_DETAILS_FETCH_FAILED",
             message: "Failed to fetch basic DNS search details"
-        });
         }
+    });
 }

pages/api/endpoint/getbasicdnssearchdetailspaged_api.js

@@ -9,18 +9,11 @@
  *       200:
  *         description: Success
  */
-import axios from "axios";
 import _ from "lodash";
 import { azureHeadersPaged } from "../../../actions/core/headers";
-import { consoleLogger } from "../../../actions/core/logger";
-import { getToken } from "../../../actions/core/token";
 import { getSelectQuery } from "../../../actions/selectQueryTypes";
-import { hashAPIPath } from "../../../actions/core/hash";
+import { respondError } from "../middleware/apiResponse";
-import { respondError, respondSuccess } from "../middleware/apiResponse";
+import { relayGet } from "../middleware/relayForwarding";
-
-const WEBAPI_URL =
-    process.env.RELAY_ROOT ||
-    "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/";
 
 export default async function ApiProxy(req, res) {
     const caseReference = req.query.caseReference;
@@ -36,9 +29,6 @@ export default async function ApiProxy(req, res) {
         });
     }
 
-    try {
-        const token = await getToken();
-
     let queryUrl =
         "pinswg_dnses?$filter=pinswg_name eq '" +
         caseReference +
@@ -46,23 +36,22 @@ export default async function ApiProxy(req, res) {
 
     queryUrl = queryUrl + getSelectQuery("pinswg_dnses");
 
-        const { data } = await axios.get(
+    return relayGet({
-            WEBAPI_URL + queryUrl + hashAPIPath(queryUrl),
+        queryUrl,
-            azureHeadersPaged(token.access_token)
+        res,
-        );
+        requestOptionsBuilder: (accessToken) => azureHeadersPaged(accessToken),
-
+        transformData: (data) => {
             if (_.has(data, "@odata.nextLink") === true) {
                 const dataStr = JSON.stringify(data["@odata.nextLink"]);
                 data["@odata.nextLink"] = dataStr.split("/v8.2/")[1];
             }
 
-        return respondSuccess(res, data);
+            return data;
-    } catch (error) {
+        },
-        consoleLogger(error);
+        errorResponse: {
-        return respondError(res, {
             status: 400,
             code: "BASIC_DNS_SEARCH_DETAILS_PAGED_FETCH_FAILED",
             message: "Failed to fetch paged basic DNS search details"
-        });
         }
+    });
 }

pages/api/endpoint/getbasicsearchdetails_api.js

@@ -29,18 +29,11 @@
  *         description: Success
  */
 
-import axios from "axios";
 import { azureHeaders } from "../../../actions/core/headers";
-import { consoleLogger } from "../../../actions/core/logger";
-import { getToken } from "../../../actions/core/token";
 import { getSelectQuery } from "../../../actions/selectQueryTypes";
 import { getNavigationPropertyByPrimaryAttribute } from "../../../components/utils";
-import { hashAPIPath } from "../../../actions/core/hash";
+import { respondError } from "../middleware/apiResponse";
-import { respondError, respondSuccess } from "../middleware/apiResponse";
+import { relayGet } from "../middleware/relayForwarding";
-
-const WEBAPI_URL =
-    process.env.RELAY_ROOT ||
-    "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/";
 
 export default async function ApiProxy(req, res) {
     const appealTypeName = req.query.appealTypeName;
@@ -77,9 +70,6 @@ export default async function ApiProxy(req, res) {
         });
     }
 
-    try {
-        const token = await getToken();
-
     const navigationProperty =
         getNavigationPropertyByPrimaryAttribute(
             primaryIdAttribute
@@ -119,11 +109,11 @@ export default async function ApiProxy(req, res) {
     //     "\n==========================================\n"
     // );
 
-        const { data } = await axios.get(
+    return relayGet({
-            WEBAPI_URL + queryUrl + hashAPIPath(queryUrl),
+        queryUrl,
-            azureHeaders(token.access_token)
+        res,
-        );
+        requestOptionsBuilder: (accessToken) => azureHeaders(accessToken),
-
+        transformData: (data) => {
             let flattened = data.value.map((r) => ({
                 ...r,
                 ticketnumber: r[navigationProperty]?.ticketnumber || null
@@ -131,13 +121,12 @@ export default async function ApiProxy(req, res) {
 
             data.value = flattened;
 
-        return respondSuccess(res, data);
+            return data;
-    } catch (error) {
+        },
-        consoleLogger(error);
+        errorResponse: {
-        return respondError(res, {
             status: 400,
             code: "BASIC_SEARCH_DETAILS_FETCH_FAILED",
             message: "Failed to fetch basic search details"
-        });
         }
+    });
 }

pages/api/endpoint/getbasicsearchdetailspaged_api.js

@@ -29,19 +29,12 @@
  *         description: Success
  */
 
-import axios from "axios";
 import _ from "lodash";
 import { azureHeadersPaged } from "../../../actions/core/headers";
-import { consoleLogger } from "../../../actions/core/logger";
-import { getToken } from "../../../actions/core/token";
 import { getSelectQuery } from "../../../actions/selectQueryTypes";
 import { getNavigationPropertyByPrimaryAttribute } from "../../../components/utils";
-import { hashAPIPath } from "../../../actions/core/hash";
+import { respondError } from "../middleware/apiResponse";
-import { respondError, respondSuccess } from "../middleware/apiResponse";
+import { relayGet } from "../middleware/relayForwarding";
-
-const WEBAPI_URL =
-    process.env.RELAY_ROOT ||
-    "https://dev-pedw-ns.servicebus.windows.net/dev-pedw-hc/";
 
 export default async function ApiProxy(req, res) {
     const appealTypeName = req.query.appealTypeName;
@@ -78,9 +71,6 @@ export default async function ApiProxy(req, res) {
         });
     }
 
-    try {
-        const token = await getToken();
-
     const navigationProperty =
         getNavigationPropertyByPrimaryAttribute(
             primaryIdAttribute
@@ -112,11 +102,11 @@ export default async function ApiProxy(req, res) {
             ? "pinswg_sipscase_value"
             : primaryIdAttribute + "s_value");
 
-        const { data } = await axios.get(
+    return relayGet({
-            WEBAPI_URL + queryUrl + hashAPIPath(queryUrl),
+        queryUrl,
-            azureHeadersPaged(token.access_token)
+        res,
-        );
+        requestOptionsBuilder: (accessToken) => azureHeadersPaged(accessToken),
-
+        transformData: (data) => {
             let flattened = data.value.map((r) => ({
                 ...r,
                 ticketnumber: r[navigationProperty]?.ticketnumber || null
@@ -129,13 +119,12 @@ export default async function ApiProxy(req, res) {
                 data["@odata.nextLink"] = dataStr.split("/v8.2/")[1];
             }
 
-        return respondSuccess(res, data);
+            return data;
-    } catch (error) {
+        },
-        consoleLogger(error);
+        errorResponse: {
-        return respondError(res, {
             status: 400,
             code: "BASIC_SEARCH_DETAILS_PAGED_FETCH_FAILED",
             message: "Failed to fetch paged basic search details"
-        });
         }
+    });
 }

pages/api/endpoint/getbasicsearchpaged_api.js

@@ -42,17 +42,10 @@
  *         description: Success
  */
 
-import axios from "axios";
 import _ from "lodash";
 import { azureHeadersPagedCustom } from "../../../actions/core/headers";
-import { consoleLogger } from "../../../actions/core/logger";
+import { respondError } from "../middleware/apiResponse";
-import { getToken } from "../../../actions/core/token";
+import { relayGet } from "../middleware/relayForwarding";
-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) {
     let searchString = req.query.searchString;
@@ -96,9 +89,6 @@ export default async function ApiProxy(req, res) {
         });
     }
 
-    try {
-        const token = await getToken();
-
     searchString = searchString.replace(/\'/g, "''");
 
     const queryUrl =
@@ -121,23 +111,23 @@ export default async function ApiProxy(req, res) {
             ? "&$skiptoken=" + '<cookie pagenumber="' + pageNumber + '" />'
             : "");
 
-        const { data } = await axios.get(
+    return relayGet({
-            WEBAPI_URL + queryUrl + hashAPIPath(queryUrl),
+        queryUrl,
-            azureHeadersPagedCustom(token.access_token, showNumberOfRecords)
+        res,
-        );
+        requestOptionsBuilder: (accessToken) =>
-
+            azureHeadersPagedCustom(accessToken, showNumberOfRecords),
+        transformData: (data) => {
             if (_.has(data, "@odata.nextLink") === true) {
                 const dataStr = JSON.stringify(data["@odata.nextLink"]);
                 data["@odata.nextLink"] = dataStr.split("/v8.2/")[1];
             }
 
-        return respondSuccess(res, data);
+            return data;
-    } catch (error) {
+        },
-        consoleLogger(error);
+        errorResponse: {
-        return respondError(res, {
             status: 400,
             code: "BASIC_SEARCH_PAGED_FETCH_FAILED",
             message: "Failed to fetch paged basic search results"
-        });
         }
+    });
 }

tests/phase21/endpoint-handler-contract.test.cjs

@@ -1794,6 +1794,7 @@ test("getbasicsearchdetails returns APPEAL_TYPE_NAME_REQUIRED when appealTypeNam
     const mod = loadModule("pages/api/endpoint/getbasicsearchdetails_api.js", {
         respondError: respondErrorMock,
         respondSuccess: respondSuccessMock,
+        relayGet: async () => ({}),
         getToken: async () => ({ access_token: "token" }),
         getSelectQuery: () => "&$select=title",
         getNavigationPropertyByPrimaryAttribute: () => ({
@@ -1825,6 +1826,8 @@ test("getbasicsearchdetails catch path returns BASIC_SEARCH_DETAILS_FETCH_FAILED
     const mod = loadModule("pages/api/endpoint/getbasicsearchdetails_api.js", {
         respondError: respondErrorMock,
         respondSuccess: respondSuccessMock,
+        relayGet: async ({ res, errorResponse }) =>
+            respondErrorMock(res, errorResponse),
         getToken: async () => ({ access_token: "token" }),
         getSelectQuery: () => "&$select=title",
         getNavigationPropertyByPrimaryAttribute: () => ({
@@ -1863,6 +1866,7 @@ test("getbasicsearchdetailspaged returns APPEAL_TYPE_NAME_REQUIRED when appealTy
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async () => ({}),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=title",
             getNavigationPropertyByPrimaryAttribute: () => ({
@@ -1898,6 +1902,8 @@ test("getbasicsearchdetailspaged catch path returns BASIC_SEARCH_DETAILS_PAGED_F
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async ({ res, errorResponse }) =>
+                respondErrorMock(res, errorResponse),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=title",
             getNavigationPropertyByPrimaryAttribute: () => ({
@@ -1936,6 +1942,7 @@ test("getbasicsearchpaged returns ORDER_BY_REQUIRED when orderby missing", async
     const mod = loadModule("pages/api/endpoint/getbasicsearchpaged_api.js", {
         respondError: respondErrorMock,
         respondSuccess: respondSuccessMock,
+        relayGet: async () => ({}),
         getToken: async () => ({ access_token: "token" }),
         hashAPIPath: () => "&hash=expected",
         azureHeadersPagedCustom: () => ({}),
@@ -1962,6 +1969,8 @@ test("getbasicsearchpaged catch path returns BASIC_SEARCH_PAGED_FETCH_FAILED", a
     const mod = loadModule("pages/api/endpoint/getbasicsearchpaged_api.js", {
         respondError: respondErrorMock,
         respondSuccess: respondSuccessMock,
+        relayGet: async ({ res, errorResponse }) =>
+            respondErrorMock(res, errorResponse),
         getToken: async () => ({ access_token: "token" }),
         hashAPIPath: () => "&hash=expected",
         azureHeadersPagedCustom: () => ({}),
@@ -2187,6 +2196,7 @@ test("getbasicdnssearchdetails returns CASE_REFERENCE_REQUIRED when caseReferenc
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async () => ({}),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=pinswg_name",
             hashAPIPath: () => "&hash=expected",
@@ -2213,6 +2223,8 @@ test("getbasicdnssearchdetails catch path returns BASIC_DNS_SEARCH_DETAILS_FETCH
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async ({ res, errorResponse }) =>
+                respondErrorMock(res, errorResponse),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=pinswg_name",
             hashAPIPath: () => "&hash=expected",
@@ -2243,6 +2255,7 @@ test("getbasicdnssearchdetailspaged returns CASE_REFERENCE_REQUIRED when caseRef
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async () => ({}),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=pinswg_name",
             hashAPIPath: () => "&hash=expected",
@@ -2270,6 +2283,8 @@ test("getbasicdnssearchdetailspaged catch path returns BASIC_DNS_SEARCH_DETAILS_
         {
             respondError: respondErrorMock,
             respondSuccess: respondSuccessMock,
+            relayGet: async ({ res, errorResponse }) =>
+                respondErrorMock(res, errorResponse),
             getToken: async () => ({ access_token: "token" }),
             getSelectQuery: () => "&$select=pinswg_name",
             hashAPIPath: () => "&hash=expected",