screwdriver-data-schema 24.0.2 → 24.1.0

package/migrations/20241014165446-add-status-message-type-to-build.js

@@ -0,0 +1,21 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}builds`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.addColumn(
+                table,
+                'statusMessageType',
+                {
+                    type: Sequelize.STRING(10)
+                },
+                { transaction }
+            );
+        });
+    }
+};

package/models/build.js

@@ -22,6 +22,7 @@ const STATUSES = [
     'COLLAPSED', // when the build is collapsed
     'FROZEN' // when the build is frozen due to freeze window
 ];
+const STATUS_MESSAGE_TYPES = ['ERROR', 'WARN', 'INFO'];
 
 const MODEL = {
     id: Joi.number().integer().positive().description('Identifier of this build').example(123345),
@@ -85,6 +86,12 @@ const MODEL = {
         .description('Status message to describe status of the build')
         .example('Build failed due to infrastructure error'),
 
+    statusMessageType: Joi.string()
+        .valid(...STATUS_MESSAGE_TYPES)
+        .max(10)
+        .description('Severity of the status message')
+        .example('WARN'),
+
     stats: Joi.object()
         .keys({
             queueEnterTime: Joi.string().isoDate().description('When this build enters queue'),
@@ -158,6 +165,7 @@ module.exports = {
                 'eventId',
                 'environment',
                 'statusMessage',
+                'statusMessageType',
                 'stats',
                 'buildClusterName',
                 'templateId',
@@ -172,7 +180,9 @@ module.exports = {
      * @property update
      * @type {Joi}
      */
-    update: Joi.object(mutate(MODEL, [], ['status', 'meta', 'statusMessage', 'stats'])).label('Update Build'),
+    update: Joi.object(mutate(MODEL, [], ['status', 'meta', 'statusMessage', 'statusMessageType', 'stats'])).label(
+        'Update Build'
+    ),
 
     /**
      * Properties for Build that will be passed during a CREATE request
@@ -223,6 +233,14 @@ module.exports = {
      */
     allKeys: Object.keys(MODEL),
 
+    /**
+     * All the available status message type
+     *
+     * @property allStatusMessageTypes
+     * @type {Array}
+     */
+    allStatusMessageTypes: STATUS_MESSAGE_TYPES,
+
     /**
      * Tablename to be used in the datastore
      *

package/package.json

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