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

fix: Fetching more than 200 Azure DevOps issues #10073

Merged
merged 1 commit into from
Aug 5, 2024

Conversation

Dschoordsch
Copy link
Contributor

@Dschoordsch Dschoordsch commented Aug 5, 2024

Description

Fixes/Partially Fixes #[issue number]
[Please include a summary of the changes and the related issue]

Demo

[If possible, please include a screenshot or gif/video, it'll make it easier for reviewers to understand the scope of the changes and how the change is supposed to work. If you're introducing something new or changing the existing patterns, please share a Loom and explain what decisions you've made and under what circumstances]

Testing scenarios

[Please list all the testing scenarios a reviewer has to check before approving the PR]

  • Scenario A

    • Step 1
    • Step 2...
  • Scenario B

    • Step 1
    • Step 2....

Final checklist

  • I checked the code review guidelines
  • I have added Metrics Representative as reviewer(s) if my PR invovles metrics/data/analytics related changes
  • I have performed a self-review of my code, the same way I'd do it for any other team member
  • I have tested all cases I listed in the testing scenarios and I haven't found any issues or regressions
  • Whenever I took a non-obvious choice I added a comment explaining why I did it this way
  • I added the label Skip Maintainer Review Indicating the PR only requires reviewer review and can be merged right after it's approved if the PR introduces only minor changes, does not contain any architectural changes or does not introduce any new patterns and I think one review is sufficient'
  • PR title is human readable and could be used in changelog

Summary by CodeRabbit

  • New Features

    • Enhanced work item fetching from Azure DevOps with improved pagination, allowing retrieval of larger sets of work items without exceeding API limits.
  • Bug Fixes

    • Improved error handling to capture the first encountered error during work item fetching.

@github-actions github-actions bot added the size/s label Aug 5, 2024
@Dschoordsch
Copy link
Contributor Author

Dschoordsch commented Aug 5, 2024

coderabbit, I'm sorry to have mentioned you.

@Dschoordsch
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

Walkthrough

The recent changes to the AzureDevOpsServerManager class enhance the method of fetching work items from the Azure DevOps API by introducing pagination. Instead of attempting to retrieve all work items in one request, the updated logic processes work item IDs in batches of 200. This improves compliance with API limits, enhances data retrieval robustness, and maintains existing error handling practices.

Changes

Files Change Summary
packages/server/utils/AzureDevOpsServerManager.ts Enhanced work item fetching logic to implement pagination, allowing retrieval of large sets of items while adhering to API limits. Error handling adjusted to capture the first encountered error; data mapping occurs within the loop for each batch, aggregating results effectively.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AzureDevOpsAPI

    Client->>AzureDevOpsAPI: Request work items (batch of 200)
    AzureDevOpsAPI-->>Client: Return work items
    loop While more items
        Client->>AzureDevOpsAPI: Request next batch of work items
        AzureDevOpsAPI-->>Client: Return work items
    end
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

coderabbitai bot commented Aug 5, 2024

@Dschoordsch, I've reviewed the changes made in the PR. The new implementation correctly handles fetching work items in batches of 200 to respect the API's limit. The error handling and mapping logic appear to be correctly implemented within the loop. Here are the key points:

  1. Batch Fetching: The loop fetches work items in batches of 200, which aligns with the API's constraints.
  2. Error Handling: The error handling logic ensures that the first encountered error is captured and returned.
  3. Mapping Logic: The mapping logic for work items remains unchanged and is applied within each batch.

Please ensure that the testing scenarios cover cases where:

  • The total number of work items exceeds 200.
  • Errors are encountered during the fetching process.

If you have any specific scenarios or additional tests in mind, please include them in the testing checklist.

Analysis chain
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Fetch the diff of the PR to review the changes made.
gh pr diff 10073

Length of output: 1713

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Outside diff range, codebase verification and nitpick comments (4)
packages/server/utils/AzureDevOpsServerManager.ts (4)

428-429: Avoid redundant comment.

The comment on line 428 is redundant as the subsequent code already makes it clear that the function fetches at most 200 items at once.

-    // we can fetch at most 200 items at once VS403474

Line range hint 474-475:
Ensure proper error handling and logging.

Similar to the getWorkItemData function, consider logging the error for better debugging and monitoring.

-      if (!firstError) {
-        firstError = res
-      }
+      if (!firstError) {
+        firstError = res
+        console.error('Error executing WIQL query:', res)
+      }
Tools
Biome

[error] 431-431: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)


Line range hint 528-531:
Ensure proper error handling and logging.

Similar to previous functions, consider logging the error for better debugging and monitoring.

-        if (!firstError) {
-          firstError = workItemsError
-        }
+        if (!firstError) {
+          firstError = workItemsError
+          console.error('Error fetching work items:', workItemsError)
+        }
Tools
Biome

[error] 431-431: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)


Line range hint 604-605:
Ensure proper error handling and logging.

Similar to previous functions, consider logging the error for better debugging and monitoring.

-      if (!!accountProjectsError && !firstError) {
-        firstError = accountProjectsError
+      if (!!accountProjectsError) {
+        if (!firstError) {
+          firstError = accountProjectsError
+        }
+        console.error('Error fetching account projects:', accountProjectsError)
Tools
Biome

[error] 431-431: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)

@Dschoordsch Dschoordsch merged commit 5829a11 into master Aug 5, 2024
8 checks passed
@Dschoordsch Dschoordsch deleted the fix/allowFetchingMoreThan200ADOissues branch August 5, 2024 09:08
@github-actions github-actions bot mentioned this pull request Aug 6, 2024
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant