Removed Azure specific headers from typespec_client_core. (Azure#2958)

Co-authored-by: Copilot <[email protected]>

Author: LarryOsterman

Cargo.lock

@@ -18,6 +18,7 @@
 - Removed feature `reqwest_rustls_tls`. See [README.md](https://github.com/heaths/azure-sdk-for-rust/blob/main/sdk/core/azure_core/README.md) for alternative HTTP client configuration.
 - Removed the `fs` module including the `FileStream` and `FileStreamBuilder` types. Moved to `examples/` for `typespec_client_core` to copy if needed.
 - Removed the `setters` macro.
+- Added the ability to configure pipeline configuration independently from `ClientOptions`. This adds a new optional `PipelineOptions` parameter to `azure_core::http::Pipeline::new()`. If not specified, it defaults to the expected options for `azure_core` services.
 
 ### Bugs Fixed
 

sdk/core/azure_core/CHANGELOG.md

@@ -66,6 +66,7 @@ impl TestServiceClient {
                 options.client_options,
                 Vec::default(),
                 Vec::default(),
+                None,
             ),
         })
     }

sdk/core/azure_core/benches/http_transport_benchmarks.rs

@@ -10,81 +10,48 @@ pub use typespec_client_core::http::headers::*;
 // We use lowercase below for simple comparisons downstream.
 
 pub const ACCOUNT_KIND: HeaderName = HeaderName::from_static("x-ms-account-kind");
-pub const ACL: HeaderName = HeaderName::from_static("x-ms-acl");
-pub const ACTIVITY_ID: HeaderName = HeaderName::from_static("x-ms-activity-id");
-pub const APP: HeaderName = HeaderName::from_static("x-ms-app");
+pub(crate) const ACTIVITY_ID: HeaderName = HeaderName::from_static("x-ms-activity-id");
+pub(crate) const APP: HeaderName = HeaderName::from_static("x-ms-app");
 pub const APPEND_POSITION: HeaderName = HeaderName::from_static("x-ms-blob-condition-appendpos"); // cspell:ignore appendpos
 pub const AZURE_ASYNCOPERATION: HeaderName = HeaderName::from_static("azure-asyncoperation");
-pub const BLOB_ACCESS_TIER: HeaderName = HeaderName::from_static("x-ms-access-tier");
-pub const BLOB_CACHE_CONTROL: HeaderName = HeaderName::from_static("x-ms-blob-cache-control");
-pub const BLOB_COMMITTED_BLOCK_COUNT: HeaderName =
-    HeaderName::from_static("x-ms-blob-committed-block-count");
-pub const BLOB_CONTENT_LENGTH: HeaderName = HeaderName::from_static("x-ms-blob-content-length");
-pub const BLOB_PUBLIC_ACCESS: HeaderName = HeaderName::from_static("x-ms-blob-public-access");
-pub const BLOB_SEQUENCE_NUMBER: HeaderName = HeaderName::from_static("x-ms-blob-sequence-number");
-pub const BLOB_TYPE: HeaderName = HeaderName::from_static("x-ms-blob-type");
+pub(crate) const BLOB_SEQUENCE_NUMBER: HeaderName =
+    HeaderName::from_static("x-ms-blob-sequence-number");
 pub const CLIENT_REQUEST_ID: HeaderName = HeaderName::from_static("x-ms-client-request-id");
-pub const CLIENT_VERSION: HeaderName = HeaderName::from_static("x-ms-client-version");
-pub const CONTENT_DISPOSITION: HeaderName =
+pub(crate) const CLIENT_VERSION: HeaderName = HeaderName::from_static("x-ms-client-version");
+pub(crate) const CONTENT_DISPOSITION: HeaderName =
     HeaderName::from_static("x-ms-blob-content-disposition");
