feat(skip-execution): add support to display system logs #957
Conversation
- fix the type of request object in jsdocs - add comments
…wrapper over events
System logs will be displayed on postman app console with special highlight, they should be used when you want to inform user that some action was taken from script.
Codecov Report
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. @@ Coverage Diff @@
## feat/skip-request #957 +/- ##
==================================================
Coverage 60.78% 60.78%
==================================================
Files 12 12
Lines 561 561
Branches 135 135
==================================================
Hits 341 341
Misses 220 220
Flags with carried forward coverage won't be shown. Click here to find out more. 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
| * @param {'skip_request'} type - this is used to identify the message type in postman-app | ||
| * @param {...any} args - any other information like request name to be used to generate console message | ||
| */ | ||
| function dispatchSystemMessage (console, type, ...args) { |
There was a problem hiding this comment.
Don't think if this should be part of this module. Maybe a helper?
| timers, | ||
| ( | ||
| new PostmanAPI(execution, function (request, callback) { | ||
| var eventId = timers.setEvent(callback); | ||
|
|
||
| dispatchEvent(bridge, execution, executionRequestEventName, options.cursor, id, eventId, request); | ||
| }, /* onStopExecution = */ function () { | ||
| // Dispatch event to display system message on console informing user that the request | ||
| // execution was skipped from script | ||
| dispatchSystemMessage(postmanConsole, 'skip_request', _.get(execution, 'legacy._itemName')); |
There was a problem hiding this comment.
Why dispatch a system type console event? Why not a "execution_stopped" or such event? Every client can then interpret it and use it however they want to.
Also, "system" type log is not supported in Console interface either.
There was a problem hiding this comment.
This can also be a part of any existing events like item event with some indication that the execution was stopped from script.
vedkribhu
force-pushed
the
feat/skip-request
branch
8 times, most recently
from
abcb20c
to
bf0e253
Compare
Stacked on top of https://github.com/postmanlabs/postman-sandbox/pull/942/files
System logs will be displayed on postman app console with special highlight, they should be used when you want to inform user that some action was taken from script.