screwdriver-data-schema 25.4.0 → 25.5.0

package/migrations/20250425162418-add-status-to-event.js

@@ -0,0 +1,31 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}events`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.addColumn(
+                table,
+                'status',
+                {
+                    type: Sequelize.STRING(10),
+                    defaultValue: 'UNKNOWN',
+                    allowNull: false
+                },
+                { transaction }
+            );
+
+            await queryInterface.removeIndex(table, `${table}_create_time_pipeline_id`, { transaction });
+
+            await queryInterface.addIndex(table, {
+                name: `${table}_create_time_pipeline_id_status`,
+                fields: ['createTime', 'pipelineId', 'status'],
+                transaction
+            });
+        });
+    }
+};

package/models/event.js

@@ -11,6 +11,14 @@ const parentBuilds = require('./build').get.extract('parentBuilds');
 const buildId = require('./build').get.extract('id');
 const prNum = Scm.hook.extract('prNum');
 const { QUALIFIED_STAGE_NAME } = require('../config/regex');
+const STATUSES = [
+    'UNKNOWN',
+    'ABORTED', // when one or more builds associated with the event is aborted
+    'CREATED', // when the event is created but none of the builds are created
+    'FAILURE',
+    'IN_PROGRESS', // when one or more incomplete (being executed or awaiting execution) builds exists
+    'SUCCESS'
+];
 
 const MODEL = {
     id: Joi.number().integer().positive().description('Identifier of this event').example(123345),
@@ -62,7 +70,14 @@ const MODEL = {
     }),
     pr: Scm.pr.description('Pull request object that holds information about the pull request'),
     prNum: prNum.description('Pull request number if it is a PR event'),
-    baseBranch: Joi.string().description('build base branch').example('develop')
+    baseBranch: Joi.string().description('build base branch').example('develop'),
+    status: Joi.string()
+        .valid(...STATUSES)
+        .max(10)
+        .description('Current status of the event')
+        .example('SUCCESS')
+        .default('UNKNOWN')
+        .required()
 };
 
 const CREATE_MODEL = { ...MODEL, buildId, parentBuildId, parentBuilds, prNum };
@@ -83,6 +98,14 @@ module.exports = {
      */
     base: Joi.object(MODEL).label('Event'),
 
+    /**
+     * All the available statuses of Build
+     *
+     * @property statuses
+     * @type {Array}
+     */
+    allStatuses: STATUSES,
+
     /**
      * All the available properties of Event
      *
@@ -100,7 +123,7 @@ module.exports = {
     get: Joi.object(
         mutate(
             MODEL,
-            ['id', 'commit', 'createTime', 'creator', 'pipelineId', 'sha', 'type'],
+            ['id', 'commit', 'createTime', 'creator', 'pipelineId', 'sha', 'type', 'status'],
             [
                 'causeMessage',
                 'meta',
@@ -177,7 +200,7 @@ module.exports = {
      * @type {Array}
      */
     indexes: [
-        { fields: ['createTime', 'pipelineId'] },
+        { fields: ['createTime', 'pipelineId', 'status'] },
         { fields: ['pipelineId'] },
         { fields: ['type'] },
         { fields: ['groupEventId'] },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "25.4.0",
+  "version": "25.5.0",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {