MAYA-108586: Keep the TF_ERROR message format consistence with TF_WARN and TF_STATUS

doc/codingGuidelines.md

@@ -268,6 +268,21 @@ Our goal is to develop [maya-usd](https://github.com/autodesk/maya-usd) followin
 * `nullptr` keyword
 * …
 
+## Diagnostic Facilities
+
+Developers are encouraged to use TF library diagnostic facilities in Maya USD. Please follow below guideline for picking the correct facility: https://graphics.pixar.com/usd/docs/api/page_tf__diagnostic.html
+
+In MayaUSD, `UsdMayaDiagnosticDelegate` converts TF diagnostics into native Maya infos, warnings, and errors. The environment flag `MAYAUSD_SHOW_FULL_DIAGNOSTICS`, controls the granularity of TF error/warning/status messages being displayed in Maya:
+
+e.g
+```
+Error: Failed verification: ' image ' -- Unable to create an image from RetroTVBody_Albedo.png
+```
+vs
+```
+Error: Failed verification: ' image ' -- Unable to create an image from RetroTVBody_Albedo.png -- Coding Error in _LoadTexture at line 422 of C:\maya-usd\lib\mayaUsd\render\vp2RenderDelegate\material.cpp
+```
+
 # Coding guidelines for Python
 We are adopting the [PEP-8](https://www.python.org/dev/peps/pep-0008) style for Python Code with the following modification:
 * Mixed-case for variable and function names are allowed 

lib/mayaUsd/render/vp2RenderDelegate/material.cpp

@@ -426,7 +426,8 @@ _LoadTexture(const std::string& path, bool& isColorSpaceSRGB, MFloatArray& uvSca
 #else
     GlfImageSharedPtr     image = GlfImage::OpenForReading(path);
 #endif
-    if (!TF_VERIFY(image)) {
+
+    if (!TF_VERIFY(image, "Unable to create an image from %s", path.c_str())) {
         return nullptr;
     }
 

lib/mayaUsd/utils/diagnosticDelegate.cpp

@@ -34,6 +34,12 @@ TF_DEFINE_ENV_SETTING(
     "If batching is off, all secondary threads' diagnostics will be "
     "printed to stderr.");
 
+TF_DEFINE_ENV_SETTING(
+    MAYAUSD_SHOW_FULL_DIAGNOSTICS,
+    false,
+    "This env flag controls the granularity of TF error/warning/status messages "
+    "being displayed in Maya.");
+
 // Globally-shared delegate. Uses shared_ptr so we can have weak ptrs.
 static std::shared_ptr<UsdMayaDiagnosticDelegate> _sharedDelegate;
 
@@ -61,14 +67,19 @@ class _WarningOnlyDelegate : public UsdUtilsCoalescingDiagnosticDelegate
 
 static MString _FormatDiagnostic(const TfDiagnosticBase& d)
 {
+    // strip out all the characters before "maya-usd"
+    std::string filterFilePath { d.GetContext().GetFile() };
+    filterFilePath = filterFilePath.substr(filterFilePath.find("maya-usd"));
+
     const std::string msg = TfStringPrintf(
         "%s -- %s in %s at line %zu of %s",
         d.GetCommentary().c_str(),
         TfDiagnosticMgr::GetCodeName(d.GetDiagnosticCode()).c_str(),
         d.GetContext().GetFunction(),
         d.GetContext().GetLine(),
-        d.GetContext().GetFile());
-    return msg.c_str();
+        filterFilePath.c_str());
+
+    return TfGetEnvSetting(MAYAUSD_SHOW_FULL_DIAGNOSTICS) ? msg.c_str() : d.GetCommentary().c_str();
 }
 
 static MString _FormatCoalescedDiagnostic(const UsdUtilsCoalescingDiagnosticDelegateItem& item)
@@ -104,12 +115,13 @@ void UsdMayaDiagnosticDelegate::IssueError(const TfError& err)
 {
     // Errors are never batched. They should be rare, and in those cases, we
     // want to see them separately.
-    // In addition, always display the full call site for errors by going
-    // through _FormatDiagnostic.
+
+    const auto diagnosticMessage = _FormatDiagnostic(err);
+
     if (ArchIsMainThread()) {
-        MGlobal::displayError(_FormatDiagnostic(err));
+        MGlobal::displayInfo(diagnosticMessage);
     } else {
-        std::cerr << _FormatDiagnostic(err) << std::endl;
+        std::cerr << diagnosticMessage << std::endl;
     }
 }
 
@@ -119,10 +131,12 @@ void UsdMayaDiagnosticDelegate::IssueStatus(const TfStatus& status)
         return; // Batched.
     }
 
+    const auto diagnosticMessage = _FormatDiagnostic(status);
+
     if (ArchIsMainThread()) {
-        MGlobal::displayInfo(status.GetCommentary().c_str());
+        MGlobal::displayInfo(diagnosticMessage);
     } else {
-        std::cerr << _FormatDiagnostic(status) << std::endl;
+        std::cerr << diagnosticMessage << std::endl;
     }
 }
 
@@ -132,10 +146,12 @@ void UsdMayaDiagnosticDelegate::IssueWarning(const TfWarning& warning)
         return; // Batched.
     }
 
+    const auto diagnosticMessage = _FormatDiagnostic(warning);
+
     if (ArchIsMainThread()) {
-        MGlobal::displayWarning(warning.GetCommentary().c_str());
+        MGlobal::displayInfo(diagnosticMessage);
     } else {
-        std::cerr << _FormatDiagnostic(warning) << std::endl;
+        std::cerr << diagnosticMessage << std::endl;
     }
 }
 

lib/mayaUsd/utils/stageCache.cpp

@@ -50,7 +50,6 @@ struct _OnSceneResetListener : public TfWeakBase
 
     void OnSceneReset(const UsdMayaSceneResetNotice& notice)
     {
-        TF_STATUS("Clearing USD Stage Cache");
         UsdMayaStageCache::Clear();
 
         std::lock_guard<std::mutex> lock(_sharedSessionLayersMutex);