Repository for the assessment model application
Find a file
Jun-te Kim 0933f05173 fix(reporting): EPC cards count certificates, not predictions (ADR-0014)
"Homes Without an EPC" and "Expired EPCs" were both derived from estimatedSql,
which asks "was this picture gap-filled?". That conflates two different questions:
provenance (was it modelled?) and coverage (does a certificate exist?).

They used to agree, because a gap-fill implied no certificate. Model ADR-0054 ends
that: the gov EPC API only serves certs registered since 2012, so a pre-2012
dwelling is gap-filled even though a real, stale certificate exists — and gets the
new source='expired'. On portfolio 824, 375 of the 403 "without an EPC" homes have
exactly that: a real certificate, just an out-of-date one. A different, and far more
actionable, problem than never having been certified.

Two defects fell out of the same conflation:

  - Every query matched source='predicted' literally, and `source` is plain text
    with no enum or CHECK. An 'expired' row matches neither the lodged nor the
    predicted alias, so the home would have read as having a VALID CURRENT cert —
    silently gone from both cards, no Estimated badge, nothing to catch it.
  - isExpiredSql read epl.registration_date alone, but 714 of 824's 4,873 lodged
    certs carry only inspection_date. All 714 counted as current; 170 are in fact
    >10 years old. lodgementDateSql already coalesced the two; expiry didn't.

The cards now partition on coverage: withoutEpcSql = no lodged AND no historical
record; isExpiredSql = a cert of either kind, out of date. estimatedSql keeps its
own meaning and spans the whole predicted slot, so an expired home is estimated AND
has an EPC — both true. The `AND estimated = false` guard is gone from the Expired
card: an expired home IS estimated, so it excluded the very homes being counted.

Legacy portfolios are untouched (632: 8/1662 before and after). 824 moves to
913 → 1,083 expired immediately (the inspection_date fix), then to 25 / 1,461 once
Model writes expired rows. Safe to deploy BEFORE Model — the predicates just find
none. The reverse was not safe, which is why this goes first.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-14 12:19:02 +00:00
.claude settings .local.json updated 2026-06-08 12:01:13 +00:00
.devcontainer docs(design): home-page redesign context — Stitch refs, PRODUCT.md, impeccable trial 2026-07-07 15:12:07 +00:00
.github/workflows updating CI 2026-05-05 19:36:33 +00:00
.impeccable/critique feat(portfolio): address impeccable critique — no-plans state, contrast, focus 2026-07-13 21:50:27 +00:00
.vscode added db filtereing 2026-01-05 17:30:58 +00:00
backlog update instruction doc and context 2026-06-03 10:33:52 +00:00
cypress updated PIBI ui 2026-05-07 11:26:22 +00:00
docs fix(reporting): EPC cards count certificates, not predictions (ADR-0014) 2026-07-14 12:19:02 +00:00
drizzle/meta Got drizzle orm working 2023-07-10 17:48:37 +01:00
public added robots and security txt files 2026-03-10 18:56:53 +00:00
src fix(reporting): EPC cards count certificates, not predictions (ADR-0014) 2026-07-14 12:19:02 +00:00
.db-env added files for reports 2025-10-30 17:15:30 +00:00
.eslintrc.json Initial commit from Create Next App 2023-05-25 06:07:00 +01:00
.gitignore refactor(tags): one calm, AA-safe chip vocabulary across every surface 2026-07-13 19:09:27 +00:00
CLAUDE.md updated claude.md 2026-05-06 16:11:00 +00:00
components.json Added layout of toolbar n portfolio page 2023-07-12 15:41:58 +01:00
CONTEXT.md fix(reporting): EPC cards count certificates, not predictions (ADR-0014) 2026-07-14 12:19:02 +00:00
cypress.config.ts Creating automated testing - blocked until we have a test account 2023-07-11 12:14:48 +01:00
devcontainer.sh pr for claude skills 2026-05-05 19:53:21 +00:00
drizzle.config.ts Added indexing for plans and plan recommendations 2026-01-05 13:34:43 +00:00
generate_migration.sh added migration scripts and ability to add a deal in hubspot@ 2025-10-22 15:44:00 +00:00
migrate_to_db.sh new migration files 2026-06-03 12:55:49 +00:00
next.config.js revamping the plan page 2026-04-10 21:54:26 +00:00
package-lock.json Surface coordinator damp & mould commentary in the risk drill-down 2026-05-28 14:58:23 +00:00
package.json perf(backfill): faster, resumable recommendation denormalization + ops tooling 2026-07-02 10:00:46 +00:00
postcss.config.js Initial commit from Create Next App 2023-05-25 06:07:00 +01:00
PRODUCT.md docs(design): home-page redesign context — Stitch refs, PRODUCT.md, impeccable trial 2026-07-07 15:12:07 +00:00
README.md deploy? 2026-05-28 13:52:01 +00:00
run_build.sh addded changes to let build work 2025-08-21 11:30:51 +00:00
run_local.sh automated script that ran for next 15 2025-07-22 10:50:50 +00:00
skills-lock.json Updated survey request UI for Devon County Council 2026-05-06 20:37:30 +00:00
tailwind.config.js re-vamping ara ui 2026-04-08 10:29:14 +00:00
tsconfig.json minor visual tweaks 2026-04-10 22:49:00 +00:00
vitest.config.ts fixing multi company bug 2026-05-07 20:08:04 +00:00

