Version creation now needs contentValue

Author: blva

tools/cli/internal/apiversion/version.go

@@ -104,6 +104,21 @@ func WithContent(contentType string) Option {
 	}
 }
 
+func WithFullContent(contentType string, contentValue *openapi3.MediaType) Option {
+	return func(v *APIVersion) error {
+		if !IsPreviewSabilityLevel(contentType) {
+			return WithContent(contentType)(v)
+		}
+
+		name, _ := GetPreviewVersionName(contentValue)
+		if name != "" {
+			return WithVersion(name)(v)
+		}
+
+		return WithContent(contentType)(v)
+	}
+}
+
 func DateFromVersion(version string) (time.Time, error) {
 	if IsPreviewSabilityLevel(version) {
 		return time.Now(), nil
@@ -112,7 +127,7 @@ func DateFromVersion(version string) (time.Time, error) {
 }
 
 func (v *APIVersion) Equal(v2 *APIVersion) bool {
-	return v.version == v2.version
+	return strings.EqualFold(v.version, v2.version)
 }
 
 func (v *APIVersion) GreaterThan(v2 *APIVersion) bool {
@@ -155,9 +170,13 @@ func (v *APIVersion) IsPrivatePreview() bool {
 	return strings.Contains(v.version, PrivatePreviewStabilityLevel)
 }
 
+func (v *APIVersion) IsPublicPreview() bool {
+	return v.IsPreview() && !v.IsPrivatePreview()
+}
+
 func IsPreviewSabilityLevel(value string) bool {
 	// we also need string match given private preview versions like "private-preview-<name>"
-	return strings.EqualFold(value, PreviewStabilityLevel) || strings.Contains(value, PrivatePreviewStabilityLevel)
+	return strings.EqualFold(value, PreviewStabilityLevel) || strings.Contains(value, PreviewStabilityLevel)
 }
 
 func IsStableSabilityLevel(value string) bool {
@@ -211,7 +230,7 @@ func FindLatestContentVersionMatched(op *openapi3.Operation, requestedVersion *A
 		}
 
 		for contentType, contentValue := range response.Value.Content {
-			contentVersion, err := New(WithContent(contentType))
+			contentVersion, err := New(WithFullContent(contentType, contentValue))
 			if err != nil {
 				log.Printf("Ignoring invalid content type: %q", contentType)
 				continue
@@ -221,9 +240,9 @@ func FindLatestContentVersionMatched(op *openapi3.Operation, requestedVersion *A
 				return contentVersion
 			}
 
-			if contentVersion.ExactMatchOnly() || requestedVersion.ExactMatchOnly() {
+			if requestedVersion.ExactMatchOnly() {
 				// for private preview, we will need to match with "preview" and x-xgen-preview name extension
-				if requestedVersion.IsPrivatePreview() && PrivatePreviewContentMatch(contentValue, requestedVersion) {
+				if privatePreviewContentMatch(contentVersion, contentValue, requestedVersion) {
 					return contentVersion
 				}
 				continue
@@ -246,10 +265,16 @@ func FindLatestContentVersionMatched(op *openapi3.Operation, requestedVersion *A
 	return latestVersionMatch
 }
 
-func PrivatePreviewContentMatch(contentValue *openapi3.MediaType, requestedVersion *APIVersion) bool {
+func privatePreviewContentMatch(contentVersion *APIVersion, contentValue *openapi3.MediaType, requestedVersion *APIVersion) bool {
+	log.Printf("trying to match in case one of the versions is private preview")
+	if !contentVersion.IsPrivatePreview() && !requestedVersion.IsPrivatePreview() {
+		return false
+	}
+
 	name, err := GetPreviewVersionName(contentValue)
 	if err != nil {
-		log.Printf("failed to parse preview version name: %v", err)
+		log.Printf("failed to parse preview version name for content=%v err=%v", contentVersion.version, err)
+		return false
 	}
 
 	return strings.EqualFold(name, requestedVersion.version)
@@ -266,6 +291,7 @@ func Sort(versions []*APIVersion) {
 	}
 }
 
+// GetPreviewVersionName returns the preview version name.
 func GetPreviewVersionName(contentTypeValue *openapi3.MediaType) (name string, err error) {
 	public, name, err := parsePreviewExtensionData(contentTypeValue)
 	if err != nil {

tools/cli/internal/apiversion/version_test.go

@@ -163,6 +163,56 @@ func TestNewAPIVersionFromContentType(t *testing.T) {
 	}
 }
 
+func TestApiVersion_WithFullContent(t *testing.T) {
+	testCases := []struct {
+		name          string
+		contentType   string
+		contentValue  *openapi3.MediaType
+		expectedMatch string
+		wantErr       bool
+	}{
+		{
+			name:          "json",
+			contentType:   "application/vnd.atlas.2023-01-01+json",
+			contentValue:  &openapi3.MediaType{},
+			expectedMatch: "2023-01-01",
+			wantErr:       false,
+		},
+		{
+			name:          "preview",
+			contentType:   "application/vnd.atlas.preview+json",
+			contentValue:  &openapi3.MediaType{},
+			expectedMatch: "preview",
+			wantErr:       false,
+		},
+		{
+			name:        "private-preview",
+			contentType: "application/vnd.atlas.preview+json",
+			contentValue: &openapi3.MediaType{
+				Extensions: map[string]interface{}{
+					"x-xgen-preview": map[string]interface{}{
+						"name": "feature",
+					},
+				},
+			},
+			expectedMatch: "private-preview-feature",
+			wantErr:       false,
+		},
+	}
+
+	for _, tt := range testCases {
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			version, err := New(WithFullContent(tt.contentType, tt.contentValue))
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.Equal(t, tt.expectedMatch, version.String())
+			}
+		})
+	}
+}
+
 func TestApiVersion_GreaterThan(t *testing.T) {
 	testCases := []struct {
 		name     string
@@ -445,6 +495,11 @@ func TestFindLatestContentVersionMatched(t *testing.T) {
 			targetVersion: "preview",
 			expectedMatch: "preview",
 		},
+		{
+			name:          "exact match private-preview-feature",
+			targetVersion: "private-preview-feature",
+			expectedMatch: "private-preview-feature",
+		},
 		{
 			name:          "exact match 2023-11-15",
 			targetVersion: "2023-11-15",

tools/cli/internal/openapi/filter/extension.go

@@ -256,8 +256,8 @@ func getVersionsInContentType(content map[string]*openapi3.MediaType) (
 	contentsInVersion = make(map[string]*openapi3.MediaType)
 	versionsInContentType := make(map[string]*apiversion.APIVersion)
 
-	for contentType := range content {
-		v, err := apiversion.New(apiversion.WithContent(contentType))
+	for contentType, contentValue := range content {
+		v, err := apiversion.New(apiversion.WithFullContent(contentType, contentValue))
 		if err != nil {
 			log.Printf("Ignoring invalid content type: %s", contentType)
 			continue

tools/cli/internal/openapi/filter/versioning.go

@@ -195,7 +195,7 @@ func filterLatestVersionedContent(content map[string]*openapi3.MediaType, latest
 	latestContent := openapi3.Content{}
 
 	for contentType, mediaType := range content {
-		contentVersion, err := apiversion.New(apiversion.WithContent(contentType))
+		contentVersion, err := apiversion.New(apiversion.WithFullContent(contentType, mediaType))
 		if err != nil {
 			log.Printf("Ignoring invalid content type: %s", contentType)
 			continue
@@ -234,13 +234,24 @@ func filterContentExactMatch(content map[string]*openapi3.MediaType, version *ap
 
 	filteredContent := make(map[string]*openapi3.MediaType)
 	for contentType, mediaType := range content {
-		contentVersion, err := apiversion.New(apiversion.WithContent(contentType))
+		contentVersion, err := apiversion.New(apiversion.WithFullContent(contentType, mediaType))
 		if err != nil {
 			log.Printf("Ignoring invalid content type: %s", contentType)
 			continue
 		}
 
+		if version.IsPrivatePreview() && !contentVersion.IsPrivatePreview() {
+			continue
+		}
+
+		if !version.IsPrivatePreview() && contentVersion.IsPrivatePreview() {
+			continue
+		}
+
 		if contentVersion.Equal(version) {
+			if version.IsPreview() {
+				log.Printf("Found preview content: %s matching with %s", contentType, version.String())
+			}
 			updateSingleMediaTypeExtension(mediaType, contentVersion)
 			filteredContent[contentType] = mediaType
 		}
@@ -263,8 +274,8 @@ func updateSingleMediaTypeExtension(m *openapi3.MediaType, version *apiversion.A
 // getDeprecatedVersionsPerContent returns the deprecated versions for a given content type.
 func getDeprecatedVersionsPerContent(content map[string]*openapi3.MediaType, version *apiversion.APIVersion) []*apiversion.APIVersion {
 	versionsInContentType := make(map[string]*apiversion.APIVersion)
-	for contentType := range content {
-		v, err := apiversion.New(apiversion.WithContent(contentType))
+	for contentType, contentValue := range content {
+		v, err := apiversion.New(apiversion.WithFullContent(contentType, contentValue))
 		if err != nil {
 			log.Printf("Ignoring invalid content type: %s", contentType)
 			continue
@@ -286,8 +297,8 @@ func isVersionedContent(content map[string]*openapi3.MediaType) bool {
 		return false
 	}
 
-	for contentType := range content {
-		if _, err := apiversion.New(apiversion.WithContent(contentType)); err == nil {
+	for contentType, contentValue := range content {
+		if _, err := apiversion.New(apiversion.WithFullContent(contentType, contentValue)); err == nil {
 			log.Printf("Found versioned content: %s", contentType)
 			return true
 		}