chore: e2e add supplementary obligation decrease

Author: shon-button

bciers/apps/compliance-e2e/poms/compliance-setup.ts

@@ -1,6 +1,8 @@
 import { Page } from "@playwright/test";
 import { pool } from "@bciers/e2e/utils/pool";
 
+export type InvoiceGenerationGateState = "open" | "closed";
+
 export class ComplianceSetupPOM {
   readonly page: Page;
 
@@ -9,16 +11,17 @@ export class ComplianceSetupPOM {
   }
 
   /**
-   * Force invoice_generation_date to be:
-   *  - yesterday  → integration allowed
-   *  - far future → integration blocked
+   * Prime the invoice-generation gate by setting invoice_generation_date to be:
+   *  - "open"   → yesterday  → integration allowed
+   *  - "closed" → far future → integration blocked
    */
-  async openInvoiceGenerationDate(isReached: boolean) {
+  async primeInvoiceGenerationGate(state: InvoiceGenerationGateState) {
     const reportingYear = new Date().getFullYear() - 1;
 
-    const invoiceGenerationDate = isReached
-      ? new Date(Date.now() - 24 * 60 * 60 * 1000) // yesterday => reached
-      : new Date(Date.now() + 50 * 365 * 24 * 60 * 60 * 1000); // far future => not reached
+    const invoiceGenerationDate =
+      state === "open"
+        ? new Date(Date.now() - 24 * 60 * 60 * 1000) // yesterday => reached
+        : new Date(Date.now() + 50 * 365 * 24 * 60 * 60 * 1000); // far future => not reached
 
     const res = await pool.query({
       text: `
@@ -34,7 +37,7 @@ export class ComplianceSetupPOM {
 
     if (res.rowCount !== 1) {
       throw new Error(
-        `openInvoiceGenerationDate: expected 1 row for reporting_year=${reportingYear}, got ${res.rowCount}`,
+        `primeInvoiceGenerationGate: expected 1 row for reporting_year=${reportingYear}, got ${res.rowCount}`,
       );
     }
 

bciers/apps/compliance-e2e/poms/compliance-summaries.ts

@@ -216,6 +216,24 @@ export class ComplianceSummariesPOM {
     return text;
   }
 
+  async assertRowCountForOperation(options: {
+    operationName: string;
+    expectedCount: number;
+  }) {
+    const { operationName, expectedCount } = options;
+
+    await this.waitForGridReady({ timeout: 30_000 });
+
+    await expect(async () => {
+      const rows = this.grid()
+        .getByRole("row")
+        .filter({ hasText: operationName });
+
+      const count = await rows.count();
+      expect(count).toBe(expectedCount);
+    }).toPass({ timeout: 30_000 });
+  }
+
   async assertStatusForOperation(
     operationName: string,
     expectedStatus: string,

bciers/apps/compliance-e2e/poms/manage-obligation/review-compliance-obligation.ts

@@ -0,0 +1,58 @@
+import { Locator, Page, expect } from "@playwright/test";
+import {
+  COMPLIANCE_INVOICE_API_BASE,
+  ComplianceInvoiceType,
+  GENERATE_INVOICE_BUTTON_TEXT,
+} from "@/compliance-e2e/utils/constants";
+
+export class ReviewComplianceObligationPOM {
+  private readonly page: Page;
+  private readonly invoiceButton: Locator;
+
+  constructor(page: Page) {
+    this.page = page;
+    this.invoiceButton = this.page.getByRole("button", {
+      name: GENERATE_INVOICE_BUTTON_TEXT,
+      exact: true,
+    });
+  }
+
+  /**
+   * Clicks "Generate Invoice" and returns the PDF buffer.
+   * Throws if the response is JSON (error path) or not OK.
+   */
+
+  async generateInvoiceAndGetPdfBuffer(
+    complianceReportVersionId: number | string,
+    type: ComplianceInvoiceType,
+  ): Promise<Buffer> {
+    const id = String(complianceReportVersionId).trim();
+    const invoiceUrl = new RegExp(
+      `${COMPLIANCE_INVOICE_API_BASE}/${id}/${type}(\\?|$)`,
+    );
+    const [response] = await Promise.all([
+      this.page.waitForResponse((r) => invoiceUrl.test(r.url()), {
+        timeout: 60_000,
+      }),
+      this.clickGenerateInvoice(),
+    ]);
+
+    const contentType = response.headers()["content-type"] ?? "";
+
+    expect(response.ok()).toBe(true);
+    expect(contentType).not.toMatch(/application\/json/i);
+    expect(contentType).toMatch(/application\/pdf|application\/octet-stream/i);
+
+    return Buffer.from(await response.body());
+  }
+
+  private async clickGenerateInvoice(): Promise<void> {
+    await expect(this.invoiceButton).toBeVisible({ timeout: 30_000 });
+    await expect(this.invoiceButton).toBeEnabled({ timeout: 30_000 });
+    await this.invoiceButton.click();
+  }
+
+  private escapeRegex(value: string): string {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  }
+}

bciers/apps/compliance-e2e/tests/workflows/manage-obligation/report-compliance-obligation.spec.ts

@@ -0,0 +1,104 @@
+import { setupBeforeEachTest } from "@bciers/e2e/setupBeforeEach";
+import { UserRole } from "@bciers/e2e/utils/enums";
+import {
+  ComplianceOperations,
+  ComplianceDisplayStatus,
+  GridActionText,
+} from "@/compliance-e2e/utils/enums";
+import { REVIEW_OBLIGATION_URL_PATTERN } from "@/compliance-e2e/utils/constants";
+
+import { CurrentReportsPOM } from "@/reporting-e2e/poms/current-reports";
+import { ComplianceSummariesPOM } from "@/compliance-e2e/poms/compliance-summaries";
+import { ManageObligationTaskListPOM } from "@/compliance-e2e/poms/manage-obligation/tasklist";
+import { PaymentInstructionsPOM } from "@/compliance-e2e/poms/manage-obligation/payment-instructions";
+
+import { ComplianceSetupPOM } from "@/compliance-e2e/poms/compliance-setup";
+import { takeStabilizedScreenshot } from "@bciers/e2e/utils/helpers";
+
+// 👤 run test using the storageState for role UserRole.INDUSTRY_USER_ADMIN
+const test = setupBeforeEachTest(UserRole.INDUSTRY_USER_ADMIN);
+
+test.describe.configure({ mode: "serial" });
+
+test.describe("Test compliance report version manage obligation flow", () => {
+  test("when invoice_generation_date is reached, compliance report version status is OBLIGATION_NOT_MET", async ({
+    page,
+    request,
+    happoScreenshot,
+  }) => {
+    // PRECONDITIONS:
+    // Prime invoice_generation_date DB state so integration is allowed
+    const complianceSetupPOM = new ComplianceSetupPOM(page);
+    await complianceSetupPOM.primeInvoiceGenerationGate("open");
+
+    // Submit obligation report
+    const reports = new CurrentReportsPOM(page);
+    await reports.submitReportObligation(false, request);
+
+    // Navigate to the compliance summaries grid
+    const summaries = new ComplianceSummariesPOM(page);
+    await summaries.route();
+
+    // Assert the gate open for invoice integration
+    await summaries.assertStatusForOperation(
+      ComplianceOperations.OBLIGATION_NOT_MET,
+      ComplianceDisplayStatus.OBLIGATION_NOT_MET,
+    );
+
+    // happo screenshot
+    await takeStabilizedScreenshot(happoScreenshot, page, {
+      component: "Compliance obligation not met",
+      variant: "status: Obligation - not met",
+    });
+
+    // Assert the record has an invoice number related to this obligation
+    await summaries.openActionForOperation({
+      operationName: ComplianceOperations.OBLIGATION_NOT_MET,
+      linkName: GridActionText.MANAGE_OBLIGATION,
+      urlPattern: REVIEW_OBLIGATION_URL_PATTERN,
+    });
+
+    const manageObligationTaskList = new ManageObligationTaskListPOM(page);
+    await manageObligationTaskList.clickDownloadPaymentInstructions();
+
+    const paymentInstructions = new PaymentInstructionsPOM(page);
+    await paymentInstructions.assertHasInvoiceNumber();
+
+    // happo screenshot
+    await takeStabilizedScreenshot(happoScreenshot, page, {
+      component: "Compliance obligation not met",
+      variant: "payment instructions invoice number",
+    });
+  });
+
+  test("when invoice_generation_date is NOT reached, compliance report version status is PENDING_INVOICE_CREATION", async ({
+    page,
+    request,
+    happoScreenshot,
+  }) => {
+    // PRECONDITIONS:
+    // Prime invoice_generation_date DB state so integration is blocked
+    const complianceSetupPOM = new ComplianceSetupPOM(page);
+    await complianceSetupPOM.primeInvoiceGenerationGate("closed");
+
+    // Submit obligation report
+    const reports = new CurrentReportsPOM(page);
+    await reports.submitReportObligation(false, request);
+
+    // Navigate to the compliance summaries grid
+    const summaries = new ComplianceSummariesPOM(page);
+    await summaries.route();
+
+    // Assert the gate blocked invoice integration
+    await summaries.assertStatusForOperation(
+      ComplianceOperations.OBLIGATION_NOT_MET,
+      ComplianceDisplayStatus.PENDING_INVOICE_CREATION,
+    );
+
+    // happo screenshot
+    await takeStabilizedScreenshot(happoScreenshot, page, {
+      component: "Compliance obligation not met",
+      variant: "status: Obligation - pending invoice creation",
+    });
+  });
+});

bciers/apps/compliance-e2e/tests/workflows/manage-obligation/report-compliance/obligation.spec.ts

@@ -0,0 +1,90 @@
+import { setupBeforeEachTest } from "@bciers/e2e/setupBeforeEach";
+import { UserRole } from "@bciers/e2e/utils/enums";
+import {
+  ComplianceOperations,
+  ComplianceDisplayStatus,
+  GridActionText,
+} from "@/compliance-e2e/utils/enums";
+import { CurrentReportsPOM } from "@/reporting-e2e/poms/current-reports";
+import { ComplianceSummariesPOM } from "@/compliance-e2e/poms/compliance-summaries";
+import { ComplianceSetupPOM } from "@/compliance-e2e/poms/compliance-setup";
+import { ReportSetUpPOM } from "@/reporting-e2e/poms/report-setup";
+import { REVIEW_OBLIGATION_URL_PATTERN } from "@/compliance-e2e/utils/constants";
+
+// 👤 run test using the storageState for role UserRole.INDUSTRY_USER_ADMIN
+const test = setupBeforeEachTest(UserRole.INDUSTRY_USER_ADMIN);
+
+test.describe.configure({ mode: "serial" });
+test.describe("Test supplementary compliance report version flow", () => {
+  test("submitting a supplementary obligation decrease does not create a new version and does not void the invoice", async ({
+    page,
+    request,
+  }) => {
+    test.slow();
+
+    // Preconditions
+    const complianceSetupPOM = new ComplianceSetupPOM(page);
+    await complianceSetupPOM.primeInvoiceGenerationGate("open");
+
+    const reportSetUpPOM = new ReportSetUpPOM(page);
+    await reportSetUpPOM.primeReportingYear("open");
+
+    // Submit obligation
+    const gridReportingReports = new CurrentReportsPOM(page);
+    await gridReportingReports.submitReportObligation(false, request);
+
+    // Assert versions in summaries grid
+    const gridComplianceSummaries = new ComplianceSummariesPOM(page);
+    await gridComplianceSummaries.route();
+
+    await gridComplianceSummaries.assertRowCountForOperation({
+      operationName: ComplianceOperations.OBLIGATION_NOT_MET,
+      expectedCount: 1,
+    });
+
+    // Assert BEFORE generate invoice
+    // Open summary and generate invoice
+    await gridComplianceSummaries.openActionForOperation({
+      operationName: ComplianceOperations.OBLIGATION_NOT_MET,
+      linkName: GridActionText.MANAGE_OBLIGATION,
+      urlPattern: REVIEW_OBLIGATION_URL_PATTERN,
+    });
+    // const reviewObligationPOM = new ReviewComplianceObligationPOM(page);
+    // Capture invoice pdf as buffer
+    // const pdfBuffer = await reviewObligationPOM.generateInvoiceAndGetPdfBuffer(
+    //   2,
+    //   "obligation",
+    // );
+    // // create invoice object from buffer
+    // const invoice = await ObligationInvoicePOM.fromBuffer(pdfBuffer);
+
+    // invoice
+    //   .assertHasInvoiceNumber()
+    //   .assertHasFeesAndAdjustments()
+    //   .assertHasAdjustmentLine()
+    //   .assertNotVoid();
+
+    // Submit supplementary decrease
+    await gridReportingReports.route();
+    await gridReportingReports.supplementaryReportObligationDecrease(request);
+
+    // Assert versions in summaries grid
+    await gridComplianceSummaries.route();
+    await gridComplianceSummaries.assertRowCountForOperation({
+      operationName: ComplianceOperations.OBLIGATION_NOT_MET,
+      expectedCount: 1,
+    });
+
+    await gridComplianceSummaries.assertStatusForOperation(
+      ComplianceOperations.OBLIGATION_NOT_MET,
+      ComplianceDisplayStatus.OBLIGATION_NOT_MET,
+    );
+
+    // Assert AFTER generate invoice
+    await gridComplianceSummaries.openActionForOperation({
+      operationName: ComplianceOperations.OBLIGATION_NOT_MET,
+      linkName: GridActionText.MANAGE_OBLIGATION,
+      urlPattern: REVIEW_OBLIGATION_URL_PATTERN,
+    });
+  });
+});