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 gltfLoader throw error when url load failed #2451

Merged
merged 3 commits into from
Dec 6, 2024

Conversation

luzhuang
Copy link
Contributor

@luzhuang luzhuang commented Dec 4, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior? (You can also link to an open issue here)

What is the new behavior (if this is a feature change)?

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

Other information:

Summary by CodeRabbit

  • New Features

    • Enhanced error handling in the asset loading process to improve robustness.
  • Bug Fixes

    • Added tests for error scenarios when loading non-existent assets, ensuring better error management.
  • Tests

    • Introduced a new test suite for loading assets with improved error handling checks.
    • Reformatted test cases for better readability without altering functionality.

@luzhuang luzhuang added Bug Something isn't working ignore for release ignore for release labels Dec 4, 2024
@luzhuang luzhuang requested a review from GuoLei1990 December 4, 2024 09:10
Copy link

coderabbitai bot commented Dec 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request enhance error handling within the _addTaskCompletePromise method of the GLTFParserContext class by adding a second argument in the promise's .then method to handle rejections without throwing errors. Additionally, the test suite for the ResourceManager class has been updated to include a new test for error handling when loading a non-existent asset, along with improvements for readability in existing test cases.

Changes

File Path Change Summary
packages/loader/src/gltf/parser/GLTFParserContext.ts - Modified _addTaskCompletePromise to include a second argument in .then for promise rejection handling.
tests/src/core/resource/ResourceManager.test.ts - Added new test suite "load asset" with error handling test for non-existent asset.
- Reformatted GLB file URL for readability.

Possibly related PRs

  • Fix sub asset repeated loading #2107: This PR modifies the GLTFParserContext class, which is directly related to the changes made in the main PR that enhances error handling in the _addTaskCompletePromise method within the same class.
  • Fix reource load issue in local downloaded npm package #2436: This PR includes updates to the ResourceManager class and its tests, which are relevant to the changes in the main PR as they both involve resource management and error handling in asset loading scenarios.

Suggested labels

glTF

Suggested reviewers

  • GuoLei1990
  • zhuxudong

Poem

In the code where errors creep,
A promise now, its secrets keep.
With tests that catch what might go wrong,
Our code grows sturdy, safe, and strong.
So hop along, let bugs take flight,
For our code shines ever bright! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 50bf0d6 and 34b705b.

📒 Files selected for processing (2)
  • packages/loader/src/gltf/parser/GLTFParserContext.ts (1 hunks)
  • tests/src/core/resource/ResourceManager.test.ts (2 hunks)

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

@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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cfe8c34 and 50bf0d6.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • packages/loader/src/gltf/parser/GLTFParserContext.ts (2 hunks)
  • tests/src/core/resource/ResourceManager.test.ts (2 hunks)
🔇 Additional comments (4)
tests/src/core/resource/ResourceManager.test.ts (2)

71-76: LGTM: Improved code readability

Breaking the long URL string into multiple lines improves code readability while maintaining functionality.


94-102: LGTM: Good test coverage for error handling

The new test case properly verifies that loading a non-existent asset throws an error, which aligns with the PR's objective to improve error handling in the glTF loader.

packages/loader/src/gltf/parser/GLTFParserContext.ts (2)

7-7: LGTM: Added Logger import

Appropriate import for error logging functionality.


154-160: Verify error handling in dependent components

The changes to error handling in _addTaskCompletePromise may affect components that rely on task completion status.

Let's verify the error handling implementation in related components:

✅ Verification successful

Based on the results, I can now generate the final response:

Error handling implementation is consistent across components

The error handling in _addTaskCompletePromise follows the established pattern across the codebase where:

  • Task progress tracking is properly maintained through _setTaskCompleteProgress and _onTaskDetail
  • Error handling is consistently propagated through promise chains
  • Errors are properly logged and don't break the task completion flow
  • The implementation aligns with error handling in related components like GLTFTextureParser, GLTFSchemaParser, and GLTFBufferParser
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for task completion and error handling patterns in related files

# Check for task completion handling
echo "Checking task completion handling:"
rg -A 5 "_setTaskCompleteProgress|_onTaskDetail"

# Check for error handling patterns in resource loading
echo "Checking resource loading error handling:"
rg -A 5 "catch.*error|throw.*error" "packages/loader/src/"

Length of output: 9623

Comment on lines 154 to 160
taskPromise
.then(() => {
this._setTaskCompleteProgress(++task.loaded, task.total);
})
.catch((e) => {
Logger.error(e.toString());
});
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider improving error handling

While adding error logging is good, consider these improvements:

  1. The error should be propagated to allow proper error handling by callers
  2. Include more error details for debugging purposes

Consider this implementation:

 taskPromise
   .then(() => {
     this._setTaskCompleteProgress(++task.loaded, task.total);
   })
   .catch((e) => {
-    Logger.error(e.toString());
+    Logger.error(`Failed to complete GLTF loading task: ${e.message}`, e);
+    throw e; // Propagate error for proper handling
   });
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
taskPromise
.then(() => {
this._setTaskCompleteProgress(++task.loaded, task.total);
})
.catch((e) => {
Logger.error(e.toString());
});
taskPromise
.then(() => {
this._setTaskCompleteProgress(++task.loaded, task.total);
})
.catch((e) => {
Logger.error(`Failed to complete GLTF loading task: ${e.message}`, e);
throw e; // Propagate error for proper handling
});

@luzhuang luzhuang force-pushed the fix/gltfLoaderThrowError branch from 50bf0d6 to 56da595 Compare December 4, 2024 09:13
@luzhuang luzhuang force-pushed the fix/gltfLoaderThrowError branch from 56da595 to ae5e2b3 Compare December 4, 2024 09:17
@GuoLei1990 GuoLei1990 merged commit 34e0879 into galacean:dev/1.4 Dec 6, 2024
7 checks passed
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.24%. Comparing base (cfe8c34) to head (34b705b).
Report is 4 commits behind head on dev/1.4.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2451      +/-   ##
===========================================
+ Coverage    67.71%   68.24%   +0.52%     
===========================================
  Files          902      902              
  Lines        93861    93864       +3     
  Branches      7825     7854      +29     
===========================================
+ Hits         63561    64053     +492     
+ Misses       30051    29562     -489     
  Partials       249      249              
Flag Coverage Δ
unittests 68.24% <100.00%> (+0.52%) ⬆️

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working ignore for release ignore for release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants