Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(api): add event #115

Merged
merged 7 commits into from
Feb 9, 2024
Merged

feat(api): add event #115

merged 7 commits into from
Feb 9, 2024

Conversation

rajdip-b
Copy link
Member

@rajdip-b rajdip-b commented Feb 8, 2024

User description

Features added

Event types

Events will be created on the following actions:

  • User updates their own profile
  • Workspace created
  • Workspace updated
  • Workspace ownership transferred
  • Workspace deleted
  • Workspace role created
  • Workspace role updated
  • Workspace role deleted
  • Workspace membership roles updated
  • Project created
  • Project deleted
  • Project updated
  • Environment created
  • Environment updated
  • Environment deleted
  • Secret created
  • Secret updated
  • Secret deleted
  • Api key added
  • Api key deleted
  • Api key updated
  • User invited to workspace
  • User removed from workspace
  • User leaves workspace
  • User rejects workspace invitation
  • User accepts workspace invitation

Services and controllers

  • Just one controller function to get a list of all the events, based on the type of event (check docs)

Type

Enhancement


Description

This PR adds event creation for various operations in the API. It introduces a new createEvent function in the common directory, which is used to create events for different types of operations. The following files have been modified:

  • api-key.service.ts: Added event creation for API key operations.
  • app.module.ts: Added EventModule to the app module.
  • create-event.ts: Added createEvent function for creating events.
  • get-secret-with-authority.ts: Added getSecretWithAuthority function for retrieving secrets with authority.
  • environment.service.ts: Added event creation for environment operations.
  • event.controller.spec.ts: Added unit test for EventController.
  • event.controller.ts: Added endpoint for getting events.
  • event.module.ts: Added EventModule.
  • event.service.spec.ts: Added unit test for EventService.
  • event.service.ts: Added event creation for event operations.
  • project.service.ts: Added event creation for project operations.
  • secret.service.ts: Added event creation for secret operations.
  • user.service.ts: Added event creation for user operations.
  • workspace-role.service.ts: Added event creation for workspace role operations.
  • workspace.service.ts: Added event creation for workspace operations.

Changes walkthrough

Relevant files
Enhancement
15 files
api-key.service.ts
Add event creation for API key operations                                           

apps/api/src/api-key/service/api-key.service.ts
Added event creation for API key operations

+46/-2   
app.module.ts
Add EventModule to app module                                                                   

apps/api/src/app/app.module.ts
Added EventModule to app module

+3/-1     
create-event.ts
Add createEvent function for creating events                                     

apps/api/src/common/create-event.ts
Added createEvent function for creating events

+155/-0 
get-secret-with-authority.ts
Add getSecretWithAuthority function for retrieving secrets with
authority

apps/api/src/common/get-secret-with-authority.ts
Added getSecretWithAuthority function for retrieving secrets with
authority

+56/-0   
environment.service.ts
Add event creation for environment operations                                   

apps/api/src/environment/service/environment.service.ts
Added event creation for environment operations

+66/-5   
event.controller.spec.ts
Add unit test for EventController                                                           

apps/api/src/event/controller/event.controller.spec.ts
Added unit test for EventController

+21/-0   
event.controller.ts
Add endpoint for getting events                                                               

apps/api/src/event/controller/event.controller.ts
Added endpoint for getting events

+46/-0   
event.module.ts
Add EventModule                                                                                               

apps/api/src/event/event.module.ts
Added EventModule

+9/-0     
event.service.spec.ts
Add unit test for EventService                                                                 

apps/api/src/event/service/event.service.spec.ts
Added unit test for EventService

+19/-0   
event.service.ts
Add event creation for event operations                                               

apps/api/src/event/service/event.service.ts
Added event creation for event operations

+107/-0 
project.service.ts
Add event creation for project operations                                           

apps/api/src/project/service/project.service.ts
Added event creation for project operations

+51/-1   
secret.service.ts
Add event creation for secret operations                                             

apps/api/src/secret/service/secret.service.ts
Added event creation for secret operations

+99/-69 
user.service.ts
Add event creation for user operations                                                 

apps/api/src/user/service/user.service.ts
Added event creation for user operations

+18/-2   
workspace-role.service.ts
Add event creation for workspace role operations                             

apps/api/src/workspace-role/service/workspace-role.service.ts
Added event creation for workspace role operations

+58/-2   
workspace.service.ts
Add event creation for workspace operations                                       

apps/api/src/workspace/service/workspace.service.ts
Added event creation for workspace operations

+205/-4 

✨ 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.

Copy link

nx-cloud bot commented Feb 8, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 00fe247. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 5 targets

Sent with 💌 from NxCloud.

Copy link

codecov bot commented Feb 8, 2024

Codecov Report

Attention: 152 lines in your changes are missing coverage. Please review.

Comparison is base (ae73e7a) 31.22% compared to head (a7e19dd) 52.97%.
Report is 12 commits behind head on develop.

❗ Current head a7e19dd differs from pull request most recent head 00fe247. Consider uploading reports for the commit 00fe247 to get more accurate results

Files Patch % Lines
apps/api/src/common/create-event.ts 40.74% 32 Missing ⚠️
apps/api/src/event/service/event.service.ts 27.27% 24 Missing ⚠️
...pps/api/src/workspace/service/workspace.service.ts 4.00% 24 Missing ⚠️
apps/api/src/secret/service/secret.service.ts 13.63% 19 Missing ⚠️
apps/api/src/auth/guard/auth/auth.guard.ts 65.78% 13 Missing ⚠️
apps/api/src/common/get-secret-with-authority.ts 26.66% 11 Missing ⚠️
...api/src/environment/service/environment.service.ts 18.18% 9 Missing ⚠️
apps/api/src/event/controller/event.controller.ts 64.28% 5 Missing ⚠️
apps/api/src/project/service/project.service.ts 20.00% 4 Missing ⚠️
apps/api/src/auth/controller/auth.controller.ts 57.14% 3 Missing ⚠️
... and 4 more
Additional details and impacted files
@@             Coverage Diff              @@
##           develop     #115       +/-   ##
============================================
+ Coverage    31.22%   52.97%   +21.74%     
============================================
  Files           54       78       +24     
  Lines         1156     1531      +375     
  Branches       210      268       +58     
============================================
+ Hits           361      811      +450     
+ Misses         795      720       -75     
Flag Coverage Δ
api-e2e-tests 51.87% <53.86%> (?)
api-unit-tests 31.76% <32.30%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rajdip-b rajdip-b changed the title Feat/event feat(api): add event Feb 8, 2024
@codiumai-pr-agent-free codiumai-pr-agent-free bot added the type: enhancement New feature or request label Feb 8, 2024
@codiumai-pr-agent-free codiumai-pr-agent-free bot changed the title feat(api): add event Feat/event Feb 8, 2024
Copy link
Contributor

PR Description updated to latest commit (a7e19dd)

Copy link
Contributor

codiumai-pr-agent-free bot commented Feb 8, 2024

PR Analysis

(review updated until commit b9a005a)

  • 🎯 Main theme: Adding event creation for various operations in the API
  • 📝 PR summary: This PR introduces event creation for various operations in the API. It adds a new createEvent function in the common directory, which is used to create events for different types of operations. The PR modifies several files to include event creation for operations like workspace creation, update, deletion, and others.
  • 📌 Type of PR: Enhancement
  • 🧪 Relevant tests added: False
  • ⏱️ Estimated effort to review [1-5]: 4, because the PR involves changes in multiple files and introduces a new functionality of event creation. It requires a thorough review to ensure that the event creation is correctly implemented for all operations and does not introduce any bugs or issues.
  • 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the code changes are logically organized. However, it would be beneficial to add error handling for the createEvent function to ensure that any issues during event creation do not disrupt the main operation. Also, consider adding tests to verify the correct working of the event creation functionality.

🤖 Code feedback:
relevant fileapps/api/src/workspace/service/workspace.service.ts
suggestion      

Consider wrapping the createEvent function calls in a try-catch block to handle any errors that might occur during event creation. This will ensure that the main operation (like workspace creation, update, etc.) is not disrupted if event creation fails for any reason. [important]

relevant line'+ createEvent('

relevant fileapps/api/src/common/create-event.ts
suggestion      

Consider adding input validation for the createEvent function to ensure that the input data is in the correct format and all required fields are present. This can help prevent issues due to incorrect or missing data. [medium]

relevant line'+export default async function createEvent('

relevant fileapps/api/src/secret/service/secret.service.ts
suggestion      

Consider adding a return type for the createSecret and updateSecret functions. This can improve code readability and make it easier to understand what these functions are expected to return. [medium]

relevant line'+ async createSecret(user: User, dto: CreateSecret, projectId: Project['id']) {'

relevant fileapps/api/src/environment/service/environment.service.ts
suggestion      

Consider adding a return type for the createEnvironment and updateEnvironment functions. This can improve code readability and make it easier to understand what these functions are expected to return. [medium]

relevant line'+ async createEnvironment(user: User, dto: CreateEnvironment, projectId: Project['id']) {'


✨ 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.

Auto-approve PRs

By invoking:

/review auto_approve

The tool will automatically approve the PR, and add a comment with the approval.

To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

[pr_reviewer]
enable_auto_approval = true

(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

[pr_reviewer]
maximal_review_effort = 5
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.

Copy link
Contributor

PR Code Suggestions

Suggestions                                                                                                                                                     
bug
Add error handling for the createEvent function call in the createWorkspace method.

Add error handling for the createEvent function call in the createWorkspace method.

apps/api/src/workspace/service/workspace.service.ts [108-121]

-createEvent(
-  {
-    triggeredBy: user,
-    entity: workspace,
-    type: EventType.WORKSPACE_CREATED,
-    source: EventSource.WORKSPACE,
-    title: `Workspace created`,
-    metadata: {
-      workspaceId: workspace.id,
-      name: workspace.name
-    }
-  },
-  this.prisma
-)
+try {
+  createEvent(
+    {
+      triggeredBy: user,
+      entity: workspace,
+      type: EventType.WORKSPACE_CREATED,
+      source: EventSource.WORKSPACE,
+      title: `Workspace created`,
+      metadata: {
+        workspaceId: workspace.id,
+        name: workspace.name
+      }
+    },
+    this.prisma
+  )
+} catch (error) {
+  this.logger.error(`Failed to create event for workspace ${workspace.name} (${workspace.id}): ${error}`)
+}
 
Add error handling for the createEvent function call in the updateWorkspace method.

Add error handling for the createEvent function call in the updateWorkspace method.

apps/api/src/workspace/service/workspace.service.ts [142-155]

-createEvent(
-  {
-    triggeredBy: user,
-    entity: workspace,
-    type: EventType.WORKSPACE_UPDATED,
-    source: EventSource.WORKSPACE,
-    title: `Workspace updated`,
-    metadata: {
-      workspaceId: workspace.id,
-      name: workspace.name
-    }
-  },
-  this.prisma
-)
+try {
+  createEvent(
+    {
+      triggeredBy: user,
+      entity: workspace,
+      type: EventType.WORKSPACE_UPDATED,
+      source: EventSource.WORKSPACE,
+      title: `Workspace updated`,
+      metadata: {
+        workspaceId: workspace.id,
+        name: workspace.name
+      }
+    },
+    this.prisma
+  )
+} catch (error) {
+  this.logger.error(`Failed to create event for workspace ${workspace.name} (${workspace.id}): ${error}`)
+}
 
Add error handling for the createEvent function call in the transferOwnership method.

Add error handling for the createEvent function call in the transferOwnership method.

apps/api/src/workspace/service/workspace.service.ts [248-261]

-createEvent(
-  {
-    triggeredBy: user,
-    entity: workspace,
-    type: EventType.WORKSPACE_TRANSFERRED,
-    source: EventSource.WORKSPACE,
-    title: `Workspace transferred`,
-    metadata: {
-      workspaceId: workspace.id,
-      name: workspace.name,
-      newOwnerId: userId
-    }
-  },
-  this.prisma
-)
+try {
+  createEvent(
+    {
+      triggeredBy: user,
+      entity: workspace,
+      type: EventType.WORKSPACE_TRANSFERRED,
+      source: EventSource.WORKSPACE,
+      title: `Workspace transferred`,
+      metadata: {
+        workspaceId: workspace.id,
+        name: workspace.name,
+        newOwnerId: userId
+      }
+    },
+    this.prisma
+  )
+} catch (error) {
+  this.logger.error(`Failed to create event for workspace ${workspace.name} (${workspace.id}): ${error}`)
+}
 
Add error handling for the createEvent function in the updateUser method of the UserService class.

Add error handling for the createEvent function

apps/api/src/user/service/user.service.ts [44-55]

-createEvent(
-  {
-    title: 'User updated',
-    type: EventType.USER_UPDATED,
-    triggeredBy: user,
-    source: EventSource.USER,
-    metadata: {
-      userId: user.id
-    }
-  },
-  this.prisma
-)
+try {
+  createEvent(
+    {
+      title: 'User updated',
+      type: EventType.USER_UPDATED,
+      triggeredBy: user,
+      source: EventSource.USER,
+      metadata: {
+        userId: user.id
+      }
+    },
+    this.prisma
+  )
+} catch (error) {
+  // Handle the error here
+  console.error('Failed to create event:', error)
+}
 
Add error handling for the getSecretWithAuthority function in the getSecretWithAuthority file.

Add error handling for the getSecretWithAuthority function

apps/api/src/common/get-secret-with-authority.ts [7-29]

 export default async function getSecretWithAuthority(
   userId: User['id'],
   secretId: Secret['id'],
   authority: Authority,
   prisma: PrismaClient
 ): Promise<SecretWithProjectAndVersion> {
-  // Fetch the secret
-  const secret = await prisma.secret.findUnique({
-    where: {
-      id: secretId
-    },
-    include: {
-      versions: true,
-      project: {
-        include: {
-          workspace: {
-            include: {
-              members: true
+  try {
+    // Fetch the secret
+    const secret = await prisma.secret.findUnique({
+      where: {
+        id: secretId
+      },
+      include: {
+        versions: true,
+        project: {
+          include: {
+            workspace: {
+              include: {
+                members: true
+              }
             }
           }
         }
       }
-    }
-  })
-  // ...
+    })
+    // ...
+  } catch (error) {
+    // Handle the error here
+    console.error('Failed to fetch secret:', error)
+    throw error
+  }
 }
 
Add validation for the severity query parameter in the getEvents method of the EventController class.

Add validation for the severity query parameter in the getEvents method

apps/api/src/event/controller/event.controller.ts [15-44]

 @Get()
 @RequiredApiKeyAuthorities(Authority.READ_EVENT)
 async getEvents(
   @CurrentUser() user: User,
   @Query('page') page: number = 1,
   @Query('limit') limit: number = 10,
   @Query('search') search: string = '',
-  @Query('severity') severity: EventSeverity,
+  @Query('severity') severity: EventSeverity | undefined, // Add validation for the severity query parameter
   @Query('workspaceId') workspaceId: string,
   @Query('projectId') projectId: string,
   @Query('environmentId') environmentId: string,
   @Query('secretId') secretId: string,
   @Query('apiKeyId') apiKeyId: string,
   @Query('workspaceRoleId') workspaceRoleId: string,
   @Query('workspaceMemberId') workspaceMemberId: string
 ) {
+  if (severity && !Object.values(EventSeverity).includes(severity)) {
+    throw new BadRequestException('Invalid severity value')
+  }
   // ...
 }
 
best practice
Use the workspace variable directly instead of fetching it again in the updateWorkspace method.

Use the workspace variable directly instead of fetching it again in the updateWorkspace
method.

apps/api/src/workspace/service/workspace.service.ts [131]

-let workspace = await getWorkspaceWithAuthority(
+const workspace = await getWorkspaceWithAuthority(
   user.id,
   workspaceId,
   Authority.UPDATE_WORKSPACE,
   this.prisma
 )
 
Use the workspace variable directly instead of fetching it again in the transferOwnership method.

Use the workspace variable directly instead of fetching it again in the transferOwnership
method.

apps/api/src/workspace/service/workspace.service.ts [225]

-const workspace = await this.prisma.workspace.findUnique({
-  where: {
-    id: workspaceId
-  }
-})
+const workspace = await getWorkspaceWithAuthority(
+  user.id,
+  workspaceId,
+  Authority.TRANSFER_OWNERSHIP,
+  this.prisma
+)
 
Use optional chaining (?.) to safely access properties that may be undefined or null.

Consider using optional chaining (?.) when accessing properties that may be undefined or
null.

apps/api/src/common/create-event.ts [43-55]

 const baseData = {
-  triggerer: data.triggerer ? data.triggerer : EventTriggerer.USER,
-  severity: data.severity ? data.severity : EventSeverity.INFO,
+  triggerer: data.triggerer ?? EventTriggerer.USER,
+  severity: data.severity ?? EventSeverity.INFO,
   type: data.type,
   source: data.source,
   title: data.title,
   description: data.description,
   metadata: data.metadata,
   sourceUser: {
     connect: {
-      id: data.triggeredBy.id
+      id: data.triggeredBy?.id
     }
   }
 }
 
enhancement
Add a return type annotation to the createEnvironment function. 

Add a return type annotation to the createEnvironment function.

apps/api/src/environment/service/environment.service.ts [18]

 export default async function createEnvironment(
   ...
-) {
+): Promise<Environment> {
 
Add a return type annotation to the createWorkspaceRole function.

Add a return type annotation to the createWorkspaceRole function.

apps/api/src/workspace-role/service/workspace-role.service.ts [18]

 async createWorkspaceRole(
   ...
-) {
+): Promise<WorkspaceRole> {
 
Import the EventModule in the AppModule to make it available for use.

Import the EventModule in the AppModule

apps/api/src/app/app.module.ts [19]

 import { WorkspaceRoleModule } from '../workspace-role/workspace-role.module'
+import { EventModule } from '../event/event.module' // Import the EventModule
 

✨ 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 rajdip-b changed the title Feat/event api(feat): add event Feb 8, 2024
@rajdip-b rajdip-b changed the title api(feat): add event feat(api): add event Feb 8, 2024
@rajdip-b
Copy link
Member Author

rajdip-b commented Feb 9, 2024

/review

Copy link
Contributor

Persistent review updated to latest commit b9a005a

Copy link

sonarqubecloud bot commented Feb 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

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

See analysis details on SonarCloud

@rajdip-b rajdip-b merged commit 19e6603 into develop Feb 9, 2024
8 checks passed
@rajdip-b rajdip-b deleted the feat/event branch February 9, 2024 12:02
rajdip-b pushed a commit that referenced this pull request Feb 12, 2024
## [1.1.0](v1.0.0...v1.1.0) (2024-02-12)

### 🚀 Features

* **api:** add event ([#115](#115)) ([19e6603](19e6603))

### 🔧 Miscellaneous Chores

* **ci:** CI rework ([788c141](788c141))
* **ci:** update CI of web and API ([bd171da](bd171da))
* **husky:** Update precommit ([b170cf3](b170cf3))
* migrate from supabase to postgresql ([#129](#129)) ([e1ff912](e1ff912))
* update CI ([32eb820](32eb820))
* Update release config in package.json ([71c75a7](71c75a7))
* **version:** Upgrade next from 14.0.4 to 14.1.0 ([#136](#136)) ([c958865](c958865))
* **version:** Upgrade reflect-metadata from 0.1.14 to 0.2.1 ([#137](#137)) ([574b6ce](574b6ce))
@rajdip-b
Copy link
Member Author

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant