refactor(sidekick): Generalize method sample information (#4228)

With the last sample model simplification, some of the specifics of how
Rust generates samples were sipping into the model. The samples model is
now language neutral, presenting only semantic information.

Author: amanda-tarafa

internal/sidekick/api/model.go

@@ -324,8 +324,9 @@ type Method struct {
 	IsAIPStandardUpdate bool
 	// IsAIPStandardList is true if the method is an AIP standard list method.
 	IsAIPStandardList bool
-	// AIPStandardSampleInfo contains sample generation information for AIP standard methods.
-	AIPStandardSampleInfo *AIPStandardSampleInfo
+	// SampleInfo may contain sample generation information for this method,
+	// usually if it is an AIP conforming metho.
+	SampleInfo *SampleInfo
 	// Codec contains language specific annotations.
 	Codec any
 }
@@ -414,36 +415,19 @@ func (m *Method) HasAutoPopulatedFields() bool {
 	return len(m.AutoPopulated) != 0
 }
 
-// AIPStandardSampleInfo contains information for generating samples for AIP standard methods.
-type AIPStandardSampleInfo struct {
-	// SampleFunctionParameters is a list of string argument names that the generated sample function requires.
-	SampleFunctionParameters []string
-	// InitFieldsFromParameter contains fields that should be initialized from a sample function parameter.
-	InitFieldsFromParameter []*SampleParameterInit
-	// InitFieldsFromStringLiteral contains fields that should be initialized with a string literal.
-	InitFieldsFromStringLiteral []*Field
-	// InitFieldsFromMessage contains fields that should be initialized with a new message instance.
-	InitFieldsFromMessage []*SampleMessageInit
-	// UpdateMaskField is the update mask field, if any, that needs to be initialized.
+// SampleInfo contains sample generation information for a single method,
+// usually if it is an AIP conforming method.
+type SampleInfo struct {
+	// ResourceNameField is the field containing the resource name or parent resource name.
+	ResourceNameField *Field
+	// ResourceIDField is the field containing the resource ID, usually present in Create methods.
+	ResourceIDField *Field
+	// MessageField is the field containing the message body to be created or updated.
+	MessageField *Field
+	// UpdateMaskField is the field containing the update mask, present in Update methods.
 	UpdateMaskField *Field
 }
 
-// SampleParameterInit describes a field that should be initialized from a parameter.
-type SampleParameterInit struct {
-	// Field is the field to be initialized.
-	Field *Field
-	// ParameterName is the name of the parameter to use.
-	ParameterName string
-}
-
-// SampleMessageInit describes a field that should be initialized with a message.
-type SampleMessageInit struct {
-	// Field is the field to be initialized.
-	Field *Field
-	// ParameterName is the name of the parameter to set as the "name" field of the message, if any.
-	ParameterName string
-}
-
 const (
 	// StandardFieldNameForResourceRef is the standard name for resource references
 	// to the resource being operated on by standard methods as defined by AIPs.

internal/sidekick/api/skip_test.go

@@ -322,7 +322,7 @@ var methodIgnoreFields = []string{
 	"IsAIPStandardCreate",
 	"IsAIPStandardUpdate",
 	"IsAIPStandardList",
-	"AIPStandardSampleInfo",
+	"SampleInfo",
 }
 
 func TestIncludeMethods(t *testing.T) {

internal/sidekick/api/xref.go

@@ -230,24 +230,24 @@ func enrichMethodSamples(m *Method) {
 
 	m.IsStreaming = m.ClientSideStreaming || m.ServerSideStreaming
 
-	if m.AIPStandardSampleInfo = aipStandardGetInfo(m); m.AIPStandardSampleInfo != nil {
+	if m.SampleInfo = aipStandardGetInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardGet = true
-	} else if m.AIPStandardSampleInfo = aipStandardDeleteInfo(m); m.AIPStandardSampleInfo != nil {
+	} else if m.SampleInfo = aipStandardDeleteInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardDelete = true
-	} else if m.AIPStandardSampleInfo = aipStandardUndeleteInfo(m); m.AIPStandardSampleInfo != nil {
+	} else if m.SampleInfo = aipStandardUndeleteInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardUndelete = true
-	} else if m.AIPStandardSampleInfo = aipStandardCreateInfo(m); m.AIPStandardSampleInfo != nil {
+	} else if m.SampleInfo = aipStandardCreateInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardCreate = true
-	} else if m.AIPStandardSampleInfo = aipStandardUpdateInfo(m); m.AIPStandardSampleInfo != nil {
+	} else if m.SampleInfo = aipStandardUpdateInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardUpdate = true
-	} else if m.AIPStandardSampleInfo = aipStandardListInfo(m); m.AIPStandardSampleInfo != nil {
+	} else if m.SampleInfo = aipStandardListInfo(m); m.SampleInfo != nil {
 		m.IsAIPStandardList = true
 	}
 
-	m.IsAIPStandard = m.AIPStandardSampleInfo != nil
+	m.IsAIPStandard = m.SampleInfo != nil
 }
 
