Support repeatable directives and preserve fragment directives

wravery · wravery · commit c29bcbfa0b29 · 2021-12-12T20:48:36.000-08:00
diff --git a/include/Validation.h b/include/Validation.h
@@ -37,6 +37,7 @@ using ValidateDirectiveArguments = internal::string_view_map<ValidateArgument>;
 
 struct ValidateDirective
 {
+	bool isRepeatable = false;
 	internal::sorted_set<introspection::DirectiveLocation> locations;
 	ValidateDirectiveArguments arguments;
 };
diff --git a/include/graphqlservice/GraphQLService.h b/include/graphqlservice/GraphQLService.h
@@ -229,6 +229,15 @@ class await_async : public coro::suspend_always
 	}
 };
 
+// Directive order matters, and some of them are repeatable. So rather than passing them in a
+// response::Value, pass directives in something like the underlying response::MapType which
+// preserves the order of the elements without complete uniqueness.
+using Directives = std::vector<std::pair<std::string_view, response::Value>>;
+
+// Traversing a fragment spread adds a new set of directives.
+using FragmentDefinitionDirectiveStack = std::list<std::reference_wrapper<const Directives>>;
+using FragmentSpreadDirectiveStack = std::list<Directives>;
+
 // Pass a common bundle of parameters to all of the generated Object::getField accessors in a
 // SelectionSet
 struct SelectionSetParams
@@ -239,14 +248,14 @@ struct SelectionSetParams
 	// The lifetime of each of these borrowed references is guaranteed until the future returned
 	// by the accessor is resolved or destroyed. They are owned by the OperationData shared pointer.
 	const std::shared_ptr<RequestState>& state;
-	const response::Value& operationDirectives;
-	const response::Value& fragmentDefinitionDirectives;
+	const Directives& operationDirectives;
+	const std::shared_ptr<FragmentDefinitionDirectiveStack> fragmentDefinitionDirectives;
 
 	// Fragment directives are shared for all fields in that fragment, but they aren't kept alive
 	// after the call to the last accessor in the fragment. If you need to keep them alive longer,
-	// you'll need to explicitly copy them into other instances of response::Value.
-	const response::Value& fragmentSpreadDirectives;
-	const response::Value& inlineFragmentDirectives;
+	// you'll need to explicitly copy them into other instances of Directives.
+	const std::shared_ptr<FragmentSpreadDirectiveStack> fragmentSpreadDirectives;
+	const std::shared_ptr<FragmentSpreadDirectiveStack> inlineFragmentDirectives;
 
 	// Field error path to this selection set.
 	std::optional<field_path> errorPath;
@@ -259,12 +268,12 @@ struct SelectionSetParams
 struct FieldParams : SelectionSetParams
 {
 	GRAPHQLSERVICE_EXPORT explicit FieldParams(
-		SelectionSetParams&& selectionSetParams, response::Value directives);
+		SelectionSetParams&& selectionSetParams, Directives directives);
 
 	// Each field owns its own field-specific directives. Once the accessor returns it will be
 	// destroyed, but you can move it into another instance of response::Value to keep it alive
 	// longer.
-	response::Value fieldDirectives;
+	Directives fieldDirectives;
 };
 
 // Field accessors may return either a result of T, an awaitable of T, or a std::future<T>, so at
@@ -379,11 +388,11 @@ class Fragment
 
 	std::string_view getType() const;
 	const peg::ast_node& getSelection() const;
-	const response::Value& getDirectives() const;
+	const Directives& getDirectives() const;
 
 private:
 	std::string_view _type;
-	response::Value _directives;
+	Directives _directives;
 
 	std::reference_wrapper<const peg::ast_node> _selection;
 };
@@ -399,16 +408,16 @@ struct ResolverParams : SelectionSetParams
 {
 	GRAPHQLSERVICE_EXPORT explicit ResolverParams(const SelectionSetParams& selectionSetParams,
 		const peg::ast_node& field, std::string&& fieldName, response::Value arguments,
-		response::Value fieldDirectives, const peg::ast_node* selection,
-		const FragmentMap& fragments, const response::Value& variables);
+		Directives fieldDirectives, const peg::ast_node* selection, const FragmentMap& fragments,
+		const response::Value& variables);
 
 	GRAPHQLSERVICE_EXPORT schema_location getLocation() const;
 
 	// These values are different for each resolver.
 	const peg::ast_node& field;
 	std::string fieldName;
 	response::Value arguments { response::Type::Map };
