Discord slash command code to grant AWS access #276

vikhyat187 · 2024-10-19T10:49:51Z

Date: 19th Oct

Developer Name: Vikhyat

Issue Ticket Number

Description

This change is for the discord command to grant AWS access to the developers, we can tag the developer and the group we wanted to add the user in.

Documentation Updated?

Yes
[ X ] No

Under Feature Flag

Yes
[ X ] No

Database Changes

Yes
[ X ] No

Breaking Changes

Yes
[ X ] No

Development Tested?

[ X ] Yes
No

Screenshots

Here I've ran the discord command and the user and the AWS group has been specified, it checks if the user is part of the AWS account if not, adds the user to the account and then to the AWS IAM group.

This is the screen which the user will see on trying to access the AWS link and they should reset their password by using the password sent to their email. (Emails are taken from our Firestore db)

Test Coverage

Screenshot 1

Writing the test cases will push the changes in the same PR

## Additional Notes

We will have to create the groups in our AWS account and then store those values in our discord service before registering the command.
We will have to create IAM access and secret keys and store them in the website backend PR - Added AWS config and identity store website-backend#2208

vikhyat187 · 2024-10-19T10:53:36Z

package.json

@@ -15,7 +15,7 @@
    "format-fix": "prettier --write .",
    "fix": "npm run lint-fix && npm run format-fix",
    "ngrok": "ngrok http 8787",
-    "register": "ts-node-esm src/register.ts"
+    "register": "npx ts-node src/register.ts"


Fixed this command as this is causing problem in local development.

Grant aws access - test cases

Grant aws access

prakashchoudhary07 · 2024-10-23T21:08:59Z

src/utils/awsAccess.ts

+    if (!response.ok) {
+      return fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${env.DISCORD_TOKEN}`,
+        },
+        body: JSON.stringify({
+          content: `<@${discordUserId}> Error occurred while granting AWS access: ${response.status} ${response.statusText}`,
+        }),
+      });
+    } else {
+      return fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${env.DISCORD_TOKEN}`,
+        },
+        body: JSON.stringify({
+          content: `AWS access granted successfully <@${discordUserId}>! Please head over to AWS - ${AWS_IAM_SIGNIN_URL}.`,
+        }),
+      });
+    }


Generate message based on condition and write API call code only once

updated this

prakashchoudhary07 · 2024-10-23T21:09:39Z

src/utils/awsAccess.ts

+    return fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${env.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify({
+        content: `[TraceId: ${TraceId}] <@${discordUserId}> Error occurred while granting AWS access.`,
+      }),
+    });


This also, same comment as above

updated this code, please check

src/utils/awsAccess.ts

prakashchoudhary07 · 2024-10-23T21:12:05Z

src/constants/commands.ts

+        {
+          name: "S3 read only access",
+          value: process.env.S3_READ_ONLY_ACCESS_AWS_GROUP_ID,
+        },


We will never do this, I think

Yeah these have to be replaced with actual values

prakashchoudhary07 · 2024-10-23T21:12:29Z

src/constants/commands.ts

+        {
+          name: "EC2 deployment access",
+          value: process.env.EC2_DEPLOYMENT_ACCESS_AWS_GROUP_ID,
+        },
+        {
+          name: "DDB read only access",
+          value: process.env.DDB_READ_ONLY_ACCESS_AWS_GROUP_ID,
+        },
+      ],


Please add some valid once here

prakashchoudhary07 · 2024-10-23T21:13:57Z

src/utils/awsAccess.ts

+  channelId: number
+) {
+  const authToken = await jwt.sign(
+    { name: "Cloudflare Worker", exp: Math.floor(Date.now() / 1000) + 2 },


What is the name here?

in the website backend, we check if the auth token has the name "cloudfare workers" to validate the token coming from right source.

Ref : https://github.com/Real-Dev-Squad/website-backend/blob/f8d76e1936647759ef7fdfd513f7ff03de226346/middlewares/authorizeBot.js#L18

how is a string helping in validating the right source?

So we create a token in the discord slash commands with name present in payload, this is signed by using the private key and in website backend we validate if the same text is being received post validating the token.
@prakashchoudhary07

I think we need to discuss on this one

sure @prakashchoudhary07

prakashchoudhary07 · 2024-10-23T21:14:29Z

src/utils/awsAccess.ts

+  TraceId: string,
+  channelId: number
+) {
+  const authToken = await jwt.sign(


Don't we already have this? why write it again?

didn't get this comment, we are using this in similar manner in one of the other API too.

So at every place we are manually signing, So don't already have a common thing to do this, if not then please create one?

Have created a common utility for this.

prakashchoudhary07 · 2024-10-23T21:15:45Z

src/utils/awsAccess.ts

+      userId: discordUserId,
+    };
+
+    const url = `${base_url}/aws-access/`;


Can you create the URL in constant it self?

And please share the doc for using it herE?

do we mean it like
const url = ${base_url}/aws-access this way we have it stored?

Didn't get this which doc?

And please share the doc for using it herE?

Please share the AWS API docs like, of what they are doing?

This is our website backend API, will add the comments there.

This reverts commit b54d9c3.

Grant aws access

correcting package.json file

prakashchoudhary07 · 2024-10-31T19:16:24Z

src/utils/awsAccess.ts

+    await fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${env.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify({
+        content: content,
+      }),
+    });
+  } catch (err) {
+    const content = `<@${discordUserId}> Error occurred while granting AWS access.`;
+    await fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${env.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify({
+        content: content,
+      }),
+    });
+  }
+}


