[AB#45976] feat: publish image alt text (#379)

* feat: publish image alt text * test: updated unit tests
Axinom · Oct 14, 2024 · c257ecc · c257ecc
1 parent d18bef3
commit c257ecc
Show file tree

Hide file tree

Showing 43 changed files with 2,469 additions and 17 deletions.
diff --git a/libs/media-messages/schemas/payloads/channel/common.json b/libs/media-messages/schemas/payloads/channel/common.json
@@ -50,6 +50,10 @@
         "height": {
           "description": "Height of the image.",
           "type": ["integer", "null"]
+        },
+        "alt_text": {
+          "description": "Alternative text for the image.",
+          "type": ["string", "null"]
         }
       }
     },

diff --git a/libs/media-messages/schemas/payloads/publish/common.json b/libs/media-messages/schemas/payloads/publish/common.json
@@ -111,6 +111,10 @@
         "height": {
           "description": "Height of the image in pixels.",
           "type": ["integer", "null"]
+        },
+        "alt_text": {
+          "description": "Alternative text for the image.",
+          "type": ["string", "null"]
         }
       },
       "required": ["type", "path"],

diff --git a/...media-messages/src/generated/schemas/payloads/channel/events/channel-published-event.json b/...media-messages/src/generated/schemas/payloads/channel/events/channel-published-event.json
@@ -66,6 +66,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         }
       }

diff --git a/...edia-messages/src/generated/schemas/payloads/channel/events/playlist-published-event.json b/...edia-messages/src/generated/schemas/payloads/channel/events/playlist-published-event.json
@@ -104,6 +104,13 @@
                   "integer",
                   "null"
                 ]
+              },
+              "alt_text": {
+                "description": "Alternative text for the image.",
+                "type": [
+                  "string",
+                  "null"
+                ]
               }
             }
           },

diff --git a/...ia-messages/src/generated/schemas/payloads/publish/events/collection-published-event.json b/...ia-messages/src/generated/schemas/payloads/publish/events/collection-published-event.json
@@ -53,6 +53,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         },
         "required": [

diff --git a/...media-messages/src/generated/schemas/payloads/publish/events/episode-published-event.json b/...media-messages/src/generated/schemas/payloads/publish/events/episode-published-event.json
@@ -93,6 +93,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         },
         "required": [

diff --git a/libs/media-messages/src/generated/schemas/payloads/publish/events/movie-published-event.json b/libs/media-messages/src/generated/schemas/payloads/publish/events/movie-published-event.json
@@ -83,6 +83,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         },
         "required": [

diff --git a/.../media-messages/src/generated/schemas/payloads/publish/events/season-published-event.json b/.../media-messages/src/generated/schemas/payloads/publish/events/season-published-event.json
@@ -89,6 +89,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         },
         "required": [

diff --git a/.../media-messages/src/generated/schemas/payloads/publish/events/tvshow-published-event.json b/.../media-messages/src/generated/schemas/payloads/publish/events/tvshow-published-event.json
@@ -83,6 +83,13 @@
               "integer",
               "null"
             ]
