chore: update ci/cd env vars, tests, examples for v2 api keys (#617)

* chore: update github workflows

* chore: update non-auth client examples to use v2 key

* chore: update tests to use v1 token + separate v2 test suite

Author: anitarua

.github/dependabot.yml

@@ -11,3 +11,6 @@ updates:
       interval: "daily"
     allow:
       - dependency-name: "Momento.Sdk"
+    commit-message:
+      # Prefix all commit messages with "chore: "
+      - prefix: "chore"

.github/workflows/build.yaml

@@ -4,6 +4,11 @@ on:
   pull_request:
     branches: [main]
 
+env:
+  V1_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+  MOMENTO_API_KEY: ${{ secrets.ALPHA_API_KEY_V2 }}
+  MOMENTO_ENDPOINT: "cell-alpha-dev.preprod.a.momentohq.com"
+
 jobs:
   format-check:
     runs-on: ubuntu-latest
@@ -20,8 +25,6 @@ jobs:
         os: [ubuntu-latest, windows-latest]
         grpc-web: [false, true]
     runs-on: ${{ matrix.os }}
-    env:
-      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
 
     steps:
       - name: Get current time
@@ -58,10 +61,6 @@ jobs:
 
   build_examples:
     runs-on: ubuntu-latest
-    env:
-      # TODO: remove token stored as secret in favor of using a
-      # momento-local instance that can be spun up for testing
-      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
 
     steps:
       - name: Setup repo

.github/workflows/on-push-to-main-branch.yaml

@@ -12,7 +12,9 @@ jobs:
         grpc-web: [false, true]
     runs-on: ${{ matrix.os }}
     env:
-      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+      V1_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
+      MOMENTO_API_KEY: ${{ secrets.ALPHA_API_KEY_V2 }}
+      MOMENTO_ENDPOINT: "cell-alpha-dev.preprod.a.momentohq.com"
 
     steps:
       - name: Get current time

examples/DictionaryExample/DictionaryExample.csproj

@@ -9,6 +9,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
-    <PackageReference Include="Momento.Sdk" Version="1.39.0" />
+    <PackageReference Include="Momento.Sdk" Version="1.41.0" />
   </ItemGroup>
 </Project>

examples/DictionaryExample/Program.cs

@@ -8,7 +8,6 @@
 
 public class Driver
 {
-    private static readonly string AUTH_TOKEN_ENV_VAR = "MOMENTO_API_KEY";
     private static readonly string CACHE_NAME_ENV_VAR = "MOMENTO_CACHE_NAME";
     private static readonly ILogger _logger;
     private static readonly ILoggerFactory _loggerFactory;
@@ -21,11 +20,12 @@ static Driver()
 
     public async static Task Main()
     {
-        var authToken = ReadAuthToken();
+        // Looks for the environment variables MOMENTO_API_KEY and MOMENTO_ENDPOINT by default
+        var creds = new EnvMomentoV2TokenProvider();
         var cacheName = ReadCacheName();
 
         // Set up the client
-        using ICacheClient client = new CacheClient(Configurations.Laptop.V1(), authToken, TimeSpan.FromSeconds(60));
+        using ICacheClient client = new CacheClient(Configurations.Laptop.V1(), creds, TimeSpan.FromSeconds(60));
         await EnsureCacheExistsAsync(client, cacheName);
 
         // Set a value
@@ -168,33 +168,6 @@ private static ILoggerFactory InitializeLogging()
         });
     }
 
-    private static ICredentialProvider ReadAuthToken()
-    {
-        try
-        {
-            return new EnvMomentoTokenProvider(AUTH_TOKEN_ENV_VAR);
-        }
-        catch (InvalidArgumentException)
-        {
-        }
-
-        Console.Write($"Auth token not detected in environment variable {AUTH_TOKEN_ENV_VAR}. Enter auth token here: ");
-        var authToken = Console.ReadLine()!.Trim();
-
-        StringMomentoTokenProvider? authProvider = null;
-        try
-        {
-            authProvider = new StringMomentoTokenProvider(authToken);
-        }
-        catch (InvalidArgumentException e)
-        {
-            _logger.LogInformation("{}", e);
-            _loggerFactory.Dispose();
-            Environment.Exit(1);
-        }
-        return authProvider!;
-    }
-
     private static string ReadCacheName()
     {
         var cacheName = System.Environment.GetEnvironmentVariable(CACHE_NAME_ENV_VAR);

examples/DictionaryExample/README.md

@@ -2,22 +2,18 @@
 
 This example program demonstrates usage of the dictionary data type.
 
-# Usage
-
-The program assumes the auth token and cache names are available in environment variables. The auth token is assumed to be in the variable `MOMENTO_API_KEY` and the cache name in `MOMENTO_CACHE_NAME`. If either of these is missing, you will be prompted to enter the values on the terminal.
+## Prerequisites
 
-To run the program, run either:
+* [`dotnet`](https://dotnet.microsoft.com/en-us/download) 6.0 or higher is required
+* A Momento API key is required.  You can generate one using the [Momento Console](https://console.gomomento.com/api-keys).
+* A Momento service endpoint is required. Choose the one for the [region](https://docs.momentohq.com/platform/regions) you'll be using, e.g. `cache.cell-1-ap-southeast-1-1.prod.a.momentohq.com` for ap-southeast-1.
 
-```bash
-MOMENTO_API_KEY=<YOUR_API_KEY_HERE> MOMENTO_CACHE_NAME=<YOUR_CACHE_NAME_HERE> dotnet run
-```
+# Usage
 
-or
+To run the program, run either:
 
 ```bash
-dotnet run
+MOMENTO_API_KEY=<YOUR_API_KEY_HERE> MOMENTO_ENDPOINT=<YOUR_ENDPOINT> MOMENTO_CACHE_NAME=<YOUR_CACHE_NAME_HERE> dotnet run
 ```
 
-and you will be prompted to enter the auth token and cache name.
-
 If the cache name entered does not exist, the program will create it.

examples/DisposableTokens/DisposableTokens.csproj

@@ -16,6 +16,6 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="Momento.Sdk" Version="1.39.0" />
+    <PackageReference Include="Momento.Sdk" Version="1.41.0" />
   </ItemGroup>
 </Project>

examples/DisposableTokens/Program.cs

@@ -11,10 +11,10 @@ static class Program
 
     private static readonly ICredentialProvider authProvider;
     private static readonly IAuthClient client;
- 
+
     static Program()
     {
-        authProvider = new EnvMomentoTokenProvider("MOMENTO_API_KEY");
+        authProvider = new EnvMomentoTokenProvider("V1_API_KEY");
         client = new AuthClient(AuthConfigurations.Default.Latest(), authProvider);
     }
 
@@ -71,9 +71,9 @@ private static GenerateDisposableTokenResponse.Success ProcessResponse(GenerateD
     private static void PrintTokenInfo(GenerateDisposableTokenResponse.Success token)
     {
         Console.WriteLine(
-            "The generated disposable token (truncated): " 
-            + token.AuthToken.Substring(0, 10) 
-            + "..." 
+            "The generated disposable token (truncated): "
+            + token.AuthToken.Substring(0, 10)
+            + "..."
             + token.AuthToken.Substring((token.AuthToken.Length - 10), 10)
         );
         Console.WriteLine("The token expires at (epoch timestamp): " + token.ExpiresAt.Epoch() + "\n");

examples/DocExampleApis/DocExampleApis.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Momento.Sdk" Version="1.39.0" />
+    <PackageReference Include="Momento.Sdk" Version="1.41.0" />
   </ItemGroup>
 
 </Project>