--[BE Week]More informative and appropriate data/metadata load and processing messages #2144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
jturner65
changed the title
Some demotions to verbose;
We often use 'Aborting' in failed assertion messages, usually implying a core dump. This commit clarifies when processes fail due to data errors, not so grievously that an assertion/std::abort is called for. These failures are often caught downstream by ESP_CHECK.
The default scene instance attributes will have all fields empty, so a stage_instance can be created with a template name of NONE, corresponding to the NONE stage. However, if a non-default scene instance configuration is loaded and it is lacking the stage_instance field, that is indicative of a dataset error (There always must be a stage instance specified for every scene instance) and so exit the program so that it can be fixed.
Function used to load, but now it just sets the attributes based on already loaded JSON.
jturner65
force-pushed
the
BE_DataLoadImprovements
branch
from
615913b
to
2d606ca
Compare
0mdc
approved these changes
Jul 5, 2023
0mdc
reviewed
Jul 12, 2023
| << activeSceneDataset_ << Mn::Debug::nospace | ||
| << "`. Likely the Scene Dataset Configuration requested was not " | ||
| "found and so a new, empty Scene Dataset was created. Verify the " | ||
| "Scene Dataset Configuration file name used."); |
There was a problem hiding this comment.
@jturner65 That check is triggered when loading FloorPlanner from Habitat-Lab.
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This PR addresses a few key issues with regard to the data load process and providing the user meaningful feedback on progress and issues that may arise. Along with clarifying many messages, the following changes were made :
MetadataMediator
ResourceManager/AttributesManagers
SceneInstanceAttributes
The default empty Scene Instance will no longer complain about not having a Stage Instance, a misleading message about an expected state. On the other hand, if a non-default Scene Instance attempts to load with no Stage Instance, this will fail an ESP_CHECK, since we expect at the very least a Stage Instance for any scene to load correctly.
General
Usage of 'Abort' in non-ESP_CHECK() messages : 'Aborting' is a commonly used tag we put at the end of failed assertion messages, implying program exit due to a specific check or line of code producing an unrecoverable error. However, many ESP_ERROR() streams (And even a few ESP_WARNING() streams) currently end just with the term "Aborting." as well, in an ambiguous attempt to infer that the function's execution is ending early, possibly with a non-useful return result, such as nullptr or ID_UNDEFINED. I have replaced these 'Aborting' messages where I could find them with clearer descriptions of what was happening in the guilty function as a result of the error.
How Has This Been Tested
All C++ and python tests pass
Types of changes
Checklist