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

Fixed: Cannot read properties of undefined (reading 'push') #8648

Merged
merged 3 commits into from
Nov 7, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 6, 2024

Motivation and context

To reproduce import annotations to a job for example:

  1. First import must be failed (e.g. wrong archive structure)
  2. Second import must have correct data, but also will be failed (another issue I will send one more pull request)
  3. Third import with correct data you will get the exception Cannot read properties of undefined (reading 'push')

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Bug Fixes

    • Resolved an error related to accessing properties of undefined, enhancing application stability.
  • Improvements

    • Updated the request management system to ensure that promises are always present and properly managed, improving error handling and overall robustness.

Copy link
Contributor

coderabbitai bot commented Nov 6, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request addresses an exception error in the codebase related to accessing properties of undefined. It modifies the RequestsManager class by changing the promise property from optional to required, ensuring that all entries in the listening object have an associated promise. The listen method has been updated for clearer promise assignment and improved error handling, which now includes deleting the entry when an error occurs. Overall, the changes enhance the robustness and clarity of request management.

Changes

File Path Change Summary
changelog.d/20241106_095739_sekachev.bs_fixed_exception_1.md Fixed an exception related to "Cannot read properties of undefined (reading 'push')"
cvat-core/src/requests-manager.ts Updated promise property in RequestsManager from optional to required; refined listen method for better promise handling and error management.

Poem

🐇 In the code where rabbits play,
A fix was made to save the day.
Promises now hold their ground,
No more errors to be found!
With every hop and every cheer,
Our code is strong, our path is clear! 🌟


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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: 0

🧹 Outside diff range and nitpick comments (1)
cvat-core/src/requests-manager.ts (1)

Line range hint 74-152: Consider adding synchronization to prevent race conditions.

While the promise creation and assignment logic is correct, there's a potential race condition between the initial check for an existing entry and the creation of a new one. Multiple simultaneous calls could create duplicate entries.

Consider this improvement:

    async listen(
        requestID: string,
        options: {
            callback: (request: Request) => void,
            initialRequest?: Request,
        },
    ): Promise<Request> {
+       // Use an atomic check-and-set operation
+       if (!this.listening[requestID]) {
+           this.listening[requestID] = {
+               onUpdate: [],
+               timeout: null,
+               request: null,
+               requestDelayIdx: 0,
+               promise: null as any, // Temporary placeholder
+           };
+       }

        if (callback) {
            this.listening[requestID].onUpdate.push(callback);
        }

+       // Only create the promise if it doesn't exist
+       if (!this.listening[requestID].promise) {
            const promise = new Promise<Request>((resolve, reject) => {
                // ... existing promise logic ...
            });
            this.listening[requestID].promise = promise;
        }

        return this.listening[requestID].promise;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6a60642 and e74144d.

📒 Files selected for processing (2)
  • changelog.d/20241106_095739_sekachev.bs_fixed_exception_1.md (1 hunks)
  • cvat-core/src/requests-manager.ts (4 hunks)
✅ Files skipped from review due to trivial changes (1)
  • changelog.d/20241106_095739_sekachev.bs_fixed_exception_1.md
🔇 Additional comments (2)
cvat-core/src/requests-manager.ts (2)

135-136: LGTM! Proper cleanup on error.

Good addition of explicit cleanup in the error handler. This ensures consistent state management by removing the listening entry in both success and error cases.


37-37: LGTM! Type change prevents undefined access.

Making promise required instead of optional is a good fix that prevents the "Cannot read properties of undefined" error by ensuring all entries in listening have an associated promise.

Let's verify there are no remaining optional promise usages:

✅ Verification successful

Type change is safe and consistent with codebase patterns

The verification shows that:

  • No optional promise declarations (promise?:) remain in the codebase
  • Similar required promise patterns exist in server-proxy.ts with LongProcessListener interface
  • The change aligns with existing promise handling patterns in the codebase
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for any remaining optional promise declarations
rg -g '*.ts' 'promise\?:\s*Promise<' 

Length of output: 38


Script:

#!/bin/bash
# Let's try a broader search for promise-related type definitions
rg -g '*.ts' 'promise.*Promise' -A 2 -B 2

# Also search for the specific interface containing this promise
ast-grep --pattern 'interface $_ {
  $$$
  promise: Promise<$_>
  $$$
}'

Length of output: 1806

Copy link

sonarcloud bot commented Nov 6, 2024

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 85.71429% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.30%. Comparing base (6a60642) to head (7790d9a).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8648      +/-   ##
===========================================
- Coverage    74.30%   74.30%   -0.01%     
===========================================
  Files          401      401              
  Lines        43421    43422       +1     
  Branches      3951     3951              
===========================================
  Hits         32265    32265              
- Misses       11156    11157       +1     
Components Coverage Δ
cvat-ui 78.65% <85.71%> (-0.01%) ⬇️
cvat-server 70.58% <ø> (ø)

@bsekachev bsekachev merged commit ac20ed2 into develop Nov 7, 2024
34 checks passed
@bsekachev bsekachev deleted the bs/fixed_exception_1 branch November 8, 2024 13:40
@cvat-bot cvat-bot bot mentioned this pull request Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants