JACoB PR for Issue Add Build Status Tracking to Project Table

Summary:

Description

To enhance our build monitoring capabilities, we need to track the current build status, the timestamp of the last build, and any error messages generated during the build process. This will help in quickly identifying build issues and maintaining the reliability of our deployment pipeline.

Proposed Changes

Database Modifications:
- Add Columns to projects Table:
- build_status (Boolean): Indicates whether the latest build was successful (true) or failed (false).
- last_build_at (Timestamp): Records the date and time when the last build was executed.
- build_error (Text, nullable): Stores any error messages generated during the build process.
Migration:
- Create a new migration file following the existing naming convention:
- Format: YYYYMMDDHHMMSS_add_build_status_to_projects_table
- Example: 20241023000000_add_build_status_to_projects_table
- Ensure the migration script correctly adds the new columns with appropriate data types and default values where applicable.
- Reference existing migration files to maintain consistency with naming and structure.

Implementation Details

ORM: Utilize the Orchid ORM for database interactions. Refer to previous migration examples to ensure compatibility, especially since we are using an older version.
Database Consistency: Ensure that the new columns do not disrupt existing functionalities and that default values are set appropriately to prevent null-related issues.
Error Handling: Implement necessary checks to handle null or malformed error messages gracefully.

Steps to Implement

Review Existing Migrations:
- Examine other migration files to understand the naming conventions and structure.
- Pay special attention to the date and time format in migration filenames.
Create Migration File:
- Name the file following the 20241023000000_add_build_status_to_projects_table format.
- Add the new columns (build_status, last_build_at, build_error) to the projects table.
Update the ORM Models:
- Reflect the new columns in the Project model to enable ORM operations on these fields.

Expected Outcome

The projects table should have three new columns: build_status, last_build_at, and build_error.
The migration should be correctly named and follow the project's naming conventions.
The application should be able to store and retrieve build status information without issues.

Additional Information

Migration Naming Convention: Ensure the migration filename starts with a four-digit year, followed by a two-digit month and day, and a series of zeros (e.g., 20241023000000_add_build_status_to_projects_table).
ORM Version: Be aware that we are using an older version of Orchid ORM, so refer to existing migration examples instead of relying on the documentation or AI-generated specifications.

@jacob-ai-bot --skip-build

Plan:

Step 1: Create `/src/server/db/migrations/20241023000000_add_build_status_to_projects_table.ts`

Task: Create migration to add build status columns to projects table

Instructions: Create a new migration file named '20241023000000_add_build_status_to_projects_table.ts' in the directory '/src/server/db/migrations/'. In this migration file, use the 'change' function to add three new columns to the 'projects' table:

buildStatus: Add a nullable boolean column named 'buildStatus' to indicate whether the latest build was successful (true) or failed (false).
lastBuildAt: Add a nullable timestamp column named 'lastBuildAt' to record when the last build was executed.
buildError: Add a nullable text column named 'buildError' to store any error messages generated during the build process.

Reference existing migration files like '/src/server/db/migrations/20240828095935_add_settings_to_project.ts' to ensure consistency with the project's migration structure and syntax. Make sure to maintain the correct naming conventions and use the ORM methods appropriately.

Exit Criteria: The migration file is correctly named and located in '/src/server/db/migrations/'. It successfully adds the 'buildStatus', 'lastBuildAt', and 'buildError' columns to the 'projects' table with the appropriate data types and nullable settings. The migration runs without errors when applied to the database.

Step 2: Edit `/src/server/db/tables/projects.table.ts`

Task: Update ProjectsTable ORM model to include new build status columns

Instructions: Open the file '/src/server/db/tables/projects.table.ts'. In the ProjectsTable class, update the columns definition within the setColumns method to include the new columns added in the migration:

buildStatus: Define a nullable boolean column named 'buildStatus' using the ORM's column definition syntax.
lastBuildAt: Define a nullable timestamp column named 'lastBuildAt'. Ensure the timestamp is handled correctly according to the ORM and the database's expectations.
buildError: Define a nullable text column named 'buildError' to store build error messages.

Ensure that these new column definitions exactly match the columns added in the migration file. Review the ORM's documentation or existing model definitions to maintain consistency in syntax and style. Confirm that the additions do not introduce any TypeScript errors and that they align with the ORM version used in the project.

Exit Criteria: The 'ProjectsTable' class in '/src/server/db/tables/projects.table.ts' includes the 'buildStatus', 'lastBuildAt', and 'buildError' columns with definitions matching the migration. The ORM model functions correctly, and the project compiles without any TypeScript errors.

jacob-ai-bot / jacob