-	response::Value fieldDirectives { response::Type::Map };
+	Directives fieldDirectives;
 	const peg::ast_node* selection;
 
 	// These values remain unchanged for the entire operation, but they're passed to each of the
@@ -944,19 +953,20 @@ struct SubscriptionParams
 struct OperationData : std::enable_shared_from_this<OperationData>
 {
 	explicit OperationData(std::shared_ptr<RequestState> state, response::Value variables,
-		response::Value directives, FragmentMap fragments);
+		Directives directives, FragmentMap fragments);
 
 	std::shared_ptr<RequestState> state;
 	response::Value variables;
-	response::Value directives;
+	Directives directives;
 	FragmentMap fragments;
 };
 
 // Subscription callbacks receive the response::Value representing the result of evaluating the
 // SelectionSet against the payload.
 using SubscriptionCallback = std::function<void(response::Value)>;
 using SubscriptionArguments = std::map<std::string_view, response::Value>;
-using SubscriptionFilterCallback = std::function<bool(response::MapType::const_reference)>;
+using SubscriptionArgumentFilterCallback = std::function<bool(response::MapType::const_reference)>;
+using SubscriptionDirectiveFilterCallback = std::function<bool(Directives::const_reference)>;
 
 // Subscriptions are stored in maps using these keys.
 using SubscriptionKey = size_t;
