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.

Sign up for GitHub

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

Jump to bottom

feat: Implement layout to errorCallout #6396

Merged
merged 4 commits into from
Mar 16, 2021
Merged

feat: Implement layout to errorCallout #6396

merged 4 commits into from
Mar 16, 2021

Conversation

cdonke
Copy link
Contributor

@cdonke cdonke commented Mar 12, 2021

Description

Implements a parsing of the JSON error object to show a more readable message.

Task Item

Closes #6395

Screenshots

Was Became
image image
image image

Made it in a way that:

  • Unknown fields are pushed to the bottom.
  • Multiline fields are wrapped in a <pre> tag
  • Whitelisted fields have the display name and order defined
  • If it's not a JSON object, no changes are made.

Tested with the error messages I could simulate.

@cwhitten
Copy link
Member

@cdonke this is awesome!

@a-b-r-o-w-n
Copy link
Contributor

Looks great @cdonke. Thanks for the PR!

@cwhitten
Copy link
Member

cwhitten commented Mar 12, 2021 •
edited
Loading

We need to make sure this doesn't adversely affect other error types that show up here, like publishing to LUIS or QnA, or add a parsed view for those as well.

@cdonke
Copy link
Contributor Author

cdonke commented Mar 12, 2021

@cwhitten
I test if it is JSON parsable.. if not, returns the text as is...
I'll try to simulate the other errors and check how it goes..

@coveralls
Copy link

coveralls commented Mar 12, 2021 •
edited
Loading

Coverage Status

Coverage decreased (-0.005%) to 52.886% when pulling fd5ee79 on cdonke:BeautifyErrorMessage into 1584c35 on microsoft:main.

@cdonke
Copy link
Contributor Author

cdonke commented Mar 12, 2021

Publishing to LUIS wasn't affected, since it returns text:
image

QnAMaker doesn't show errors there...
It shows a pop-up with some details...

image

IT would be nice to join all the messages on the same place...

@srinaath
Copy link
Contributor

srinaath commented Mar 12, 2021 •
edited
Loading

Thanks @cdonke. In the upcoming sprint we are also going to push this detailed error view inside a "Outputs" tab in the Debug drawer at the bottom. This tab would house the stdout from the runtime as well as errors that happen while starting. We will reuse your code to display errors.

@cdonke
Copy link
Contributor Author

cdonke commented Mar 12, 2021

Great @srinaath ...
I really miss the runtime stdout (especially logging).

@a-b-r-o-w-n
Copy link
Contributor

@srinaath I checked with @cwhitten and concluded that this is fine to take into main as we work towards surfacing these errors in the debug tray, so I'll merge once it goes green.

