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 feature to export data of a workspace #152

Merged
merged 1 commit into from
Feb 22, 2024

Conversation

rajdip-b
Copy link
Member

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

User description

Fixes #128


Type

enhancement, tests


Description

  • Added functionality to export data of a workspace including details, roles, projects, environments, variables, and secrets.
  • Refactored environmentId field in CreateSecret and CreateVariable DTOs from number to string.
  • Introduced a new endpoint :workspaceId/export-data in WorkspaceController with WORKSPACE_ADMIN authority requirement.
  • Implemented exportData method in WorkspaceService to support the data export feature.
  • Added comprehensive e2e tests to validate the new export data functionality, including checks for unauthorized access and successful data export.

Changes walkthrough

Relevant files
Enhancement
create.secret.ts
Refactor environmentId to Use String Validator in CreateSecret DTO

apps/api/src/secret/dto/create.secret/create.secret.ts

  • Removed IsNumber import and validator from environmentId.
  • Changed environmentId validator from IsNumber to IsString.
  • +2/-2     
    create.variable.ts
    Refactor environmentId to Use String Validator in CreateVariable DTO

    apps/api/src/variable/dto/create.variable/create.variable.ts

  • Removed IsNumber import and validator from environmentId.
  • Changed environmentId validator from IsNumber to IsString.
  • +2/-2     
    workspace.controller.ts
    Add Export Data Endpoint to Workspace Controller                 

    apps/api/src/workspace/controller/workspace.controller.ts

  • Added a new endpoint :workspaceId/export-data to export data of a
    workspace.
  • Required WORKSPACE_ADMIN authority for accessing the export data
    endpoint.
  • +9/-0     
    workspace.service.ts
    Implement Export Data Functionality in Workspace Service 

    apps/api/src/workspace/service/workspace.service.ts

  • Implemented exportData method to gather and return workspace data.
  • Data includes workspace details, roles, projects, environments,
    variables, and secrets.
  • +83/-0   
    Tests
    workspace.e2e.spec.ts
    Add E2E Tests for Workspace Data Export Functionality       

    apps/api/src/workspace/workspace.e2e.spec.ts

  • Added e2e tests for the new export data functionality.
  • Tests cover unauthorized access, non-existing workspace, and
    successful data export.
  • +53/-0   

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @codiumai-pr-agent-free codiumai-pr-agent-free bot added type: enhancement New feature or request Tests labels Feb 22, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (9d52280)

    Copy link
    Contributor

    PR Review

         PR feedback                    
    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and well-defined across a few files. The refactor of environmentId from number to string is clear, and the addition of the export data functionality is encapsulated within its own method, making it easier to review. The e2e tests provide good coverage for the new functionality.

    🧪 Relevant tests

    Yes

    🔍 Possible issues
    • The exportData method in workspace.service.ts does not seem to handle potential exceptions that could occur while fetching data from the database. It might be beneficial to add try-catch blocks or checks to ensure the stability of the export feature.
    • The data export functionality includes sensitive information such as privateKey for projects. Ensure that this does not pose a security risk or consider excluding such sensitive information from the export.
    🔒 Security concerns

    Yes, because the export includes potentially sensitive information such as project privateKeys. It's crucial to ensure that this data is handled securely and that the export feature cannot be exploited to gain unauthorized access to sensitive data. Consider implementing additional security measures such as data encryption or limiting the scope of exported data.


    ✨ Review tool 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 'possible issues' 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

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

    PR Code Suggestions

    Suggestions                                                                                                                                                     
    maintainability
    Remove unused imports to clean up the code.                                  

    Consider removing the IsOptional import if it's no longer used in this file.

    apps/api/src/secret/dto/create.secret/create.secret.ts [1]

    -import { IsOptional, IsString, Length } from 'class-validator'
    +import { IsString, Length } from 'class-validator'
     
    Abstract common test setup to improve maintainability.                       

    Consider abstracting common setup code for tests into a beforeEach block to improve test
    maintainability and reduce redundancy.

    apps/api/src/workspace/workspace.e2e.spec.ts [1134-1140]

    -const response = await app.inject({
    -  method: 'GET',
    -  headers: {
    -    'x-e2e-user-email': user1.email
    -  },
    -  url: `/workspace/abc/export-data`
    -})
    +let response;
    +beforeEach(async () => {
    +  response = await app.inject({
    +    method: 'GET',
    +    headers: {
    +      'x-e2e-user-email': user1.email
    +    },
    +    url: `/workspace/${workspaceId}/export-data` // Use a variable for workspaceId
    +  });
    +});
     
    possible issue
    Verify and possibly adjust the order of decorators for correct validation behavior.

    Ensure the order of decorators @IsString() and @IsOptional() is intentional, as it might
    affect validation behavior.

    apps/api/src/variable/dto/create.variable/create.variable.ts [15-16]

    +@IsOptional()
     @IsString()
    -@IsOptional()
     
    enhancement
    Add API documentation for clarity and maintainability.                       

    Add API documentation comments for the exportData method to describe its purpose,
    parameters, and return type.

    apps/api/src/workspace/controller/workspace.controller.ts [186-192]

    +/**
    + * Exports the data of a workspace.
    + * @param user The current user.
    + * @param workspaceId The ID of the workspace to export data from.
    + * @returns The exported data of the workspace.
    + */
     @Get(':workspaceId/export-data')
     @RequiredApiKeyAuthorities(Authority.WORKSPACE_ADMIN)
     async exportData(
       @CurrentUser() user: User,
       @Param('workspaceId') workspaceId: Workspace['id']
     ) {
       return this.workspaceService.exportData(user, workspaceId)
     }
     
    best practice
    Use specific types instead of any for better type safety.       

    Replace the usage of any with a more specific type or interface for data to improve type
    safety.

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

    -// eslint-disable-next-line @typescript-eslint/no-explicit-any
    -const data: any = {}
    +interface WorkspaceData {
    +  name: string;
    +  description: string;
    +  workspaceRoles: Array<object>; // Define a more specific type
    +  projects: Array<object>; // Define a more specific type
    +}
    +const data: WorkspaceData = {}
     

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

    Copy link

    Quality Gate Passed Quality Gate passed

    Issues
    0 New issues

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

    See analysis details on SonarCloud

    Copy link

    codecov bot commented Feb 22, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Comparison is base (7bb3d21) 62.20% compared to head (9d52280) 94.24%.
    Report is 19 commits behind head on develop.

    Additional details and impacted files
    @@             Coverage Diff              @@
    ##           develop     #152       +/-   ##
    ============================================
    + Coverage    62.20%   94.24%   +32.03%     
    ============================================
      Files           76       83        +7     
      Lines         1503     1582       +79     
      Branches       260      256        -4     
    ============================================
    + Hits           935     1491      +556     
    + Misses         568       91      -477     
    Flag Coverage Δ
    api-e2e-tests 94.24% <100.00%> (+32.03%) ⬆️

    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 merged commit 46833aa into develop Feb 22, 2024
    9 checks passed
    @rajdip-b rajdip-b deleted the feat/export-data branch February 22, 2024 07:40
    Copy link

    nx-cloud bot commented Feb 22, 2024

    ☁️ Nx Cloud Report

    CI is running/has finished running commands for commit 9d52280. 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 3 targets

    Sent with 💌 from NxCloud.

    rajdip-b pushed a commit that referenced this pull request May 12, 2024
    ## [1.3.0](v1.2.0...v1.3.0) (2024-05-12)
    
    ### 🚀 Features
    
    * Add approval support ([#158](#158)) ([e09ae60](e09ae60))
    * **api:** Add configuration live update support ([#181](#181)) ([f7d6684](f7d6684))
    * **api:** Add feature to export data of a workspace ([#152](#152)) ([46833aa](46833aa))
    * **api:** Add Integration support ([#203](#203)) ([f1ae87e](f1ae87e))
    * **api:** Add note to [secure] and variable ([#151](#151)) ([2e62351](2e62351))
    * **api:** Add OAuth redirection and polished authentication ([#212](#212)) ([d2968bc](d2968bc))
    * **api:** Add support for storing and managing variables ([#149](#149)) ([963a8ae](963a8ae))
    * **api:** Added GitLab OAuth ([#188](#188)) ([4d3bbe4](4d3bbe4))
    * **api:** Added validation for reason field ([#190](#190)) ([90b8ff2](90b8ff2))
    * **api:** Create default workspace on user's creation ([#182](#182)) ([3dc0c4c](3dc0c4c))
    * **api:** Reading `port` Dynamically ([#170](#170)) ([fd46e3e](fd46e3e))
    * **auth:** Add Google OAuth ([#156](#156)) ([cf387ea](cf387ea))
    * **web:** Added waitlist ([#168](#168)) ([1084c77](1084c77))
    * **web:** Landing revamp ([#165](#165)) ([0bc723b](0bc723b))
    
    ### 🐛 Bug Fixes
    
    * **web:** alignment issue in “Collaboration made easy” section ([#178](#178)) ([df5ca75](df5ca75))
    * **workspace:** delete duplicate tailwind config ([99d922a](99d922a))
    
    ### 📚 Documentation
    
    * add contributor list ([f37569a](f37569a))
    * Add integration docs ([#204](#204)) ([406ddb7](406ddb7))
    * Added integration docs to gitbook summary ([ab37530](ab37530))
    * **api:** Add swagger docs of API key controller ([#167](#167)) ([2910476](2910476))
    * **api:** Add swagger docs of User Controller ([#166](#166)) ([fd59522](fd59522))
    * fix typo in environment-variables.md ([#163](#163)) ([48294c9](48294c9))
    * Remove supabase from docs ([#169](#169)) ([eddbce8](eddbce8))
    * **setup:** replace NX with Turbo in setup instructions ([#175](#175)) ([af8a460](af8a460))
    * Update README.md ([b59f16b](b59f16b))
    * Update running-the-api.md ([177dbbf](177dbbf))
    * Update running-the-api.md ([#193](#193)) ([3d5bcac](3d5bcac))
    
    ### 🔧 Miscellaneous Chores
    
    * Added lockfile ([60a3b9b](60a3b9b))
    * Added lockfile ([6bb512c](6bb512c))
    * **api:** Added type inference and runtime validation to `process.env` ([#200](#200)) ([249e07d](249e07d))
    * **api:** Fixed prisma script env errors ([#209](#209)) ([8762354](8762354))
    * **API:** Refactor authority check functions in API ([#189](#189)) ([e9d710d](e9d710d))
    * **api:** Refactor user e2e tests ([b38d45a](b38d45a))
    * **ci:** Disabled api stage release ([97877c4](97877c4))
    * **ci:** Update stage deployment config ([868a6a1](868a6a1))
    * **codecov:** update api-e2e project coverage ([1e90d7e](1e90d7e))
    * **dockerfile:** Fixed web dockerfile ([6134bb2](6134bb2))
    * **docker:** Optimized web Dockerfile to reduct image size ([#173](#173)) ([444286a](444286a))
    * **release:** Downgraded package version ([c173fee](c173fee))
    * **release:** Fix failing release ([#213](#213)) ([40f64f3](40f64f3))
    * **release:** Install pnpm ([1081bea](1081bea))
    * **release:** Updated release commit ([b8958e7](b8958e7))
    * **release:** Updated release commit ([e270eb8](e270eb8))
    * Update deprecated husky Install command ([#202](#202)) ([e61102c](e61102c))
    * Upgrade @million/lint from 0.0.66 to 0.0.73 ([#172](#172)) ([dd43ed9](dd43ed9))
    * **web:** Updated fly memory config ([4debc66](4debc66))
    
    ### 🔨 Code Refactoring
    
    * **api:** Made events central to workspace ([#159](#159)) ([9bc00ae](9bc00ae))
    * **api:** Migrated to cookie based authentication ([#206](#206)) ([ad6911f](ad6911f))
    * **monorepo:** Migrate from nx to turbo ([#153](#153)) ([88b4b00](88b4b00))
    @rajdip-b
    Copy link
    Member Author

    🎉 This PR is included in version 1.3.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.

    Export data
    1 participant