-pub const CONTINUATION: HeaderName = HeaderName::from_static("x-ms-continuation");
-pub const COPY_COMPLETION_TIME: HeaderName = HeaderName::from_static("x-ms-copy-completion-time");
-pub const COPY_PROGRESS: HeaderName = HeaderName::from_static("x-ms-copy-progress");
-pub const COPY_SOURCE: HeaderName = HeaderName::from_static("x-ms-copy-source");
-pub const COPY_STATUS_DESCRIPTION: HeaderName =
-    HeaderName::from_static("x-ms-copy-status-description");
-pub const COPY_STATUS: HeaderName = HeaderName::from_static("x-ms-copy-status");
-pub const CREATION_TIME: HeaderName = HeaderName::from_static("x-ms-creation-time");
-pub const DELETE_SNAPSHOTS: HeaderName = HeaderName::from_static("x-ms-delete-snapshots");
-pub const DELETE_TYPE_PERMANENT: HeaderName = HeaderName::from_static("x-ms-delete-type-permanent");
-pub const ENCRYPTION_ALGORITHM: HeaderName = HeaderName::from_static("x-ms-encryption-algorithm");
-pub const ENCRYPTION_KEY_SHA256: HeaderName = HeaderName::from_static("x-ms-encryption-key-sha256");
-pub const ENCRYPTION_KEY: HeaderName = HeaderName::from_static("x-ms-encryption-key");
-pub const HAS_IMMUTABILITY_POLICY: HeaderName =
-    HeaderName::from_static("x-ms-has-immutability-policy");
-pub const HAS_LEGAL_HOLD: HeaderName = HeaderName::from_static("x-ms-has-legal-hold");
-pub const IF_SEQUENCE_NUMBER_EQ: HeaderName = HeaderName::from_static("x-ms-if-sequence-number-eq");
-pub const IF_SEQUENCE_NUMBER_LE: HeaderName = HeaderName::from_static("x-ms-if-sequence-number-le");
-pub const IF_SEQUENCE_NUMBER_LT: HeaderName = HeaderName::from_static("x-ms-if-sequence-number-lt");
-pub const IF_TAGS: HeaderName = HeaderName::from_static("x-ms-if-tags");
-pub const ITEM_COUNT: HeaderName = HeaderName::from_static("x-ms-item-count");
-pub const ITEM_TYPE: HeaderName = HeaderName::from_static("x-ms-item-type");
-pub const LEASE_ACTION: HeaderName = HeaderName::from_static("x-ms-lease-action");
-pub const LEASE_BREAK_PERIOD: HeaderName = HeaderName::from_static("x-ms-lease-break-period");
-pub const LEASE_DURATION: HeaderName = HeaderName::from_static("x-ms-lease-duration");
-pub const LEASE_ID: HeaderName = HeaderName::from_static("x-ms-lease-id");
-pub const LEASE_STATE: HeaderName = HeaderName::from_static("x-ms-lease-state");
-pub const LEASE_STATUS: HeaderName = HeaderName::from_static("x-ms-lease-status");
-pub const LEASE_TIME: HeaderName = HeaderName::from_static("x-ms-lease-time");
-pub const MAX_ITEM_COUNT: HeaderName = HeaderName::from_static("x-ms-max-item-count");
-pub const META_PREFIX: HeaderName = HeaderName::from_static("x-ms-meta-");
+pub(crate) const CONTINUATION: HeaderName = HeaderName::from_static("x-ms-continuation");
+pub const ERROR_CODE: HeaderName = HeaderName::from_static("x-ms-error-code");
+pub(crate) const IF_SEQUENCE_NUMBER_EQ: HeaderName =
+    HeaderName::from_static("x-ms-if-sequence-number-eq");
+pub(crate) const IF_SEQUENCE_NUMBER_LE: HeaderName =
+    HeaderName::from_static("x-ms-if-sequence-number-le");
+pub(crate) const IF_SEQUENCE_NUMBER_LT: HeaderName =
+    HeaderName::from_static("x-ms-if-sequence-number-lt");
+pub(crate) const IF_TAGS: HeaderName = HeaderName::from_static("x-ms-if-tags");
+pub(crate) const LEASE_BREAK_PERIOD: HeaderName =
+    HeaderName::from_static("x-ms-lease-break-period");
+pub(crate) const LEASE_DURATION: HeaderName = HeaderName::from_static("x-ms-lease-duration");
+pub(crate) const LEASE_ID: HeaderName = HeaderName::from_static("x-ms-lease-id");
+pub(crate) const MAX_ITEM_COUNT: HeaderName = HeaderName::from_static("x-ms-max-item-count");
 pub const MS_DATE: HeaderName = HeaderName::from_static("x-ms-date");
