21 more cosmos db partitions by default (#24)

* Update solution to build on cmd line and VS2017, and hopefully in build pipeline.

* Fix versions

* Verify signing on .nupkg files only.

* Use Cosmos partitions by default, keyed by full sessionId.

* Partitioning off by default. Opt-in to mega-partitioning.

* Update Cosmos tests for wildcard partitioning.

* Prevent using 'id' for partition key. Update Readme.

* Fix versioning.

* More rebase cleanup. :/

Author: StephenMolloy

Microsoft.Aspnet.SessionState.sln

@@ -21,6 +21,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionItems", "SolutionIt
 	ProjectSection(SolutionItems) = preProject
 		tools\CosmosDBSessionStateProviderAsync.settings.targets = tools\CosmosDBSessionStateProviderAsync.settings.targets
 		tools\MicrosoftAspNetSessionState.settings.targets = tools\MicrosoftAspNetSessionState.settings.targets
+		Readme.md = Readme.md
 		tools\SessionStateModule.settings.targets = tools\SessionStateModule.settings.targets
 		tools\SqlSessionStateProviderAsync.settings.targets = tools\SqlSessionStateProviderAsync.settings.targets
 		tools\version.targets = tools\version.targets

MicrosoftAspNetSessionState.msbuild

@@ -15,7 +15,7 @@
   </ItemGroup>
 
   <Target Name="Build" DependsOnTargets="BuildAssemblies;UnitTest;BuildPackages" />
-  <Target Name="BuildAll" DependsOnTargets="BuildAssemblies;BuildSamples;UnitTest;BuildPackages" />
+  <Target Name="BuildAll" DependsOnTargets="BuildAssemblies;BuildSamples;BuildPackages;UnitTest" />
   <Target Name="Clean" DependsOnTargets="CleanPackages;CleanSamples;CleanTests;CleanAssemblies" />
   <Target Name="Rebuild" DependsOnTargets="Clean;Build" />
 

Readme.md

@@ -50,12 +50,16 @@ Information on contributing to this repo is in the [Contributing Guide](CONTRIBU
       <providers>
         <add name="CosmosDBSessionStateProviderAsync" cosmosDBEndPointSettingKey="cosmosDBEndPointSetting" cosmosDBAuthKeySettingKey="cosmosDBAuthKeySetting"
           databaseId="[DataBaseId]" collectionId="[CollectionId]" offerThroughput="5000" connectionMode="Direct" connectionProtocol="Tcp" requestTimeout="5"
-          maxConnectionLimit="50" maxRetryAttemptsOnThrottledRequests="10" maxRetryWaitTimeInSeconds="10" preferredLocations="" partitionKey=""
-          partitionNumUsedByProvider=""
+          maxConnectionLimit="50" maxRetryAttemptsOnThrottledRequests="10" maxRetryWaitTimeInSeconds="10" preferredLocations="" partitionKey="pKey"
+          partitionNumUsedByProvider="*"
           type="Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"/>
       </providers>
     </sessionState>
 ```
+
+NOTE: For the best scalability, it is recommended to configure your CosmosDB provider with "wildcard" partitioning. For update-compatibility purposes, this is not the default. Please read about
+*partitionKeyPath* and *partitionNumUsedByProvider* below.
+
 1. *cosmosDBEndPointSettingKey* - The appsetting key name which points to a CosmosDB end point
 
 2. *cosmosDBAuthKeySettingKey* - The appsetting key name which points to a CosmosDB auth key
@@ -76,6 +80,6 @@ Information on contributing to this repo is in the [Contributing Guide](CONTRIBU
 
 10. *preferredLocations* - Sets the preferred locations(regions) for geo-replicated database accounts in the Azure DocumentDB database service. Use ';' to split multiple locations. e.g. "East US;South Central US;North Europe"
 
-11. *partitionKey* - The partition key name of the collection
+11. *partitionKeyPath* - The name of the key to use for logically partitioning the collection. This key name should be different from 'id' unless "wildcard" partitioning is being used.
 
-12. *partitionNumUsedByProvider* - the number of partition can be used for sessionstate
+12. *partitionNumUsedByProvider* - The number of partition can be used for sessionstate. This was designed with the thought that multiple Cosmos partitions would be an extra cost. CosmosDB as it stands today encourages as many diverse logical partitions as you can imagine, as more partitions allow for better horizontal scaling. Setting this to an integer value will effectively reduce the partition count to 32 or less, even if the specified value is much greater. This is a result of how session ID's were translated to partition ID's by this provider. ***It is now recommended to specify "\*" for this option if possible.*** This will reuse the full session ID for partitioning, allowing Cosmos maximum ability for horizontal scaling.

src/CosmosDBSessionStateProviderAsync/CosmosDBSessionStateProviderAsync.cs

@@ -39,6 +39,15 @@ public class CosmosDBSessionStateProviderAsync : SessionStateStoreProviderAsyncB
         private static int s_timeout;
         private static Uri s_documentCollectionUri;
         private static IDocumentClient s_client;
+        private static IndexingPolicy s_indexNone = new IndexingPolicy()
+        {
+            IndexingMode = IndexingMode.Consistent,
+            ExcludedPaths = new System.Collections.ObjectModel.Collection<ExcludedPath>()
+                            {
+                                new ExcludedPath() { Path = "/*" }
+                            },
+            IncludedPaths = new System.Collections.ObjectModel.Collection<IncludedPath>()
+        };
 
         #region CosmosDB Stored Procedures            
         private static readonly string CreateSessionStateItemSPID = "CreateSessionStateItem";
@@ -862,10 +871,21 @@ internal static void ParseCosmosDbEndPointSettings(NameValueCollection providerC
 
             if (PartitionEnabled)
             {
-                if(!int.TryParse(providerConfig["partitionNumUsedByProvider"], out s_partitionNumUsedBySessionProvider) || s_partitionNumUsedBySessionProvider < 1)
+                if (providerConfig["partitionNumUsedByProvider"] == "*")
+                {
+                    s_partitionNumUsedBySessionProvider = -1;
+                }
+                else if (!int.TryParse(providerConfig["partitionNumUsedByProvider"], out s_partitionNumUsedBySessionProvider) || s_partitionNumUsedBySessionProvider < 1)
                 {
                     s_partitionNumUsedBySessionProvider = 10;
                 }
+
+                // If the value of 'id' and the partition key are the same, it is ok to combine them. Since we're not doing wildcard partitioning
+                // the values will not be the same. So we should throw if trying to use 'id' as the partition key. It will cause problems.
+                if (s_partitionNumUsedBySessionProvider >= 0 && s_partitionKey == "id")
+                {
+                    throw new ConfigurationErrorsException(string.Format(SR.Cant_use_id_for_partition_key, "s_partitionKey"));
+                }
             }
         }
 
@@ -954,6 +974,11 @@ private static RequestOptions CreateRequestOptions(string sessionId)
 
         private static string CreatePartitionValue(string sessionId)
         {
+            // If s_partitionNumUsedBySessionProvider is less than 0, that means the wildcard option was specified.
+            // In which case, we are not limiting partition count. Just use the entire sessionId.
+            if (s_partitionNumUsedBySessionProvider < 0)
+                return sessionId;
+
             Debug.Assert(!string.IsNullOrEmpty(sessionId));
             Debug.Assert(PartitionEnabled);
             Debug.Assert(s_partitionNumUsedBySessionProvider != 0);
@@ -997,7 +1022,24 @@ private static async Task CreateCollectionIfNotExistsAsync()
         {
             try
             {
-                await s_client.ReadDocumentCollectionAsync(DocumentCollectionUri);
+                DocumentCollection dc = await s_client.ReadDocumentCollectionAsync(DocumentCollectionUri);
+
+                // If we're using the updated partition strategy (see comment below) but we haven't updated our indexing policy - do that now.
+                if (PartitionEnabled && (s_partitionNumUsedBySessionProvider < 0))
+                {
+                    // Contains doesn't work, presumably because a 'new ExcludePath' is a different object from the existing one, even if the path strings
+                    // are exactly the same. So we do this the old-fashioned way.
+                    bool containsWildcard = false;
+                    foreach (var epath in dc.IndexingPolicy.ExcludedPaths)
+                        if (epath.Path.Equals("/*", StringComparison.InvariantCultureIgnoreCase))
+                            containsWildcard = true;
+
+                    if (!containsWildcard)
+                    {
+                        dc.IndexingPolicy = s_indexNone;
+                        await s_client.ReplaceDocumentCollectionAsync(DocumentCollectionUri, dc, new RequestOptions { OfferThroughput = s_offerThroughput });
+                    }
+                }
             }
             catch (DocumentClientException e)
             {
@@ -1008,9 +1050,15 @@ private static async Task CreateCollectionIfNotExistsAsync()
                         Id = s_collectionId,
                         DefaultTimeToLive = s_timeout
                     };
+
                     if(PartitionEnabled)
                     {
                         docCollection.PartitionKey.Paths.Add($"/{s_partitionKey}");
+
+                        // If we're using the updated partition strategy - 1 logical partition per sessionId - then there is no
+                        // need for indexing. It will not speed up lookup, and it only contributes to overhead on writes.
+                        if (s_partitionNumUsedBySessionProvider < 0)
+                            docCollection.IndexingPolicy = s_indexNone;
                     }
 
                     await s_client.CreateDocumentCollectionAsync(

src/CosmosDBSessionStateProviderAsync/Resources/SR.Designer.cs

@@ -120,6 +120,9 @@
   <data name="ArgumentNull_WithParamName" xml:space="preserve">
     <value>Parameter '{0}' cannot be null.</value>
   </data>
+  <data name="Cant_use_id_for_partition_key" xml:space="preserve">
+    <value>The value '{0}' is invalid for 'partitionKeyPath' when not using wildcard partitioning.</value>
+  </data>
   <data name="EmptyConfig_WithName" xml:space="preserve">
     <value>Configuration '{0}' cannot be null.</value>
   </data>