Move Base64 conversions from GraphQLService to GraphQLResponse

Author: wravery

include/graphqlservice/GraphQLResponse.h

@@ -107,7 +107,10 @@ struct ValueTypeTraits<FloatType>
 template <>
 struct ValueTypeTraits<IdType>
 {
-	// ID values are represented as a String, there's no separate handling of this type.
+	// 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.
@@ -121,6 +124,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 Value(Value&& other) noexcept;
 	GRAPHQLRESPONSE_EXPORT explicit Value(const Value& other);
@@ -247,6 +251,8 @@ 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);
+template <>
 GRAPHQLRESPONSE_EXPORT const MapType& Value::get<MapType>() const;
 template <>
 GRAPHQLRESPONSE_EXPORT const ListType& Value::get<ListType>() const;
@@ -261,13 +267,17 @@ GRAPHQLRESPONSE_EXPORT FloatType Value::get<FloatType>() const;
 template <>
 GRAPHQLRESPONSE_EXPORT const ScalarType& Value::get<ScalarType>() const;
 template <>
+GRAPHQLRESPONSE_EXPORT IdType Value::get<IdType>() const;
+template <>
 GRAPHQLRESPONSE_EXPORT MapType Value::release<MapType>();
 template <>
 GRAPHQLRESPONSE_EXPORT ListType Value::release<ListType>();
 template <>
 GRAPHQLRESPONSE_EXPORT StringType Value::release<StringType>();
 template <>
 GRAPHQLRESPONSE_EXPORT ScalarType Value::release<ScalarType>();
+template <>
+GRAPHQLRESPONSE_EXPORT IdType Value::release<IdType>();
 #endif // GRAPHQL_DLLEXPORTS
 
 } /* namespace graphql::response */

include/graphqlservice/GraphQLService.h

@@ -281,46 +281,6 @@ struct ResolverResult
 using Resolver = std::function<std::future<ResolverResult>(ResolverParams&&)>;
 using ResolverMap = internal::string_view_map<Resolver>;
 
-// Binary data and opaque strings like IDs are encoded in Base64.
-class Base64
-{
-public:
-	// Map a single Base64-encoded character to its 6-bit integer value.
-	static constexpr uint8_t fromBase64(char ch) noexcept
-	{
-		return (ch >= 'A' && ch <= 'Z'
-				? ch - 'A'
-				: (ch >= 'a' && ch <= 'z'
-						? ch - 'a' + 26
-						: (ch >= '0' && ch <= '9' ? ch - '0' + 52
-												  : (ch == '+' ? 62 : (ch == '/' ? 63 : 0xFF)))));
-	}
-
-	// Convert a Base64-encoded string to a vector of bytes.
-	GRAPHQLSERVICE_EXPORT static std::vector<uint8_t> fromBase64(const char* encoded, size_t count);
-
-	// Map a single 6-bit integer value to its Base64-encoded character.
-	static constexpr char toBase64(uint8_t i) noexcept
-	{
-		return (i < 26 ? static_cast<char>(i + static_cast<uint8_t>('A'))
-					   : (i < 52 ? static_cast<char>(i - 26 + static_cast<uint8_t>('a'))
-								 : (i < 62 ? static_cast<char>(i - 52 + static_cast<uint8_t>('0'))
-										   : (i == 62 ? '+' : (i == 63 ? '/' : padding)))));
-	}
-
-	// Convert a set of bytes to Base64.
-	GRAPHQLSERVICE_EXPORT static std::string toBase64(const std::vector<uint8_t>& bytes);
-
-private:
-	static constexpr char padding = '=';
-
-	// Throw a schema_exception if the character is out of range.
-	static uint8_t verifyFromBase64(char ch);
-
-	// Throw a logic_error if the integer is out of range.
-	static char verifyToBase64(uint8_t i);
-};
-
 // GraphQL types are nullable by default, but they may be wrapped with non-null or list types.
 // Since nullability is a more special case in C++, we invert the default and apply that modifier
 // instead when the non-null wrapper is not present in that part of the wrapper chain.

