Fixes for pr60 (#66)

* Fix some things that were not caught in #60 now that it's rebased on a 'main' that can build and run tests.

* Update docs to match changes.

Author: StephenMolloy

Readme.md

@@ -34,3 +34,12 @@ The specific settings available for the new session state module and providers a
 - [Microsoft.AspNet.SessionState.SessionStateModule](docs/SessionStateModule.md)
 - [Microsoft.AspNet.SessionState.SqlSessionStateProviderAsync](docs/SqlSessionStateProviderAsync.md)
 - [Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync](docs/CosmosDBSessionStateProviderAsync.md)
+
+<a name="updates"></a>
+## V1.2 Updates:
+  * :warning: ***Breaking Change*** - CosmosDB partition-related parameters are ignored. All containers use `/id` as the partition path now. Using an existing container with a different partition key path will result in exceptions.
+    > The original design around partition use in the CosmosDB provider was influenced by experience with the older SQL partition paradigms. There was an effort to enable them for scalability, but keep them reasonable for managability. In reality, CosmosDB encourages the use of as many "logical" partitions as can be used so long as they make sense. The complexity of managing and scaling is all handled magically by CosmosDB.
+    >
+    > The most logical partition field for session state is the session ID. The CosmosDB provider has been updated to alway use `"/id"` as the partition key path with the full session ID as the partition value. Pre-existing containers that use a different partition key path (which is any that opted into using partitions previously) will need to migrate to a container that uses `"/id"` as the partition key path. The data is all still good - although, the old partition key path can be dropped when migrating. There is unfortunately no way to simply update the partition key path on an existing container right now. [This blog post](https://devblogs.microsoft.com/cosmosdb/how-to-change-your-partition-key/) is a guide for migrating to a new container with the correct partition key path.
+  * CosmosDB `collectionId` is now `containerId` in keeping with the updated terminology from the CosmosDB offering. Please use the updated parameter name when configuring your provider. (The old name will continue to work just the same.)
+  * CosmosDB `connectionProtocol` is obsolete. It will not cause errors to have it in configuration, but it is ignored. The current [CosmosDB SDK chooses the protocol based on connection mode](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/sdk-connection-modes).

docs/CosmosDBSessionStateProviderAsync.md

@@ -8,9 +8,8 @@ Then, register your new provider like so:
   <sessionState cookieless="false" regenerateExpiredSessionId="true" mode="Custom" customProvider="CosmosDBSessionStateProviderAsync">
     <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="" partitionKeyPath="pKey"
-          partitionNumUsedByProvider="*"
+          databaseId="[DataBaseId]" collectionId="[CollectionId]" offerThroughput="5000" connectionMode="Direct" requestTimeout="5"
+          maxConnectionLimit="50" maxRetryAttemptsOnThrottledRequests="10" maxRetryWaitTimeInSeconds="10" preferredLocations=""
           type="Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Version=1.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"/>
     </providers>
   </sessionState>
@@ -27,18 +26,12 @@ Then, register your new provider like so:
 
 4. *connectionMode* - Direct | Gateway
 
-5. *connectionProtocol* - Https | Tcp
+5. *requestTimeout* - The request timeout in seconds when connecting to the Azure DocumentDB database service.
 
-6. *requestTimeout* - The request timeout in seconds when connecting to the Azure DocumentDB database service.
+6. *maxConnectionLimit* - maximum number of concurrent connections allowed for the target service endpoint in the Azure DocumentDB database service.
 
-7. *maxConnectionLimit* - maximum number of concurrent connections allowed for the target service endpoint in the Azure DocumentDB database service.
+7. *maxRetryAttemptsOnThrottledRequests* - the maximum number of retries in the case where the request fails because the Azure DocumentDB database service has applied rate limiting on the client.
 
-8. *maxRetryAttemptsOnThrottledRequests* - the maximum number of retries in the case where the request fails because the Azure DocumentDB database service has applied rate limiting on the client.
+8. *maxRetryWaitTimeInSeconds* - The maximum retry time in seconds for the Azure DocumentDB database service.
 
-9. *maxRetryWaitTimeInSeconds* - The maximum retry time in seconds for the Azure DocumentDB database service.
-
-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. *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. 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.
+9. *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"

src/CosmosDBSessionStateProviderAsync/CosmosDBSessionStateProviderAsync.cs

@@ -46,7 +46,7 @@ public class CosmosDBSessionStateProviderAsync : SessionStateStoreProviderAsyncB
         };
 
         #region CosmosDB Stored Procedures            
-        private static readonly string CreateSessionStateItemSPID = "CreateSessionStateItemInPartition";
+        private static readonly string CreateSessionStateItemSPID = "CreateSessionStateItem";
         private static readonly string GetStateItemSPID = "GetStateItem";
         private static readonly string GetStateItemExclusiveSPID = "GetStateItemExclusive";
         private static readonly string ReleaseItemExclusiveSPID = "ReleaseItemExclusive";
@@ -801,7 +801,7 @@ internal static void ParseCosmosDbEndPointSettings(NameValueCollection providerC
             if (string.IsNullOrEmpty(s_containerId))
             {
                 s_containerId = providerConfig["collectionId"];
-                if (string.IsNullOrEmpty(s_collectionId))
+                if (string.IsNullOrEmpty(s_containerId))
                 {
                     throw new ConfigurationErrorsException(string.Format(SR.EmptyConfig_WithName, "containerId"));
                 }
@@ -889,7 +889,7 @@ private static async Task CreateContainerIfNotExistsAsync()
 
             ContainerResponse response = await database.CreateContainerIfNotExistsAsync(containerProperties, s_offerThroughput).ConfigureAwait(false);
 
-            if (response.Resource?.PartitionKeyPath != partitionKeyPath)
+            if (response?.Resource?.PartitionKeyPath != partitionKeyPath)
             {
                 throw new Exception(String.Format(CultureInfo.CurrentCulture, SR.Container_PKey_Does_Not_Match, s_containerId, partitionKeyPath));
             }

src/CosmosDBSessionStateProviderAsync/Properties/AssemblyInfo.cs

@@ -25,4 +25,4 @@
 // The following GUID is for the ID of the typelib if this project is exposed to COM
 [assembly: Guid("4cfb2896-d5c1-4e96-a3da-d57c58539209")]
 [assembly: InternalsVisibleTo("Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync.Test, PublicKey=0024000004800000940000000602000000240000525341310004000001000100b5fc90e7027f67871e773a8fde8938c81dd402ba65b9201d60593e96c492651e889cc13f1415ebb53fac1131ae0bd333c5ee6021672d9718ea31a8aebd0da0072f25d87dba6fc90ffd598ed4da35e44c398c454307e8e33b8426143daec9f596836f97c8f74750e5975c64e2189f45def46b2a2b1247adc3652bf5c308055da9")]
-
+[assembly: InternalsVisibleTo("DynamicProxyGenAssembly2, PublicKey=0024000004800000940000000602000000240000525341310004000001000100c547cac37abd99c8db225ef2f6c8a3602f3b3606cc9891605d02baa56104f4cfc0734aa39b93bf7852f7d9266654753cc297e7d2edfe0bac1cdcf9f717241550e0a7b191195b7667bb4f64bcb8e2121380fd1d9d46ad2d92d2d15605093924cceaf74c4861eff62abf69b9291ed0a340e113be11e6a7d3113e92484cf7045cc7")]

src/CosmosDBSessionStateProviderAsync/Resources/SR.Designer.cs

@@ -25,7 +25,6 @@
             offerThroughput: The offer throughput provisioned for a collection in measurement of Requests-per-Unit in the Azure DocumentDB database service. 
                             If the collection provided doesn't exist, the provider will create a collection with this offerThroughput.
             connectionMode: Direct | Gateway
-            connectionProtocol: Https | Tcp
             requestTimeout: the request timeout in seconds when connecting to the Azure DocumentDB database service.
             maxConnectionLimit: maximum number of concurrent connections allowed for the target service endpoint in the Azure DocumentDB database service.
             maxRetryAttemptsOnThrottledRequests: the maximum number of retries in the case where the request fails because the Azure DocumentDB database service has applied rate limiting on the client.
@@ -34,8 +33,8 @@
             partitionKey: the partition key name of the collection
             partitionNumUsedByProvider: the number of partition can be used for sessionstate
       -->
-        <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=""
+        <add name="CosmosDBSessionStateProviderAsync" cosmosDBEndPointSettingKey="cosmosDBEndPointSetting" cosmosDBAuthKeySettingKey="cosmosDBAuthKeySetting" databaseId="[DataBaseId]" containerId="[ContainerId]" offerThroughput="5000"
+          connectionMode="Direct" requestTimeout="5" maxConnectionLimit="50" maxRetryAttemptsOnThrottledRequests="10" maxRetryWaitTimeInSeconds="10" preferredLocations=""
           type="Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Microsoft.AspNet.SessionState.CosmosDBSessionStateProviderAsync, Version=1.1.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35"
              xdt:Transform="InsertIfMissing" />
       </providers>