-pub const MS_RANGE: HeaderName = HeaderName::from_static("x-ms-range");
-pub const NAMESPACE_ENABLED: HeaderName = HeaderName::from_static("x-ms-namespace-enabled");
-pub const PAGE_WRITE: HeaderName = HeaderName::from_static("x-ms-page-write");
-pub const PROPERTIES: HeaderName = HeaderName::from_static("x-ms-properties");
-pub const PROPOSED_LEASE_ID: HeaderName = HeaderName::from_static("x-ms-proposed-lease-id");
-pub const RANGE_GET_CONTENT_CRC64: HeaderName =
+pub(crate) const MS_RANGE: HeaderName = HeaderName::from_static("x-ms-range");
+pub(crate) const PROPOSED_LEASE_ID: HeaderName = HeaderName::from_static("x-ms-proposed-lease-id");
+pub(crate) const RANGE_GET_CONTENT_CRC64: HeaderName =
     HeaderName::from_static("x-ms-range-get-content-crc64");
-pub const RANGE_GET_CONTENT_MD5: HeaderName = HeaderName::from_static("x-ms-range-get-content-md5");
-pub const REQUEST_ID: HeaderName = HeaderName::from_static("x-ms-request-id");
-pub const REQUEST_SERVER_ENCRYPTED: HeaderName =
-    HeaderName::from_static("x-ms-request-server-encrypted");
-pub const REQUIRES_SYNC: HeaderName = HeaderName::from_static("x-ms-requires-sync");
-pub const SERVER_ENCRYPTED: HeaderName = HeaderName::from_static("x-ms-server-encrypted");
-pub const SESSION_TOKEN: HeaderName = HeaderName::from_static("x-ms-session-token");
-pub const SKU_NAME: HeaderName = HeaderName::from_static("x-ms-sku-name");
-pub const SOURCE_IF_MATCH: HeaderName = HeaderName::from_static("x-ms-source-if-match");
-pub const SOURCE_IF_MODIFIED_SINCE: HeaderName =
+pub(crate) const REQUEST_ID: HeaderName = HeaderName::from_static("x-ms-request-id");
+pub const RETRY_AFTER_MS: HeaderName = HeaderName::from_static("retry-after-ms");
+pub(crate) const SOURCE_IF_MATCH: HeaderName = HeaderName::from_static("x-ms-source-if-match");
+pub(crate) const SOURCE_IF_MODIFIED_SINCE: HeaderName =
     HeaderName::from_static("x-ms-source-if-modified-since");
-pub const SOURCE_IF_NONE_MATCH: HeaderName = HeaderName::from_static("x-ms-source-if-none-match");
-pub const SOURCE_IF_UNMODIFIED_SINCE: HeaderName =
+pub(crate) const SOURCE_IF_NONE_MATCH: HeaderName =
+    HeaderName::from_static("x-ms-source-if-none-match");
+pub(crate) const SOURCE_IF_UNMODIFIED_SINCE: HeaderName =
     HeaderName::from_static("x-ms-source-if-unmodified-since");
-pub const SOURCE_LEASE_ID: HeaderName = HeaderName::from_static("x-ms-source-lease-id");
-pub const SOURCE_RANGE: HeaderName = HeaderName::from_static("x-ms-source-range");
-pub const TAGS: HeaderName = HeaderName::from_static("x-ms-tags");
-pub const USER: HeaderName = HeaderName::from_static("x-ms-user");
+pub(crate) const SOURCE_LEASE_ID: HeaderName = HeaderName::from_static("x-ms-source-lease-id");
+pub(crate) const USER: HeaderName = HeaderName::from_static("x-ms-user");
 pub const VERSION: HeaderName = HeaderName::from_static("x-ms-version");
+pub const X_MS_RETRY_AFTER_MS: HeaderName = HeaderName::from_static("x-ms-retry-after-ms");
 
 /// Constants related to the Content-Type header
 ///
@@ -95,15 +62,8 @@ pub mod content_type {
     // Form content types
     // https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4
 
-    pub const MULTIPART_FORM_DATA: HeaderValue = HeaderValue::from_static("multipart/form-data");
     pub const APPLICATION_X_WWW_FORM_URLENCODED: HeaderValue =
         HeaderValue::from_static("application/x-www-form-urlencoded");
-
-    pub const APPLICATION_XML: HeaderValue = HeaderValue::from_static("application/xml");
-    pub const APPLICATION_JSON: HeaderValue = HeaderValue::from_static("application/json");
-    pub const APPLICATION_OCTET_STREAM: HeaderValue =
-        HeaderValue::from_static("application/octet-stream");
-    pub const TEXT_PLAIN: HeaderValue = HeaderValue::from_static("text/plain");
 }
 
 /// Constants related to query parameters