@@ -970,15 +980,15 @@ using AwaitableDeliver = internal::Awaitable<void>;
 struct SubscriptionData : std::enable_shared_from_this<SubscriptionData>
 {
 	explicit SubscriptionData(std::shared_ptr<OperationData> data, SubscriptionName&& field,
-		response::Value arguments, response::Value fieldDirectives, peg::ast&& query,
+		response::Value arguments, Directives fieldDirectives, peg::ast&& query,
 		std::string&& operationName, SubscriptionCallback&& callback,
 		const peg::ast_node& selection);
 
 	std::shared_ptr<OperationData> data;
 
 	SubscriptionName field;
 	response::Value arguments;
-	response::Value fieldDirectives;
+	Directives fieldDirectives;
 	peg::ast query;
 	std::string operationName;
 	SubscriptionCallback callback;
@@ -1023,29 +1033,29 @@ class Request : public std::enable_shared_from_this<Request>
 	GRAPHQLSERVICE_EXPORT void deliver(const SubscriptionName& name,
 		const SubscriptionArguments& arguments, std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT void deliver(const SubscriptionName& name,
-		const SubscriptionArguments& arguments, const SubscriptionArguments& directives,
+		const SubscriptionArguments& arguments, const Directives& directives,
 		std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT void deliver(const SubscriptionName& name,
-		const SubscriptionFilterCallback& applyArguments,
+		const SubscriptionArgumentFilterCallback& applyArguments,
 		std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT void deliver(const SubscriptionName& name,
-		const SubscriptionFilterCallback& applyArguments,
-		const SubscriptionFilterCallback& applyDirectives,
+		const SubscriptionArgumentFilterCallback& applyArguments,
+		const SubscriptionDirectiveFilterCallback& applyDirectives,
 		std::shared_ptr<Object> subscriptionObject) const;
 
 	GRAPHQLSERVICE_EXPORT AwaitableDeliver deliver(await_async launch, const SubscriptionName& name,
 		std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT AwaitableDeliver deliver(await_async launch, const SubscriptionName& name,
 		const SubscriptionArguments& arguments, std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT AwaitableDeliver deliver(await_async launch, const SubscriptionName& name,
-		const SubscriptionArguments& arguments, const SubscriptionArguments& directives,
+		const SubscriptionArguments& arguments, const Directives& directives,
 		std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT AwaitableDeliver deliver(await_async launch, const SubscriptionName& name,
-		const SubscriptionFilterCallback& applyArguments,
+		const SubscriptionArgumentFilterCallback& applyArguments,
 		std::shared_ptr<Object> subscriptionObject) const;
 	GRAPHQLSERVICE_EXPORT AwaitableDeliver deliver(await_async launch, const SubscriptionName& name,
-		const SubscriptionFilterCallback& applyArguments,
-		const SubscriptionFilterCallback& applyDirectives,
+		const SubscriptionArgumentFilterCallback& applyArguments,
+		const SubscriptionDirectiveFilterCallback& applyDirectives,
 		std::shared_ptr<Object> subscriptionObject) const;
 
 private:
diff --git a/samples/today/TodayMock.cpp b/samples/today/TodayMock.cpp
@@ -4,12 +4,12 @@
 #include "TodayMock.h"
 
 #include "AppointmentConnectionObject.h"
-#include "TaskConnectionObject.h"
+#include "CompleteTaskPayloadObject.h"
+#include "ExpensiveObject.h"
 #include "FolderConnectionObject.h"
-#include "UnionTypeObject.h"
 #include "NestedTypeObject.h"
-#include "ExpensiveObject.h"
-#include "CompleteTaskPayloadObject.h"
+#include "TaskConnectionObject.h"
+#include "UnionTypeObject.h"
 
 #include <algorithm>
 #include <chrono>
@@ -501,10 +501,16 @@ std::stack<CapturedParams> NestedType::_capturedParams;
 NestedType::NestedType(service::FieldParams&& params, int depth)
 	: depth(depth)
 {
-	_capturedParams.push({ response::Value(params.operationDirectives),
-		response::Value(params.fragmentDefinitionDirectives),
-		response::Value(params.fragmentSpreadDirectives),
-		response::Value(params.inlineFragmentDirectives),
+	_capturedParams.push({ { params.operationDirectives },
+		params.fragmentDefinitionDirectives->empty()
+			? service::Directives {}
+			: service::Directives { params.fragmentDefinitionDirectives->front().get() },
+		params.fragmentSpreadDirectives->empty()
+			? service::Directives {}
+			: service::Directives { params.fragmentSpreadDirectives->front() },
+		params.inlineFragmentDirectives->empty()
+			? service::Directives {}
+			: service::Directives { params.inlineFragmentDirectives->front() },
 		std::move(params.fieldDirectives) });
 }
 
diff --git a/samples/today/TodayMock.h b/samples/today/TodayMock.h
@@ -571,13 +571,13 @@ class NodeChange
 struct CapturedParams
 {
 	// Copied in the constructor
-	const response::Value operationDirectives;
-	const response::Value fragmentDefinitionDirectives;
-	const response::Value fragmentSpreadDirectives;
-	const response::Value inlineFragmentDirectives;
+	const service::Directives operationDirectives;
+	const service::Directives fragmentDefinitionDirectives;
+	const service::Directives fragmentSpreadDirectives;
+	const service::Directives inlineFragmentDirectives;
 
 	// Moved in the constructor
-	const response::Value fieldDirectives;
+	const service::Directives fieldDirectives;
 };
 
 class NestedType
diff --git a/samples/today/nointrospection/TodaySchema.cpp b/samples/today/nointrospection/TodaySchema.cpp
@@ -262,11 +262,6 @@ void AddTypesToSchema(const std::shared_ptr<schema::Schema>& schema)
 	schema->AddDirective(schema::Directive::Make(R"gql(id)gql"sv, R"md()md"sv, {
 		introspection::DirectiveLocation::FIELD_DEFINITION
 	}, {}, false));
-	schema->AddDirective(schema::Directive::Make(R"gql(subscriptionTag)gql"sv, R"md()md"sv, {
-		introspection::DirectiveLocation::SUBSCRIPTION
-	}, {
-		schema::InputValue::Make(R"gql(field)gql"sv, R"md()md"sv, schema->LookupType(R"gql(String)gql"sv), R"gql()gql"sv)
-	}, true));
 	schema->AddDirective(schema::Directive::Make(R"gql(queryTag)gql"sv, R"md()md"sv, {
 		introspection::DirectiveLocation::QUERY
 	}, {
@@ -292,6 +287,9 @@ void AddTypesToSchema(const std::shared_ptr<schema::Schema>& schema)
 	}, {
 		schema::InputValue::Make(R"gql(inlineFragment)gql"sv, R"md()md"sv, schema->WrapType(introspection::TypeKind::NON_NULL, schema->LookupType(R"gql(String)gql"sv)), R"gql()gql"sv)
 	}, false));
+	schema->AddDirective(schema::Directive::Make(R"gql(repeatableOnField)gql"sv, R"md()md"sv, {
+		introspection::DirectiveLocation::FIELD
+	}, {}, true));
 
 	schema->AddQueryType(typeQuery);
 	schema->AddMutationType(typeMutation);
diff --git a/samples/today/schema.today.graphql b/samples/today/schema.today.graphql
@@ -111,8 +111,6 @@ type Subscription {
     nodeChange(id: ID!): Node!
 }
 
-directive @subscriptionTag(field: String) repeatable on SUBSCRIPTION
-
 scalar DateTime @specifiedBy(url: "https://en.wikipedia.org/wiki/ISO_8601")
 
 enum TaskState {
@@ -151,6 +149,7 @@ directive @fieldTag(field: String!) on FIELD
 directive @fragmentDefinitionTag(fragmentDefinition: String!) on FRAGMENT_DEFINITION
 directive @fragmentSpreadTag(fragmentSpread: String!) on FRAGMENT_SPREAD
 directive @inlineFragmentTag(inlineFragment: String!) on INLINE_FRAGMENT
+directive @repeatableOnField repeatable on FIELD
 
 "Infinitely nestable type which can be used with nested fragments to test directive handling"
 type NestedType {
diff --git a/samples/today/schema/TodaySchema.cpp b/samples/today/schema/TodaySchema.cpp
@@ -265,11 +265,6 @@ void AddTypesToSchema(const std::shared_ptr<schema::Schema>& schema)
 	schema->AddDirective(schema::Directive::Make(R"gql(id)gql"sv, R"md()md"sv, {
 		introspection::DirectiveLocation::FIELD_DEFINITION
 	}, {}, false));
-	schema->AddDirective(schema::Directive::Make(R"gql(subscriptionTag)gql"sv, R"md()md"sv, {
-		introspection::DirectiveLocation::SUBSCRIPTION
-	}, {
-		schema::InputValue::Make(R"gql(field)gql"sv, R"md()md"sv, schema->LookupType(R"gql(String)gql"sv), R"gql()gql"sv)
-	}, true));
 	schema->AddDirective(schema::Directive::Make(R"gql(queryTag)gql"sv, R"md()md"sv, {
 		introspection::DirectiveLocation::QUERY
 	}, {
@@ -295,6 +290,9 @@ void AddTypesToSchema(const std::shared_ptr<schema::Schema>& schema)
 	}, {
 		schema::InputValue::Make(R"gql(inlineFragment)gql"sv, R"md()md"sv, schema->WrapType(introspection::TypeKind::NON_NULL, schema->LookupType(R"gql(String)gql"sv)), R"gql()gql"sv)
 	}, false));
+	schema->AddDirective(schema::Directive::Make(R"gql(repeatableOnField)gql"sv, R"md()md"sv, {
+		introspection::DirectiveLocation::FIELD
+	}, {}, true));
 
 	schema->AddQueryType(typeQuery);
 	schema->AddMutationType(typeMutation);
diff --git a/src/GraphQLService.cpp b/src/GraphQLService.cpp
diff --git a/src/Validation.cpp b/src/Validation.cpp
diff --git a/test/TodayTests.cpp b/test/TodayTests.cpp

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ using ValidateDirectiveArguments = internal::string_view_map<ValidateArgument>;`
`37`	`37`
`38`	`38`	`struct ValidateDirective`
`39`	`39`	`{`
	`40`	`+ bool isRepeatable = false;`
`40`	`41`	`internal::sorted_set<introspection::DirectiveLocation> locations;`
`41`	`42`	`ValidateDirectiveArguments arguments;`
`42`	`43`	`};`