Remove TokenCredential::clear_cache (#2385)

* Remove TokenCredential::clear_cache

* remove implementations

* delete azure_identity's TokenCache implementation

* keep caching behavior; remove only the public API

* allow unused TokenCache::clear

Author: chlowell

sdk/core/azure_core/CHANGELOG.md

@@ -14,6 +14,7 @@
 
 ### Breaking Changes
 
+- Removed `azure_core::credentials::TokenCredential::clear_cache()`
 - Consolidated all the `tokio` features into a single feature named `tokio`. Traits remain separate but `tokio` support is enabled with a single feature.
 - Moved `AppendToUrlQuery` type under `http` module.
 - Moved `ByteStream` and `SeekableStream` types under `stream` module.

sdk/core/azure_core/src/credentials.rs

@@ -100,7 +100,4 @@ impl AccessToken {
 pub trait TokenCredential: Send + Sync + Debug {
     /// Gets a `AccessToken` for the specified resource
     async fn get_token(&self, scopes: &[&str]) -> crate::Result<AccessToken>;
-
-    /// Clear the credential's cache.
-    async fn clear_cache(&self) -> crate::Result<()>;
 }

sdk/core/azure_core_test/src/credentials.rs

@@ -26,10 +26,6 @@ impl TokenCredential for MockCredential {
         );
         Ok(AccessToken { token, expires_on })
     }
-
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        Ok(())
-    }
 }
 
 /// Gets a `TokenCredential` appropriate for the current environment.

sdk/cosmos/azure_data_cosmos/src/pipeline/authorization_policy.rs

@@ -175,10 +175,6 @@ mod tests {
                 OffsetDateTime::now_utc().saturating_add(time::Duration::minutes(5)),
             ))
         }
-
-        async fn clear_cache(&self) -> azure_core::Result<()> {
-            Ok(())
-        }
     }
 
     #[tokio::test]

sdk/identity/azure_identity/CHANGELOG.md

@@ -16,6 +16,7 @@
 - `ClientAssertionCredential` constructors moved some parameters to an `Option<ClientAssertionCredentialOptions>` parameter.
 - Removed `get_subscription()` and `get_tenant()` from `AzureCliCredential`.
 - `WorkloadIdentityCredential` constructors moved some parameters to an `Option<ClientAssertionCredentialOptions>` parameter.
+- Removed `clear_cache()` from all credential types
 
 ### Bugs Fixed
 

sdk/identity/azure_identity/examples/specific_credential.rs

@@ -81,20 +81,6 @@ impl TokenCredential for SpecificAzureCredentialKind {
             }
         }
     }
-
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        match self {
-            #[cfg(not(target_arch = "wasm32"))]
-            SpecificAzureCredentialKind::AzureCli(credential) => credential.clear_cache().await,
-            SpecificAzureCredentialKind::VirtualMachine(credential) => {
-                credential.clear_cache().await
-            }
-            SpecificAzureCredentialKind::AppService(credential) => credential.clear_cache().await,
-            SpecificAzureCredentialKind::WorkloadIdentity(credential) => {
-                credential.clear_cache().await
-            }
-        }
-    }
 }
 
 /// Define a credential that uses an environment variable named `AZURE_CREDENTIAL_KIND`
@@ -161,8 +147,4 @@ impl TokenCredential for SpecificAzureCredential {
     async fn get_token(&self, scopes: &[&str]) -> azure_core::Result<AccessToken> {
         self.source.get_token(scopes).await
     }
-
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        self.source.clear_cache().await
-    }
 }

sdk/identity/azure_identity/src/azure_pipelines_credential.rs

@@ -111,10 +111,6 @@ impl TokenCredential for AzurePipelinesCredential {
     async fn get_token(&self, scopes: &[&str]) -> azure_core::Result<AccessToken> {
         self.0.get_token(scopes).await
     }
-
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        self.0.clear_cache().await
-    }
 }
 
 #[derive(Debug)]

sdk/identity/azure_identity/src/chained_token_credential.rs

@@ -114,21 +114,6 @@ impl TokenCredential for ChainedTokenCredential {
     async fn get_token(&self, scopes: &[&str]) -> azure_core::Result<AccessToken> {
         self.cache.get_token(scopes, self.get_token(scopes)).await
     }
-
-    /// Clear the credential's cache.
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        // clear the internal cache as well as each of the underlying providers
-        self.cache.clear().await?;
-
-        for source in &self.sources {
-            source.clear_cache().await?;
-        }
-
-        // clear the successful credential if we are clearing the token cache
-        self.successful_credential.write().await.take();
-
-        Ok(())
-    }
 }
 
 fn format_aggregate_error(errors: &[Error]) -> String {
@@ -182,10 +167,6 @@ mod tests {
             *count += 1;
             Err(Error::message(ErrorKind::Credential, "failed to get token"))
         }
-
-        async fn clear_cache(&self) -> azure_core::Result<()> {
-            Ok(())
-        }
     }
 
     #[tokio::test]

sdk/identity/azure_identity/src/credentials/app_service_managed_identity_credential.rs

@@ -55,8 +55,4 @@ impl TokenCredential for AppServiceManagedIdentityCredential {
     async fn get_token(&self, scopes: &[&str]) -> azure_core::Result<AccessToken> {
         self.credential.get_token(scopes).await
     }
-
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        self.credential.clear_cache().await
-    }
 }

sdk/identity/azure_identity/src/credentials/azure_cli_credentials.rs

@@ -293,11 +293,6 @@ impl TokenCredential for AzureCliCredential {
     async fn get_token(&self, scopes: &[&str]) -> azure_core::Result<AccessToken> {
         self.cache.get_token(scopes, self.get_token(scopes)).await
     }
-
-    /// Clear the credential's cache.
-    async fn clear_cache(&self) -> azure_core::Result<()> {
-        self.cache.clear().await
-    }
 }
 
 impl From<TokenCredentialOptions> for AzureCliCredentialOptions {