feat: add DB models to support build task feature (#4184)

api/models/build-task-type.js

@@ -0,0 +1,33 @@
+const associate = ({
+  BuildTaskType,
+  BuildTask,
+}) => {
+  // Associations
+  BuildTaskType.hasMany(BuildTask, {
+    foreignKey: 'buildTaskTypeId',
+  });
+};
+
+module.exports = (sequelize, DataTypes) => {
+  const BuildTaskType = sequelize.define(
+    'BuildTaskType',
+    {
+      name: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      description: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      metadata: {
+        type: DataTypes.JSON,
+      },
+    }, {
+      tableName: 'build_task_type',
+    }
+  );
+
+  BuildTaskType.associate = associate;
+  return BuildTaskType;
+};

api/models/build-task.js

@@ -0,0 +1,56 @@
+const { buildEnum } = require('../utils');
+
+const Statuses = buildEnum([
+  'created',
+  'queued',
+  'tasked',
+  'error',
+  'processing',
+  'skipped', // remove?
+  'success',
+]);
+
+const associate = ({ BuildTask, Build }) => {
+  BuildTask.belongsTo(Build, {
+    foreignKey: 'buildId',
+    allowNull: false,
+  });
+};
+
+module.exports = (sequelize, DataTypes) => {
+  const BuildTask = sequelize.define(
+    'BuildTask',
+    {
+      name: {
+        type: DataTypes.STRING,
+        allowNull: false,
+      },
+      artifact: {
+        type: DataTypes.STRING,
+      },
+      status: {
+        type: DataTypes.ENUM,
+        values: Statuses.values,
+        defaultValue: Statuses.Created,
+        allowNull: false,
+        validate: {
+          isIn: [Statuses.values],
+        },
+      },
+    }, {
+      tableName: 'build_task',
+      paranoid: true,
+      indexes: [
+        {
+          name: 'build_task_build_id_type_index',
+          unique: true,
+          fields: ['buildId'],
+        },
+      ],
+    }
+  );
+
+  BuildTask.associate = associate;
+
+  return BuildTask;
+};

api/models/build.js

@@ -20,6 +20,7 @@ const States = buildEnum([
 const associate = ({
   Build,
   BuildLog,
+  BuildTask,
   Organization,
   Site,
   User,
@@ -37,6 +38,9 @@ const associate = ({
     foreignKey: 'user',
     allowNull: false,
   });
+  Build.hasMany(BuildTask, {
+    foreignKey: 'buildId',
+  });
 
   // Scopes
   Build.addScope('byOrg', id => ({

api/models/index.js

@@ -17,6 +17,8 @@ const sequelize = new Sequelize(database, username, password, {
 
 require('./build')(sequelize, DataTypes);
 require('./build-log')(sequelize, DataTypes);
+require('./build-task-type')(sequelize, DataTypes);
+require('./build-task')(sequelize, DataTypes);
 require('./site')(sequelize, DataTypes);
 require('./site-branch-config')(sequelize, DataTypes);
 require('./site-user')(sequelize, DataTypes);

migrations/20230829172947-build-tasks.js

@@ -0,0 +1,60 @@
+
+const TYPE_TABLE_NAME = "build_task_type";
+const TYPE_TABLE_SCHEMA = {
+  id: { type: "int", primaryKey: true, autoIncrement: true },
+  name: { type: "string", notNull: true },
+  description: { type: "string", notNull: true },
+  metadata: { type: "jsonb", allowNull: true },
+  createdAt: { type: "timestamp", notNull: true },
+  updatedAt: { type: "timestamp", notNull: true },
+};
+
+const TABLE_NAME = "build_task";
+const TABLE_INDEX_NAME = "build_task_build_id_type_index";
+const TABLE_SCHEMA = {
+  id: { type: "int", primaryKey: true, autoIncrement: true },
+  buildId: {
+    type: "int",
+    notNull: true,
+    foreignKey: {
+      name: "build_task_build_id_fk",
+      table: "build",
+      rules: {
+        onDelete: "CASCADE",
+        onUpdate: "RESTRICT"
+      },
+      mapping: "id"
+    }
+  },
+  buildTaskTypeId: {
+    type: "int",
+    notNull: true,
+    foreignKey: {
+      name: "build_task_build_task_type_id_fk",
+      table: "build_task_type",
+      rules: {
+        onDelete: "CASCADE",
+        onUpdate: "RESTRICT"
+      },
+      mapping: "id"
+    }
+  },
+  name: { type: "string", notNull: true },
+  status: { type: "string", notNull: true, default: "created" },
+  artifact: { type: "string", allowNull: true },
+  createdAt: { type: "timestamp", notNull: true },
+  updatedAt: { type: "timestamp", notNull: true },
+  deletedAt: { type: "timestamp", allowNull: true },
+};
+
+exports.up = async (db) => {
+  await db.createTable(TYPE_TABLE_NAME, TYPE_TABLE_SCHEMA);
+  await db.createTable(TABLE_NAME, TABLE_SCHEMA)
+  await db.addIndex(TABLE_NAME, TABLE_INDEX_NAME, ["buildId", "buildTaskTypeId"], true);
+};
+
+exports.down = async (db) => {
+  await db.dropTable(TABLE_NAME);
+  return db.dropTable(TYPE_TABLE_NAME);
+};
+

scripts/create-dev-data.js

@@ -8,6 +8,8 @@ const cleanDatabase = require('../api/utils/cleanDatabase');
 const {
   ActionType,
   Build,
+  BuildTaskType,
+  BuildTask,
   BuildLog,
   Domain,
   Event,
@@ -434,6 +436,20 @@ async function createData() {
     })),
   ]);
 
+  const taskType = await BuildTaskType.create({
+    name: 'test',
+    description: 'test description',
+    metadata: {
+      foo: 'bar',
+    },
+  });
+  await BuildTask.create({
+    buildId: nodeSiteBuilds[0].id,
+    buildTaskTypeId: taskType.id,
+    name: 'type',
+    status: 'processing',
+  });
+
   const goSiteBuilds = await Promise.all([
     Build.create({
       branch: goSite.defaultBranch,

test/api/unit/services/NightlyBuildsHelper.test.js

@@ -20,7 +20,7 @@ describe('NightlyBuildsHelper', () => {
 
   beforeEach(async () => {
     await Promise.all([
-      Build.truncate(),
+      Build.truncate({ force: true, cascade: true }),
       Site.truncate(),
       SiteBranchConfig.truncate(),
     ]);
@@ -29,7 +29,7 @@ describe('NightlyBuildsHelper', () => {
   afterEach(async () => {
     sinon.restore();
     await Promise.all([
-      Build.truncate(),
+      Build.truncate({ force: true, cascade: true }),
       Site.truncate(),
       SiteBranchConfig.truncate(),
     ]);