TASK22211: standardize search-document endpoint contracts and phase21 coverage

2026-03-23 11:07:52 +00:00
parent 2caae7b458
commit b57f3de06f
6 changed files with 578 additions and 139 deletions
@@ -971,6 +971,368 @@ test("getadvancedsearch catch path returns ADVANCED_SEARCH_FETCH_FAILED", async
    );
 });

+test("getsearchdocumenthistory returns DOCUMENT_ID_REQUIRED when documentid missing", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumenthistory_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            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, "DOCUMENT_ID_REQUIRED");
+});
+
+test("getsearchdocumenthistory catch path returns SEARCH_DOCUMENT_HISTORY_FETCH_FAILED", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumenthistory_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            axios: {
+                get: async () => {
+                    throw new Error("relay failed");
+                }
+            },
+            consoleLogger: () => {}
+        }
+    );
+
+    const req = { query: { documentid: "d1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(
+        res.state.jsonBody.error.code,
+        "SEARCH_DOCUMENT_HISTORY_FETCH_FAILED"
+    );
+});
+
+test("getsearchdocumenthistory success returns existing data payload contract", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumenthistory_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            axios: {
+                get: async () => ({
+                    data: { value: [{ _pinswg_documentid_value: "d1" }] }
+                })
+            },
+            consoleLogger: () => {}
+        }
+    );
+
+    const req = { query: { documentid: "d1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 200);
+    assert.deepStrictEqual(JSON.parse(JSON.stringify(res.state.jsonBody)), {
+        value: [{ _pinswg_documentid_value: "d1" }]
+    });
+});
+
+test("getsearchdocumenthistorypaged returns DOCUMENT_ID_REQUIRED when documentid missing", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumenthistorypaged_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            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, "DOCUMENT_ID_REQUIRED");
+});
+
+test("getsearchdocumenthistorypaged catch path returns SEARCH_DOCUMENT_HISTORY_PAGED_FETCH_FAILED", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumenthistorypaged_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            axios: {
+                get: async () => {
+                    throw new Error("relay failed");
+                }
+            },
+            consoleLogger: () => {}
+        }
+    );
+
+    const req = { query: { documentid: "d1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(
+        res.state.jsonBody.error.code,
+        "SEARCH_DOCUMENT_HISTORY_PAGED_FETCH_FAILED"
+    );
+});
+
+test("getsearchdocumentdetails returns INCIDENT_ID_REQUIRED when incidentid missing", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumentdetails_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            axios: { get: async () => ({ data: { value: [] } }) },
+            consoleLogger: () => {},
+            CryptoJS: {
+                HmacSHA256: () => ({ toString: () => "hash" }),
+                enc: { Hex: { parse: () => "parsed", stringify: () => "hex" } }
+            },
+            _: { 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, "INCIDENT_ID_REQUIRED");
+});
+
+test("getsearchdocumentdetails catch path returns SEARCH_DOCUMENT_DETAILS_FETCH_FAILED", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumentdetails_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPaged: () => ({}),
+            axios: {
+                get: async () => {
+                    throw new Error("relay failed");
+                }
+            },
+            consoleLogger: () => {},
+            CryptoJS: {
+                HmacSHA256: () => ({ toString: () => "hash" }),
+                enc: { Hex: { parse: () => "parsed", stringify: () => "hex" } }
+            },
+            _: { has: () => false }
+        }
+    );
+
+    const req = { query: { incidentid: "i1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(
+        res.state.jsonBody.error.code,
+        "SEARCH_DOCUMENT_DETAILS_FETCH_FAILED"
+    );
+});
+
+test("getsearchdocumentdetailspaged returns INCIDENT_ID_REQUIRED when incidentid missing", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumentdetailspaged_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPagedCustom: () => ({}),
+            axios: { get: async () => ({ data: { value: [] } }) },
+            consoleLogger: () => {},
+            CryptoJS: {
+                HmacSHA256: () => ({ toString: () => "hash" }),
+                enc: { Hex: { parse: () => "parsed", stringify: () => "hex" } }
+            },
+            _: { has: () => false }
+        }
+    );
+
+    const req = {
+        query: {
+            orderby: "createdon",
+            fieldSort: "asc",
+            showNumberOfRecords: "10"
+        }
+    };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(res.state.jsonBody.error.code, "INCIDENT_ID_REQUIRED");
+});
+
+test("getsearchdocumentdetailspaged catch path returns SEARCH_DOCUMENT_DETAILS_PAGED_FETCH_FAILED", async () => {
+    const mod = loadModule(
+        "pages/api/endpoint/getsearchdocumentdetailspaged_api.js",
+        {
+            respondError: respondErrorMock,
+            respondSuccess: respondSuccessMock,
+            getToken: async () => ({ access_token: "token" }),
+            hashAPIPath: () => "&hash=expected",
+            azureHeadersPagedCustom: () => ({}),
+            axios: {
+                get: async () => {
+                    throw new Error("relay failed");
+                }
+            },
+            consoleLogger: () => {},
+            CryptoJS: {
+                HmacSHA256: () => ({ toString: () => "hash" }),
+                enc: { Hex: { parse: () => "parsed", stringify: () => "hex" } }
+            },
+            _: { has: () => false }
+        }
+    );
+
+    const req = {
+        query: {
+            incidentid: "i1",
+            orderby: "createdon",
+            fieldSort: "asc",
+            showNumberOfRecords: "10"
+        }
+    };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(
+        res.state.jsonBody.error.code,
+        "SEARCH_DOCUMENT_DETAILS_PAGED_FETCH_FAILED"
+    );
+});
+
+test("getsearchdocumentTypes returns INCIDENT_ID_REQUIRED when incidentid missing", async () => {
+    const mod = loadModule("pages/api/endpoint/getsearchdocumentTypes_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, "INCIDENT_ID_REQUIRED");
+});
+
+test("getsearchdocumentTypes catch path returns SEARCH_DOCUMENT_TYPES_FETCH_FAILED", async () => {
+    const mod = loadModule("pages/api/endpoint/getsearchdocumentTypes_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: { incidentid: "i1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 400);
+    assert.strictEqual(
+        res.state.jsonBody.error.code,
+        "SEARCH_DOCUMENT_TYPES_FETCH_FAILED"
+    );
+});
+
+test("getsearchdocumentTypes success returns grouped data payload contract", async () => {
+    const mod = loadModule("pages/api/endpoint/getsearchdocumentTypes_api.js", {
+        respondError: respondErrorMock,
+        respondSuccess: respondSuccessMock,
+        getToken: async () => ({ access_token: "token" }),
+        hashAPIPath: () => "&hash=expected",
+        azureHeaders: () => ({}),
+        axios: {
+            get: async () => ({
+                data: {
+                    value: [
+                        {
+                            pinswg_isharedocumentlocations: 1,
+                            "pinswg_isharedocumentlocations@OData.Community.Display.V1.FormattedValue":
+                                "Plans"
+                        },
+                        {
+                            pinswg_isharedocumentlocations: 1,
+                            "pinswg_isharedocumentlocations@OData.Community.Display.V1.FormattedValue":
+                                "Plans"
+                        },
+                        {
+                            pinswg_isharedocumentlocations: 2,
+                            "pinswg_isharedocumentlocations@OData.Community.Display.V1.FormattedValue":
+                                "Letters"
+                        }
+                    ]
+                }
+            })
+        },
+        consoleLogger: () => {}
+    });
+
+    const req = { query: { incidentid: "i1" } };
+    const res = createRes();
+    await mod.default(req, res);
+
+    assert.strictEqual(res.state.statusCode, 200);
+    assert.deepStrictEqual(JSON.parse(JSON.stringify(res.state.jsonBody)), [
+        {
+            pinswg_isharedocumentlocations: 1,
+            pinswg_isharedocumentlocationsLabel: "Plans",
+            count: 2
+        },
+        {
+            pinswg_isharedocumentlocations: 2,
+            pinswg_isharedocumentlocationsLabel: "Letters",
+            count: 1
+        }
+    ]);
+});
+
 const run = async () => {
    let passed = 0;
    for (const currentTest of tests) {