983f4f8e20
The Model backend reads several gov-EPC fields the calculator uses, but our Postgres schema had no column for them, so they were dropped on save. A dwelling reloaded from the DB lost them and was re-scored on pessimistic defaults -- worst cases -15.5 SAP. This is the FE half of Model #1665 and the deploy gate for the backend change. One migration, additive only: epc_property +1 col: heating_cylinder_heat_loss (double precision, null) epc_building_part +7 cols: alt_wall_{1,2}_{u_value, thickness_mm, is_basement} wall_u_value epc_roof_window (new) 0..n per epc_property epc_room_in_roof (new) 0..1 per epc_building_part epc_room_in_roof_surface (new) 0..n per epc_room_in_roof wall_u_value is the lodged gov-EPC wall U-value. #1661 dropped the lodged wall/roof/floor U-values as full-SAP artefacts because the re-model derived U-values from the construction-default cascade; #1665 reverses that for wall_u_value specifically -- the calculator now honours the lodged wall U over the derived default. Nullable: null means "not lodged → the calculator derives it". roof_u_value / floor_u_value stay unpersisted. Nullability is load-bearing, not incidental: - alt_wall_{1,2}_is_basement are nullable, NOT notNull().default(false). null "not stated" vs false "explicitly not a basement" are distinct; collapsing them re-enables the code-6 basement heuristic the flag defeats. - room_in_roof_surface.insulation_thickness_mm nullable -- null vs 0 is the U-value branch (Table 17 vs default). - room_in_roof_surface.u_value nullable -- assessor override, null != 0. - room_in_roof_surface.area_m2 has no CHECK >= 0: it can be negative (signed RdSAP 3.9.2 adjustment). - surface.kind is TEXT, not a pg enum -- the value set has grown twice. Child FKs use no explicit onDelete, matching every existing EPC child table (epc_photovoltaic_array, epc_window, epc_floor_dimension, …): the Python backend owns these tables and rewrites children by delete-and-reinsert on re-ingest; the app-side deleteProperty path does not touch epc_property or its children. Supersession without a drop: epc_room_in_roof supersedes the inlined epc_building_part.room_in_roof_floor_area / room_in_roof_construction_age_band, but those are left in place. They are dropped in a follow-up migration after the backend deploys and the round-trip is verified -- dropping them here would make the deploy non-reversible. Deploy ordering: this migration must be applied to every environment BEFORE the backend deploys. The backend SELECTs these columns explicitly, so if code ships first every EPC read raises UndefinedColumn/UndefinedTable -- a hard failure on all property loads. And because the columns never existed, existing rows have nothing to restore: affected properties (~11% with a room-in-roof, plus the roof-window / cylinder / alt-wall / wall-U cohorts) must be re-ingested from the gov-EPC API before their scores move. Refs Hestia-Homes/Model#1665 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> |
||
|---|---|---|
| .agents | ||
| .claude | ||
| .devcontainer | ||
| .github/workflows | ||
| .impeccable/critique | ||
| .vscode | ||
| backlog | ||
| cypress | ||
| docs | ||
| drizzle/meta | ||
| public | ||
| src | ||
| vitest | ||
| .db-env | ||
| .eslintrc.json | ||
| .gitignore | ||
| CLAUDE.md | ||
| components.json | ||
| CONTEXT.md | ||
| cypress.config.ts | ||
| devcontainer.sh | ||
| drizzle.config.ts | ||
| generate_migration.sh | ||
| migrate_to_db.sh | ||
| next.config.js | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| PRODUCT.md | ||
| README.md | ||
| run_build.sh | ||
| run_local.sh | ||
| skills-lock.json | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| vitest.config.ts | ||
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:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
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:
- Run
npm run test:e2e:open
Which will open Crypress test runner
- 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.