feat: Add descriptions to all system defined GQL stuff #1387

AndrewSisley · 2023-04-21T17:37:29Z

Relevant issue(s)

Resolves #796

Description

Adds descriptions to all system defined GQL stuff (fields, args, enum values, etc). Also adds a couple of missing tests that I needed in order to be sure of the behaviour I was documenting.

I'm not terribly fussed about the location of the constant declarations, this will need to be redone once Pavneet and co have decided on how they wish to manage these long-term.

All the descriptions have been added in the last commit only, other commits include misc changes (such as tests).

Tested via Altair:

codecov · 2023-04-21T17:38:23Z

Codecov Report

Merging #1387 (42c9f0d) into develop (56b8a22) will increase coverage by 0.16%.
The diff coverage is 98.48%.

@@             Coverage Diff             @@
##           develop    #1387      +/-   ##
===========================================
+ Coverage    70.56%   70.73%   +0.16%     
===========================================
  Files          184      184              
  Lines        17838    17875      +37     
===========================================
+ Hits         12588    12644      +56     
+ Misses        4293     4280      -13     
+ Partials       957      951       -6

Impacted Files	Coverage Δ
request/graphql/schema/manager.go	`97.34% <ø> (-0.03%)`	⬇️
request/graphql/schema/generate.go	`84.87% <98.44%> (+0.54%)`	⬆️
request/graphql/schema/types/types.go	`100.00% <100.00%> (ø)`

... and 5 files with indirect coverage changes

fredcarle

Just a few todos related to the text in the descriptions.

Thanks for adding the tests related to empty sets.

fredcarle · 2023-04-22T21:50:47Z

request/graphql/schema/descriptions.go

+`
+	dockeysArgDescription string = `
+An optional set of dockeys for this field. Only documents with a dockey
+ matching an dockey in the given set will be returned.  If no documents match,


todo: matching *a* dockey.

fredcarle · 2023-04-22T22:10:40Z

request/graphql/schema/descriptions.go

+An optional filter for this join, if none of the related records do
+ not meet the filter criteria the host record will still be returned,


todo:if none of the related records meet the filter criteria

rm extra words

fredcarle · 2023-04-22T22:19:37Z

request/graphql/schema/types/descriptions.go

