Output the original request in a header comment block

Author: wravery

include/ClientGenerator.h

@@ -26,7 +26,8 @@ class Generator
 {
 public:
 	// Initialize the generator with the introspection client or a custom GraphQL client.
-	explicit Generator(SchemaOptions&& schemaOptions, RequestOptions&& requestOptions, GeneratorOptions&& options);
+	explicit Generator(
+		SchemaOptions&& schemaOptions, RequestOptions&& requestOptions, GeneratorOptions&& options);
 
 	// Run the generator and return a list of filenames that were output.
 	std::vector<std::string> Build() const noexcept;
@@ -38,6 +39,7 @@ class Generator
 	std::string getSourcePath() const noexcept;
 
 	bool outputHeader() const noexcept;
+	void outputRequestComment(std::ostream& headerFile) const noexcept;
 	void outputObjectDeclaration(
 		std::ostream& headerFile, const ObjectType& objectType, bool isQueryType) const;
 	std::string getFieldDeclaration(const InputField& inputField) const noexcept;

include/RequestLoader.h

@@ -12,6 +12,16 @@
 
 namespace graphql::generator {
 
+using ResponseField = InputField;
+using ResponseFieldList = InputFieldList;
+
+struct ResponseType
+{
+	std::string_view type;
+	std::string_view cppType;
+	ResponseFieldList fields;
+};
+
 struct RequestOptions
 {
 	const std::string requestFilename;
@@ -24,16 +34,30 @@ class RequestLoader
 public:
 	explicit RequestLoader(RequestOptions&& requestOptions, const SchemaLoader& schemaLoader);
 
+	std::string_view getRequestFilename() const noexcept;
+	std::string_view getOperationName() const noexcept;
+	std::string_view getRequestText() const noexcept;
+
+	const ResponseType& getVariablesType() const noexcept;
+	const ResponseType& getResponseType() const noexcept;
+
 private:
-	void buildSchema(const SchemaLoader& schemaLoader);
-	void addTypesToSchema(const SchemaLoader& schemaLoader);
+	void buildSchema();
+	void addTypesToSchema();
 	std::shared_ptr<const schema::BaseType> getSchemaType(
 		std::string_view type, const TypeModifierStack& modifiers) const noexcept;
 	void validateRequest() const;
 
+	static std::string_view trimWhitespace(std::string_view content) noexcept;
+
 	const RequestOptions _requestOptions;
+	const SchemaLoader& _schemaLoader;
 	std::shared_ptr<schema::Schema> _schema;
 	peg::ast _ast;
+
+	std::string _requestText;
+	ResponseType _variablesType;
+	ResponseType _responseType;
 };
 
 } /* namespace graphql::generator */

samples/client/MutateClient.h

@@ -19,6 +19,24 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
+/** Operation: (default)
+
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+mutation {
+  completedTask: completeTask(input: {id: "ZmFrZVRhc2tJZA==", isComplete: true, clientMutationId: "Hi There!"}) {
+    completedTask: task {
+      completedTaskId: id
+      title
+      isComplete
+    }
+    clientMutationId
+  }
+}
+
+**/
+
 namespace graphql {
 namespace mutate {
 

samples/client/QueryClient.h

@@ -19,6 +19,47 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
+/** Operation: (default)
+
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+query Everything {
+  appointments {
+    edges {
+      node {
+        id
+        subject
+        when
+        isNow
+        __typename
+      }
+    }
+  }
+  tasks {
+    edges {
+      node {
+        id
+        title
+        isComplete
+        __typename
+      }
+    }
+  }
+  unreadCounts {
+    edges {
+      node {
+        id
+        name
+        unreadCount
+        __typename
+      }
+    }
+  }
+}
+
+**/
+
 namespace graphql {
 namespace query {
 

samples/client/SubscribeClient.h

@@ -19,6 +19,22 @@ static_assert(graphql::internal::MinorVersion == 6, "regenerate with clientgen:
 #include <string>
 #include <vector>
 
+/** Operation: (default)
+
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+subscription TestSubscription {
+  nextAppointment: nextAppointmentChange {
+    nextAppointmentId: id
+    when
+    subject
+    isNow
+  }
+}
+
+**/
+
 namespace graphql {
 namespace subscribe {
 

src/ClientGenerator.cpp

@@ -48,7 +48,8 @@ using namespace std::literals;
 
 namespace graphql::generator::client {
 
-Generator::Generator(SchemaOptions&& schemaOptions, RequestOptions&& requestOptions, GeneratorOptions&& options)
+Generator::Generator(
+	SchemaOptions&& schemaOptions, RequestOptions&& requestOptions, GeneratorOptions&& options)
 	: _schemaLoader(std::make_optional(std::move(schemaOptions)))
 	, _requestLoader(std::move(requestOptions), _schemaLoader)
 	, _options(std::move(options))
@@ -139,9 +140,12 @@ static_assert(graphql::internal::MinorVersion == )cpp"
 #include <memory>
 #include <string>
 #include <vector>
-
 )cpp";
 
+	outputRequestComment(headerFile);
+
+	headerFile << std::endl;
+
 	NamespaceScope graphqlNamespace { headerFile, "graphql" };
 	NamespaceScope schemaNamespace { headerFile, _schemaLoader.getSchemaNamespace() };
 	NamespaceScope objectNamespace { headerFile, "object", true };
@@ -334,6 +338,19 @@ std::shared_ptr<client::Client> GetClient();
 	return true;
 }
 
+void Generator::outputRequestComment(std::ostream& headerFile) const noexcept
+{
+	headerFile << R"cpp(
+/** Operation: )cpp"
+			   << _requestLoader.getOperationName() << R"cpp(
+
+)cpp" << _requestLoader.getRequestText()
+			   << R"cpp(
+
+**/
+)cpp";
+}
+
 void Generator::outputObjectDeclaration(
 	std::ostream& headerFile, const ObjectType& objectType, bool isQueryType) const
 {
@@ -413,9 +430,9 @@ std::string Generator::getFieldDeclaration(const OutputField& outputField) const
 	std::string fieldName { outputField.cppName };
 
 	fieldName[0] = static_cast<char>(std::toupper(static_cast<unsigned char>(fieldName[0])));
-	output << R"cpp(	virtual service::FieldResult<)cpp" << _schemaLoader.getOutputCppType(outputField)
-		   << R"cpp(> )cpp" << outputField.accessor << fieldName
-		   << R"cpp((service::FieldParams&& params)cpp";
+	output << R"cpp(	virtual service::FieldResult<)cpp"
+		   << _schemaLoader.getOutputCppType(outputField) << R"cpp(> )cpp" << outputField.accessor
+		   << fieldName << R"cpp((service::FieldParams&& params)cpp";
 
 	for (const auto& argument : outputField.arguments)
 	{
@@ -839,8 +856,8 @@ void Generator::outputObjectImplementation(
 		fieldName[0] = static_cast<char>(std::toupper(static_cast<unsigned char>(fieldName[0])));
 		sourceFile << R"cpp(
 service::FieldResult<)cpp"
-				   << _schemaLoader.getOutputCppType(outputField) << R"cpp(> )cpp" << objectType.cppType
-				   << R"cpp(::)cpp" << outputField.accessor << fieldName
+				   << _schemaLoader.getOutputCppType(outputField) << R"cpp(> )cpp"
+				   << objectType.cppType << R"cpp(::)cpp" << outputField.accessor << fieldName
 				   << R"cpp((service::FieldParams&&)cpp";
 		for (const auto& argument : outputField.arguments)
 		{