feat: redux - stream manager, channel and shared redux slices (#40)

Author: drewhan90

README.md

@@ -42,7 +42,10 @@ Deploying the CDK stack will:
 
 ## Features
 
+<<<<<<< HEAD
+=======
 
+>>>>>>> fork/main
 ### User Registration, Login and Password Reset using Amazon Cognito
 
 New users can create an account from the `/register` route. Returning users can login to their account from the `/login` route. They can also reset their password at `/reset`.
@@ -268,6 +271,31 @@ The `cdk/cdk.json` file provides two configuration objects: one for the `dev` st
    "productLinkRegionCode": "20"
    ```
 
+- The `multitrackInputConfiguration` object configures [Amazon IVS multitrack video](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) streaming for a channel.
+
+  It's important to note that to enable multitrack, the ivsChannelType must be set to "STANDARD".
+
+  When `enabled` is set to true, it allows the channel to accept multiple video tracks from a single streaming source.
+
+  The `maximumResolution` field sets the highest input resolution allowed, with options being "SD" (480p or less), "HD" (720p or less), or "FULL_HD" (1080p or less).
+
+  The `policy` field determines whether multitrack input is optional ("ALLOW") or mandatory ("REQUIRE") for broadcasters connecting to the channel.
+
+  This configuration optimizes streaming efficiency, potentially reducing costs and improving viewer experience by enabling adaptive bitrate streaming without server-side transcoding. Remember, multitrack functionality is only available for Standard channels, so ensuring the correct channel type is crucial for this feature to work.
+
+  For more information on the feature, please refer to the [CDK README.md](<(./cdk/README.md#Amazon-IVS-multitrack-video)>) file.
+
+  Example:
+
+  ```json
+   "ivsChannelType": "STANDARD",
+   "multitrackInputConfiguration": {
+      "enabled": true,
+      "maximumResolution": "FULL_HD",
+      "policy": "ALLOW"
+   }
+  ```
+
 ## Guides
 
 
@@ -330,7 +358,7 @@ To set your Product Advertising API credentials you must:
 
 After deployment, through [Amazon OneLink](https://affiliate-program.amazon.com/resource-center/onelink-launch), you can best earn money via product affiliate links by redirecting international traffic to the appropriate Amazon store for their location, increasing the likelihood that they will make a purchase. To get started:
 
-1. Sign up for Amazon Associates: To use Amazon OneLink, you need to be an [Amazon Associate](https://affiliate-program.amazon.com/). If you're not already signed up, go to the Amazon Associates website and create an account.
+1. Sign up for Amazon Associates: To use Amazon OneLink, you need to be an [Amazon Associate](https://associates.amazon.ca/). If you're not already signed up, go to the Amazon Associates website and create an account.
 
 2. Enable OneLink: Once you've signed up for Amazon Associates, navigate to the 'Manage Tracking IDs' section located at the top right-hand corner
    of the Amazon Associates portal.

cdk/Makefile

@@ -10,6 +10,10 @@ PUBLISH					 ?=	false
 STACK 					 ?=	UGC-$(STAGE)
 COGNITO_CLEANUP_SCHEDULE ?= rate(48 hours)
 STAGE_CLEANUP_SCHEDULE   ?= rate(24 hours)
+## Overide STAGE_CLEANUP_SCHEDULE for prod stage
+ifeq ($(STAGE),prod)
+STAGE_CLEANUP_SCHEDULE   = rate(10 minutes)
+endif
 CDK_OPTIONS 			 =	$(if $(AWS_PROFILE),$(AWS_PROFILE_FLAG)) -c stage=$(STAGE) -c publish=$(PUBLISH) -c stackName=$(STACK) -c cognitoCleanupScheduleExp="$(strip $(COGNITO_CLEANUP_SCHEDULE))" -c stageCleanupScheduleExp="$(strip $(STAGE_CLEANUP_SCHEDULE))"
 FE_DEPLOYMENT_STACK		 =	UGC-Frontend-Deployment-$(STAGE)
 SEED_COUNT 				 ?=	50

cdk/README.md

@@ -128,3 +128,27 @@ The cleanup lambda function follows these steps:
 
 ### Amazon FIFO SQS
 A FIFO queue using content body for message deduplication and a 3-minute delayed delivery, allowing the host sufficient time to rejoin if they choose to.
+
+### Amazon IVS multitrack video
+
+Amazon Interactive Video Service (IVS) support low-latency streaming approach called multitrack video. This technology empowers broadcasting software like OBS Studio to:
+- Encode and stream multiple video qualities directly from their GPU-powered computer.
+- Automatically configure encoder settings for the best possible stream.
+- Deliver a high quality Adaptive Bitrate (ABR) viewing experience.
+
+Unlike single-track video streaming, which necessitates server-side transcoding, multitrack video achieves these capabilities without such requirements. Multitrack video enhances streaming efficiency and quality for content creators and viewers alike.
+
+Please refer to the [Amazon IVS Multitrack Video](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html) documentation for more information.
+
+#### Required CDK configuration to enable channel multitrack input
+
+Please make sure the correct configurations are set in the [cdk.json](./cdk.json) file to enable multitrack. If any of these configurations are incorrectly set, the stack deployment process will throw an error. 
+
+Refer to the [Amazon IVS Multitrack Video: Setup Guide](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video-setup.html) for more information on how to setup the feature. 
+
+- ivsChannelType = "STANDARD"
+- multitrackInputConfiguration.enabled = true
+- multitrackInputConfiguration.maximumResolution = "SD" | "HD" | "FULL_HD" 
+- multitrackInputConfiguration.policy = "ALLOW" | "REQUIRE" 
+
+Please note that `ContainerFormat` will be automatically set as "FRAGMENTED_MP4" when multitrack is enabled. 

cdk/api/channel/authRouter/createResources.ts

@@ -1,12 +1,18 @@
 import {
   ChannelType,
   CreateChannelCommand,
+  MultitrackInputConfiguration,
   TranscodePreset
 } from '@aws-sdk/client-ivs';
 import { CreateRoomCommand } from '@aws-sdk/client-ivschat';
 import { FastifyReply, FastifyRequest } from 'fastify';
 
-import { generateDeterministicId, getUser } from '../helpers';
+import {
+  ChannelConfiguration,
+  generateDeterministicId,
+  getMultitrackChannelInputFields,
+  getUser
+} from '../helpers';
 import {
   CHANNELS_TABLE_STAGE_FIELDS,
   UNEXPECTED_EXCEPTION
@@ -43,12 +49,15 @@ const handler = async (
     // Create IVS channel
     const cleanedUserName = username.replace(/[^a-zA-Z0-9-_]/g, '');
     const channelName = `${cleanedUserName}s-channel`;
+    const multitrackChannelInputFields = getMultitrackChannelInputFields();
+
     const createChannelCommand = new CreateChannelCommand({
       name: channelName,
       type: process.env.IVS_CHANNEL_TYPE as ChannelType,
       preset: process.env
         .IVS_ADVANCED_CHANNEL_TRANSCODE_PRESET as TranscodePreset,
-      tags: { project: process.env.PROJECT_TAG as string }
+      tags: { project: process.env.PROJECT_TAG as string },
+      ...multitrackChannelInputFields
     });
     const { channel, streamKey } = await ivsClient.send(createChannelCommand);
 
@@ -65,6 +74,11 @@ const handler = async (
     const streamKeyArn = streamKey?.arn;
     const playbackUrl = channel?.playbackUrl;
     const chatRoomArn = chatRoom.arn;
+    const channelConfiguration: ChannelConfiguration = {
+      type: channel?.type as ChannelType,
+      multitrackInputConfiguration:
+        channel?.multitrackInputConfiguration as MultitrackInputConfiguration
+    };
 
     let trackingId;
 
@@ -109,6 +123,10 @@ const handler = async (
         {
           key: CHANNELS_TABLE_STAGE_FIELDS.STAGE_CREATION_DATE,
           value: null
+        },
+        {
+          key: 'channelConfiguration',
+          value: channelConfiguration
         }
       ],
       primaryKey: { key: 'id', value: sub },

cdk/api/channel/authRouter/getUser.ts

@@ -22,6 +22,7 @@ interface GetUserResponseBody extends ResponseBody {
   streamKeyValue?: string;
   username?: string;
   trackingId?: string;
+  stageId?: string;
 }
 
 const handler = async (request: FastifyRequest, reply: FastifyReply) => {
@@ -31,6 +32,8 @@ const handler = async (request: FastifyRequest, reply: FastifyReply) => {
   try {
     // Get user from channelsTable
     const { Item = {} } = await getUser(sub);
+    const data = unmarshall(Item);
+    let channelId;
     const {
       avatar,
       channelArn,
@@ -40,9 +43,10 @@ const handler = async (request: FastifyRequest, reply: FastifyReply) => {
       playbackUrl,
       streamKeyValue,
       username,
-      trackingId
-    } = unmarshall(Item);
-    let channelId;
+      trackingId,
+      stageId,
+      channelConfiguration
+    } = data;
 
     if (!channelArn) {
       throw new Error('No IVS resources have been created for this user.');
@@ -64,6 +68,8 @@ const handler = async (request: FastifyRequest, reply: FastifyReply) => {
     responseBody.channelAssetUrls = getChannelAssetUrls(channelAssets);
     responseBody.trackingId = trackingId;
     responseBody.channelId = channelId;
+    responseBody.stageId = stageId;
+    responseBody.channelConfiguration = channelConfiguration;
   } catch (error) {
     console.error(error);
 

cdk/api/channel/authRouter/index.ts

@@ -17,6 +17,7 @@ import addToFollowingList from './addToFollowingList';
 import removeFromFollowingList from './removeFromFollowingList';
 import getFollowingChannels from './getFollowingChannels';
 import getLiveStatus from './getLiveStatus';
+import updateChannelConfig from './updateChannelConfiguration';
 
 declare module '@fastify/request-context' {
   interface RequestContextData {
@@ -42,6 +43,7 @@ const router: FastifyPluginAsync = async (resource) => {
     generateImagePresignedPost
   );
 
+  resource.put('/config/update', updateChannelConfig);
   resource.put('/username/update', changeUsername);
   resource.put('/preferences/update', changeUserPreferences);
   resource.put('/followingList/add', addToFollowingList);

cdk/api/channel/authRouter/updateChannelConfiguration.ts

@@ -0,0 +1,84 @@
+import {
+  ChannelType,
+  UpdateChannelCommand,
+  TranscodePreset,
+  MultitrackInputConfiguration
+} from '@aws-sdk/client-ivs';
+import { FastifyReply, FastifyRequest } from 'fastify';
+import { unmarshall } from '@aws-sdk/util-dynamodb';
+
+import {
+  areObjectsSame,
+  ChannelConfiguration,
+  getMultitrackChannelInputFields,
+  getUser
+} from '../helpers';
+import { UNEXPECTED_EXCEPTION } from '../../shared/constants';
+import { ivsClient, updateDynamoItemAttributes } from '../../shared/helpers';
+import { UserContext } from '../../shared/authorizer';
+
+const cdkMultitrackInputConfiguration: MultitrackInputConfiguration =
+  JSON.parse(process.env.CHANNEL_MULTITRACK_INPUT_CONFIGURATION || '{}');
+
+const handler = async (request: FastifyRequest, reply: FastifyReply) => {
+  const { sub } = request.requestContext.get('user') as UserContext;
+
+  try {
+    const { Item = {} } = await getUser(sub);
+    const userData = unmarshall(Item);
+    const cdkChannelConfiguration: ChannelConfiguration = {
+      type: process.env.IVS_CHANNEL_TYPE as ChannelType,
+      multitrackInputConfiguration: cdkMultitrackInputConfiguration
+    };
+    if (
+      userData &&
+      areObjectsSame(userData.channelConfiguration, cdkChannelConfiguration)
+    ) {
+      reply.statusCode = 204;
+
+      return reply.send({
+        message: 'Channel configuration is already up to date'
+      });
+    }
+
+    const { containerFormat, multitrackInputConfiguration } =
+      getMultitrackChannelInputFields();
+
+    const updateChannelCommand = new UpdateChannelCommand({
+      arn: userData.channelArn,
+      type: process.env.IVS_CHANNEL_TYPE as ChannelType,
+      preset: process.env
+        .IVS_ADVANCED_CHANNEL_TRANSCODE_PRESET as TranscodePreset,
+      containerFormat,
+      multitrackInputConfiguration
+    });
+    const { channel } = await ivsClient.send(updateChannelCommand);
+
+    // Update the "channelConfiguration" field in the channel record
+    await updateDynamoItemAttributes({
+      attributes: [
+        {
+          key: 'channelConfiguration',
+          value: {
+            type: channel?.type,
+            multitrackInputConfiguration: channel?.multitrackInputConfiguration
+          }
+        }
+      ],
+      primaryKey: { key: 'id', value: sub },
+      tableName: process.env.CHANNELS_TABLE_NAME as string
+    });
+  } catch (error) {
+    console.error(error);
+
+    reply.statusCode = 500;
+
+    return reply.send({ __type: UNEXPECTED_EXCEPTION });
+  }
+
+  reply.statusCode = 201;
+
+  return reply.send({});
+};
+
+export default handler;

cdk/api/channel/helpers.ts

@@ -24,6 +24,18 @@ import {
   USER_NOT_FOUND_EXCEPTION
 } from '../shared/constants';
 import { dynamoDbClient, ivsChatClient, s3Client } from '../shared/helpers';
+import {
+  ChannelType,
+  ContainerFormat,
+  MultitrackInputConfiguration
+} from '@aws-sdk/client-ivs';
+
+type ChannelTypeValues = (typeof ChannelType)[keyof typeof ChannelType];
+
+export interface ChannelConfiguration {
+  type: ChannelTypeValues;
+  multitrackInputConfiguration: MultitrackInputConfiguration;
+}
 
 export const getUser = (sub: string) => {
   const getItemCommand = new GetItemCommand({
@@ -147,7 +159,7 @@ export const createChatRoomToken = async (
     color?: string;
     displayName?: string;
   },
-  capabilities?: (ChatTokenCapability | string)[]
+  capabilities?: ChatTokenCapability[] | undefined
 ) => {
   let chatRoomArn, bannedUserSubs;
   const { Items } = await getUserByUsername(chatRoomOwnerUsername);
@@ -342,3 +354,53 @@ export const processAssetPreference = (
     }
   });
 };
+
+export const getMultitrackChannelInputFields = () => {
+  const multitrackInputConfiguration: MultitrackInputConfiguration = JSON.parse(
+    process.env.CHANNEL_MULTITRACK_INPUT_CONFIGURATION || '{}'
+  );
+
+  if (!multitrackInputConfiguration.enabled) {
+    return {};
+  }
+
+  return {
+    containerFormat: ContainerFormat.FragmentedMP4,
+    multitrackInputConfiguration
+  };
+};
+
+/**
+ * Compares two values to determine if they are the same.
+ * For objects, it checks if they have the same keys and values.
+ * For non-objects, it performs a strict equality check.
+ *
+ * @param {*} obj1 - The first value to compare.
+ * @param {*} obj2 - The second value to compare.
+ * @returns {boolean} - Returns true if the values are the same; otherwise, false.
+ */
+export const areObjectsSame = <T extends Record<string, any>>(
+  obj1: T,
+  obj2: T
+): boolean => {
+  // Handle null/undefined and non-object cases
+  if (obj1 === obj2) return true;
+  if (
+    obj1 == null ||
+    obj2 == null ||
+    typeof obj1 !== 'object' ||
+    typeof obj2 !== 'object'
+  )
+    return false;
+
+  const keys1 = Object.keys(obj1);
+  const keys2 = Object.keys(obj2);
+
+  // Check if the number of keys is the same
+  if (keys1.length !== keys2.length) return false;
+
+  // Check if all keys and values are the same
+  return keys1.every(
+    (key) => keys2.includes(key) && areObjectsSame(obj1[key], obj2[key])
+  );
+};

cdk/api/channel/unauthRouter/createChatToken.ts

@@ -56,7 +56,7 @@ const handler = async (
 
   try {
     let token, sessionExpirationTime, tokenExpirationTime;
-    const capabilities: ChatTokenCapabilityType[] = [];
+    const capabilities: ChatTokenCapability[] | undefined = [];
 
     if (!viewerSub) {
       ({ token, sessionExpirationTime, tokenExpirationTime } =