feat(api): add GitHub oauth #98

HarshPatel5940 · 2024-01-28T10:01:41Z

User description

Description

This pull request adds GitHub OAuth functionality to the application. It includes the following commits:

feat(oauth): add github oauth
need to work on todo's
chore: resolve comments
chore: rename file
feat(oauth): get 'name' and 'avatar' of the user
this for github oauth

The changes include adding the necessary configuration for GitHub OAuth, implementing the GitHubStrategy, and adding the necessary routes for GitHub OAuth login and callback.

Fixes #3

Dependencies

passport
passport-github2
passport-jwt

Mentions

@rajdip-b

Developer's checklist

My PR follows the style guidelines of this project
I have performed a self-check on my work
I have followed the coding guidelines
My changes in code generate no new warnings
My changes are breaking another fix/feature of the project
I have added test cases to show that my feature works
I have added relevant screenshots in my PR
There are no UI/UX issues

Documentation Update

This PR requires an update to the documentation at docs.keyshade.xyz
I have made the necessary updates to the documentation, or no documentation changes are required.

Type

Enhancement

Description

This PR adds Github OAuth functionality to the application.
It includes the necessary configuration for Github OAuth, implementation of the GithubStrategy, and addition of necessary routes for Github OAuth login and callback.
The AuthService has been refactored to include the name and profile picture in the createUserIfNotExists method.
A new method handleGithubOAuth has been added to handle Github OAuth.
New environment variables for Github OAuth have been added to the .env.example file.
New dependencies for passport and passport-github2 have been added.

Changes walkthrough

Relevant files

Configuration changes

auth.module.ts `Added GithubStrategy to AuthModule providers` apps/api/src/auth/auth.module.ts Added `GithubStrategy` to the providers in the `AuthModule`.	+2/-1
.env.example `Added Github OAuth environment variables` .env.example Added new environment variables for Github OAuth.	+5/-0

Enhancement

auth.controller.ts `Added Github OAuth endpoints and logic` apps/api/src/auth/controller/auth.controller.ts Added new endpoints for Github OAuth login and callback. Implemented the logic for Github OAuth login and callback.	+56/-1
github.stratergy.ts `Implemented GithubStrategy for passport authentication` apps/api/src/auth/github.stratergy.ts Created a new file `github.stratergy.ts`. Implemented GithubStrategy for passport authentication.	+20/-0
auth.service.ts `Refactored and added new methods in AuthService` apps/api/src/auth/service/auth.service.ts Refactored `createUserIfNotExists` method to include name and profile picture. Added `handleGithubOAuth` method to handle Github OAuth.	+41/-11

Dependencies

package.json `Added new dependencies` package.json Added new dependencies for passport and passport-github2.	+2/-0
pnpm-lock.yaml `Updated lock file with new dependencies` pnpm-lock.yaml Updated the lock file with new dependencies.	+37/-6

✨ Usage guide:

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: `pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...]` meaning the `describe` tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: `pr_commands = ["/describe --pr_description.use_description_markers=true", ...]` the tool will replace every marker of the form `pr_agent:marker_name` in the PR description with the relevant content, where `marker_name` is one of the following: `type`: the PR type. `summary`: the PR summary. `walkthrough`: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels The default labels of the `describe` tool are quite generic: [`Bug fix`, `Tests`, `Enhancement`, `Documentation`, `Other`]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: `Main topic:performance` - pr_agent:The main topic of this PR is performance `New endpoint` - pr_agent:A new endpoint was added in this PR `SQL query` - pr_agent:A new SQL query was added in this PR `Dockerfile changes` - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎 For enhanced user experience, the `describe` tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are: `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. `false` (default): File changes walkthrough will be added only to the "Conversation" tab.
Utilizing extra instructions The `describe` tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: `[pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

* need to work on todo's

sonarqubecloud · 2024-01-28T10:02:15Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

3 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

HarshPatel5940 · 2024-01-28T10:02:27Z

I will update the description and other Stuff, as soon as time permits.

apps/api/src/auth/auth.stratergy.ts

apps/api/src/auth/controller/auth.controller.ts

apps/api/src/auth/service/auth.service.ts

* this for github oauth

codiumai-pr-agent-free · 2024-01-28T10:47:37Z

PR Description updated to latest commit (76dba70)

codiumai-pr-agent-free · 2024-01-28T10:47:56Z

PR Analysis

(review updated until commit `63da386`)

🎯 Main theme: Adding GitHub OAuth functionality to the application.
📝 PR summary: This PR introduces GitHub OAuth functionality to the application. It includes the necessary configuration for GitHub OAuth, implementation of the GitHubStrategy, and addition of necessary routes for GitHub OAuth login and callback. The AuthService has been refactored to include the name and profile picture in the createUserIfNotExists method.
📌 Type of PR: Enhancement
🧪 Relevant tests added: No
⏱️ Estimated effort to review [1-5]: 3, because the PR includes changes in multiple files and introduces new functionality which requires understanding of the existing authentication system and the new OAuth flow. However, the code is well-structured and follows good practices, which makes it easier to review.
🔒 Security concerns: Yes, because the PR introduces new functionality that interacts with a third-party service (GitHub), which could potentially expose sensitive information if not handled correctly. However, from the provided code, it seems that the implementation follows good security practices. It's important to ensure that the GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET, and GITHUB_CALLBACK_URL environment variables are stored securely and not exposed.

PR Feedback

💡 General suggestions: The PR is generally well-structured and follows good practices. However, it would be beneficial to add tests to ensure the new functionality works as expected and does not introduce regressions. Also, it would be good to handle potential errors in the new OAuth flow, for example when the GitHub API does not return expected data.

🤖 Code feedback:

relevant file	apps/api/src/auth/controller/auth.controller.ts
suggestion	It would be good to handle potential errors in the OAuth flow. For example, if the GitHub API does not return expected data (e.g., emails or photos), the application could crash. You could add checks for the existence of these properties and throw a meaningful error if they are not present. [important]
relevant line	const { emails, displayName: name, photos } = req.user

relevant file	apps/api/src/auth/service/auth.service.ts
suggestion	The `handleGithubOAuth` method could be improved by adding error handling. For example, if the `createUserIfNotExists` method fails for some reason, the application could crash. You could add a try-catch block around the call to `createUserIfNotExists` and throw a meaningful error if it fails. [important]
relevant line	const user = await this.createUserIfNotExists(

relevant file	apps/api/src/auth/github.stratergy.ts
suggestion	The `validate` method in the `GithubStrategy` class could be improved by adding error handling. For example, if the `profile` argument is not as expected, the application could crash. You could add checks for the existence of necessary properties in the `profile` argument and throw a meaningful error if they are not present. [medium]
relevant line	async validate(accessToken: string, _refreshToken: string, profile: Profile) {

✨ Usage guide:

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The `review` tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: `[pr_reviewer] # /review # extra_instructions=""" In the 'general suggestions' section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation When you first install PR-Agent app, the default mode for the `review` tool is: `pr_commands = ["/review", ...]` meaning the `review` tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels The `review` tool can auto-generate two specific types of labels for a PR: a `possible security issue` label, that detects possible security issues (`enable_review_labels_security` flag) a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag)
Extra sub-tools The `review` tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: `require_score_review`, `require_soc2_ticket`, and more.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

codiumai-pr-agent-free · 2024-01-28T10:48:51Z

PR Code Suggestions

Suggestions

enhancement

Add a return statement to the `githubOAuthLogin` function. The `githubOAuthLogin` function is currently empty and only serves as a placeholder for the `AuthGuard`. However, it would be beneficial to add a return statement that provides a `<br>` meaningful `<br>` response `<br>` when `<br>` the `<br>` function `<br>` is `<br>` called. `<br>` This `<br>` could `<br>` be `<br>` a `<br>` simple `<br>` message `<br>` indicating `<br>` that `<br>` the `<br>` function `<br>` has `<br>` been `<br>` called `<br>` successfully. apps/api/src/auth/controller/auth.controller.ts [93-98] async githubOAuthLogin() { /** * NOTE: * This function does nothing and the oauth redirect is managed my AuthGuard * - The 'github' method inside the authguard is managed by passport */ + return { message: 'Github OAuth login initiated.' }; }

maintainability

Separate token generation into a new function in the AuthService.

The handleGithubOAuth function currently directly returns the user object along with the
token. It would be better to separate the concerns by creating a separate function to
generate the token. This would make the code more maintainable and easier to test.

apps/api/src/auth/service/auth.service.ts [141-156]

 async handleGithubOAuth(
   email: string,
   name: string,
   profilePictureUrl: string
 ) {
   // We need to create the user if it doesn't exist yet
   const user = await this.createUserIfNotExists(
     email,
     name,
     profilePictureUrl
   )
 
+  const token = await this.generateToken(user.id);
   return {
     ...user,
-    token: await this.jwt.signAsync({ id: user.id })
+    token
   }
 }
 
+async generateToken(userId: string) {
+  return await this.jwt.signAsync({ id: userId });
+}
+

Separate user creation into a new function in the AuthService.

The createUserIfNotExists function currently directly creates a user if it doesn't
exist. It would be better to separate the concerns by creating a separate function to
create the user. This would make the code more maintainable and easier to test.

apps/api/src/auth/service/auth.service.ts [33-50]

 private async createUserIfNotExists(
   email: string,
   name?: string,
   profilePictureUrl?: string
 ) {
   let user = await this.findUserByEmail(email)
 
   // We need to create the user if it doesn't exist yet
   if (!user) {
     // Create the user
-    user = await this.prisma.user.create({
-      data: {
-        email,
-        name,
-        profilePictureUrl
-      }
-    })
+    user = await this.createUser(email, name, profilePictureUrl);
   }
   return user
 }
 
+private async createUser(
+  email: string,
+  name?: string,
+  profilePictureUrl?: string
+) {
+  return await this.prisma.user.create({
+    data: {
+      email,
+      name,
+      profilePictureUrl
+    }
+  });
+}
+

best practice

Use destructuring to retrieve configuration values in the GithubStrategy constructor.

The GithubStrategy class currently uses configService.get<string> to retrieve
configuration values. While this works, it would be better to use destructuring to
retrieve these values. This would make the code cleaner and easier to read.

apps/api/src/auth/github.stratergy.ts [8-14]

 constructor(configService: ConfigService) {
+  const clientID = configService.get<string>('GITHUB_CLIENT_ID');
+  const clientSecret = configService.get<string>('GITHUB_CLIENT_SECRET');
+  const callbackURL = configService.get<string>('GITHUB_CALLBACK_URL');
+
   super({
-    clientID: configService.get<string>('GITHUB_CLIENT_ID'),
-    clientSecret: configService.get<string>('GITHUB_CLIENT_SECRET'),
-    callbackURL: configService.get<string>('GITHUB_CALLBACK_URL'),
+    clientID,
+    clientSecret,
+    callbackURL,
     scope: ['public_profile', 'user:email']
   })
 }

✨ Usage guide:

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: `pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]` meaning the `improve` tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions Extra instructions are very important for the `improve` tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on. Examples for extra instructions: `[pr_code_suggestions] # /improve # extra_instructions=""" Emphasize the following aspects: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically. Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.

rajdip-b

Awesome work on this!!

HarshPatel5940 · 2024-01-28T11:06:02Z

Just wait a min before merge

rajdip-b · 2024-01-28T11:06:29Z

@HarshPatel5940 sure

rajdip-b · 2024-01-28T11:06:41Z

/review

codiumai-pr-agent-free · 2024-01-28T11:07:13Z

Persistent review updated to latest commit 63da386

sonarqubecloud · 2024-01-28T11:09:03Z

Quality Gate passed

The SonarCloud Quality Gate passed, but some issues were introduced.

1 New issue
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

HarshPatel5940 · 2024-01-28T11:09:49Z

@rajdip-b with the latest commit i have implemented suggestions given by the workflows.

rajdip-b · 2024-01-28T11:10:04Z

@HarshPatel5940 mind telling me what the last commit did? I can't figure out much

rajdip-b · 2024-01-28T11:11:14Z

@rajdip-b with the latest commit i have implemented suggestions given by the workflows.

thats awesome!

rajdip-b · 2024-02-02T18:01:25Z

🎉 This PR is included in version 1.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

rajdip-b · 2024-02-09T06:19:24Z

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

feat(oauth): add github oauth

f7379e2

* need to work on todo's

rajdip-b requested changes Jan 28, 2024

View reviewed changes

apps/api/src/auth/auth.stratergy.ts Outdated Show resolved Hide resolved

apps/api/src/auth/controller/auth.controller.ts Outdated Show resolved Hide resolved

apps/api/src/auth/service/auth.service.ts Outdated Show resolved Hide resolved

rajdip-b changed the title ~~feat(oauth): add github oauth~~ feat(api): add GitHub oauth Jan 28, 2024

HarshPatel5940 added 3 commits January 28, 2024 15:54

chore: resolve comments

768530a

chore: rename file

1bde784

feat(oauth): get 'name' and 'avatar' of the user

76dba70

* this for github oauth

HarshPatel5940 marked this pull request as ready for review January 28, 2024 10:47

HarshPatel5940 requested a review from rajdip-b January 28, 2024 10:47

codiumai-pr-agent-free bot added the type: enhancement New feature or request label Jan 28, 2024

codiumai-pr-agent-free bot added the Review effort [1-5]: 3 label Jan 28, 2024

chore: remove unused import

63da386

rajdip-b approved these changes Jan 28, 2024

View reviewed changes

codiumai-pr-agent-free bot added the Possible security concern label Jan 28, 2024

refactor: service functions as suggested

52bf64b

rajdip-b approved these changes Jan 28, 2024

View reviewed changes

rajdip-b added the type: feature Release drafter tag for tagging PRs related to adding new features label Jan 28, 2024

rajdip-b merged commit c1ae78a into keyshade-xyz:main Jan 28, 2024
4 checks passed

HarshPatel5940 deleted the hp/feat/add-github-auth branch January 28, 2024 11:12

rajdip-b added the released on @alpha label Feb 2, 2024

rajdip-b added the released label Feb 9, 2024

rajdip-b mentioned this pull request Feb 26, 2024

[User] Log in using Google #4

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): add GitHub oauth #98

feat(api): add GitHub oauth #98

HarshPatel5940 commented Jan 28, 2024 •

edited by codiumai-pr-agent-free bot

Loading

sonarqubecloud bot commented Jan 28, 2024

HarshPatel5940 commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024 •

edited

Loading

codiumai-pr-agent-free bot commented Jan 28, 2024

rajdip-b left a comment

HarshPatel5940 commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024

sonarqubecloud bot commented Jan 28, 2024

HarshPatel5940 commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Feb 2, 2024

rajdip-b commented Feb 9, 2024

feat(api): add GitHub oauth #98

feat(api): add GitHub oauth #98

Conversation

HarshPatel5940 commented Jan 28, 2024 • edited by codiumai-pr-agent-free bot Loading

User description

Description

Dependencies

Mentions

Developer's checklist

Documentation Update

Type

Description

Changes walkthrough

sonarqubecloud bot commented Jan 28, 2024

Quality Gate passed

HarshPatel5940 commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024 • edited Loading

PR Analysis

(review updated until commit 63da386)

PR Feedback

codiumai-pr-agent-free bot commented Jan 28, 2024

PR Code Suggestions

rajdip-b left a comment

Choose a reason for hiding this comment

HarshPatel5940 commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

codiumai-pr-agent-free bot commented Jan 28, 2024

sonarqubecloud bot commented Jan 28, 2024

Quality Gate passed

HarshPatel5940 commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Jan 28, 2024

rajdip-b commented Feb 2, 2024

rajdip-b commented Feb 9, 2024

HarshPatel5940 commented Jan 28, 2024 •

edited by codiumai-pr-agent-free bot

Loading

codiumai-pr-agent-free bot commented Jan 28, 2024 •

edited

Loading

(review updated until commit `63da386`)