feat: IVS real-time screen share (#29)

* merge: real-time screenshare

* update: cdk package-lock, docker version to 1.45.0

* remove: github folder

* hotfix: preAuthenticationLambda var name

* hotfix: remove readme auto-formatting

Author: drewhan90

README.md

@@ -4,15 +4,16 @@ RESET := \033[0m
 
 .PHONY: help app install bootstrap deploy destroy clean
 
-AWS_PROFILE_FLAG		=	--profile $(AWS_PROFILE)
-STAGE					?=	dev
-PUBLISH					?=	false
-STACK 					?=	UGC-$(STAGE)
-SCHEDULE 				?= 	rate(48 hours)
-CDK_OPTIONS 			=	$(if $(AWS_PROFILE),$(AWS_PROFILE_FLAG)) -c stage=$(STAGE) -c publish=$(PUBLISH) -c stackName=$(STACK) -c scheduleExp="$(strip $(SCHEDULE))"
-FE_DEPLOYMENT_STACK		=	UGC-Frontend-Deployment-$(STAGE)
-SEED_COUNT 				?=	50
-OFFLINE_SESSION_COUNT	?=	1
+AWS_PROFILE_FLAG		 =	--profile $(AWS_PROFILE)
+STAGE					 ?=	dev
+PUBLISH					 ?=	false
+STACK 					 ?=	UGC-$(STAGE)
+COGNITO_CLEANUP_SCHEDULE ?= rate(48 hours)
+STAGE_CLEANUP_SCHEDULE   ?= rate(24 hours)
+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
+OFFLINE_SESSION_COUNT	 ?=	1
 
 help: ## Shows this help message
 	@echo "\n$$(tput bold)Available Rules:$$(tput sgr0)\n"

cdk/Makefile

@@ -34,7 +34,7 @@ The outcome of the seed command above is 50 new channels and streams, 20 of thes
 make seed JSON=./seed.example.json
 ```
 
-**\*NOTE:** Please refer to the [seed.example.json file](./seed.example.json) so that you may create data that the DynamoDB client can use. Incorrect JSON data will lead to errors when seeding.\*
+***NOTE:** Please refer to the [seed.example.json file](./seed.example.json) so that you may create data that the DynamoDB client can use. Incorrect JSON data will lead to errors when seeding.*
 
 All the environment variables can be used together to generate mock data that suites your needs:
 
@@ -82,3 +82,49 @@ When the postStreamEvents function receives an event with a `session created` ev
 When a `session ended` event is received, the corresponding stream record is grabbed and updated by removing the `isOpen` attribute.
 
 You can find the Stream events API code in the `/streamEventsApi` folder.
+
+## Scheduled resource cleanup AWS Lambdas
+
+The scheduled resource cleanup lambdas are created when the stack is deployed. No additional steps are necessary to set up and trigger these functions. The lambda functions exist in the `cdk/lambdas` folder. The schedule can be customized in the `cdk/Makefile`. AWS Lambda supports standard rate and cron expressions for frequencies of up to once per minute. Read more about [schedule expressions using rate or cron](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents-expressions.html).
+
+### Amazon IVS idle stages cleanup
+
+The cleanup lambda function follows these steps:
+1. It retrieves a list of all stages
+2. The `getIdleStageArn` helper function is employed to filter out idle stages that have been in existence for at least 1 hour
+3. Subsequently, the filtered idle stages are deleted.
+
+### Amazon Cognito unverified users cleanup
+
+The cleanup lambda function follows these steps:
+1. It retrieves a list of users with a `UNCONFIRMED` status
+2. Within the unconfirmed users, we filter for users that have existed for at least 24 hours
+3. Finally, the filtered unverified and expired users are deleted both from the Cognito user pool and AWS DynamoDB channels table.
+
+
+## Amazon IVS Real-time host disconnect event handler
+
+Amazon IVS host disconnect event cleanup is designed to delete active stages for which hosts have been disconnected from the session for at least 3 minutes. Upon a host's disconnection from a stage, the responsible endpoint follows these steps:
+1. Extracts the host's channel ID from the request body, accommodating both object and JSON string formats
+2. It retrieves the corresponding host details, including the stage and session, and formats them into a message body
+3. This structured data is sent to an Amazon SQS queue for additional processing. It's important to highlight that the message comes with a 3-minute delay, allowing the host sufficient time to rejoin if they choose to
+4. After 3-minute wait time, SQS triggers deleteStage lambda function.
+
+### Amazon IVS Real-time host disconnect event cleanup triggers
+
+This flow is triggered by:
+1. Beacon API [Beacon API documention](https://developer.mozilla.org/en-US/docs/Web/API/Beacon_API)
+2. Stage participantConnectionChangedEvent event [STAGE_CONNECTION_STATE_CHANGED](https://aws.github.io/amazon-ivs-web-broadcast/docs/sdk-reference/enums/StageEvents#stage_connection_state_changed)
+3. EventBridge
+4. SQS [Amazon FIFO SQS](#amazon-fifo-sqs)
+
+### Amazon IVS real-time host disconnect event lamnda cleanup
+
+The cleanup lambda function follows these steps:
+1. Lambda receives a message from the SQS queue
+2. Checks if the host is present in the stage for potential reconnection
+3. If the host is not detected in the stage, deletes the stage
+4. Updates the channel table to reflect changes such as the removal/nullification of the stageId and stageCreationDate fields.
+
+### 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.

cdk/README.md

@@ -0,0 +1,46 @@
+{
+  "UserItem": {
+    "trackingId": {
+      "S": "4wpfqidqx0pv"
+    },
+    "avatar": {
+      "S": "bird2"
+    },
+    "streamKeyValue": {
+      "S": "sk_us-east-1_DbRFyxHFRDYp_Olmd3kZgUt5gOGVriEnjk9jT6Ap9C8"
+    },
+    "email": {
+      "S": "sina@fournine.digital"
+    },
+    "ingestEndpoint": {
+      "S": "bb6c96699fb6.global-contribute.live-video.net"
+    },
+    "chatRoomArn": {
+      "S": "arn:aws:ivschat:us-east-1:045801317995:room/w0QFAKIvsEVe"
+    },
+    "channelArn": {
+      "S": "arn:aws:ivs:us-east-1:045801317995:channel/4WpFQIDqX0pV"
+    },
+    "playbackUrl": {
+      "S": "https://bb6c96699fb6.us-east-1.playback.live-video.net/api/video/v1/us-east-1.045801317995.channel.4WpFQIDqX0pV.m3u8"
+    },
+    "username": {
+      "S": "sina"
+    },
+    "channelAssets": {
+      "M": {}
+    },
+    "channelAssetId": {
+      "S": "7625ec0f-9f2f-54e6-b08a-d6a586b8c4e6"
+    },
+    "id": {
+      "S": "d4c834b8-7021-70bd-467b-2ab09fc164fe"
+    },
+    "color": {
+      "S": "salmon"
+    },
+    "streamKeyArn": {
+      "S": "arn:aws:ivs:us-east-1:045801317995:stream-key/DbRFyxHFRDYp"
+    }
+  }
+}

cdk/api/__mocks__/userInfo.json

@@ -5,6 +5,7 @@ import channelRouters from './channel';
 import channelsRouters from './channels';
 import metricsRouter from './metrics/';
 import productsRouters from './product';
+import stagesRouter from './stages';
 
 import configureRoute from './shared/hooks/configureRoute';
 import { MAX_SERVER_PARAM_LENGTH } from './shared/constants';
@@ -49,6 +50,8 @@ const buildServer = () => {
       // Create /products authenticated resources
       server.register(productsRouters, { prefix: 'products' });
     }
+
+    server.register(stagesRouter, { prefix: 'stages' });
   }
 
   if (['all', 'metrics'].includes(serviceName)) {

cdk/api/buildServer.ts

@@ -2,10 +2,6 @@ import {
   GetItemCommandOutput,
   UpdateItemCommand
 } from '@aws-sdk/client-dynamodb';
-import {
-  DisconnectUserCommand,
-  SendEventCommand
-} from '@aws-sdk/client-ivschat';
 import { mockClient } from 'aws-sdk-client-mock';
 
 import buildServer from '../../../buildServer';

cdk/api/channel/authRouter/__tests__/banUser.test.ts

@@ -14,7 +14,7 @@ import {
   getChannelId
 } from '../../shared/helpers';
 import { getUser, getUserByUsername } from '../helpers';
-import { UserContext } from '../authorizer';
+import { UserContext } from '../../shared/authorizer';
 
 export const getFollowingChannelArn = async ({
   reply,

cdk/api/channel/authRouter/addToFollowingList.ts

@@ -1,24 +1,15 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
 import { convertToAttr, unmarshall } from '@aws-sdk/util-dynamodb';
-import {
-  DisconnectUserCommand,
-  SendEventCommand
-} from '@aws-sdk/client-ivschat';
 import { UpdateItemCommand } from '@aws-sdk/client-dynamodb';
 
-import {
-  dynamoDbClient,
-  getUserByChannelArn,
-  isIvsChatError,
-  ivsChatClient
-} from '../../shared/helpers';
+import { dynamoDbClient, getUserByChannelArn } from '../../shared/helpers';
 import { getUser } from '../helpers';
 import {
   UNEXPECTED_EXCEPTION,
   BAN_USER_EXCEPTION,
   USER_NOT_FOUND_EXCEPTION
 } from '../../shared/constants';
-import { UserContext } from '../authorizer';
+import { UserContext } from '../../shared/authorizer';
 
 type BanUserRequestBody = { bannedChannelArn?: string };
 
@@ -30,7 +21,7 @@ const handler = async (
     'user'
   ) as UserContext;
   const { bannedChannelArn } = request.body;
-  let chatRoomArn, chatRoomOwnerChannelArn, bannedUsername;
+  let chatRoomOwnerChannelArn;
 
   // Check input
   if (!bannedChannelArn) {
@@ -46,8 +37,7 @@ const handler = async (
   // Retrieve the chat room data for the requester's channel
   try {
     const { Item: UserItem = {} } = await getUser(sub);
-    ({ chatRoomArn, channelArn: chatRoomOwnerChannelArn } =
-      unmarshall(UserItem));
+    ({ channelArn: chatRoomOwnerChannelArn } = unmarshall(UserItem));
 
     // Disallow users from banning themselves from their own channel
     if (bannedChannelArn === chatRoomOwnerChannelArn) {
@@ -83,8 +73,7 @@ const handler = async (
     }
 
     // Add the bannedUserSub to the bannedUserSubs set in the user table
-    const { id: bannedUserSub, username } = unmarshall(BannedUserItems[0]);
-    bannedUsername = username;
+    const { id: bannedUserSub } = unmarshall(BannedUserItems[0]);
 
     await dynamoDbClient.send(
       new UpdateItemCommand({

cdk/api/channel/authRouter/banUser.ts

@@ -4,7 +4,7 @@ import { FastifyReply, FastifyRequest } from 'fastify';
 import { CHANGE_USER_PREFERENCES_EXCEPTION } from '../../shared/constants';
 import { updateDynamoItemAttributes } from '../../shared/helpers';
 import { processAssetPreference, Preference } from '../helpers';
-import { UserContext } from '../authorizer';
+import { UserContext } from '../../shared/authorizer';
 
 interface ChangeUserPreferencesRequestBody {
   [key: string]: Preference;

cdk/api/channel/authRouter/changeUserPreferences.ts

@@ -15,7 +15,7 @@ import {
   ResponseBody,
   updateDynamoItemAttributes
 } from '../../shared/helpers';
-import { UserContext } from '../authorizer';
+import { UserContext } from '../../shared/authorizer';
 
 type ChangeUsernameRequestBody = { newUsername: string | undefined };