RE: as same, please refactor this. Also please maintain a separate constant for URL's

done updated

prakashchoudhary07 · 2024-10-31T19:19:49Z

src/utils/awsAccess.ts

+      userId: discordUserId,
+    };
+
+    const url = `${base_url}/aws-access`;


Please move the URL to a separate constant sir

Also please name it more appropriately

Have created as a constant in the same file as we can use the base URL depending on the env as per config

Discord slash command code to grant AWS access

fff804c

vikhyat187 self-assigned this Oct 19, 2024

Merge branch 'develop' into grant-aws-access

0421825

vikhyat187 commented Oct 19, 2024

View reviewed changes

vikhyat187 and others added 8 commits October 19, 2024 23:03

added test cases for the discord command

f3d33e3

Merge branch 'Real-Dev-Squad:grant-aws-access' into grant-aws-access

50579bf

Merge pull request #277 from vikhyat187/grant-aws-access

87a08d7

Grant aws access - test cases

Merge branch 'develop' into grant-aws-access

b9e8d03

added uuid as types

9a958f6

Merge branch 'Real-Dev-Squad:grant-aws-access' into grant-aws-access

7433c40

Merge pull request #278 from vikhyat187/grant-aws-access

90f46f4

Grant aws access

Merge branch 'develop' into grant-aws-access

4b218f0

prakashchoudhary07 reviewed Oct 23, 2024

View reviewed changes

src/utils/awsAccess.ts Outdated Show resolved Hide resolved

prakashchoudhary07 reviewed Oct 23, 2024

View reviewed changes

vinit717 and others added 10 commits October 25, 2024 21:55

Revert "remove feature flag (#275)" (#281)

725e491

This reverts commit b54d9c3.

removed uuid, code refactoring and fixed test cases post changes

0d5a3fd

Merge branch 'Real-Dev-Squad:grant-aws-access' into grant-aws-access

7130af6

Merge pull request #283 from vikhyat187/grant-aws-access

49f45f0

Grant aws access

correcting package.json file

75875f6

Merge pull request #284 from vikhyat187/grant-aws-access

fa37aa3

correcting package.json file

lint fix

fb649cf

code refactoring to call the API outside if/else

fd71a85

Updated the command options to valid one

89a8350

fix test cases

fddc63a

vikhyat187 added 2 commits October 29, 2024 21:39

Fixing test case - changing the return type to Promise<void>

2bc33d0

lint fix

a9f8156

prakashchoudhary07 reviewed Oct 31, 2024

View reviewed changes

vikhyat187 added 2 commits November 1, 2024 21:45

Updated the logic of signing JWT into seperate file

ef03bd0

added documentation for website backend API

1ebb5f2

vikhyat187 requested a review from joyguptaa November 3, 2024 06:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Discord slash command code to grant AWS access #276

Discord slash command code to grant AWS access #276

vikhyat187 commented Oct 19, 2024 •

edited

Loading

vikhyat187 Oct 19, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 25, 2024

vikhyat187 Oct 25, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 25, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 24, 2024

prakashchoudhary07 Oct 23, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 31, 2024 •

edited

Loading

prakashchoudhary07 Oct 31, 2024

vikhyat187 Nov 1, 2024

prakashchoudhary07 Nov 2, 2024

vikhyat187 Nov 2, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 25, 2024

prakashchoudhary07 Oct 31, 2024

vikhyat187 Nov 1, 2024

prakashchoudhary07 Oct 23, 2024

prakashchoudhary07 Oct 23, 2024

vikhyat187 Oct 25, 2024

vikhyat187 Oct 25, 2024

prakashchoudhary07 Nov 2, 2024

vikhyat187 Nov 2, 2024

prakashchoudhary07 Oct 31, 2024

vikhyat187 Nov 1, 2024

prakashchoudhary07 Oct 31, 2024

prakashchoudhary07 Oct 31, 2024

vikhyat187 Nov 1, 2024

Discord slash command code to grant AWS access #276

Are you sure you want to change the base?

Discord slash command code to grant AWS access #276

Conversation

vikhyat187 commented Oct 19, 2024 • edited Loading

Issue Ticket Number

Description

Documentation Updated?

Under Feature Flag

Database Changes

Breaking Changes

Development Tested?

Screenshots

Test Coverage

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vikhyat187 Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vikhyat187 commented Oct 19, 2024 •

edited

Loading

vikhyat187 Oct 31, 2024 •

edited

Loading