chore: update tests and examples for v2 keys (#515)

Update the examples to use v2 keys everywhere except the auth client.

Make the test setup create clients that use v2 keys.

Add v2 key client versions of the tests.

Update the docs to use the new key version.

Align the styles of the test setup scripts.

Make all docs example functions return MomentoResult<()>. Functions that
have no return type break the rust doc snippet parsing code.

Use #[allow(unused)] to let us have code snippets that define unused
variables instead of requiring a _ prefix.

Use correctly formatted fake API keys for credential provider snippets.

Make sure all the example functions are called.

Author: nand4011

.github/workflows/on-pull-request.yml

@@ -7,6 +7,9 @@ on:
 env:
   CARGO_TERM_COLOR: always
   GITHUB_TOKEN: ${{ secrets.GITHUB_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"
   TEST_CACHE_NAME: rust-integration-test-ci-cache-${{ github.sha }}
   TEST_AUTH_CACHE_NAME: rust-integration-test-ci-cache-auth-${{ github.sha }}
 
@@ -85,8 +88,6 @@ jobs:
 
   build_rust:
     runs-on: ubuntu-24.04
-    env:
-      MOMENTO_API_KEY: ${{ secrets.ALPHA_TEST_AUTH_TOKEN }}
 
     steps:
       - uses: actions/checkout@v3

CONTRIBUTING.md

@@ -11,6 +11,7 @@ Happy coding :dancer:
 
 - A modern `cargo` tool chain is required; we love [rustup](https://rustup.rs/)
 - A Momento API key is required. You can generate one using the [Momento Console](https://console.gomomento.com)
+- A Momento service endpoint is required. You can find a [list of them here](https://docs.momentohq.com/platform/regions)
 
 > :bulb: **Tip** When installing with `rustup`, which we recommend, ensure no other versions of the Rust toolchain are installed on your system (eg via package managers like homebrew). This can lead to puzzling issues with the `cargo` command. Check `which cargo` to ensure you are using the correct version. Uninstall any other versions of Rust if necessary (`brew uninstall rust`).
 
@@ -36,10 +37,10 @@ make build
 make lint
 
 # run all tests (unit, integration, and doctests)
-MOMENTO_API_KEY=<api key> make test
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make test
 
 # shortcut to run all of the targets before committing:
-MOMENTO_API_KEY=<api key> make
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make
 ```
 
 ## Development 🔨
@@ -59,7 +60,7 @@ an alternative, including but not limited to:
 Run this command to verify everything passes so that you can save yourself some time when our GitHub actions are ran against the commit:
 
 ```bash
-MOMENTO_API_KEY=<api key> make
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make
 ```
 
 ### Tests
@@ -73,39 +74,39 @@ There are three different kinds of tests in this repo:
 To run all the tests you can do:
 
 ```
-MOMENTO_API_KEY=<api key> make test
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make test
 ```
 
 To run only the unit tests:
 
 ```
-MOMENTO_API_KEY=<api key> make test-unit
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make test-unit
 ```
 
 To run only the doc tests:
 
 ```
-MOMENTO_API_KEY=<api key> make test-doctests
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make test-doctests
 ```
 
 To run only the integration tests:
 
 ```
-MOMENTO_API_KEY=<api key> make test-integration
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> make test-integration
 ```
 
 To run a single file of integration tests:
 
 ```
-MOMENTO_API_KEY=<api key> cargo test --test 'cache_sorted_set'
+V1_API_KEY=<v1 key> MOMENTO_API_KEY=<v2 key> MOMENTO_ENDPOINT=<endpoint> cargo test --test 'cache_sorted_set'
 ```
 
 #### Running through VSCode
 
 If you're using VSCode, you would have been prompted to install certain extensions when you opened the project. If not, then navigate to the [extensions file](./.vscode/extensions.json) and install them. The Rust Analyzer extension displays a `Run Test | Debug` button above every test
 that's handy to run tests through the IDE and add breakpoints to debug request paths. 
 
-To configure required the environment variable, `MOMENTO_API_KEY`, for the Rust Analyzer, you'll need to update your VSCode `settings.json`. The repository includes a default settings file that you can use as a starting point. If you do not already have a `settings.json` file in your .vscode directory or if you don't have existing global settings that conflict, you can rename `settings.json.default` to `settings.json`. If you already have a `settings.json` file, consider merging the necessary configurations to preserve your existing settings. Note that changes to `settings.json` may require restarting VSCode to take effect.
+To configure required the environment variables, `V1_API_KEY`, `MOMENTO_API_KEY`, and `MOMENTO_ENDPOINT`, for the Rust Analyzer, you'll need to update your VSCode `settings.json`. The repository includes a default settings file that you can use as a starting point. If you do not already have a `settings.json` file in your .vscode directory or if you don't have existing global settings that conflict, you can rename `settings.json.default` to `settings.json`. If you already have a `settings.json` file, consider merging the necessary configurations to preserve your existing settings. Note that changes to `settings.json` may require restarting VSCode to take effect.
 
 ### How the integration tests are organized
 

Cargo.lock

@@ -60,5 +60,6 @@ momento-test-util = { path = "test-util" }
 anyhow = "1"
 base64-url = "3"
 env_logger = "0"
+serial_test = "3.3.1"
 tokio-test = "0"
 uuid = { version = "1", features = ["v4"] }

Cargo.toml

@@ -17,7 +17,7 @@ path = "src/docs_examples/docs_examples.rs"
 
 [dependencies]
 futures = "0.3.30"
-momento = { version = "0.57.0" }
+momento = { version = "0.59.0" }
 tokio = { version = "1.37.0", features = ["full"] }
 uuid = { version = "1.8.0", features = ["v4"] }
 anyhow = "1"

example/rust/Cargo.lock

@@ -19,7 +19,7 @@ This example demonstrates a basic set and get from a cache.
 
 ```bash
 # Run example code
-MOMENTO_API_KEY=<YOUR API KEY> cargo run --bin=cache
+MOMENTO_API_KEY=<YOUR API KEY> MOMENTO_ENDPOINT=<endpoint> cargo run --bin=cache
 ```
 
 Example Code: [cache.rs](src/bin/cache.rs)
@@ -30,7 +30,7 @@ This example demonstrates subscribing to and publishing to a Topic.
 
 ```bash
 # Run example code
-MOMENTO_API_KEY=<YOUR API KEY> cargo run --bin=topics
+V1_API_KEY=<YOUR V1 API KEY> cargo run --bin=topics
 ```
 
 Example Code: [topics.rs](src/bin/topics.rs)

example/rust/Cargo.toml

@@ -10,8 +10,7 @@ async fn main() -> Result<(), MomentoError> {
         .default_ttl(Duration::from_secs(60))
         .configuration(configurations::Laptop::latest())
         .credential_provider(
-            CredentialProvider::from_env_var("MOMENTO_API_KEY".to_string())
-                .expect("auth token should be valid"),
+            CredentialProvider::from_default_env_var_v2().expect("auth token should be valid"),
         )
         .build()
     {

example/rust/README.template.md

@@ -12,8 +12,8 @@ async fn main() -> Result<(), MomentoError> {
     env_logger::init();
     info!("Starting Momento ProtosocketCacheClient example");
 
-    let credential_provider = CredentialProvider::from_env_var("MOMENTO_API_KEY".to_string())
-        .expect("auth token should be valid");
+    let credential_provider =
+        CredentialProvider::from_default_env_var_v2().expect("auth token should be valid");
 
     let config = momento::protosocket::cache::Configuration::builder()
         .timeout(Duration::from_secs(60))

example/rust/src/bin/cache.rs

@@ -9,9 +9,7 @@ pub async fn main() -> Result<(), MomentoError> {
     let cache_client = CacheClient::builder()
         .default_ttl(Duration::from_secs(60))
         .configuration(Laptop::latest())
-        .credential_provider(CredentialProvider::from_env_var(
-            "MOMENTO_API_KEY".to_string(),
-        )?)
+        .credential_provider(CredentialProvider::from_default_env_var_v2()?)
         .build()?;
 
     cache_client.create_cache(CACHE_NAME.to_string()).await?;