This is a Next.js project bootstrapped with create-next-app.

Getting Started

When first getting set up you'll firstly want to install the existing dependencies. To do this, simply run

npm install
# or
yarn install

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

We currently have a development version, found at https://assessment-model-dev.vercel.app, and a production version at https://assessment-model.vercel.app, however the production version is missing a significant number of environmental variables, which will need to be added.

Drizzle ORM

We're using Drizzle ORM to interface with our AWS Postgres database. Documentation on getting set up can be found here

Schemas

In order to get started with Drizzle, a schema needs to be created. Schemas can be added src/app/db/schema as typescript files. See the documentation on how to set up schemas but effectively, Drizzle allows you to define schemas as typescript code, which allows for simple, type safe schema definitions.

Creating Migrations

To create a migration, a command has been set up in package.json. Simply run

npm run migration:generate

Or with yarn/pnmp accordingly.

Note, there seems to be a bug with Drizzle which is documented here.

The workaround is to open up tsconfig.json and comment out "target": "es5", and replace it with "target": "ESNext". This should hopefully only be a temporary workaround required.

Pushing migrations

To push migrations, another command has been set up in package.json, since drizzle-kit currently does not support pushing for Postgres out of the box.

Run

npm run migration:push

Which will commit changes to the database. The database changes will be pushed to the public schema, whereas a meta record will be pushed to the __drizzle_migrations schema.

Inserting users into the database

In order to insert a user into the database, simply run

npm run create_users -- {email} {firstName}

Since we're using just the built in process arguments to read command line arguments, the ordering of arguments needs to be email address and then name

Cypress Testing Documentation

This document provides an overview of how to perform end-to-end testing using Cypress for the login functionality of the application. The testing code is based on the provided code snippets.

Prerequisites

Node.js installed on your machine Cypress installed as a dev dependency in your project

Test Execution

To execute the login tests, follow these steps:

  1. Run
npm run test:e2e:open

Which will open Crypress test runner

  1. Select the tests that you want to run. At the time of writing, only login tests have been completed

Key files

The key files that are at play for testing are documented here. Because of some issues testing next-auth and setting cookies, a custom command to set the JWT, and avoid the functionality defined in the signIn function as defined in src/app/api/auth/[...nextauth]/route.ts

cypress/plugins/index.js is a standard file, required by cypress to journey through the Google Oauth flow

cypress/figtures/session.json is a user fixture that is used to log in a user in the login tests

cypress/support/commands.ts creates a custom login user command which sets a JWT and allows us to actually authenticate. cy.intercept only mocks the client side behaviour of the apis and therefore does not set any cookies, do this function does this manually.

Generating pre-signed urls

In our terraform stack, we have a module called s3_presignable_bucket which contains the definition for our bucket which we will use to store retrofit plan input csv's in.

We will generate a pre-signed url and then make a post request to that endpoint to store that data to s3. Part of that process is the creation of an AWS IAM role which contains the permission set to access the bucket, rerofit-plan-inputs-<stage>. The name of this IAM role is s3_presign_role_<stage> and for our NextJS application, as it's hosted outside of AWS (for the moment), we need to generate a set of access credentials to give the application access to this bucket. The access key and secret key are automatically generated and stored in AWS secrets manager under dev/presign_frontend/access_key and dev/presign_frontend/secret_key and need to be set in the environment for the pre-sign api to store csv data to aws.