Merged PR 2375: update representation policy
## Summary Introduces a new `representation-policy` domain boundary and incrementally extracts low-risk representation entry policy logic while preserving existing behaviour. This PR intentionally stops before extracting ROW and Advert entry rules because characterization uncovered behavioural differences between consumers that require a separate business decision. ## What Changed Added: ```text lib/domain/representation-policy/ ``` Including: - `resolveRepresentationWindow(...)` - `isRepresentationWindowOpen(...)` - `isRepresentationWindowClosed(...)` - `canShowRepresentationButtonForAppealType(...)` - `canStartHouseholderRepresentation(...)` - `canStartCpoRepresentation(...)` Updated consumers: ```text components/case/summary/utils/representationEntry.js components/search/repsonresults.js ``` ## Extracted Behaviour ### Representation Window Calculation Centralised shared representation window logic and adopted it in both consumers. ### Appeal Type Entry Gating Centralised excluded appeal-type logic while preserving existing behaviour. ### Householder Rule Centralised Householder (`846040004`) entry rule. Preserved behaviour: ```text Householder representations can only be started by LPAs. ``` ### CPO Rule Centralised CPO (`846040019`) entry rule. Preserved behaviour using: ```text pinswg_startdate pinswg_statementduedate ``` No fallback date broadening introduced. ## Characterization Added ### ROW (`846040015`) Documented: - hearing vs non-hearing behaviour - specialist-process field behaviour - date gating - appeal-type coercion behaviour ### Advert (`846040018`) Documented: - LPA/non-LPA behaviour - specialist-process behaviour - appeal-type coercion behaviour ## Important Findings ### ROW Divergence Summary and Search consumers currently behave differently when only: ```text pinswg_speacialistcaseprocess ``` exists. ### Advert Divergence Summary and Search consumers currently use different specialist-process resolution paths. ### CRM Compatibility Both fields remain in production use and must be preserved: ```text pinswg_specialistcaseprocess pinswg_speacialistcaseprocess ``` ## Documentation Added: ```text lib/domain/representation-policy/README.md ``` Documenting: - ownership - non-goals - CRM compatibility requirements - ROW divergence - Advert divergence - future extraction constraints ## Validation Executed during the slice series: ```bash node tests/phase22/representation-window.test.cjs node tests/phase22/representation-appeal-type-entry-gating.test.cjs node tests/phase22/representation-householder-entry-rule.test.cjs node tests/phase22/representation-cpo-entry-rule.test.cjs node tests/phase22/representation-row-entry-rule.test.cjs node tests/phase22/representation-advert-entry-rule.test.cjs npm run lint ``` All passing. ## Out of Scope No changes to: - submission/finalisation - uploads - dashboards - CRM/OData queries - API routes - Redux state - translations - blocked-message rendering - CTA l...
This commit is contained in:
Robert Bond
@@ -0,0 +1,457 @@
|
||||
const fs = require("fs");
|
||||
const path = require("path");
|
||||
const vm = require("vm");
|
||||
const assert = require("assert");
|
||||
|
||||
const rootDir = path.resolve(__dirname, "..", "..");
|
||||
|
||||
const createFakeDate = (isoString) => {
|
||||
const RealDate = Date;
|
||||
|
||||
function FakeDate(...args) {
|
||||
if (!(this instanceof FakeDate)) {
|
||||
return new RealDate(...args);
|
||||
}
|
||||
|
||||
if (args.length === 0) {
|
||||
return new RealDate(isoString);
|
||||
}
|
||||
|
||||
return new RealDate(...args);
|
||||
}
|
||||
|
||||
FakeDate.UTC = RealDate.UTC;
|
||||
FakeDate.parse = RealDate.parse;
|
||||
FakeDate.now = () => new RealDate(isoString).getTime();
|
||||
FakeDate.prototype = RealDate.prototype;
|
||||
|
||||
return FakeDate;
|
||||
};
|
||||
|
||||
const loadEsModuleFunctions = (
|
||||
relativePath,
|
||||
exportNames,
|
||||
contextExtras = {}
|
||||
) => {
|
||||
const filePath = path.join(rootDir, ...relativePath.split("/"));
|
||||
let source = fs.readFileSync(filePath, "utf8");
|
||||
|
||||
for (const exportName of exportNames) {
|
||||
source = source.replace(
|
||||
new RegExp(`export function\\s+${exportName}`, "g"),
|
||||
`function ${exportName}`
|
||||
);
|
||||
source = source.replace(
|
||||
new RegExp(`export const\\s+${exportName}\\s*=`, "g"),
|
||||
`const ${exportName} =`
|
||||
);
|
||||
}
|
||||
|
||||
source = source.replace(
|
||||
/import\s+\{\s*isRepresentationWindowOpen\s*\}\s+from\s+"\.\/resolveRepresentationWindow";/,
|
||||
'const { isRepresentationWindowOpen } = require("./resolveRepresentationWindow");'
|
||||
);
|
||||
|
||||
source += `\nmodule.exports = { ${exportNames.join(", ")} };\n`;
|
||||
|
||||
const context = {
|
||||
module: { exports: {} },
|
||||
exports: {},
|
||||
require,
|
||||
Date,
|
||||
Number,
|
||||
Set,
|
||||
...contextExtras
|
||||
};
|
||||
|
||||
vm.runInNewContext(source, context, { filename: filePath });
|
||||
return context.module.exports;
|
||||
};
|
||||
|
||||
const windowHelpers = loadEsModuleFunctions(
|
||||
"lib/domain/representation-policy/resolveRepresentationWindow.js",
|
||||
[
|
||||
"isRepresentationWindowOpen",
|
||||
"isRepresentationWindowClosed",
|
||||
"resolveRepresentationWindow"
|
||||
]
|
||||
);
|
||||
|
||||
const gatingHelpers = loadEsModuleFunctions(
|
||||
"lib/domain/representation-policy/canShowRepresentationButtonForAppealType.js",
|
||||
["canShowRepresentationButtonForAppealType"]
|
||||
);
|
||||
|
||||
const householderHelpers = loadEsModuleFunctions(
|
||||
"lib/domain/representation-policy/canStartHouseholderRepresentation.js",
|
||||
["canStartHouseholderRepresentation"]
|
||||
);
|
||||
|
||||
const cpoHelpers = loadEsModuleFunctions(
|
||||
"lib/domain/representation-policy/canStartCpoRepresentation.js",
|
||||
["canStartCpoRepresentation"],
|
||||
{
|
||||
require: (modulePath) => {
|
||||
if (modulePath === "./resolveRepresentationWindow") {
|
||||
return windowHelpers;
|
||||
}
|
||||
return require(modulePath);
|
||||
}
|
||||
}
|
||||
);
|
||||
|
||||
const { normalizeSpecialistProcess } = loadEsModuleFunctions(
|
||||
"lib/domain/case-lifecycle/normalizeSpecialistProcess.js",
|
||||
["normalizeSpecialistProcess"]
|
||||
);
|
||||
|
||||
const evaluateSearchRowRule = ({
|
||||
appealType,
|
||||
detailsObj,
|
||||
isLPA,
|
||||
DateCtor = Date
|
||||
}) => {
|
||||
const specialistProcess = normalizeSpecialistProcess(detailsObj);
|
||||
|
||||
if (!gatingHelpers.canShowRepresentationButtonForAppealType(appealType)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
switch (appealType) {
|
||||
case 846040004:
|
||||
return householderHelpers.canStartHouseholderRepresentation(
|
||||
appealType,
|
||||
isLPA
|
||||
);
|
||||
|
||||
case 846040015:
|
||||
return specialistProcess == 846040001
|
||||
? windowHelpers.isRepresentationWindowOpen(
|
||||
detailsObj.pinswg_startdate,
|
||||
detailsObj.pinswg_finalcommentsduedate,
|
||||
DateCtor
|
||||
)
|
||||
: true;
|
||||
|
||||
case 846040018:
|
||||
return specialistProcess == 846040000 && isLPA
|
||||
? true
|
||||
: specialistProcess == 846040001
|
||||
? true
|
||||
: false;
|
||||
|
||||
case 846040019:
|
||||
return cpoHelpers.canStartCpoRepresentation(
|
||||
appealType,
|
||||
detailsObj,
|
||||
DateCtor
|
||||
);
|
||||
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
const tests = [];
|
||||
const test = (name, fn) => tests.push({ name, fn });
|
||||
|
||||
const evaluateSummaryRowRule = ({
|
||||
appealType,
|
||||
detailsObj,
|
||||
DateCtor = Date
|
||||
}) => {
|
||||
if (!gatingHelpers.canShowRepresentationButtonForAppealType(appealType)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
switch (appealType) {
|
||||
case 846040004:
|
||||
return householderHelpers.canStartHouseholderRepresentation(
|
||||
appealType,
|
||||
false
|
||||
);
|
||||
|
||||
case 846040015:
|
||||
return detailsObj.pinswg_specialistcaseprocess == 846040001
|
||||
? windowHelpers.isRepresentationWindowOpen(
|
||||
detailsObj.pinswg_startdate,
|
||||
detailsObj.pinswg_finalcommentsduedate,
|
||||
DateCtor
|
||||
)
|
||||
: true;
|
||||
|
||||
case 846040018:
|
||||
return detailsObj.pinswg_speacialistcaseprocess == 846040000
|
||||
? false
|
||||
: detailsObj.pinswg_speacialistcaseprocess == 846040001
|
||||
? true
|
||||
: false;
|
||||
|
||||
case 846040019:
|
||||
return cpoHelpers.canStartCpoRepresentation(
|
||||
appealType,
|
||||
detailsObj,
|
||||
DateCtor
|
||||
);
|
||||
|
||||
default:
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
test("ROW hearing specialist process is date-gated in both consumers", () => {
|
||||
const openDate = createFakeDate("2026-04-15T10:00:00.000Z");
|
||||
const expiredDate = createFakeDate("2026-05-01T10:00:00.000Z");
|
||||
const futureDate = createFakeDate("2026-03-31T10:00:00.000Z");
|
||||
const detailsObj = {
|
||||
pinswg_specialistcaseprocess: 846040001,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: openDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: openDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: expiredDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: expiredDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: futureDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: futureDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
});
|
||||
|
||||
test("ROW hearing specialist process with missing dates is blocked in both consumers", () => {
|
||||
const FakeDate = createFakeDate("2026-04-15T10:00:00.000Z");
|
||||
|
||||
for (const detailsObj of [
|
||||
{
|
||||
pinswg_specialistcaseprocess: 846040001,
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
},
|
||||
{
|
||||
pinswg_specialistcaseprocess: 846040001,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z"
|
||||
},
|
||||
{
|
||||
pinswg_specialistcaseprocess: 846040001
|
||||
}
|
||||
]) {
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("ROW non-hearing specialist process values are allowed without date gating", () => {
|
||||
const FakeDate = createFakeDate("2026-05-01T10:00:00.000Z");
|
||||
|
||||
for (const specialistValue of [846040000, 846040002, 846040003]) {
|
||||
const detailsObj = {
|
||||
pinswg_specialistcaseprocess: specialistValue,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
}
|
||||
});
|
||||
|
||||
test("canonical and misspelled specialist process fields differ between consumers for ROW hearing", () => {
|
||||
const FakeDate = createFakeDate("2026-05-01T10:00:00.000Z");
|
||||
const misspelledOnly = {
|
||||
pinswg_speacialistcaseprocess: 846040001,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj: misspelledOnly,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true,
|
||||
"summary consumer falls through to non-hearing behaviour when only misspelled field exists"
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj: misspelledOnly,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
false,
|
||||
"search consumer applies hearing/date gating via normalizeSpecialistProcess fallback"
|
||||
);
|
||||
});
|
||||
|
||||
test("canonical specialist process field takes precedence when both specialist fields exist", () => {
|
||||
const FakeDate = createFakeDate("2026-05-01T10:00:00.000Z");
|
||||
const detailsObj = {
|
||||
pinswg_specialistcaseprocess: 846040000,
|
||||
pinswg_speacialistcaseprocess: 846040001,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(normalizeSpecialistProcess(detailsObj), 846040000);
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
});
|
||||
|
||||
test("ROW currently uses only pinswg_startdate and pinswg_finalcommentsduedate for date gating", () => {
|
||||
const FakeDate = createFakeDate("2026-04-15T10:00:00.000Z");
|
||||
const detailsObj = {
|
||||
pinswg_specialistcaseprocess: 846040001,
|
||||
pinswg_startdates: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_applicationacceptedasvalid: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_statementduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: 846040015,
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
false
|
||||
);
|
||||
});
|
||||
|
||||
test("ROW appeal type string form falls through to default allowed behaviour in both consumers", () => {
|
||||
const FakeDate = createFakeDate("2026-05-01T10:00:00.000Z");
|
||||
const detailsObj = {
|
||||
pinswg_specialistcaseprocess: 846040001,
|
||||
pinswg_startdate: "2026-04-01T00:00:00.000Z",
|
||||
pinswg_finalcommentsduedate: "2026-04-30T00:00:00.000Z"
|
||||
};
|
||||
|
||||
assert.strictEqual(
|
||||
evaluateSummaryRowRule({
|
||||
appealType: "846040015",
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
assert.strictEqual(
|
||||
evaluateSearchRowRule({
|
||||
appealType: "846040015",
|
||||
detailsObj,
|
||||
DateCtor: FakeDate
|
||||
}),
|
||||
true
|
||||
);
|
||||
});
|
||||
|
||||
const run = async () => {
|
||||
let passed = 0;
|
||||
|
||||
for (const currentTest of tests) {
|
||||
await currentTest.fn();
|
||||
passed += 1;
|
||||
}
|
||||
|
||||
console.log(
|
||||
`Phase 22 representation-row-entry-rule tests passed (${passed}/${tests.length}).`
|
||||
);
|
||||
};
|
||||
|
||||
module.exports = run;
|
||||
|
||||
if (require.main === module) {
|
||||
run().catch((error) => {
|
||||
console.error(error);
|
||||
process.exit(1);
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user