Botframework-sdk: Unable to set the TTL for CosmosDB userstate container

[nmishr]

This is not for asking questions or filing bugs

To get help with an issue with your bot

• "How To" questions should be submitted on Stack Overflow.

To file an issue against a component please go to the components repo

• Create Azure Bot Framework Service or Channel issue
• Create Bot Builder Tools issue
• Create Bot Builder SDK V3 (.NET or Javascript) issue
• Create Bot Builder SDK V4 .NET issue
• Create Bot Builder SDK V4 Javascript issue
• Create Bot Builder SDK V4 Java issue
• Create Bot Builder SDK V4 Python issue

Issue

When creating the CosmosDB container, there should be a way to set the TTL for the user state

Proposed change

Describe the proposed solution

Component Impact

Describe which components need to be updated

Customer Impact

Describe the impact on customers

Tracking Status

Dotnet SDK

• [ ] PR
• [ ] Merged

Javascript SDK

• [ ] PR
• [ ] Merged

Java SDK

• [ ] PR
• [ ] Merged

Python SDK

• [ ] PR
• [ ] Merged

Emulator

• [ ] PR
• [ ] Merged

Samples

• [ ] PR
• [ ] Merged

Docs

• [ ] PR
• [ ] Merged

Tools

• [ ] PR
• [ ] Merged

[dcr]

[mdrichardson]

@nmishr At one point, we decided not to support this in the Bot Framework SDK since it just adds additional complexity that very few customers are asking for. However, you can set TTL manually after the SDK creates the container.

[EricDahlvang]

If the goal is for the sdk to set ttl on the container, one option is to use an initializer to ensure the database container has the desired Time To Live, before creating the IStorage:

public static class CosmosDbStorageInitializer 
{
    public static async Task<IStorage> GetStorageAsync(CosmosDbPartitionedStorageOptions options, int timeToLiveInSeconds = -1)
    {
        using (var client = new CosmosClient(
            options.CosmosDbEndpoint,
            options.AuthKey,
            options.CosmosClientOptions ?? new CosmosClientOptions()))
        {
            var containerResponse = await client
                .GetDatabase(options.DatabaseId)
                .DefineContainer(options.ContainerId, "/id")
                .WithDefaultTimeToLive(timeToLiveInSeconds)
                .WithIndexingPolicy().WithAutomaticIndexing(false).Attach()
                .CreateIfNotExistsAsync(options.ContainerThroughput)
                .ConfigureAwait(false);
        }

        return new CosmosDbPartitionedStorage(options);
    }
} 

[garypretty]

I have received the suggestion about adding reference to TTL in the docs as part of the R10 docs pillar. Along with that, we have another open issue for ensuring we call out that the newer partitioned storage provider doesn't create the database for you. I think both items could be referenced in an update to the existing cosmos db docs, adding links to the Cosmos TTL docs and also referencing the option Eric specified above.

[mdrichardson]

I'm going to close this issue as there are now two workarounds and there's a new docs issue that will address this for the future.