Context Support

.github/pull_request_template.md

@@ -1,5 +1,5 @@
 <!-- Provide a general summary of your changes in the Title above -->
-<!-- Apply the label "bug" or "enhacement" as applicable. -->
+<!-- Apply the label "bug" or "enhancement" as applicable. -->
 
 ## Description / Motivation
 <!-- Describe your changes in detail -->
@@ -10,7 +10,7 @@
 ## Testing
 
 - [ ] The Unit & Intergration tests are passing.
-- [ ] I have added the necesary tests to cover my changes.
+- [ ] I have added the necessary tests to cover my changes.
 
 ## Terms
 <!-- Place an X in the [] to check. -->

src/Sitecore.AspNetCore.SDK.GraphQL/Client/Models/SitecoreGraphQLClientOptions.cs

@@ -9,11 +9,31 @@ namespace Sitecore.AspNetCore.SDK.GraphQL.Client.Models;
 /// </summary>
 public class SitecoreGraphQlClientOptions : GraphQLHttpClientOptions
 {
+    /// <summary>
+    /// ContextId query string key.
+    /// </summary>
+    public const string ContextIdQueryStringKey = "sitecoreContextId";
+
+    /// <summary>
+    /// Header name for the ApiKey.
+    /// </summary>
+    public const string ApiKeyHeaderName = "sc_apikey";
+
+    /// <summary>
+    /// Default Edge Endpoint Uri.
+    /// </summary>
+    public static readonly Uri DefaultEdgeEndpoint = new("https://edge-platform.sitecorecloud.io/v1/content/api/graphql/v1");
+
     /// <summary>
     /// Gets or sets ApiKey.
     /// </summary>
     public string? ApiKey { get; set; }
 
+    /// <summary>
+    /// Gets or sets ContextId.
+    /// </summary>
+    public string? ContextId { get; set; }
+
     /// <summary>
     /// Gets or sets Default site name, used by middlewares which use GraphQl client.
     /// </summary>

src/Sitecore.AspNetCore.SDK.GraphQL/Extensions/GraphQlConfigurationExtensions.cs

@@ -3,6 +3,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Sitecore.AspNetCore.SDK.GraphQL.Client.Models;
 using Sitecore.AspNetCore.SDK.GraphQL.Exceptions;
+using Sitecore.AspNetCore.SDK.GraphQL.Properties;
 
 namespace Sitecore.AspNetCore.SDK.GraphQL.Extensions;
 
@@ -24,13 +25,24 @@ public static IServiceCollection AddGraphQlClient(this IServiceCollection servic
 
         services.Configure(configuration);
 
-        SitecoreGraphQlClientOptions graphQlClientOptions = TryGetConfiguration(configuration);
+        SitecoreGraphQlClientOptions options = TryGetConfiguration(configuration);
 
         services.AddSingleton<IGraphQLClient, GraphQLHttpClient>(_ =>
         {
-            GraphQLHttpClient graphQlHttpClient = new(graphQlClientOptions.EndPoint!, graphQlClientOptions.GraphQlJsonSerializer);
+            if (!string.IsNullOrWhiteSpace(options.ContextId))
+            {
+                options.EndPoint = options.EndPoint.AddQueryString(
+                    SitecoreGraphQlClientOptions.ContextIdQueryStringKey,
+                    options.ContextId);
+            }
+
+            GraphQLHttpClient graphQlHttpClient = new(options.EndPoint!, options.GraphQlJsonSerializer);
+
+            if (!string.IsNullOrWhiteSpace(options.ApiKey))
+            {
+                graphQlHttpClient.HttpClient.DefaultRequestHeaders.Add(SitecoreGraphQlClientOptions.ApiKeyHeaderName, options.ApiKey);
+            }
 
-            graphQlHttpClient.HttpClient.DefaultRequestHeaders.Add("sc_apikey", graphQlClientOptions.ApiKey);
             return graphQlHttpClient;
         });
 
@@ -39,19 +51,23 @@ public static IServiceCollection AddGraphQlClient(this IServiceCollection servic
 
     private static SitecoreGraphQlClientOptions TryGetConfiguration(Action<SitecoreGraphQlClientOptions> configuration)
     {
-        SitecoreGraphQlClientOptions graphQlClientOptions = new();
-        configuration.Invoke(graphQlClientOptions);
+        SitecoreGraphQlClientOptions options = new();
+        configuration.Invoke(options);
 
-        if (string.IsNullOrWhiteSpace(graphQlClientOptions.ApiKey))
+        if (string.IsNullOrWhiteSpace(options.ApiKey) && string.IsNullOrWhiteSpace(options.ContextId))
         {
-            throw new InvalidGraphQlConfigurationException("Empty ApiKey, provided in GraphQLClientOptions.");
+            throw new InvalidGraphQlConfigurationException(Resources.Exception_MissingApiKeyAndContextId);
         }
 
-        if (graphQlClientOptions.EndPoint == null)
+        if (options.EndPoint == null && !string.IsNullOrWhiteSpace(options.ContextId))
+        {
+            options.EndPoint = SitecoreGraphQlClientOptions.DefaultEdgeEndpoint;
+        }
+        else if (options.EndPoint == null)
         {
-            throw new InvalidGraphQlConfigurationException("Empty EndPoint, provided in GraphQLClientOptions.");
+            throw new InvalidGraphQlConfigurationException(Resources.Exception_MissingEndpoint);
         }
 
-        return graphQlClientOptions;
+        return options;
     }
 }

src/Sitecore.AspNetCore.SDK.GraphQL/Extensions/UriExtensions.cs

@@ -0,0 +1,30 @@
+using System.Web;
+
+namespace Sitecore.AspNetCore.SDK.GraphQL.Extensions;
+
+/// <summary>
+/// Extension methods for <see cref="Uri"/>.
+/// </summary>
+public static class UriExtensions
+{
+    /// <summary>
+    /// Adds a query string to the <see cref="Uri"/>.
+    /// </summary>
+    /// <param name="uri">The original <see cref="Uri"/>.</param>
+    /// <param name="key">The key to use.</param>
+    /// <param name="value">The value to use. This will be UrlEncoded.</param>
+    /// <returns>New <see cref="Uri"/> with the query or the original if <paramref name="uri"/> is null or <paramref name="key"/> is null, empty or whitespace.</returns>
+    public static Uri? AddQueryString(this Uri? uri, string key, string value)
+    {
+        Uri? result = uri;
+        if (uri != null && !string.IsNullOrWhiteSpace(key))
+        {
+            int queryIndex = uri.OriginalString.IndexOf('?');
+            result = queryIndex > 0
+                ? new Uri(uri.OriginalString.Insert(queryIndex + 1, $"{key}={HttpUtility.UrlEncode(value)}&"), UriKind.RelativeOrAbsolute)
+                : new Uri($"{uri.OriginalString}?{key}={HttpUtility.UrlEncode(value)}", UriKind.RelativeOrAbsolute);
+        }
+
+        return result;
+    }
+}

src/Sitecore.AspNetCore.SDK.GraphQL/Properties/Resources.resx

@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+  <!-- 
+    Microsoft ResX Schema 
+
+    Version 2.0
+
+    The primary goals of this format is to allow a simple XML format 
+    that is mostly human readable. The generation and parsing of the 
+    various data types are done through the TypeConverter classes 
+    associated with the data types.
+
+    Example:
+
+    ... ado.net/XML headers & schema ...
+    <resheader name="resmimetype">text/microsoft-resx</resheader>
+    <resheader name="version">2.0</resheader>
+    <resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
+    <resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
+    <data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
+    <data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
+    <data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
+        <value>[base64 mime encoded serialized .NET Framework object]</value>
+    </data>
+    <data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
+        <value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
+        <comment>This is a comment</comment>
+    </data>
+
+    There are any number of "resheader" rows that contain simple 
+    name/value pairs.
+
+    Each data row contains a name, and value. The row also contains a 
+    type or mimetype. Type corresponds to a .NET class that support 
+    text/value conversion through the TypeConverter architecture. 
+    Classes that don't support this are serialized and stored with the 
+    mimetype set.
+
+    The mimetype is used for serialized objects, and tells the 
+    ResXResourceReader how to depersist the object. This is currently not 
+    extensible. For a given mimetype the value must be set accordingly:
+
+    Note - application/x-microsoft.net.object.binary.base64 is the format 
+    that the ResXResourceWriter will generate, however the reader can 
+    read any of the formats listed below.
+
+    mimetype: application/x-microsoft.net.object.binary.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.soap.base64
+    value   : The object must be serialized with 
+            : System.Runtime.Serialization.Formatters.Soap.SoapFormatter
+            : and then encoded with base64 encoding.
+
+    mimetype: application/x-microsoft.net.object.bytearray.base64
+    value   : The object must be serialized into a byte array 
+            : using a System.ComponentModel.TypeConverter
+            : and then encoded with base64 encoding.
+    -->
+  <xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
+    <xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
+    <xsd:element name="root" msdata:IsDataSet="true">
+      <xsd:complexType>
+        <xsd:choice maxOccurs="unbounded">
+          <xsd:element name="metadata">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" />
+              </xsd:sequence>
+              <xsd:attribute name="name" use="required" type="xsd:string" />
+              <xsd:attribute name="type" type="xsd:string" />
+              <xsd:attribute name="mimetype" type="xsd:string" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="assembly">
+            <xsd:complexType>
+              <xsd:attribute name="alias" type="xsd:string" />
+              <xsd:attribute name="name" type="xsd:string" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="data">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+                <xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
+              <xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
+              <xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
+              <xsd:attribute ref="xml:space" />
+            </xsd:complexType>
+          </xsd:element>
+          <xsd:element name="resheader">
+            <xsd:complexType>
+              <xsd:sequence>
+                <xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
+              </xsd:sequence>
+              <xsd:attribute name="name" type="xsd:string" use="required" />
+            </xsd:complexType>
+          </xsd:element>
+        </xsd:choice>
+      </xsd:complexType>
+    </xsd:element>
+  </xsd:schema>
+  <resheader name="resmimetype">
+    <value>text/microsoft-resx</value>
+  </resheader>
+  <resheader name="version">
+    <value>2.0</value>
+  </resheader>
+  <resheader name="reader">
+    <value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <resheader name="writer">
+    <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
+  </resheader>
+  <data name="Exception_MissingApiKeyAndContextId" xml:space="preserve">
+    <value>Both the API Key and Context Id are empty, one or the other must be filled to allow successfull connection.</value>
+  </data>
+  <data name="Exception_MissingEndpoint" xml:space="preserve">
+    <value>The endpoint was not configured.</value>
+  </data>
+</root>

src/Sitecore.AspNetCore.SDK.GraphQL/Sitecore.AspNetCore.SDK.GraphQL.csproj

@@ -11,4 +11,25 @@
     <PackageReference Include="Microsoft.Extensions.Options" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Compile Update="Properties\Resources.Designer.cs">
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Resources.resx</DependentUpon>
+    </Compile>
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Update="Properties\Resources.resx">
+      <Generator>ResXFileCodeGenerator</Generator>
+      <LastGenOutput>Resources.Designer.cs</LastGenOutput>
+    </EmbeddedResource>
+  </ItemGroup>
+
+  <ItemGroup>
+    <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+      <_Parameter1>Sitecore.AspNetCore.SDK.GraphQL.Tests</_Parameter1>
+    </AssemblyAttribute>
+  </ItemGroup>
+
 </Project>