Dev to Main Sync

.github/pull_request_template.md

@@ -0,0 +1,33 @@
+Date: `<DATE>`
+
+Developer Name: `<DEVELOPER NAME>`
+
+----
+
+## Issue Ticket Number:- 
+`<ISSUE NUMBER>`
+
+## Description: 
+`<DESCRIPTION>`
+
+
+Is Under Feature Flag 
+- [ ] Yes
+- [ ] No
+
+Database changes
+- [ ] Yes
+- [ ] No
+
+Breaking changes (If your feature is breaking/missing something please mention pending tickets)
+- [ ] Yes
+- [ ] No
+
+Is Development Tested?
+
+- [ ] Yes
+- [ ] No
+
+
+### Add relevant Screenshot below ( e.g test coverage etc. )
+

.github/workflows/production.yaml

@@ -7,16 +7,22 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     steps:
-      - uses: actions/checkout@v2
-      - uses: cloudflare/[email protected]
+      - uses: actions/checkout@v3
+      - run: npm install
+      - uses: cloudflare/wrangler-action@v3
         with:
           apiToken: ${{secrets.CLOUDFLARE_API_TOKEN}}
           accountId: ${{secrets.CLOUDFLARE_ACCOUNT_ID}}
+          command: deploy --env=${{ vars.CURRENT_ENVIRONMENT }}
           secrets: |
-            CRON_JOB_PRIVATE_KEY
             CURRENT_ENVIRONMENT
+            CRON_JOB_PRIVATE_KEY
+            DISCORD_BOT_PRIVATE_KEY
+            DISCORD_BOT_API_URL
         env:
-          CURRENT_ENVIRONMENT: production
-          CRON_JOB_PRIVATE_KEY: ${{secrets.CRON_JOB_PRIVATE_KEY}}
           CLOUDFLARE_API_TOKEN: ${{secrets.CLOUDFLARE_API_TOKEN}}
           CLOUDFLARE_ACCOUNT_ID: ${{secrets.CLOUDFLARE_ACCOUNT_ID}}
+          CURRENT_ENVIRONMENT: ${{vars.CURRENT_ENVIRONMENT}}
+          CRON_JOB_PRIVATE_KEY: ${{secrets.CRON_JOB_PRIVATE_KEY}}
+          DISCORD_BOT_PRIVATE_KEY: ${{secrets.DISCORD_BOT_PRIVATE_KEY}}
+          DISCORD_BOT_API_URL: ${{secrets.DISCORD_BOT_API_URL}}

.github/workflows/staging.yaml

@@ -8,15 +8,23 @@ jobs:
     environment: staging
     steps:
       - uses: actions/checkout@v2
-      - uses: cloudflare/[email protected]
+      - run: npm install
+      - uses: cloudflare/wrangler-action@v3
         with:
           apiToken: ${{secrets.CLOUDFLARE_API_TOKEN}}
           accountId: ${{secrets.CLOUDFLARE_ACCOUNT_ID}}
+          command: deploy --env=${{ vars.CURRENT_ENVIRONMENT }}
           secrets: |
-            CRON_JOB_PRIVATE_KEY
             CURRENT_ENVIRONMENT
+            CRON_JOB_PRIVATE_KEY
+            DISCORD_BOT_PRIVATE_KEY
+            DISCORD_BOT_API_URL
         env:
-          CURRENT_ENVIRONMENT: staging
-          CRON_JOB_PRIVATE_KEY: ${{secrets.CRON_JOB_PRIVATE_KEY}}
           CLOUDFLARE_API_TOKEN: ${{secrets.CLOUDFLARE_API_TOKEN}}
           CLOUDFLARE_ACCOUNT_ID: ${{secrets.CLOUDFLARE_ACCOUNT_ID}}
+          CURRENT_ENVIRONMENT: ${{vars.CURRENT_ENVIRONMENT}}
+          CRON_JOB_PRIVATE_KEY: ${{secrets.CRON_JOB_PRIVATE_KEY}}
+          DISCORD_BOT_PRIVATE_KEY: ${{secrets.DISCORD_BOT_PRIVATE_KEY}}
+          DISCORD_BOT_API_URL: ${{secrets.DISCORD_BOT_API_URL}}
+
+

.github/workflows/test.yaml

@@ -9,4 +9,5 @@ jobs:
             - uses: actions/checkout@v2
             - run: npm install
             - run: npm run lint-check
-            - run: npm run format-check
+            - run: npm run format-check
+            - run: npm run test

Readme.md

@@ -37,11 +37,17 @@ To ensure secure communication between the cron jobs and the backend, every requ
 ## How to Set Up Locally
 
 1. Clone this repository to your local machine.
+
 2. Run `npm install` to install the required dependencies.
+
 3. Run `npm deploy` to deploy the Cloudflare Worker.
+
 4. Generate a pair of RSA 2048-bit keys (private and public).
+
 5. Go to `dash.cloudflare.com`, select "Workers," and find the worker named "Cron Jobs."
+
 6. Go to its settings > variables and add a variable named `CRON_JOB_PRIVATE_KEY`, and paste your private key.
+
 7. Copy and paste the public key in the RDS backend configuration file (`config/local.js`) under `cronJobHandler`:
 
 ```js
@@ -50,21 +56,28 @@ publicKey: <copied public key>,
 }
 ```
 
-Make sure the public key is formatted as it is in `config/test.js`. 8. Start the backend by running the following command in your terminal:
+Make sure the public key is formatted as it is in `config/test.js`. 
+
+8. Start the backend by running the following command in your terminal:
 
 ```bash
 yarn dev
 ```
 
 9. With the backend running, use ngrok to expose your local server publicly. Install ngrok if you haven't already.
+
 10. Start ngrok with the following command:
 
 ```
 ngrok http <PORT_NUMBER>
 ```
 
 Replace `<PORT_NUMBER>` with the port number your backend is running on (e.g., 3000). 