sdk/core/azure_core/src/http/headers.rs

@@ -8,8 +8,8 @@ pub use instrumentation::*;
 use std::sync::Arc;
 use typespec_client_core::http::policies::Policy;
 pub use typespec_client_core::http::{
-    ClientMethodOptions, ExponentialRetryOptions, FixedRetryOptions, LoggingOptions, RetryOptions,
-    TransportOptions,
+    ClientMethodOptions, ExponentialRetryOptions, FixedRetryOptions, LoggingOptions,
+    PipelineOptions, RetryOptions, TransportOptions,
 };
 pub use user_agent::*;
 

sdk/core/azure_core/src/http/options/mod.rs

@@ -3,6 +3,7 @@
 
 use super::policies::ClientRequestIdPolicy;
 use crate::http::{
+    headers::{ERROR_CODE, RETRY_AFTER_MS, X_MS_RETRY_AFTER_MS},
     policies::{
         Policy, PublicApiInstrumentationPolicy, RequestInstrumentationPolicy, UserAgentPolicy,
     },
@@ -13,7 +14,9 @@ use std::{
     ops::Deref,
     sync::Arc,
 };
-use typespec_client_core::http;
+use typespec_client_core::http::{
+    self, headers::RETRY_AFTER, policies::RetryHeaders, PipelineOptions,
+};
 
 /// Execution pipeline.
 ///
@@ -43,12 +46,21 @@ impl Pipeline {
     ///
     /// Crates can simply pass `option_env!("CARGO_PKG_NAME")` and `option_env!("CARGO_PKG_VERSION")` for the
     /// `crate_name` and `crate_version` arguments respectively.
+    ///
+    /// # Arguments
+    /// * `crate_name` - The name of the crate implementing the client library.
+    /// * `crate_version` - The version of the crate implementing the client library.
+    /// * `options` - The client options.
+    /// * `per_call_policies` - Policies to be executed per call, before the policies in `ClientOptions::per_call_policies`.
+    /// * `per_try_policies` - Policies to be executed per try, before the policies in `ClientOptions::per_try_policies`.
+    /// * `pipeline_options` - Additional options for the pipeline. If `None`, default options will be used.
     pub fn new(
         crate_name: Option<&'static str>,
         crate_version: Option<&'static str>,
         options: ClientOptions,
         per_call_policies: Vec<Arc<dyn Policy>>,
         per_try_policies: Vec<Arc<dyn Policy>>,
+        pipeline_options: Option<PipelineOptions>,
     ) -> Self {
         let (core_client_options, options) = options.deconstruct();
 
@@ -91,10 +103,18 @@ impl Pipeline {
             push_unique(&mut per_try_policies, request_instrumentation_policy);
         }
 
+        let pipeline_options = pipeline_options.unwrap_or_else(|| PipelineOptions {
+            retry_headers: RetryHeaders {
+                retry_headers: vec![X_MS_RETRY_AFTER_MS, RETRY_AFTER_MS, RETRY_AFTER],
+                error_header: Some(ERROR_CODE),
+            },
+        });
+
         Self(http::Pipeline::new(
             options,
             per_call_policies,
             per_try_policies,
+            Some(pipeline_options),
         ))
     }
 }
@@ -179,6 +199,7 @@ mod tests {
             options,
             per_call_policies,
             per_retry_policies,
+            None,
         );
 
         let mut request = Request::new("https://example.com".parse().unwrap(), Method::Get);
@@ -232,6 +253,7 @@ mod tests {
             options,
             per_call_policies,
             per_retry_policies,
+            None,
         );
 
         let mut request = Request::new("https://example.com".parse().unwrap(), Method::Get);
@@ -285,6 +307,7 @@ mod tests {
             options,
             per_call_policies,
             per_retry_policies,
+            None,
         );
 
         let mut request = Request::new("https://example.com".parse().unwrap(), Method::Get);
@@ -345,6 +368,7 @@ mod tests {
             options,
             per_call_policies,
             per_retry_policies,
+            None,
         );
 
         let mut request = Request::new("https://example.com".parse().unwrap(), Method::Get);