Merge branch 'main' into more-constexpr-schema

Author: wravery

.github/workflows/windows.yml

@@ -3,7 +3,7 @@ name: Windows
 on: [push, pull_request]
 
 jobs:
-  vs2019:
+  vs2022:
     strategy:
       fail-fast: false
       matrix:
@@ -52,7 +52,7 @@ jobs:
         $cmakeSharedLibs = $(if ('${{ matrix.libs }}' -eq 'shared') { 'ON' } else { 'OFF' })
         $msbuildArch = $(if ('${{ matrix.arch }}' -eq 'x64') { 'X64' } else { 'Win32' })
 
-        cmake "-DCMAKE_TOOLCHAIN_FILE=$vcpkgToolchain" "-DVCPKG_TARGET_TRIPLET=$vcpkgTriplet" "-DBUILD_SHARED_LIBS=$cmakeSharedLibs" -G "Visual Studio 16 2019" -A "$msbuildArch" ${{ github.workspace }}
+        cmake "-DCMAKE_TOOLCHAIN_FILE=$vcpkgToolchain" "-DVCPKG_TARGET_TRIPLET=$vcpkgTriplet" "-DBUILD_SHARED_LIBS=$cmakeSharedLibs" -G "Visual Studio 17 2022" -A "$msbuildArch" ${{ github.workspace }}
 
     - name: Build
       working-directory: build/

PEGTL

@@ -109,9 +109,9 @@ the license text. Please see the license or copyright notice which comes with ea
 
 ### graphqlpeg
 
-- GraphQL parsing: [Parsing Expression Grammar Template Library (PEGTL)](https://github.com/taocpp/PEGTL) release 3.2.2,
+- GraphQL parsing: [Parsing Expression Grammar Template Library (PEGTL)](https://github.com/taocpp/PEGTL) release 3.2.5,
 which is part of [The Art of C++](https://taocpp.github.io/) library collection. I've added this as a sub-module, so you
-do not need to install this separately. If you already have 3.2.2 installed where CMake can find it, it will use that
+do not need to install this separately. If you already have 3.2.5 installed where CMake can find it, it will use that
 instead of the sub-module and avoid installing another copy of PEGTL.
 
 ### graphqlservice

README.md

@@ -38,7 +38,7 @@ endforeach()
 
 # Don't update the files in the source directory if no files were generated in the binary directory.
 if(NOT FILE_NAMES)
-  message(FATAL_ERROR "Schema generation failed!")
+  message(FATAL_ERROR "Client generation failed!")
 endif()
 
  # Support if() IN_LIST operator: https://cmake.org/cmake/help/latest/policy/CMP0057.html
@@ -48,8 +48,10 @@ cmake_policy(SET CMP0057 NEW)
 file(GLOB OLD_FILES ${CLIENT_SOURCE_DIR}/*.h ${CLIENT_SOURCE_DIR}/*.cpp)
 foreach(OLD_FILE ${OLD_FILES})
   get_filename_component(OLD_FILE ${OLD_FILE} NAME)
-  if(NOT OLD_FILE IN_LIST FILE_NAMES)
-    file(REMOVE "${CLIENT_SOURCE_DIR}/${OLD_FILE}")
+  if(NOT OLD_FILE IN_LIST FILE_NAMES AND
+      NOT OLD_FILE STREQUAL "${CLIENT_PREFIX}Client.h" AND
+      NOT OLD_FILE STREQUAL "${CLIENT_PREFIX}Client.cpp")
+    message(WARNING "Unexpected file in ${CLIENT_TARGET} client sources: ${OLD_FILE}")
   endif()
 endforeach()
 

cmake/cppgraphqlgen-update-client-files.cmake

@@ -48,7 +48,12 @@ file(GLOB OLD_FILES ${SCHEMA_SOURCE_DIR}/*.h ${SCHEMA_SOURCE_DIR}/*.cpp)
 foreach(OLD_FILE ${OLD_FILES})
   get_filename_component(OLD_FILE ${OLD_FILE} NAME)
   if(NOT OLD_FILE IN_LIST FILE_NAMES)
-    file(REMOVE "${SCHEMA_SOURCE_DIR}/${OLD_FILE}")
+    if(OLD_FILE MATCHES "Object\\.h$" OR OLD_FILE MATCHES "Object\\.cpp$")
+      file(REMOVE "${SCHEMA_SOURCE_DIR}/${OLD_FILE}")
+    elseif(NOT OLD_FILE STREQUAL "${SCHEMA_PREFIX}Schema.h" AND
+        NOT OLD_FILE STREQUAL "${SCHEMA_PREFIX}Schema.cpp")
+      message(WARNING "Unexpected file in ${SCHEMA_TARGET} GraphQL schema sources: ${OLD_FILE}")
+    endif()
   endif()
 endforeach()
 

cmake/cppgraphqlgen-update-schema-files.cmake

@@ -1 +1 @@
-4.1.1
+4.2.0

cmake/version.txt

@@ -154,7 +154,6 @@ struct OutputField
 {
 	std::string_view type;
 	std::string_view name;
-	std::string_view cppName;
 	InputFieldList arguments;
 	OutputFieldType fieldType = OutputFieldType::Builtin;
 	TypeModifierStack modifiers;
@@ -263,6 +262,9 @@ class SchemaLoader
 	std::string getInputCppType(const InputField& field) const noexcept;
 	std::string getOutputCppType(const OutputField& field) const noexcept;
 
+	static std::string getOutputCppAccessor(const OutputField& field) noexcept;
+	static std::string getOutputCppResolver(const OutputField& field) noexcept;
+
 private:
 	static bool isExtension(const peg::ast_node& definition) noexcept;
 
@@ -303,6 +305,8 @@ class SchemaLoader
 	void validateTransitiveInterfaces(
 		std::string_view typeName, const std::vector<std::string_view>& interfaces) const;
 
+	static std::string getJoinedCppName(std::string_view prefix, std::string_view fieldName) noexcept;
+
 	static const std::string_view s_introspectionNamespace;
 	static const BuiltinTypeMap s_builtinTypes;
 	static const CppTypeMap s_builtinCppTypes;

include/SchemaLoader.h

@@ -188,12 +188,12 @@ struct ModifiedResponse
 	};
 
 	// Parse a single value of the response document.
-	static Type parse(response::Value response);
+	static Type parse(response::Value&& response);
 
 	// Peel off the none modifier. If it's included, it should always be last in the list.
 	template <TypeModifier Modifier = TypeModifier::None, TypeModifier... Other>
 	static typename std::enable_if_t<TypeModifier::None == Modifier && sizeof...(Other) == 0, Type>
-	parse(response::Value response)
+	parse(response::Value&& response)
 	{
 		return parse(std::move(response));
 	}
@@ -202,7 +202,7 @@ struct ModifiedResponse
 	template <TypeModifier Modifier, TypeModifier... Other>
 	static typename std::enable_if_t<TypeModifier::Nullable == Modifier,
 		std::optional<typename ResponseTraits<Type, Other...>::type>>
-	parse(response::Value response)
+	parse(response::Value&& response)
 	{
 		if (response.type() == response::Type::Null)
 		{
@@ -217,7 +217,7 @@ struct ModifiedResponse
 	template <TypeModifier Modifier, TypeModifier... Other>
 	static typename std::enable_if_t<TypeModifier::List == Modifier,
 		std::vector<typename ResponseTraits<Type, Other...>::type>>
-	parse(response::Value response)
+	parse(response::Value&& response)
 	{
 		std::vector<typename ResponseTraits<Type, Other...>::type> result;
 
@@ -251,19 +251,19 @@ using ScalarResponse = ModifiedResponse<response::Value>;
 #ifdef GRAPHQL_DLLEXPORTS
 // Export all of the built-in converters
 template <>
-GRAPHQLCLIENT_EXPORT int ModifiedResponse<int>::parse(response::Value response);
+GRAPHQLCLIENT_EXPORT int ModifiedResponse<int>::parse(response::Value&& response);
 template <>
-GRAPHQLCLIENT_EXPORT double ModifiedResponse<double>::parse(response::Value response);
+GRAPHQLCLIENT_EXPORT double ModifiedResponse<double>::parse(response::Value&& response);
 template <>
-GRAPHQLCLIENT_EXPORT std::string ModifiedResponse<std::string>::parse(response::Value response);
+GRAPHQLCLIENT_EXPORT std::string ModifiedResponse<std::string>::parse(response::Value&& response);
 template <>
-GRAPHQLCLIENT_EXPORT bool ModifiedResponse<bool>::parse(response::Value response);
+GRAPHQLCLIENT_EXPORT bool ModifiedResponse<bool>::parse(response::Value&& response);
 template <>
 GRAPHQLCLIENT_EXPORT response::IdType ModifiedResponse<response::IdType>::parse(
-	response::Value response);
+	response::Value&& response);
 template <>
 GRAPHQLCLIENT_EXPORT response::Value ModifiedResponse<response::Value>::parse(
-	response::Value response);
+	response::Value&& response);
 #endif // GRAPHQL_DLLEXPORTS
 
 } // namespace graphql::client

include/graphqlservice/GraphQLClient.h

@@ -34,11 +34,17 @@ struct ast
 	bool validated = false;
 };
 
-GRAPHQLPEG_EXPORT ast parseSchemaString(std::string_view input);
-GRAPHQLPEG_EXPORT ast parseSchemaFile(std::string_view filename);
+// By default, we want to limit the depth of nested nodes. You can override this with
+// another value for the depthLimit parameter in these parse functions.
+constexpr size_t c_defaultDepthLimit = 25;
 
-GRAPHQLPEG_EXPORT ast parseString(std::string_view input);
-GRAPHQLPEG_EXPORT ast parseFile(std::string_view filename);
+GRAPHQLPEG_EXPORT ast parseSchemaString(
+	std::string_view input, size_t depthLimit = c_defaultDepthLimit);
+GRAPHQLPEG_EXPORT ast parseSchemaFile(
+	std::string_view filename, size_t depthLimit = c_defaultDepthLimit);
+
+GRAPHQLPEG_EXPORT ast parseString(std::string_view input, size_t depthLimit = c_defaultDepthLimit);
+GRAPHQLPEG_EXPORT ast parseFile(std::string_view filename, size_t depthLimit = c_defaultDepthLimit);
 
 } // namespace peg
 

include/graphqlservice/GraphQLParse.h

@@ -20,6 +20,8 @@
 
 #include "graphqlservice/internal/Awaitable.h"
 
+#include <cstdint>
+#include <initializer_list>
 #include <memory>
 #include <string>
 #include <string_view>
@@ -31,7 +33,7 @@ namespace graphql::response {
 // GraphQL responses are not technically JSON-specific, although that is probably the most common
 // way of representing them. These are the primitive types that may be represented in GraphQL, as
 // of the [October 2021 spec](https://spec.graphql.org/October2021/#sec-Serialization-Format).
-enum class Type : uint8_t
+enum class Type : std::uint8_t
 {
 	Map,	   // JSON Object
 	List,	   // JSON Array
@@ -41,6 +43,7 @@ enum class Type : uint8_t
 	Int,	   // JSON Number
 	Float,	   // JSON Number
 	EnumValue, // JSON String
+	ID,		   // JSON String
 	Scalar,	   // JSON any type
 };
 
@@ -53,13 +56,70 @@ using BooleanType = bool;
 using IntType = int;
 using FloatType = double;
 using ScalarType = Value;
-using IdType = std::vector<uint8_t>;
+
+struct IdType
+{
+	using ByteData = std::vector<std::uint8_t>;
+	using OpaqueString = std::string;
+
+	GRAPHQLRESPONSE_EXPORT IdType(IdType&& other = IdType { ByteData {} }) noexcept;
+	GRAPHQLRESPONSE_EXPORT IdType(const IdType& other);
+	GRAPHQLRESPONSE_EXPORT ~IdType();
+
+	// Implicit ByteData constructors
+	GRAPHQLRESPONSE_EXPORT IdType(size_t count, typename ByteData::value_type value = 0);
+	GRAPHQLRESPONSE_EXPORT IdType(std::initializer_list<typename ByteData::value_type> values);
+	GRAPHQLRESPONSE_EXPORT IdType(
+		typename ByteData::const_iterator begin, typename ByteData::const_iterator end);
+
+	// Assignment
+	GRAPHQLRESPONSE_EXPORT IdType& operator=(IdType&& rhs) noexcept;
+	IdType& operator=(const IdType& rhs) = delete;
+
+	// Conversion
+	GRAPHQLRESPONSE_EXPORT IdType(ByteData&& data) noexcept;
+	GRAPHQLRESPONSE_EXPORT IdType& operator=(ByteData&& data) noexcept;
+
+	GRAPHQLRESPONSE_EXPORT IdType(OpaqueString&& opaque) noexcept;
+	GRAPHQLRESPONSE_EXPORT IdType& operator=(OpaqueString&& opaque) noexcept;
+
+	template <typename ValueType>
+	const ValueType& get() const;
+
+	template <typename ValueType>
+	ValueType release();
+
+	// Comparison
+	GRAPHQLRESPONSE_EXPORT bool operator==(const IdType& rhs) const noexcept;
+	GRAPHQLRESPONSE_EXPORT bool operator==(const ByteData& rhs) const noexcept;
+	GRAPHQLRESPONSE_EXPORT bool operator==(const OpaqueString& rhs) const noexcept;
+
+	GRAPHQLRESPONSE_EXPORT bool operator<(const IdType& rhs) const noexcept;
+
+	// Check the Type
+	GRAPHQLRESPONSE_EXPORT bool isBase64() const noexcept;
+
+private:
+	std::variant<ByteData, OpaqueString> _data;
+};
+
+#ifdef GRAPHQL_DLLEXPORTS
+// Export all of the specialized template methods
+template <>
+GRAPHQLRESPONSE_EXPORT const IdType::ByteData& IdType::get<IdType::ByteData>() const;
+template <>
+GRAPHQLRESPONSE_EXPORT const IdType::OpaqueString& IdType::get<IdType::OpaqueString>() const;
+template <>
+GRAPHQLRESPONSE_EXPORT IdType::ByteData IdType::release<IdType::ByteData>();
+template <>
+GRAPHQLRESPONSE_EXPORT IdType::OpaqueString IdType::release<IdType::OpaqueString>();
+#endif // GRAPHQL_DLLEXPORTS
 
 template <typename ValueType>
 struct ValueTypeTraits
 {
-	// Set by r-value reference, get by const reference, and release by value. The only types
-	// that actually support all 3 methods are StringType and ScalarType, everything else
+	// Set by r-value reference, get by const reference, and release by value. The only types that
+	// actually support all 3 methods are StringType, IdType, and ScalarType, everything else
 	// overrides some subset of these types with a template specialization.
 	using set_type = ValueType&&;
 	using get_type = const ValueType&;
@@ -106,15 +166,6 @@ struct ValueTypeTraits<FloatType>
 	using get_type = FloatType;
 };
 
-template <>
-struct ValueTypeTraits<IdType>
-{
-	// ID values are represented as a Base64 String, so they require conversion.
-	using set_type = const IdType&;
-	using get_type = IdType;
-	using release_type = IdType;
-};
-
 // Represent a discriminated union of GraphQL response value types.
 struct Value
 {
@@ -126,7 +177,7 @@ struct Value
 	GRAPHQLRESPONSE_EXPORT explicit Value(BooleanType value);
 	GRAPHQLRESPONSE_EXPORT explicit Value(IntType value);
 	GRAPHQLRESPONSE_EXPORT explicit Value(FloatType value);
-	GRAPHQLRESPONSE_EXPORT explicit Value(const IdType& value);
+	GRAPHQLRESPONSE_EXPORT explicit Value(IdType&& value);
 
 	GRAPHQLRESPONSE_EXPORT Value(Value&& other) noexcept;
 	GRAPHQLRESPONSE_EXPORT explicit Value(const Value& other);
@@ -138,16 +189,22 @@ struct Value
 
 	// Comparison
 	GRAPHQLRESPONSE_EXPORT bool operator==(const Value& rhs) const noexcept;
-	GRAPHQLRESPONSE_EXPORT bool operator!=(const Value& rhs) const noexcept;
 
 	// Check the Type
 	GRAPHQLRESPONSE_EXPORT Type type() const noexcept;
 
-	// JSON doesn't distinguish between Type::String and Type::EnumValue, so if this value comes
-	// from JSON and it's a string we need to track the fact that it can be interpreted as either.
+	// JSON doesn't distinguish between Type::String, Type::EnumValue, and Type::ID, so if this
+	// value comes from JSON and it's a string we need to track the fact that it can be interpreted
+	// as any of those types.
 	GRAPHQLRESPONSE_EXPORT Value&& from_json() noexcept;
 	GRAPHQLRESPONSE_EXPORT bool maybe_enum() const noexcept;
 
+	// Input values don't distinguish between Type::String and Type::ID, so if this value comes from
+	// a string literal input value we need to track that fact that it can be interpreted as either
+	// of those types.
+	GRAPHQLRESPONSE_EXPORT Value&& from_input() noexcept;
+	GRAPHQLRESPONSE_EXPORT bool maybe_id() const noexcept;
+
 	// Valid for Type::Map or Type::List
 	GRAPHQLRESPONSE_EXPORT void reserve(size_t count);
 	GRAPHQLRESPONSE_EXPORT size_t size() const;
@@ -196,6 +253,7 @@ struct Value
 
 		StringType string;
 		bool from_json = false;
+		bool from_input = false;
 	};
 
 	// Type::Null
@@ -218,10 +276,12 @@ struct Value
 	using SharedData = std::shared_ptr<const Value>;
 
 	using TypeData = std::variant<MapData, ListType, StringData, NullData, BooleanType, IntType,
-		FloatType, EnumData, ScalarData, SharedData>;
+		FloatType, EnumData, IdType, ScalarData, SharedData>;
 
 	const TypeData& data() const noexcept;
 
+	static Type typeOf(const TypeData& data) noexcept;
+
 	TypeData _data;
 };
 
@@ -238,7 +298,7 @@ GRAPHQLRESPONSE_EXPORT void Value::set<FloatType>(FloatType value);
 template <>
 GRAPHQLRESPONSE_EXPORT void Value::set<ScalarType>(ScalarType&& value);
 template <>
-GRAPHQLRESPONSE_EXPORT void Value::set<IdType>(const IdType& value);
+GRAPHQLRESPONSE_EXPORT void Value::set<IdType>(IdType&& value);
 template <>
 GRAPHQLRESPONSE_EXPORT const MapType& Value::get<MapType>() const;
 template <>
@@ -254,7 +314,7 @@ GRAPHQLRESPONSE_EXPORT FloatType Value::get<FloatType>() const;
 template <>
 GRAPHQLRESPONSE_EXPORT const ScalarType& Value::get<ScalarType>() const;
 template <>
-GRAPHQLRESPONSE_EXPORT IdType Value::get<IdType>() const;
+GRAPHQLRESPONSE_EXPORT const IdType& Value::get<IdType>() const;
 template <>
 GRAPHQLRESPONSE_EXPORT MapType Value::release<MapType>();
 template <>