-11. Ngrok will generate a public URL (e.g., `https://abc123.ngrok.io`) that forwards requests to your local server. Copy this ngrok URL. 12. Paste the ngrok URL in the "else" part of the Cron Jobs project's `src/config.ts` file, inside the `handleConfig` function. 
+
+11. Ngrok will generate a public URL (e.g., `https://abc123.ngrok.io`) that forwards requests to your local server. Copy this ngrok URL. 
+
+12. Paste the ngrok URL in the "else" part of the Cron Jobs project's `src/config.ts` file, inside the `handleConfig` function. 
+
 13. Now set the desired trigger time as mentioned [here](#how-to-set-trigger-time)
 
 Now, your backend will get the call at the set time using the public ngrok URL. Remember to keep the backend running with ngrok to ensure the scheduled cron jobs work as intended.

__mocks__/@tsndr/cloudflare-worker-jwt.ts

@@ -0,0 +1,7 @@
+const mockJwt = {
+  sign: jest.fn().mockImplementation(() => {
+    return "SIGNED_JWT";
+  }),
+};
+
+export default mockJwt;

src/config/config.ts

@@ -1,15 +1,26 @@
-import { env } from '../types/global.types';
+import { MISSED_UPDATES_DEVELOPMENT_ROLE_ID, MISSED_UPDATES_PROD_ROLE_ID, MISSED_UPDATES_STAGING_ROLE_ID } from '../constants/commons';
+import { RDS_BASE_API_URL, RDS_BASE_DEVELOPMENT_API_URL, RDS_BASE_STAGING_API_URL } from '../constants/urls';
+import { env, environment } from '../types/global.types';
 
-export const handleConfig = (env: env) => {
-	let baseUrl: string;
-	if (env.CURRENT_ENVIRONMENT) {
-		if (env.CURRENT_ENVIRONMENT.toLowerCase() === 'production') {
-			baseUrl = 'https://api.realdevsquad.com';
-		} else {
-			baseUrl = 'https://staging-api.realdevsquad.com';
-		}
-	} else {
-		baseUrl = 'https://staging-api.realdevsquad.com';
-	}
-	return { baseUrl };
+const config = (env: env) => {
+	const environment: environment = {
+		production: {
+			RDS_BASE_API_URL: RDS_BASE_API_URL,
+			DISCORD_BOT_API_URL: env.DISCORD_BOT_API_URL,
+			MISSED_UPDATES_ROLE_ID: MISSED_UPDATES_PROD_ROLE_ID,
+		},
+		staging: {
+			RDS_BASE_API_URL: RDS_BASE_STAGING_API_URL,
+			DISCORD_BOT_API_URL: env.DISCORD_BOT_API_URL,
+			MISSED_UPDATES_ROLE_ID: MISSED_UPDATES_STAGING_ROLE_ID,
+		},
+		default: {
+			RDS_BASE_API_URL: RDS_BASE_DEVELOPMENT_API_URL,
+			DISCORD_BOT_API_URL: env.DISCORD_BOT_API_URL,
+			MISSED_UPDATES_ROLE_ID: MISSED_UPDATES_DEVELOPMENT_ROLE_ID,
+		},
+	};
+
+	return environment[env.CURRENT_ENVIRONMENT] || environment.default;
 };
+export default config;

src/constants.ts

@@ -0,0 +1,3 @@
+const NAMESPACE_NAME = 'CronJobsTimestamp';
+
+export { NAMESPACE_NAME };

src/constants/commons.ts

@@ -0,0 +1,3 @@
+export const MISSED_UPDATES_PROD_ROLE_ID = '1183553844811153458';
+export const MISSED_UPDATES_STAGING_ROLE_ID = '1183553844811153458';
+export const MISSED_UPDATES_DEVELOPMENT_ROLE_ID = '1181214205081296896';

src/constants/urls.ts

@@ -0,0 +1,7 @@
+export const RDS_BASE_API_URL = 'https://api.realdevsquad.com';
+export const RDS_BASE_STAGING_API_URL = 'https://staging-api.realdevsquad.com';
+export const RDS_BASE_DEVELOPMENT_API_URL = 'http://localhost:3000'; // If needed, modify the URL to your local API server run through ngrok
+
+export const DISCORD_BOT_API_URL = 'env';
+export const DISCORD_BOT_STAGING_API_URL = '';
+export const DISCORD_BOT_DEVELOPMENT_API_URL = '';

src/handlers/scheduledEventHandler.ts

@@ -1,8 +1,95 @@
-import { handleConfig } from '../config/config';
-import { env } from '../types/global.types';
+import { KVNamespace } from '@cloudflare/workers-types';
+
+import config from '../config/config';
+import { NAMESPACE_NAME } from '../constants';
+import { updateUserRoles } from '../services/discordBotServices';
+import { getMissedUpdatesUsers } from '../services/rdsBackendService';
+import { DiscordUserRole, env, NicknameUpdateResponseType } from '../types/global.types';
+import { chunks } from '../utils/arrayUtils';
+import { generateJwt } from '../utils/generateJwt';
 
 export async function ping(env: env) {
-	const url = handleConfig(env);
-	const response = await fetch(`${url.baseUrl}/healthcheck`);
+	const url = config(env).RDS_BASE_API_URL;
+	const response = await fetch(`${url}/healthcheck`);
 	return response;
 }
+
+export async function callDiscordNicknameBatchUpdate(env: env) {
+	const namespace = env[NAMESPACE_NAME] as unknown as KVNamespace;
+	let lastNicknameUpdate: string | null = '0';
+	try {
+		lastNicknameUpdate = await namespace.get('DISCORD_NICKNAME_UPDATED_TIME');
+		if (lastNicknameUpdate === null) {
+			throw new Error('Error while fetching KV "DISCORD_NICKNAME_UPDATED_TIME" timestamp');
+		}
+		if (!lastNicknameUpdate) {
+			lastNicknameUpdate = '0';
+		}
+	} catch (err) {
+		console.error(err, 'Error while fetching the timestamp for last nickname update');
+		throw err;
+	}
+
+	const url = config(env).RDS_BASE_API_URL;
+	let token;
+	try {
+		token = await generateJwt(env);
+	} catch (err) {
+		console.error(`Error while generating JWT token: ${err}`);
+		throw err;
+	}
+	const response = await fetch(`${url}/discord-actions/nickname/status`, {
+		method: 'POST',
+		headers: {
+			Authorization: `Bearer ${token}`,
+			'Content-Type': 'application/json',
+		},
+		body: JSON.stringify({
+			lastNicknameUpdate,
+		}),
+	});
+	if (!response.ok) {
+		throw new Error("Error while trying to update users' discord nickname");
+	}
+
+	const data: NicknameUpdateResponseType = await response.json();
+	if (data?.data.unsuccessfulNicknameUpdates === 0) {
+		try {
+			await namespace.put('DISCORD_NICKNAME_UPDATED_TIME', Date.now().toString());
+		} catch (err) {
+			console.error('Error while trying to update the last nickname change timestamp');
+		}
+	}
+	return data;
+}
+
+export const addMissedUpdatesRole = async (env: env) => {
+	const MAX_ROLE_UPDATE = 25;
+	try {
+		let cursor: string | undefined = undefined;
+		for (let index = MAX_ROLE_UPDATE; index > 0; index--) {
+			if (index < MAX_ROLE_UPDATE && !cursor) break;
+
+			const missedUpdatesUsers = await getMissedUpdatesUsers(env, cursor);
+
+			if (!!missedUpdatesUsers && missedUpdatesUsers.usersToAddRole?.length > 1) {
+				const discordUserIdRoleIdList: DiscordUserRole[] = missedUpdatesUsers.usersToAddRole.map((userId) => ({
+					userid: userId,
+					roleid: config(env).MISSED_UPDATES_ROLE_ID,
+				}));
+
+				const discordUserRoleChunks = chunks(discordUserIdRoleIdList, MAX_ROLE_UPDATE);
+				for (const discordUserRoleList of discordUserRoleChunks) {
+					try {
+						await updateUserRoles(env, discordUserRoleList);
+					} catch (error) {
+						console.error('Error occurred while updating discord users', error);
+					}
+				}
+			}
+			cursor = missedUpdatesUsers?.cursor;
+		}
+	} catch (err) {
+		console.error('Error while adding missed updates roles');
+	}
+};

src/services/discordBotServices.ts

@@ -0,0 +1,27 @@
+import config from '../config/config';
+import { DiscordRoleUpdatedList, DiscordUserRole, env } from '../types/global.types';
+import { generateDiscordBotJwt } from '../utils/generateJwt';
+
+export const updateUserRoles = async (env: env, payload: DiscordUserRole[]): Promise<DiscordRoleUpdatedList> => {
+	try {
+		const url = config(env).DISCORD_BOT_API_URL;
+		const token = await generateDiscordBotJwt(env);
+
+		const response = await env.DISCORD_BOT.fetch(`${url}/roles?action=add-role`, {
+			method: 'POST',
+			headers: {
+				Authorization: `Bearer ${token}`,
+				'Content-Type': 'application/json',
+			},
+			body: JSON.stringify(payload),
+		});
+		if (!response.ok) {
+			throw Error(`Role Update failed with status: ${response.status}`);
+		}
+		const data: DiscordRoleUpdatedList = await response.json();
+		return data;
+	} catch (error) {
+		console.error('Error while updating discord user roles');
+		throw error;
+	}
+};

src/services/rdsBackendService.ts

@@ -0,0 +1,32 @@
+import config from '../config/config';
+import { DiscordUsersResponse, env } from '../types/global.types';
+import { generateJwt } from '../utils/generateJwt';
+
+export const getMissedUpdatesUsers = async (env: env, cursor: string | undefined) => {
+	try {
+		const baseUrl = config(env).RDS_BASE_API_URL;
+
+		const url = new URL(`${baseUrl}/tasks/users/discord`);
+		url.searchParams.append('q', 'status:missed-updates');
+		if (cursor) {
+			url.searchParams.append('cursor', cursor);
+		}
+		const token = await generateJwt(env);
+		const response = await fetch(url, {
+			method: 'GET',
+			headers: {
+				Authorization: `Bearer ${token}`,
+				'Content-Type': 'application/json',
+			},
+		});
+		if (!response.ok) {
+			throw new Error(`Fetch call to get user discord details failed with status: ${response.status}`);
+		}
+
+		const responseData: DiscordUsersResponse = await response.json();
+		return responseData?.data;
+	} catch (error) {
+		console.error('Error occurrent while fetching discord user details');
+		throw error;
+	}
+};