-func aipStandardGetInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardGetInfo(m *Method) *SampleInfo {
 	if !m.IsSimple || m.InputType == nil || m.ReturnsEmpty {
 		return nil
 	}
@@ -280,15 +280,12 @@ func aipStandardGetInfo(m *Method) *AIPStandardSampleInfo {
 		return nil
 	}
 
-	return &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"resource_name"},
-		InitFieldsFromParameter: []*SampleParameterInit{
-			{Field: resourceField, ParameterName: "resource_name"},
-		},
+	return &SampleInfo{
+		ResourceNameField: resourceField,
 	}
 }
 
-func aipStandardDeleteInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardDeleteInfo(m *Method) *SampleInfo {
 	if !m.IsSimple && m.OperationInfo == nil {
 		return nil
 	}
@@ -312,15 +309,12 @@ func aipStandardDeleteInfo(m *Method) *AIPStandardSampleInfo {
 		return nil
 	}
 
-	return &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"resource_name"},
-		InitFieldsFromParameter: []*SampleParameterInit{
-			{Field: resourceField, ParameterName: "resource_name"},
-		},
+	return &SampleInfo{
+		ResourceNameField: resourceField,
 	}
 }
 
-func aipStandardUndeleteInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardUndeleteInfo(m *Method) *SampleInfo {
 	if !m.IsSimple && m.OperationInfo == nil {
 		return nil
 	}
@@ -344,15 +338,12 @@ func aipStandardUndeleteInfo(m *Method) *AIPStandardSampleInfo {
 		return nil
 	}
 
-	return &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"resource_name"},
-		InitFieldsFromParameter: []*SampleParameterInit{
-			{Field: resourceField, ParameterName: "resource_name"},
-		},
+	return &SampleInfo{
+		ResourceNameField: resourceField,
 	}
 }
 
-func aipStandardCreateInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardCreateInfo(m *Method) *SampleInfo {
 	if (!m.IsSimple && !m.IsLRO) || m.InputType == nil || m.ReturnsEmpty {
 		return nil
 	}
@@ -391,22 +382,17 @@ func aipStandardCreateInfo(m *Method) *AIPStandardSampleInfo {
 
 	resourceIDField := findResourceIDField(m.InputType, maybeSingular)
 
-	info := &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"parent"},
-		InitFieldsFromParameter: []*SampleParameterInit{
-			{Field: parentField, ParameterName: "parent"},
-		},
-		InitFieldsFromMessage: []*SampleMessageInit{
-			{Field: resourceField},
-		},
+	info := &SampleInfo{
+		ResourceNameField: parentField,
+		MessageField:      resourceField,
 	}
 	if resourceIDField != nil {
-		info.InitFieldsFromStringLiteral = []*Field{resourceIDField}
+		info.ResourceIDField = resourceIDField
 	}
 	return info
 }
 
-func aipStandardUpdateInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardUpdateInfo(m *Method) *SampleInfo {
 	if (!m.IsSimple && !m.IsLRO) || m.InputType == nil || m.ReturnsEmpty {
 		return nil
 	}
@@ -443,16 +429,13 @@ func aipStandardUpdateInfo(m *Method) *AIPStandardSampleInfo {
 		}
 	}
 
-	return &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"name"},
-		InitFieldsFromMessage: []*SampleMessageInit{
-			{Field: resourceField, ParameterName: "name"},
-		},
+	return &SampleInfo{
+		MessageField:    resourceField,
 		UpdateMaskField: updateMaskField,
 	}
 }
 
-func aipStandardListInfo(m *Method) *AIPStandardSampleInfo {
+func aipStandardListInfo(m *Method) *SampleInfo {
 	if !m.IsList || m.InputType == nil {
 		return nil
 	}
@@ -482,11 +465,8 @@ func aipStandardListInfo(m *Method) *AIPStandardSampleInfo {
 		return nil
 	}
 
-	return &AIPStandardSampleInfo{
-		SampleFunctionParameters: []string{"parent"},
-		InitFieldsFromParameter: []*SampleParameterInit{
-			{Field: parentField, ParameterName: "parent"},
-		},
+	return &SampleInfo{
+		ResourceNameField: parentField,
 	}
 }