+	GroupByArgDescription string = `
+An optional set of fields for which to group the contents of this field by.
+ If this argument is provided, only fields used to group may be rendered in
+ he immediate child selector.  Additional fields may be selected by using


todo: in the immediate

Add missing letter

fredcarle · 2023-04-22T22:21:44Z

request/graphql/schema/types/descriptions.go

+ commit composed of the field level commits and the prior composite commit
+ (in the case of an update).


suggestion: field level commits and, in the case of an update, the prior composite commit

Nice suggestion, will do - thanks

fredcarle · 2023-04-22T22:51:48Z

request/graphql/schema/types/descriptions.go

+ to determine the state of the data model at the time of commit.
+`
+	commitDeltaFieldDescription string = `
+The CBOR encoded representation of the new value that saved as part of this commit.


todo: of the value that is saved

I'm 50-50 on that, but will change

rm new

It was mostly the "is" that was missing :)

fredcarle · 2023-04-22T22:52:51Z

request/graphql/schema/types/descriptions.go

+These are the set of fields supported for grouping by in a commits query.
+`
+	commitsQueryDescription string = `
+Returns a set of commits matching any provided criteria, if no arguments are


todo: criteria. If no

:) feels a bit like a nitpick lol, but will change 😁

.

It just that it feels like 2 sentences so the comma feels like the wrong break.

haha I agree with you lol, I'm just not sure I'd have flagged this as it is quite minor

I think that I might be a bit more picky here because it's publicly displayed text 😅

fredcarle · 2023-04-22T22:56:47Z

request/graphql/schema/types/descriptions.go

+ provided all commits in the system will be returned.
+`
+	latestCommitsQueryDescription string = `
+Returns a set of head commits matching any provided criteria, if no arguments are


todo: criteria. If no

fredcarle · 2023-04-22T23:09:29Z

request/graphql/schema/types/descriptions.go

+ values.
+`
+	eqOperatorDescription string = `
+The equality operator, if the target matches the value the check will pass.


todo: From here to line 205, I would change , if to . If.

I prefer the comma, if you really don't like it I can suggest - instead?

It feels like it should be all part of the same sentence. "-" is totally fine too.

fredcarle · 2023-04-22T23:10:23Z

request/graphql/schema/types/descriptions.go

+Indicate the primary side of a one-to-one relationship.
+`
+	relationDirectiveDescription string = `
+Allows the explicit definition of relationship attributes, instead of using the system generated


todo: remove comma.

shahzadlone

Cheers for taking care of these.

fredcarle

Thanks for doing the changes Andy!

…#1387) * Remove out of date todo * Remove commented out code * Remove commented out code * Remove unused GQL type (Delta) * Do not overwrite key field declaration * Add test for empty groupBy * Add empty order test * Add limit:0 test * Add test for update with nonexistantID * Add test for delete ids, empty set * Add field description to gql fields

AndrewSisley added documentation Improvements or additions to documentation area/query Related to the query component action/no-benchmark Skips the action that runs the benchmark. labels Apr 21, 2023

AndrewSisley added this to the DefraDB v0.5.1 milestone Apr 21, 2023

AndrewSisley requested a review from a team April 21, 2023 17:37

AndrewSisley self-assigned this Apr 21, 2023

AndrewSisley force-pushed the sisley/feat/I796-gql-descr branch 2 times, most recently from f297842 to 877f860 Compare April 21, 2023 17:58

fredcarle requested changes Apr 22, 2023

View reviewed changes

AndrewSisley requested a review from fredcarle April 24, 2023 14:49

AndrewSisley added 13 commits April 24, 2023 14:32

Remove out of date todo

f96d51e

Remove commented out code

f439d1b

Remove commented out code

fc601bb

Remove unused GQL type (Delta)

8946322

Do not overwrite key field declaration

6510d33

Add test for empty groupBy

b031eef

Add empty order test

c9cd026

Add limit:0 test

6c7fb9f

Add test for update with nonexistantID

288b3ec

Add test for delete ids, empty set

cf080d0

Add field description to gql fields

82acb77

PR FIXUP - text suggestions

6e7a7e0

PR FIXUP - =>

42c9f0d

AndrewSisley force-pushed the sisley/feat/I796-gql-descr branch from 877f860 to 42c9f0d Compare April 24, 2023 18:33

shahzadlone approved these changes Apr 24, 2023

View reviewed changes

fredcarle approved these changes Apr 24, 2023

View reviewed changes

AndrewSisley merged commit e20f364 into develop Apr 24, 2023

AndrewSisley deleted the sisley/feat/I796-gql-descr branch April 24, 2023 21:33

orpheuslummis mentioned this pull request May 6, 2023

No description field on GraphQL default types #1196

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add descriptions to all system defined GQL stuff #1387

feat: Add descriptions to all system defined GQL stuff #1387

AndrewSisley commented Apr 21, 2023

codecov bot commented Apr 21, 2023 •

edited

Loading

fredcarle left a comment

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 24, 2023

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 24, 2023

AndrewSisley Apr 24, 2023

fredcarle Apr 24, 2023

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023

fredcarle Apr 24, 2023

AndrewSisley Apr 24, 2023

fredcarle Apr 22, 2023

AndrewSisley Apr 24, 2023 •

edited

Loading

shahzadlone left a comment

fredcarle left a comment

		An optional filter for this join, if none of the related records do
		not meet the filter criteria the host record will still be returned,

		commit composed of the field level commits and the prior composite commit
		(in the case of an update).

feat: Add descriptions to all system defined GQL stuff #1387

feat: Add descriptions to all system defined GQL stuff #1387

Conversation

AndrewSisley commented Apr 21, 2023

Relevant issue(s)

Description

codecov bot commented Apr 21, 2023 • edited Loading

Codecov Report

fredcarle left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AndrewSisley Apr 24, 2023 • edited Loading

Choose a reason for hiding this comment

shahzadlone left a comment

Choose a reason for hiding this comment

fredcarle left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 21, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading

AndrewSisley Apr 24, 2023 •

edited

Loading