refactor(actions): extract fileClient with phase22 coverage
This commit is contained in:
@@ -0,0 +1,23 @@
|
|||||||
|
import { getJson, requestJson } from "./endpointClient";
|
||||||
|
import { buildHashedQueryUrl } from "./relayClient";
|
||||||
|
|
||||||
|
export const getFileJson = (url) => {
|
||||||
|
return getJson(url);
|
||||||
|
};
|
||||||
|
|
||||||
|
export const getSignedFileJson = async (queryUrl) => {
|
||||||
|
const signedUrl = await buildHashedQueryUrl(queryUrl);
|
||||||
|
|
||||||
|
return requestJson({
|
||||||
|
method: "get",
|
||||||
|
url: signedUrl
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
export const downloadFileBlob = (url) => {
|
||||||
|
return requestJson({
|
||||||
|
method: "get",
|
||||||
|
url,
|
||||||
|
responseType: "blob"
|
||||||
|
});
|
||||||
|
};
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
export * from "./relayClient";
|
export * from "./relayClient";
|
||||||
export * from "./endpointClient";
|
export * from "./endpointClient";
|
||||||
|
export * from "./fileClient";
|
||||||
|
|||||||
@@ -3,6 +3,11 @@ import { consoleLogger } from "../core/logger";
|
|||||||
import { hashAPIPath } from "../core/hash";
|
import { hashAPIPath } from "../core/hash";
|
||||||
import { buildHashedQueryUrl } from "../clients/relayClient";
|
import { buildHashedQueryUrl } from "../clients/relayClient";
|
||||||
import { getJson, requestJson } from "../clients/endpointClient";
|
import { getJson, requestJson } from "../clients/endpointClient";
|
||||||
|
import {
|
||||||
|
getFileJson,
|
||||||
|
getSignedFileJson,
|
||||||
|
downloadFileBlob
|
||||||
|
} from "../clients/fileClient";
|
||||||
|
|
||||||
export const getAwaitingSubmissionFromBlob = (containerName) => {
|
export const getAwaitingSubmissionFromBlob = (containerName) => {
|
||||||
return getJson(
|
return getJson(
|
||||||
@@ -48,7 +53,7 @@ export const getAwaitingSubmissionFromBlobProxy = async (containerName) => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
export const getFilesFromBlobproxy = (containerName, casefolderID) => {
|
export const getFilesFromBlobproxy = (containerName, casefolderID) => {
|
||||||
return getJson(
|
return getFileJson(
|
||||||
"/api/file/getbloblistproxy?container=" +
|
"/api/file/getbloblistproxy?container=" +
|
||||||
containerName +
|
containerName +
|
||||||
"&casefolderID=" +
|
"&casefolderID=" +
|
||||||
@@ -68,14 +73,7 @@ export const deleteAwaitingSubmissionsFromBlob = (
|
|||||||
"&casefolderID=" +
|
"&casefolderID=" +
|
||||||
casefolderID;
|
casefolderID;
|
||||||
|
|
||||||
return buildHashedQueryUrl(queryUrl)
|
return getSignedFileJson(queryUrl).catch((error) => {
|
||||||
.then((signedUrl) =>
|
|
||||||
requestJson({
|
|
||||||
method: "get",
|
|
||||||
url: signedUrl
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.catch((error) => {
|
|
||||||
consoleLogger(error);
|
consoleLogger(error);
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
@@ -93,14 +91,7 @@ export const deleteMyRepresentationsFromBlob = (
|
|||||||
"&repfile=" +
|
"&repfile=" +
|
||||||
repfile;
|
repfile;
|
||||||
|
|
||||||
return buildHashedQueryUrl(queryUrl)
|
return getSignedFileJson(queryUrl).catch((error) => {
|
||||||
.then((signedUrl) =>
|
|
||||||
requestJson({
|
|
||||||
method: "get",
|
|
||||||
url: signedUrl
|
|
||||||
})
|
|
||||||
)
|
|
||||||
.catch((error) => {
|
|
||||||
consoleLogger(error);
|
consoleLogger(error);
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
@@ -299,7 +290,7 @@ export const deleteBlob = async (
|
|||||||
deleteblobhash,
|
deleteblobhash,
|
||||||
casefolderID
|
casefolderID
|
||||||
) => {
|
) => {
|
||||||
return getJson(
|
return getFileJson(
|
||||||
"/api/file/deleteblob?container=" +
|
"/api/file/deleteblob?container=" +
|
||||||
containerName +
|
containerName +
|
||||||
"&casefolderID=" +
|
"&casefolderID=" +
|
||||||
@@ -319,7 +310,7 @@ export const deleteRepBlob = async (
|
|||||||
casefolderID,
|
casefolderID,
|
||||||
filenamePrefix
|
filenamePrefix
|
||||||
) => {
|
) => {
|
||||||
return getJson(
|
return getFileJson(
|
||||||
"/api/file/deleteblob?container=" +
|
"/api/file/deleteblob?container=" +
|
||||||
containerName +
|
containerName +
|
||||||
"&casefolderID=" +
|
"&casefolderID=" +
|
||||||
@@ -340,11 +331,7 @@ export const downloadBlob = (containerName, blobName) => {
|
|||||||
"&blobname=" +
|
"&blobname=" +
|
||||||
blobName;
|
blobName;
|
||||||
|
|
||||||
return requestJson({
|
return downloadFileBlob(queryUrl).catch((error) => {
|
||||||
method: "get",
|
|
||||||
url: queryUrl,
|
|
||||||
responseType: "blob"
|
|
||||||
}).catch((error) => {
|
|
||||||
consoleLogger(error);
|
consoleLogger(error);
|
||||||
});
|
});
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -2266,3 +2266,49 @@ Validation:
|
|||||||
Follow-ups:
|
Follow-ups:
|
||||||
|
|
||||||
- Optional next bounded slice: add focused phase22 behavioural coverage for any future shared client wrappers introduced beyond `endpointClient`/`relayClient`.
|
- Optional next bounded slice: add focused phase22 behavioural coverage for any future shared client wrappers introduced beyond `endpointClient`/`relayClient`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### CL-065: TASK22260 next slice — fileClient extraction + phase22 behavioural coverage
|
||||||
|
|
||||||
|
date: 2026-03-25
|
||||||
|
author: Cline
|
||||||
|
scope: `actions/clients/{fileClient,index}.js`, `actions/services/documentDirectService.js`, `tests/phase22/{file-client-behaviour,index}.test.cjs`
|
||||||
|
type: change
|
||||||
|
rationale: Continue bounded shared-client decomposition by extracting repeated file-route request patterns into `fileClient` and hardening behaviour with dedicated phase22 tests.
|
||||||
|
impact: Reduces request-boilerplate duplication in document service and increases regression confidence for extracted file client helper contracts.
|
||||||
|
status: completed
|
||||||
|
|
||||||
|
Summary:
|
||||||
|
|
||||||
|
- Added new shared client wrapper: `actions/clients/fileClient.js`:
|
||||||
|
- `getFileJson(url)`
|
||||||
|
- `getSignedFileJson(queryUrl)`
|
||||||
|
- `downloadFileBlob(url)`
|
||||||
|
- Exported `fileClient` from `actions/clients/index.js` (and therefore via `actions/index.js` barrel path).
|
||||||
|
- Migrated a bounded subset of `actions/services/documentDirectService.js` call sites to `fileClient` while preserving catch-path logging behavior:
|
||||||
|
- `getFilesFromBlobproxy` -> `getFileJson`
|
||||||
|
- `deleteAwaitingSubmissionsFromBlob` -> `getSignedFileJson`
|
||||||
|
- `deleteMyRepresentationsFromBlob` -> `getSignedFileJson`
|
||||||
|
- `deleteBlob` -> `getFileJson`
|
||||||
|
- `deleteRepBlob` -> `getFileJson`
|
||||||
|
- `downloadBlob` -> `downloadFileBlob`
|
||||||
|
- Added `tests/phase22/file-client-behaviour.test.cjs` covering:
|
||||||
|
- delegation to `getJson`
|
||||||
|
- signed URL generation + `requestJson` invocation
|
||||||
|
- blob download config contract (`responseType: "blob"`)
|
||||||
|
- Updated aggregate runner `tests/phase22/index.test.cjs` to include file-client suite.
|
||||||
|
|
||||||
|
Validation:
|
||||||
|
|
||||||
|
- `node tests/phase22/file-client-behaviour.test.cjs` -> pass (3/3)
|
||||||
|
- `node tests/phase22/index.test.cjs` -> pass
|
||||||
|
- core-token: 2/2
|
||||||
|
- client-utils: 5/5
|
||||||
|
- file-client: 3/3
|
||||||
|
- phase22 combined: pass
|
||||||
|
- `npm run lint` -> warnings only (pre-existing `react-hooks/exhaustive-deps`; no new lint errors)
|
||||||
|
|
||||||
|
Follow-ups:
|
||||||
|
|
||||||
|
- Optional next bounded slice: evaluate whether additional `documentDirectService` file-route call sites can adopt `fileClient` without altering current behavior contracts.
|
||||||
|
|||||||
@@ -0,0 +1,127 @@
|
|||||||
|
const fs = require("fs");
|
||||||
|
const path = require("path");
|
||||||
|
const vm = require("vm");
|
||||||
|
const assert = require("assert");
|
||||||
|
|
||||||
|
const rootDir = path.resolve(__dirname, "..", "..");
|
||||||
|
|
||||||
|
const loadFileClientModule = (injected = {}) => {
|
||||||
|
const filePath = path.join(rootDir, "actions", "clients", "fileClient.js");
|
||||||
|
let source = fs.readFileSync(filePath, "utf8");
|
||||||
|
|
||||||
|
source = source.replace(/import[\s\S]*?from\s+"[^"]+";\n?/g, "");
|
||||||
|
source = source.replace(/export const\s+/g, "const ");
|
||||||
|
source +=
|
||||||
|
"\nmodule.exports = { getFileJson, getSignedFileJson, downloadFileBlob };\n";
|
||||||
|
|
||||||
|
const context = {
|
||||||
|
module: { exports: {} },
|
||||||
|
exports: {},
|
||||||
|
require,
|
||||||
|
getJson: async () => {
|
||||||
|
throw new Error("getJson not injected");
|
||||||
|
},
|
||||||
|
requestJson: async () => {
|
||||||
|
throw new Error("requestJson not injected");
|
||||||
|
},
|
||||||
|
buildHashedQueryUrl: async () => {
|
||||||
|
throw new Error("buildHashedQueryUrl not injected");
|
||||||
|
},
|
||||||
|
...injected
|
||||||
|
};
|
||||||
|
|
||||||
|
vm.runInNewContext(source, context, { filename: filePath });
|
||||||
|
return context.module.exports;
|
||||||
|
};
|
||||||
|
|
||||||
|
const tests = [];
|
||||||
|
const test = (name, fn) => tests.push({ name, fn });
|
||||||
|
|
||||||
|
test("clients/fileClient getFileJson delegates to getJson", async () => {
|
||||||
|
const calls = [];
|
||||||
|
|
||||||
|
const mod = loadFileClientModule({
|
||||||
|
getJson: async (url) => {
|
||||||
|
calls.push(url);
|
||||||
|
return { ok: true };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await mod.getFileJson("/api/file/getbloblistproxy?x=1");
|
||||||
|
|
||||||
|
assert.deepStrictEqual(JSON.parse(JSON.stringify(result)), { ok: true });
|
||||||
|
assert.strictEqual(calls.length, 1);
|
||||||
|
assert.strictEqual(calls[0], "/api/file/getbloblistproxy?x=1");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("clients/fileClient getSignedFileJson signs url and requests json", async () => {
|
||||||
|
const signedCalls = [];
|
||||||
|
const requestCalls = [];
|
||||||
|
|
||||||
|
const mod = loadFileClientModule({
|
||||||
|
buildHashedQueryUrl: async (queryUrl) => {
|
||||||
|
signedCalls.push(queryUrl);
|
||||||
|
return queryUrl + "&hash=signed";
|
||||||
|
},
|
||||||
|
requestJson: async (config) => {
|
||||||
|
requestCalls.push(config);
|
||||||
|
return { deleted: true };
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await mod.getSignedFileJson(
|
||||||
|
"/api/file/deleteblobcase?container=a&casefolderID=b"
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.deepStrictEqual(JSON.parse(JSON.stringify(result)), {
|
||||||
|
deleted: true
|
||||||
|
});
|
||||||
|
assert.strictEqual(signedCalls.length, 1);
|
||||||
|
assert.strictEqual(requestCalls.length, 1);
|
||||||
|
assert.strictEqual(requestCalls[0].method, "get");
|
||||||
|
assert.strictEqual(
|
||||||
|
requestCalls[0].url,
|
||||||
|
"/api/file/deleteblobcase?container=a&casefolderID=b&hash=signed"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("clients/fileClient downloadFileBlob requests blob response", async () => {
|
||||||
|
const requestCalls = [];
|
||||||
|
|
||||||
|
const mod = loadFileClientModule({
|
||||||
|
requestJson: async (config) => {
|
||||||
|
requestCalls.push(config);
|
||||||
|
return "blob-data";
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const result = await mod.downloadFileBlob("/api/file/downloadblob?x=1");
|
||||||
|
|
||||||
|
assert.strictEqual(result, "blob-data");
|
||||||
|
assert.strictEqual(requestCalls.length, 1);
|
||||||
|
assert.strictEqual(requestCalls[0].method, "get");
|
||||||
|
assert.strictEqual(requestCalls[0].responseType, "blob");
|
||||||
|
assert.strictEqual(requestCalls[0].url, "/api/file/downloadblob?x=1");
|
||||||
|
});
|
||||||
|
|
||||||
|
const run = async () => {
|
||||||
|
let passed = 0;
|
||||||
|
|
||||||
|
for (const currentTest of tests) {
|
||||||
|
await currentTest.fn();
|
||||||
|
passed += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(
|
||||||
|
`Phase 22 file-client tests passed (${passed}/${tests.length}).`
|
||||||
|
);
|
||||||
|
};
|
||||||
|
|
||||||
|
module.exports = run;
|
||||||
|
|
||||||
|
if (require.main === module) {
|
||||||
|
run().catch((error) => {
|
||||||
|
console.error(error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -1,9 +1,11 @@
|
|||||||
const runCoreTokenTests = require("./core-token-behaviour.test.cjs");
|
const runCoreTokenTests = require("./core-token-behaviour.test.cjs");
|
||||||
const runClientUtilsTests = require("./client-utils-behaviour.test.cjs");
|
const runClientUtilsTests = require("./client-utils-behaviour.test.cjs");
|
||||||
|
const runFileClientTests = require("./file-client-behaviour.test.cjs");
|
||||||
|
|
||||||
const run = async () => {
|
const run = async () => {
|
||||||
await runCoreTokenTests();
|
await runCoreTokenTests();
|
||||||
await runClientUtilsTests();
|
await runClientUtilsTests();
|
||||||
|
await runFileClientTests();
|
||||||
console.log("Phase 22 combined suite passed.");
|
console.log("Phase 22 combined suite passed.");
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user