include/graphqlservice/internal/Base64.h

@@ -0,0 +1,71 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+#pragma once
+
+#ifndef BASE64_H
+#define BASE64_H
+
+// clang-format off
+#ifdef GRAPHQL_DLLEXPORTS
+	#ifdef IMPL_GRAPHQLRESPONSE_DLL
+		#define GRAPHQLRESPONSE_EXPORT __declspec(dllexport)
+	#else // !IMPL_GRAPHQLRESPONSE_DLL
+		#define GRAPHQLRESPONSE_EXPORT __declspec(dllimport)
+	#endif // !IMPL_GRAPHQLRESPONSE_DLL
+#else // !GRAPHQL_DLLEXPORTS
+	#define GRAPHQLRESPONSE_EXPORT
+#endif // !GRAPHQL_DLLEXPORTS
+// clang-format on
+
+#include <cstdint>
+#include <string>
+#include <string_view>
+#include <vector>
+
+namespace graphql::internal {
+
+// Binary data and opaque strings like IDs are encoded in Base64.
+class Base64
+{
+public:
+	// Map a single Base64-encoded character to its 6-bit integer value.
+	static constexpr std::uint8_t fromBase64(char ch) noexcept
+	{
+		return (ch >= 'A' && ch <= 'Z'
+				? ch - 'A'
+				: (ch >= 'a' && ch <= 'z'
+						? ch - 'a' + 26
+						: (ch >= '0' && ch <= '9' ? ch - '0' + 52
+												  : (ch == '+' ? 62 : (ch == '/' ? 63 : 0xFF)))));
+	}
+
+	// Convert a Base64-encoded string to a vector of bytes.
+	GRAPHQLRESPONSE_EXPORT static std::vector<std::uint8_t> fromBase64(std::string_view encoded);
+
+	// Map a single 6-bit integer value to its Base64-encoded character.
+	static constexpr char toBase64(std::uint8_t i) noexcept
+	{
+		return (i < 26
+				? static_cast<char>(i + static_cast<std::uint8_t>('A'))
+				: (i < 52 ? static_cast<char>(i - 26 + static_cast<std::uint8_t>('a'))
+						  : (i < 62 ? static_cast<char>(i - 52 + static_cast<std::uint8_t>('0'))
+									: (i == 62 ? '+' : (i == 63 ? '/' : padding)))));
+	}
+
+	// Convert a set of bytes to Base64.
+	GRAPHQLRESPONSE_EXPORT static std::string toBase64(const std::vector<std::uint8_t>& bytes);
+
+private:
+	static constexpr char padding = '=';
+
+	// Throw a std::logic_error if the character is out of range.
+	static std::uint8_t verifyFromBase64(char ch);
+
+	// Throw a std::logic_error if the integer is out of range.
+	static char verifyToBase64(std::uint8_t i);
+};
+
+} // namespace graphql::internal
+
+#endif // BASE64_H

samples/client/MutateClient.cpp

@@ -5,8 +5,6 @@
 
 #include "MutateClient.h"
 
-#include "graphqlservice/GraphQLService.h"
-
 #include <algorithm>
 #include <array>
 #include <sstream>

samples/client/QueryClient.cpp

@@ -5,8 +5,6 @@
 
 #include "QueryClient.h"
 
-#include "graphqlservice/GraphQLService.h"
-
 #include <algorithm>
 #include <array>
 #include <sstream>

samples/client/SubscribeClient.cpp

@@ -5,8 +5,6 @@
 
 #include "SubscribeClient.h"
 
-#include "graphqlservice/GraphQLService.h"
-
 #include <algorithm>
 #include <array>
 #include <sstream>

samples/today/TodayMock.cpp

@@ -183,16 +183,15 @@ struct EdgeConstraints
 	}
 
 	std::shared_ptr<_Connection> operator()(const std::optional<int>& first,
-		const std::optional<response::Value>& after, const std::optional<int>& last,
-		const std::optional<response::Value>& before) const
+		std::optional<response::Value>&& after, const std::optional<int>& last,
+		std::optional<response::Value>&& before) const
 	{
 		auto itrFirst = _objects.cbegin();
 		auto itrLast = _objects.cend();
 
 		if (after)
 		{
-			const auto& encoded = after->get<response::StringType>();
-			auto afterId = service::Base64::fromBase64(encoded.c_str(), encoded.size());
+			auto afterId = after->release<response::IdType>();
 			auto itrAfter =
 				std::find_if(itrFirst, itrLast, [&afterId](const std::shared_ptr<_Object>& entry) {
 					return entry->id() == afterId;
@@ -206,8 +205,7 @@ struct EdgeConstraints
 
 		if (before)
 		{
-			const auto& encoded = before->get<response::StringType>();
-			auto beforeId = service::Base64::fromBase64(encoded.c_str(), encoded.size());
+			auto beforeId = before->release<response::IdType>();
 			auto itrBefore =
 				std::find_if(itrFirst, itrLast, [&beforeId](const std::shared_ptr<_Object>& entry) {
 					return entry->id() == beforeId;
@@ -281,7 +279,7 @@ service::FieldResult<std::shared_ptr<object::AppointmentConnection>> Query::getA
 			loadAppointments(state);
 
 			EdgeConstraints<Appointment, AppointmentConnection> constraints(state, _appointments);
-			auto connection = constraints(firstWrapped, afterWrapped, lastWrapped, beforeWrapped);
+			auto connection = constraints(firstWrapped, std::move(afterWrapped), lastWrapped, std::move(beforeWrapped));
 
 			return std::static_pointer_cast<object::AppointmentConnection>(connection);
 		},
@@ -307,7 +305,7 @@ service::FieldResult<std::shared_ptr<object::TaskConnection>> Query::getTasks(
 			loadTasks(state);
 
 			EdgeConstraints<Task, TaskConnection> constraints(state, _tasks);
-			auto connection = constraints(firstWrapped, afterWrapped, lastWrapped, beforeWrapped);
+			auto connection = constraints(firstWrapped, std::move(afterWrapped), lastWrapped, std::move(beforeWrapped));
 
 			return std::static_pointer_cast<object::TaskConnection>(connection);
 		},
@@ -333,7 +331,7 @@ service::FieldResult<std::shared_ptr<object::FolderConnection>> Query::getUnread
 			loadUnreadCounts(state);
 
 			EdgeConstraints<Folder, FolderConnection> constraints(state, _unreadCounts);
-			auto connection = constraints(firstWrapped, afterWrapped, lastWrapped, beforeWrapped);
+			auto connection = constraints(firstWrapped, std::move(afterWrapped), lastWrapped, std::move(beforeWrapped));
 
 			return std::static_pointer_cast<object::FolderConnection>(connection);
 		},

samples/today/TodayMock.h

@@ -183,8 +183,7 @@ class AppointmentEdge : public object::AppointmentEdge
 
 	service::FieldResult<response::Value> getCursor(service::FieldParams&& params) const final
 	{
-		return response::Value(
-			service::Base64::toBase64(_appointment->getId(std::move(params)).get()));
+		return response::Value(_appointment->getId(std::move(params)).get());
 	}
 
 private:
@@ -277,7 +276,7 @@ class TaskEdge : public object::TaskEdge
 
 	service::FieldResult<response::Value> getCursor(service::FieldParams&& params) const final
 	{
-		return response::Value(service::Base64::toBase64(_task->getId(std::move(params)).get()));
+		return response::Value(_task->getId(std::move(params)).get());
 	}
 
 private:
@@ -370,7 +369,7 @@ class FolderEdge : public object::FolderEdge
 
 	service::FieldResult<response::Value> getCursor(service::FieldParams&& params) const final
 	{
-		return response::Value(service::Base64::toBase64(_folder->getId(std::move(params)).get()));
+		return response::Value(_folder->getId(std::move(params)).get());
 	}
 
 private: