impl(storage-control): auto-populate request IDs (googleapis#2591)

Author: dbolduc

internal/api/model.go

@@ -245,6 +245,10 @@ func (m *Method) HasRouting() bool {
 	return len(m.Routing) != 0
 }
 
+func (m *Method) HasAutoPopulatedFields() bool {
+	return len(m.AutoPopulated) != 0
+}
+
 // Normalized request path information.
 type PathInfo struct {
 	// The list of bindings, including the top-level binding.

internal/rust/templates/crate/src/builder.rs.mustache

@@ -149,7 +149,13 @@ pub mod {{Codec.ModuleName}} {
                 traits (e.g. `std::clone::Clone`) making the call ambiguous.
                 Using `*self.0.stub` makes the call not-ambiguous.
             }}
+            {{#HasAutoPopulatedFields}}
+            let req = Self::auto_populate(self.0.request, false);
+            (*self.0.stub).{{Codec.Name}}(req, self.0.options).await.map(gax::response::Response::into_body)
+            {{/HasAutoPopulatedFields}}
+            {{^HasAutoPopulatedFields}}
             (*self.0.stub).{{Codec.Name}}(self.0.request, self.0.options).await.map(gax::response::Response::into_body)
+            {{/HasAutoPopulatedFields}}
         }
         {{#Pagination}}
 
@@ -164,6 +170,19 @@ pub mod {{Codec.ModuleName}} {
             {{/Optional}}
             let execute = move |token: String| {
                 let mut builder = self.clone();
+                {{#HasAutoPopulatedFields}}
+                {{!
+                    If we have a new page token, this is a new request. New
+                    requests need new request IDs.
+                }}
+                {{^Optional}}
+                let initial = builder.0.request.{{Codec.FieldName}} == token;
+                {{/Optional}}
+                {{#Optional}}
+                let initial = builder.0.request.{{Codec.FieldName}}.as_deref().is_none_or(|s| s == token);
+                {{/Optional}}
+                builder.0.request = Self::auto_populate(builder.0.request, !initial);
+                {{/HasAutoPopulatedFields}}
                 builder.0.request = builder.0.request.set_{{Codec.SetterName}}(token);
                 builder.send()
             };
@@ -234,6 +253,22 @@ pub mod {{Codec.ModuleName}} {
             {{/Codec.BothAreEmpty}}
         }
         {{/OperationInfo}}
+        {{#HasAutoPopulatedFields}}
+
+        fn auto_populate(mut req: {{InputType.Codec.QualifiedName}}, force: bool) -> {{InputType.Codec.QualifiedName}} {
+            {{#AutoPopulated}}
+            {{#Optional}}
+            if force || req.{{Codec.FieldName}}.is_none() {
+            {{/Optional}}
+            {{^Optional}}
+            if force || req.{{Codec.FieldName}}.is_empty() {
+            {{/Optional}}
+                req = req.set_{{Codec.SetterName}}(uuid::Uuid::new_v4().to_string())
+            }
+            {{/AutoPopulated}}
+            req
+        }
+        {{/HasAutoPopulatedFields}}
         {{#InputType.Codec.BasicFields}}
 
         /// Sets the value of [{{Codec.FieldName}}][{{Codec.FQMessageName}}::{{Codec.SetterName}}].

internal/rust/templates/crate/src/transport.rs.mustache

@@ -74,6 +74,12 @@ impl super::stub::{{Codec.Name}} for {{Codec.Name}} {
         use gaxi::path_parameter::try_match;
         use gaxi::routing_parameter::Segment;
         {{/Codec.HasBindingSubstitutions}}
+        {{#HasAutoPopulatedFields}}
+        let options = gax::options::internal::set_default_idempotency(
+            options,
+            true,
+        );
+        {{/HasAutoPopulatedFields}}
         let (builder, method) = None
         {{#PathInfo.Bindings}}
         .or_else(|| {
@@ -128,6 +134,7 @@ impl super::stub::{{Codec.Name}} for {{Codec.Name}} {
         })??;
         let options = gax::options::internal::set_default_idempotency(
             options,
+            {{! TODO(#2588) - return idempotency from the above closure }}
             gaxi::http::default_idempotency(&method),
         );
         let builder = builder

internal/rust/templates/grpc-client/transport.rs.mustache

@@ -97,7 +97,13 @@ impl super::stub::{{Codec.Name}} for {{Codec.Name}} {
         use gaxi::prost::ToProto;
         let options = gax::options::internal::set_default_idempotency(
             options,
+            {{! TODO(#2588) - resolve this in the model }}
+            {{#HasAutoPopulatedFields}}
+            true,
+            {{/HasAutoPopulatedFields}}
+            {{^HasAutoPopulatedFields}}
             {{PathInfo.Codec.IsIdempotent}},
+            {{/HasAutoPopulatedFields}}
         );
         let extensions = {
             let mut e = tonic::Extensions::new();