+          },
+          "alt_text": {
+            "description": "Alternative text for the image.",
+            "type": [
+              "string",
+              "null"
+            ]
           }
         },
         "required": [

diff --git a/libs/media-messages/src/generated/types/payloads/channel/types/detailed-image.ts b/libs/media-messages/src/generated/types/payloads/channel/types/detailed-image.ts
@@ -22,6 +22,10 @@ export interface DetailedImage {
    * Height of the image.
    */
   height?: number | null;
+  /**
+   * Alternative text for the image.
+   */
+  alt_text?: string | null;
 
   [k: string]: unknown;
 }
diff --git a/libs/media-messages/src/generated/types/payloads/publish/types/image.ts b/libs/media-messages/src/generated/types/payloads/publish/types/image.ts
@@ -19,4 +19,8 @@ export interface Image {
    * Height of the image in pixels.
    */
   height?: number | null;
+  /**
+   * Alternative text for the image.
+   */
+  alt_text?: string | null;
 }
diff --git a/services/catalog/service/migrations/committed/000017-image-alt-text-added.sql b/services/catalog/service/migrations/committed/000017-image-alt-text-added.sql
@@ -0,0 +1,47 @@
+--! Previous: sha1:fc9415fd1858d514f88cce07b2bd0be73c05d3e8
+--! Hash: sha1:677b5e78a2bfb199af4c633568e2c80a8aebc78b
+--! Message: image-alt-text-added
+
+-- Media Service
+ALTER TABLE app_public.movie_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.movie_images 
+ADD COLUMN alt_text TEXT;
+
+ALTER TABLE app_public.tvshow_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.tvshow_images 
+ADD COLUMN alt_text TEXT;
+
+ALTER TABLE app_public.season_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.season_images 
+ADD COLUMN alt_text TEXT;
+
+ALTER TABLE app_public.episode_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.episode_images 
+ADD COLUMN alt_text TEXT;
+
+ALTER TABLE app_public.collection_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.collection_images 
+ADD COLUMN alt_text TEXT;
+
+-- Channel Service
+ALTER TABLE app_public.channel_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.channel_images 
+ADD COLUMN alt_text TEXT;
+
+ALTER TABLE app_public.program_images
+DROP COLUMN IF EXISTS alt_text CASCADE;
+
+ALTER TABLE app_public.program_images 
+ADD COLUMN alt_text TEXT;
diff --git a/.../catalog/service/src/domains/channels/handlers/channel-published-event-handler.db.spec.ts b/.../catalog/service/src/domains/channels/handlers/channel-published-event-handler.db.spec.ts
@@ -53,7 +53,7 @@ describe('ChannelPublishEventHandler', () => {
         {
           channel_id: payload.content_id,
         },
-        { columns: ['height', 'width', 'path', 'type'] },
+        { columns: ['height', 'width', 'path', 'type', 'alt_text'] },
       ).run(ctx.ownerPool);
       const { id: imageId, ...messageImage } = payload.images![0];
       expect(image).toMatchObject(messageImage);

diff --git a/services/catalog/service/src/domains/channels/handlers/channel-published-event-handler.ts b/services/catalog/service/src/domains/channels/handlers/channel-published-event-handler.ts
@@ -51,6 +51,7 @@ export class ChannelPublishedEventHandler extends TransactionalInboxMessageHandl
             path: image.path,
             width: image.width,
             height: image.height,
+            alt_text: image.alt_text,
           }),
         ),
       ).run(txnClient);

diff --git a/services/catalog/service/src/domains/channels/handlers/playlist-published-event-handler.ts b/services/catalog/service/src/domains/channels/handlers/playlist-published-event-handler.ts
@@ -75,6 +75,7 @@ export class PlaylistPublishedEventHandler extends TransactionalInboxMessageHand
                 path: p.image.path,
                 width: p.image.width,
                 height: p.image.height,
+                alt_text: p.image.alt_text,
               },
             });
           }

diff --git a/services/catalog/service/src/generated/db/schema.sql b/services/catalog/service/src/generated/db/schema.sql
@@ -2130,7 +2130,8 @@ CREATE TABLE app_public.channel_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -2235,7 +2236,8 @@ CREATE TABLE app_public.collection_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -2403,7 +2405,8 @@ CREATE TABLE app_public.episode_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -2758,7 +2761,8 @@ CREATE TABLE app_public.movie_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -3026,7 +3030,8 @@ CREATE TABLE app_public.program_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -3162,7 +3167,8 @@ CREATE TABLE app_public.season_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );
 
 
@@ -3504,7 +3510,8 @@ CREATE TABLE app_public.tvshow_images (
     type text,
     path text,
     width integer,
-    height integer
+    height integer,
+    alt_text text
 );