@a-b-r-o-w-n a-b-r-o-w-n merged commit d1b46fe into microsoft:main Mar 16, 2021
cwhitten pushed a commit that referenced this pull request Mar 16, 2021
@cdonke @a-b-r-o-w-n @cwhitten
feat: Implement layout to errorCallout (#6396)
c40ecb0 
* implement layout to errorCallout

* Fix linting issues

Co-authored-by: Andy Brown <asbrown002@gmail.com>
cwhitten added a commit that referenced this pull request Mar 23, 2021
@tonyanziano @cwhitten
@lei9444 @beyackle @tdurnford @sorgh @benbrown @a-b-r-o-w-n @pavolum @pavolumMsft @taicchoumsft @cdonke @boydc2014 @luhan2017 @alanlong9278 @hatpick
feature: Merge 1.4.0 into main (#6529)
463b41f 
* release: 1.4.0-rc0

* fix: lg create error with multi-language (#6412)

Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>

* fix: Remove Attachment Lg template when they are deleted in the Response Editor (#6405)

* fix: Remove Attachment Lg template when they are deleted in the Response Editor

* strings

Co-authored-by: Soroush <sorgh@microsoft.com>

* 1.4.0-rc1

* Added gray Composer icon to 'no triggers' dialog state (#6414)

Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>

* Get an ARM token only when publishing to Azure (#6418)

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: composer doesn't see component dialogs that are in subfolders (#6420)

* fix: composer doesn't see component dialogs that are in subfolders

* clean unused code

* fix: revert yeoman-environment to 2.10.3 from 3.1.0 (#6415)

* 1.4.0-rc2

* fix: load feature flags if default keys have changed (#6432)

* handle case when default feature flags change

If a feature flag is renamed or removed, Composer would fail when updating feature flags.

* show app error when feature flags fail to fetch in development

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: use new create flow during add skill if enabled (#6427)

* Initial changes for component model add skills flow

* Reusing function

* Add new bot as skill working e2e in component model creation

* cleaning up PR

* removing unused imports

* - fixing typos
- enabling qna template to be instantiated as a skill

* Fixing title in addSkills modal and fixing default template

* fix useEffect

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* Update bf-orchestrator to 4.12.0-beta.20210316.cdd0819 (#6435)

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: make CSS show triangles in project tree (#6428)

Co-authored-by: Andy Brown <asbrown002@gmail.com>

* feat: Implement layout to errorCallout (#6396)

* implement layout to errorCallout

* Fix linting issues

Co-authored-by: Andy Brown <asbrown002@gmail.com>

* fis: change feature flag text (#6438)

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* feat: update runtime package to 4.12.1 (#6441)

* Update to 4.12.1

* update schema

Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>

* fix: hidden showCode button when url is all & show code for form dialog (#6444)

* hidden showCode button when dialog is all & show code for form dialog

* ci fix

* lint

Co-authored-by: Dong Lei <donglei@microsoft.com>

* Fixing projectId state by ordering state change (#6437)

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* prepare changelog for 1.4.0

* 1.4.0-rc3

* feat: take 4.12.2 runtime package (#6469)

* take 4.12.2

* Update schema

Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>

* fix: Allow multiline variations for LG text and speech modalities (#6394)

* fix: Allow multiline variations for LG text and speech modalities

* fix tests

* pr comment

Co-authored-by: Soroush <sorgh@microsoft.com>

* fix actions (#6476)

Co-authored-by: Soroush <sorgh@microsoft.com>

* release: 1.4.0

* Update 1.4.0.md

* RC4

* Update bf-orchestrator to 4.12.0-beta.20210322.314475a (#6496)

Co-authored-by: Chris Whitten <christopherwhitten@gmail.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>
Co-authored-by: TJ Durnford <tjdford@gmail.com>
Co-authored-by: Soroush <sorgh@microsoft.com>
Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>
Co-authored-by: Ben Brown <benbro@microsoft.com>
Co-authored-by: Andy Brown <asbrown002@gmail.com>
Co-authored-by: pavolum <pavolum@outlook.com>
Co-authored-by: Patrick Volum <pavolum@microsoft.com>
Co-authored-by: taicchoumsft <61705609+taicchoumsft@users.noreply.github.com>
Co-authored-by: Christiano Donke <cdonke@users.noreply.github.com>
Co-authored-by: Dong Lei <donglei@microsoft.com>
Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>
Co-authored-by: Long Alan <julong@microsoft.com>
Co-authored-by: Soroush <hatpick@gmail.com>
@cwhitten cwhitten mentioned this pull request May 20, 2021
Merged
lei9444 pushed a commit to lei9444/BotFramework-Composer-1 that referenced this pull request Jun 15, 2021
@cdonke @a-b-r-o-w-n
feat: Implement layout to errorCallout (microsoft#6396)
b434bbd 
* implement layout to errorCallout

* Fix linting issues

Co-authored-by: Andy Brown <asbrown002@gmail.com>
lei9444 added a commit to lei9444/BotFramework-Composer-1 that referenced this pull request Jun 15, 2021
@tonyanziano @cwhitten
@lei9444 @beyackle @tdurnford @sorgh @benbrown @a-b-r-o-w-n @pavolum @pavolumMsft @taicchoumsft @cdonke @boydc2014 @luhan2017 @alanlong9278 @hatpick
feature: Merge 1.4.0 into main (microsoft#6529)
6a4e84f 
* release: 1.4.0-rc0

* fix: lg create error with multi-language (microsoft#6412)

Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>

* fix: Remove Attachment Lg template when they are deleted in the Response Editor (microsoft#6405)

* fix: Remove Attachment Lg template when they are deleted in the Response Editor

* strings

Co-authored-by: Soroush <sorgh@microsoft.com>

* 1.4.0-rc1

* Added gray Composer icon to 'no triggers' dialog state (microsoft#6414)

Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>

* Get an ARM token only when publishing to Azure (microsoft#6418)

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: composer doesn't see component dialogs that are in subfolders (microsoft#6420)

* fix: composer doesn't see component dialogs that are in subfolders

* clean unused code

* fix: revert yeoman-environment to 2.10.3 from 3.1.0 (microsoft#6415)

* 1.4.0-rc2

* fix: load feature flags if default keys have changed (microsoft#6432)

* handle case when default feature flags change

If a feature flag is renamed or removed, Composer would fail when updating feature flags.

* show app error when feature flags fail to fetch in development

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: use new create flow during add skill if enabled (microsoft#6427)

* Initial changes for component model add skills flow

* Reusing function

* Add new bot as skill working e2e in component model creation

* cleaning up PR

* removing unused imports

* - fixing typos
- enabling qna template to be instantiated as a skill

* Fixing title in addSkills modal and fixing default template

* fix useEffect

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* Update bf-orchestrator to 4.12.0-beta.20210316.cdd0819 (microsoft#6435)

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>

* fix: make CSS show triangles in project tree (microsoft#6428)

Co-authored-by: Andy Brown <asbrown002@gmail.com>

* feat: Implement layout to errorCallout (microsoft#6396)

* implement layout to errorCallout

* Fix linting issues

Co-authored-by: Andy Brown <asbrown002@gmail.com>

* fis: change feature flag text (microsoft#6438)

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* feat: update runtime package to 4.12.1 (microsoft#6441)

* Update to 4.12.1

* update schema

Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>

* fix: hidden showCode button when url is all & show code for form dialog (microsoft#6444)

* hidden showCode button when dialog is all & show code for form dialog

* ci fix

* lint

Co-authored-by: Dong Lei <donglei@microsoft.com>

* Fixing projectId state by ordering state change (microsoft#6437)

Co-authored-by: Patrick Volum <pavolum@microsoft.com>

* prepare changelog for 1.4.0

* 1.4.0-rc3

* feat: take 4.12.2 runtime package (microsoft#6469)

* take 4.12.2

* Update schema

Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>

* fix: Allow multiline variations for LG text and speech modalities (microsoft#6394)

* fix: Allow multiline variations for LG text and speech modalities

* fix tests

* pr comment

Co-authored-by: Soroush <sorgh@microsoft.com>

* fix actions (microsoft#6476)

Co-authored-by: Soroush <sorgh@microsoft.com>

* release: 1.4.0

* Update 1.4.0.md

* RC4

* Update bf-orchestrator to 4.12.0-beta.20210322.314475a (microsoft#6496)

Co-authored-by: Chris Whitten <christopherwhitten@gmail.com>
Co-authored-by: leileizhang <leilzh@microsoft.com>
Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>
Co-authored-by: TJ Durnford <tjdford@gmail.com>
Co-authored-by: Soroush <sorgh@microsoft.com>
Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>
Co-authored-by: Ben Brown <benbro@microsoft.com>
Co-authored-by: Andy Brown <asbrown002@gmail.com>
Co-authored-by: pavolum <pavolum@outlook.com>
Co-authored-by: Patrick Volum <pavolum@microsoft.com>
Co-authored-by: taicchoumsft <61705609+taicchoumsft@users.noreply.github.com>
Co-authored-by: Christiano Donke <cdonke@users.noreply.github.com>
Co-authored-by: Dong Lei <donglei@microsoft.com>
Co-authored-by: Lu Han <32191031+luhan2017@users.noreply.github.com>
Co-authored-by: Long Alan <julong@microsoft.com>
Co-authored-by: Soroush <hatpick@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@a-b-r-o-w-n a-b-r-o-w-n a-b-r-o-w-n approved these changes

@beyackle beyackle Awaiting requested review from beyackle

@boydc2014 boydc2014 Awaiting requested review from boydc2014

@cwhitten cwhitten Awaiting requested review from cwhitten

@GeoffCoxMSFT GeoffCoxMSFT Awaiting requested review from GeoffCoxMSFT

@hatpick hatpick Awaiting requested review from hatpick

@srinaath srinaath Awaiting requested review from srinaath

@tonyanziano tonyanziano Awaiting requested review from tonyanziano

Assignees
No one assigned
Labels
1.4-RC2
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Beautify error output for bot start
5 participants
@cdonke @cwhitten @a-b-r-o-w-n @coveralls @srinaath