[MGNLRESTCL-87] Developers can view full REST calls and responses Created: 21/Oct/19  Updated: 19/Feb/20  Resolved: 22/Jan/20

Status: Closed
Project: REST Client
Component/s: None
Affects Version/s: None
Fix Version/s: 2.0

Type: Improvement Priority: Major
Reporter: Christopher Zimmermann Assignee: Dai Ha
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 12d 5h
Original Estimate: Not Specified

Attachments: PNG File image-2020-02-05-16-12-52-581.png    
Issue Links:
causality
is causing MGNLRESTCL-133 DOC: Debug subapp in the REST Client app Closed
dependency
depends upon MGNLRESTCL-43 Handle errors in a REST response Closed
supersession
supersedes MGNLRESTCL-101 Log of most recent REST client calls ... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Documentation update required:
Yes
Date of First Response:
Epic Link: Declarative REST clients
Sprint: Declarative REST 13, Declarative REST 14, Declarative REST 15
Story Points: 8

 Description   

Currently, if a REST call fails a developer has no information about the REST call, and does not even necessarily know if it failed.

It's tricky for a developer because the problem could be in many places:  in the restclient definition, or it could be with the external service itself, or it could be in the FTL or in the App configuration. Its easy to introduce a problem in the call since the calls themselves are often dynamically constructed.

Acceptance Criteria:

  • An error while making a REST call should be written to the log.
    • Dedicated log file?
  • All details about the request and response should be included - body, cookies, headers, parameters. 
  • Secure information should not be written to the log.

Additional ideas for later:

  • Secure info is only written when the server is in developer mode.
  • If call can be written in a format compatible with 'curl' that is a bonus, because then developers could try it.


 Comments   
Comment by Christopher Zimmermann [ 04/Feb/20 ]

Please add a comment describing how to use this feature, or what was done.

Comment by Dai Ha [ 05/Feb/20 ]

Solution

Add a new Debug subapp to Rest Client app as below

To monitoring requests/responses, select definitions from Available Definition columns, keep the subapp opens during debug session. Closing the Debug subapp after debug session is necessary for data cleanup as well as data confidential reason. For each of call, there will be an entry in Debug Content dropdown. Select one entry will populate string content of that request/response to underneath tabsheets. For more usage detail, refer to Rest Client App documentation.

Generated at Mon Feb 12 10:43:05 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.