screwdriver-data-schema 24.0.2 → 24.2.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/migrations/20250113235218-add-scope-and-scopeId-to-banner.js

@@ -0,0 +1,36 @@
+/* eslint-disable new-cap */
+
+'use strict';
+
+const prefix = process.env.DATASTORE_SEQUELIZE_PREFIX || '';
+const table = `${prefix}banners`;
+
+module.exports = {
+    up: async (queryInterface, Sequelize) => {
+        await queryInterface.sequelize.transaction(async transaction => {
+            await queryInterface.addColumn(
+                table,
+                'scope',
+                {
+                    type: Sequelize.STRING(15),
+                    defaultValue: 'GLOBAL',
+                    allowNull: false
+                },
+                { transaction }
+            );
+            await queryInterface.addColumn(
+                table,
+                'scopeId',
+                {
+                    type: Sequelize.INTEGER.UNSIGNED
+                },
+                { transaction }
+            );
+            await queryInterface.addIndex(table, {
+                name: `${table}_scope_and_scopeId`,
+                fields: ['scope', 'scopeId'],
+                transaction
+            });
+        });
+    }
+};

package/models/banner.js

@@ -3,6 +3,8 @@
 const Joi = require('joi');
 const mutate = require('../lib/mutate');
 
+const SCOPES = ['GLOBAL', 'PIPELINE', 'BUILD'];
+
 const MODEL = {
     id: Joi.number().integer().positive(),
 
@@ -21,7 +23,26 @@ const MODEL = {
 
     createdBy: Joi.string().max(128).description('Username of user creating the banner').example('batman123'),
 
-    type: Joi.string().valid('info', 'warn').max(32).description('Type/Severity of the banner message').example('info')
+    type: Joi.string().valid('info', 'warn').max(32).description('Type/Severity of the banner message').example('info'),
+
+    scope: Joi.string()
+        .max(16)
+        .valid(...SCOPES)
+        .description('Scope of the banner')
+        .example('GLOBAL')
+        .default('GLOBAL')
+        .required(),
+
+    scopeId: Joi.number()
+        .integer()
+        .positive()
+        .description('Identifier to pipelineId for PIPELINE, buildId for BUILD, or null for GLOBAL')
+        .when('scope', {
+            is: Joi.valid('GLOBAL'),
+            then: Joi.allow(null).optional(),
+            otherwise: Joi.required()
+        })
+        .example(1234)
 };
 
 module.exports = {
@@ -47,9 +68,9 @@ module.exports = {
      * @property get
      * @type {Joi}
      */
-    get: Joi.object(mutate(MODEL, ['id', 'message', 'type', 'isActive', 'createdBy', 'createTime'], [])).label(
-        'Get Banner'
-    ),
+    get: Joi.object(
+        mutate(MODEL, ['id', 'message', 'type', 'isActive', 'scope', 'scopeId', 'createdBy', 'createTime'], [])
+    ).label('Get Banner'),
 
     /**
      * Properties for Banners that will be passed during a CREATE request
@@ -57,7 +78,7 @@ module.exports = {
      * @property create
      * @type {Joi}
      */
-    create: Joi.object(mutate(MODEL, ['message'], ['type', 'isActive'])).label('Create Banner'),
+    create: Joi.object(mutate(MODEL, ['message'], ['type', 'isActive', 'scope', 'scopeId'])).label('Create Banner'),
 
     /**
      * Properties for Banners that will be passed during a UPDATE request
@@ -72,7 +93,11 @@ module.exports = {
      * The LIST request will list all banners
      */
     list: Joi.array()
-        .items(Joi.object(mutate(MODEL, ['id', 'message', 'type', 'isActive', 'createdBy', 'createTime'], [])))
+        .items(
+            Joi.object(
+                mutate(MODEL, ['id', 'message', 'type', 'isActive', 'scope', 'scopeId', 'createdBy', 'createTime'], [])
+            )
+        )
         .label('List Banners'),
 
     /**
@@ -81,7 +106,7 @@ module.exports = {
      * @property keys
      * @type {Array}
      */
-    keys: ['message', 'type', 'createTime'],
+    keys: ['message', 'type', 'createTime', 'scope', 'scopeId'],
 
     /**
      * List of all fields in the model
@@ -104,5 +129,5 @@ module.exports = {
      * @property indexes
      * @type {Array}
      */
-    indexes: [{ fields: ['isActive'] }]
+    indexes: [{ fields: ['isActive'] }, { fields: ['scope', 'scopeId'] }]
 };

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.2.0",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {
@@ -51,12 +51,12 @@
     "npx": "^3.0.0",
     "nyc": "^15.1.0",
     "pg": "^7.18.2",
-    "sequelize": "^6.25.8",
-    "sequelize-cli": "^6.5.2",
-    "sqlite3": "^5.1.2"
+    "sequelize": "^6.37.5",
+    "sequelize-cli": "^6.6.2",
+    "sqlite3": "^5.1.7"
   },
   "dependencies": {
     "cron-parser": "^4.7.0",
-    "joi": "^17.7.0"
+    "joi": "^17.13.3"
   }
 }