Update formatting for errors and query info #563
Merged
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.
issues: FE-6013, FE-6285
While I was working on the displaying aborts and constraint failures, I wasn't sure how it would play with query info, so I ended up working on these together. If this is too much at once, I can split them out into separate PRs.
update: same deal with printing metrics for successful v4 queries. I just noticed that that wasn't wired up, so I tacked that on, but we can still split if that helps.
Problem
Query info fields specified with
--include
are not displayed with errors.v10 aborts and constraint failures come with additional information that is not displayed.
v4 errors don't look like v10 errors.
--include
options middleware is not being used for theshell
command.Also, query info is not being printed for successful v4 queries.
Solution
Refactor
formatQueryInfo
into the separate functions within thefauna.mjs
andfaunadb.mjs
modules.formatQueryInfo
in each of the modules'formatError
methods.Pipe the
include
option intoformatError
.shell
command resolves include options using provided middleware.Update
query
andshell
commands to show v4 metrics with--include stats
is used.Modify v10
formatError
Modify v10
formatError
"*query*"
to make it look more like a v10 errorResult
Users can get all the information from errors that they want.
v10
before
![image](https://private-user-images.githubusercontent.com/7998974/403591888-b98b8b41-5a75-4315-b5f9-7e9ec9139b18.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5MTg4OC1iOThiOGI0MS01YTc1LTQzMTUtYjVmOS03ZTllYzkxMzliMTgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YTdhZDRlYjI1N2UwNTAxMjRlNTcxN2IzYmY4NDFmNDI1ZTkxNDIxMjI3MTgyN2E2NzYzNWVhZGZkZGExNTU1NyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.3HB8n4uVgaVHIP8ol-SdCaNBtw32JmJy8K3JXkm-M6I)
after
![image](https://private-user-images.githubusercontent.com/7998974/403592003-f1b5ad7e-3fba-47e1-9471-2a155aeb7108.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5MjAwMy1mMWI1YWQ3ZS0zZmJhLTQ3ZTEtOTQ3MS0yYTE1NWFlYjcxMDgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9NWExNjI5ZDU5ZmFkN2Q1MDVkODg5ZDRiNzFiZDQ1MjNhNTg5NWFmOTliZTg4NDhhN2IwZWIzNzIyYWQ4NDk5MiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.5Fdl7JK6o7uQelFGbtfQhTK1N8PKuwKZNNH8HR-en44)
abort before
![image](https://private-user-images.githubusercontent.com/7998974/403592480-26558429-4ac3-4bc8-8d58-5a6e57d72fbc.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5MjQ4MC0yNjU1ODQyOS00YWMzLTRiYzgtOGQ1OC01YTZlNTdkNzJmYmMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YzdiZDk1ZGRjYjM4N2E1ZTUxZmRkYWI5ODI5NjM5YTBlN2ViNzFhYjkzZDA2Yjg4ODY2M2U2MTc3NDNkMjdmZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.x5cCTa61ia9rqJqD8Af-ubfTlMPxpHZD_qIY2LchrLE)
abort after
![image](https://private-user-images.githubusercontent.com/7998974/403592665-c9c550b3-f236-4e23-b807-09eddca46068.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5MjY2NS1jOWM1NTBiMy1mMjM2LTRlMjMtYjgwNy0wOWVkZGNhNDYwNjgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YmQ2YzczOGM0NjEwMWMyOGRhYWVkMTQyYjA1YjYzYmUzOWZkOTA3NTk5MDhhNjVjNmMyYzg3MzM0NTM4YTkzZiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.rNsuUsqHDL5kyfM-9DDA7qIqrfG-wsnrcdzOL9OyF5w)
It's a little weird when other summary bits are included in errors, but that's no different than how it is now.
v4
before
![image](https://private-user-images.githubusercontent.com/7998974/403594464-1a4d1fd8-ce42-41e6-bd79-f27713da9e88.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5NDQ2NC0xYTRkMWZkOC1jZTQyLTQxZTYtYmQ3OS1mMjc3MTNkYTllODgucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9YjNlYTQwODUyMzdmYmI1YWViYWFhYjNjMDVlZWRmN2FiMTdiZjBhMTA4MWQ5NjI5YjUxMDYxM2M3YjE5ZWZkNiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.h8p1oyFYjcqUMuUEZQWTd26TY91yfcBGFdMdhhirxss)
after
![image](https://private-user-images.githubusercontent.com/7998974/403594300-66d80b32-222c-4451-8c1a-a99ee61fe4fe.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzU5NDMwMC02NmQ4MGIzMi0yMjJjLTQ0NTEtOGMxYS1hOTllZTYxZmU0ZmUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9OWJmMjM5NTI1NGFhZjYzMWEwMTg1ZWMyMGFkZmQ0YWQ4NzA2NjQ2MjUyZjA3ZGI4N2IxYjA2OWVmNTA0YmJiMSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.8lXKUWlAOCTWVfq5PJlyamsdtu_puy-TapdNcH6xHa4)
shell
Works there too
![image](https://private-user-images.githubusercontent.com/7998974/403912104-ac1c4472-7682-4949-b667-7943a633e86e.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzk0NDU2NjQsIm5iZiI6MTczOTQ0NTM2NCwicGF0aCI6Ii83OTk4OTc0LzQwMzkxMjEwNC1hYzFjNDQ3Mi03NjgyLTQ5NDktYjY2Ny03OTQzYTYzM2U4NmUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTNUMTExNjA0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MWZkMjE3YTIyY2EyMjdhM2JiMTAyZWU0NDM4MjU1ZmExOWM1OGY5Njk4NDI4MzNkNDU0NjZjMDM1Yjk2YTI2NyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.uPsNg4rIC4WtFrWw8OzGJpxuQOMB-qyEeGzJmA0SROg)
Testing
Added tests for