CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set #243

blva · 2024-10-08T15:14:44Z

Proposed changes

Jira ticket: CLOUDP-271223

No doc diff + duplicated path

➜  cli git:(CLOUDP-271223) ✗ ./bin/foascli merge -b test/data/base_spec.json -e test/data/apiregistry_spec.json --output tes.json
2024/10/08 16:06:56 Detected x-xgen-soa-migration annotation in all operations for path:  /rest/v2/openapi/info
2024/10/08 16:06:56 Skipping conflict for path: /rest/v2/openapi/info
2024/10/08 16:06:56 No doc diff detected for path /rest/v2/openapi/info, merging the paths
2024/10/08 16:06:56 
We silently resolved the conflict with the schemas "OpenApiInfo" because the definition was identical.
2024/10/08 16:06:56 
We silently resolved the conflict with the schemas "info" because the definition was identical.
2024/10/08 16:06:56 
We silently resolved the conflict with the schemas "license" because the definition was identical.
2024/10/08 16:06:56 
We silently resolved the conflict with the schemas "ApiError" because the definition was identical.
2024/10/08 16:06:56 
File was saved in 'tes.json'.

Doc diff + duplicated path

➜  cli git:(CLOUDP-271223) ✗ ./bin/foascli merge -b test/data/base_spec.json -e test/data/apiregistry_spec.json --output tes.json
2024/10/08 17:11:06 Detected x-xgen-soa-migration annotation in all operations for path:  /rest/v2/openapi/info
2024/10/08 17:11:06 Skipping conflict for path: /rest/v2/openapi/info
Error: the path: "/rest/v2/openapi/info" is enabled for merge but it has a diff between the base and external spec. See the diff:
{
  "operations": {
    "modified": {
      "GET": {
        "operationID": {
          "from": "getOpenApiInaafo",
          "to": "getOpenApiInfo"
        }
      }
    }
  }
}

➜  cli git:(CLOUDP-271223) ✗ ./bin/foascli merge -b test/data/base_spec.json -e test/data/apiregistry_spec.json --output tes.json
2024/10/08 17:11:24 Detected x-xgen-soa-migration annotation in all operations for path:  /rest/v2/openapi/info
2024/10/08 17:11:24 Skipping conflict for path: /rest/v2/openapi/info
Error: the path: "/rest/v2/openapi/info" is enabled for merge but the flag to allow docs diff is not supported

Checklist

I have signed the MongoDB CLA
I have added tests that prove my fix is effective or that my feature works

Further comments

tools/cli/internal/openapi/oasdiff.go

tools/cli/internal/openapi/errors/merge_conflict_error.go

andreaangiolillo · 2024-10-09T11:08:23Z

tools/cli/internal/openapi/errors/merge_conflict_error.go

+		pathDiff, _ = json.MarshalIndent(e.Diff.PathsDiff.Modified[e.Entry], "", "  ")
+	}
+
+	return fmt.Sprintf("the path: %q is enabled for merge but it has a diff between the base and external spec. See the diff:\n%s", e.Entry, pathDiff)


could you also provide the two files involved in this mismatch? We have a ticket to improve the error message of a conflict to list also the files that are involved to help investigate the issue.

let me do this in another task, so that we can update all the error outputs or else this will grow. maybe we can defer to the ticket you mentioned

andreaangiolillo · 2024-10-09T11:12:58Z

tools/cli/internal/openapi/oasdiff.go

+	external  *load.SpecInfo
+	config    *diff.Config
+	specDiff  *diff.Diff
+	noExtDiff NoExtensionDiff


The name NoExtensionDiff gives fom granted a lot of context on how we use extensions in the spec. Main question from a person without context is what is the difference between specDiff *diff.Diff and noExtDiff NoExtensionDiff?

Question: can we have an interface that includes both specDiff *diff.Diff and noExtDiff NoExtensionDiff as they are both checking differences between specifications

starting with decoupling specDiff since we already have an oasdiff result struct in #250

andreaangiolillo · 2024-10-09T11:19:55Z

tools/cli/internal/openapi/oasdiff.go

+		return nil
+	}
+
+	// allowDocsDiff = true not supported


Could you update this comment to add more context: what is allowDocsDiff?, why is not supported? what is the implication in this piece of code?

andreaangiolillo · 2024-10-09T11:21:48Z

tools/cli/internal/openapi/oasdiff.go

@@ -417,6 +483,27 @@ func (o OasDiff) areSchemaIdentical(name string) bool {
 	return !ok
 }

+// arePathsIdenticalWithExcludeExtensions checks if the paths are identical with the extensions excluded


could you provide an example of the extension in the comment?

this runs oasdiff with an "ignore extensions" config, I've updated the comment

andreaangiolillo · 2024-10-09T11:23:08Z

tools/cli/internal/openapi/oasdiff.go

@@ -417,6 +483,27 @@ func (o OasDiff) areSchemaIdentical(name string) bool {
 	return !ok
 }

+// arePathsIdenticalWithExcludeExtensions checks if the paths are identical with the extensions excluded
+func (o OasDiff) arePathsIdenticalWithExcludeExtensions(name string) (bool, error) {


the code seems to be checking if the path are identical with and without extensions 🤔 is this correct? if yes , we should rename the function to reflect this logic

no, it's excluding extensions from the diff since there will always be Extensions, will update!

andreaangiolillo · 2024-10-09T11:28:45Z

tools/cli/internal/openapi/oasdiff_test.go

+				Get: &openapi3.Operation{
+					Extensions: map[string]interface{}{
+						"x-xgen-soa-migration": map[string]interface{}{
+							"allowDocsDiff": "true",


if we have AllowDocsDiffNotSupportedError, why allowDocsDiff can be set to true?

I think answer is the same as it's a separate ticket to support it (cause initially we were not going to support)

tools/cli/internal/openapi/paths.go

andreaangiolillo · 2024-10-09T11:33:03Z

tools/cli/internal/openapi/paths.go

+	return operation.Extensions[extensionName]
+}
+
+func allOperationsAllowDocsDiff(basePath *openapi3.PathItem) bool {


all of these functions seem to share the logic to check for something in each resource operation. Could you just have a function that runs multiple checks for each operation?

can cover as a follow up as we have many other places in the code where we perform checks for each operation

Co-authored-by: Andrea Angiolillo <[email protected]>

andreaangiolillo

LGTM, thanks for all the clarifications!

blva added 12 commits October 8, 2024 12:14

CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set

2f091dd

Use const

04c2eb8

Update

5c1b255

Simplify

b69e8a1

Fix tests

9df5a39

Simplify

ef3b6e6

update

dd500c8

Merge branch 'main' into CLOUDP-271223

fa10ddf

Add unit tests

d35e601

Lint and update

5ded458

Add tests

0a5d7df

Lint

8eb3c9e

blva marked this pull request as ready for review October 9, 2024 00:20

blva requested a review from a team as a code owner October 9, 2024 00:20

andreaangiolillo reviewed Oct 9, 2024

View reviewed changes

tools/cli/internal/openapi/oasdiff.go Outdated Show resolved Hide resolved

andreaangiolillo reviewed Oct 9, 2024

View reviewed changes

tools/cli/internal/openapi/oasdiff.go Show resolved Hide resolved

Address comment

e45a90b

blva requested a review from andreaangiolillo October 9, 2024 11:01

andreaangiolillo reviewed Oct 9, 2024

View reviewed changes

blva and others added 10 commits October 9, 2024 20:43

Update tools/cli/internal/openapi/paths.go

bf5ed4b

Co-authored-by: Andrea Angiolillo <[email protected]>

address comment

580dcd5

Address comment

61613ab

Merge branch 'main' into CLOUDP-271223

03e789d

Address comments

413a716

Update

eaed0f0

Update tests

73e8aae

Update

354f4d9

Update

d78e2c2

Lint

a97ba4e

blva requested a review from andreaangiolillo October 11, 2024 16:06

andreaangiolillo approved these changes Oct 24, 2024

View reviewed changes

blva merged commit dbebab7 into main Oct 24, 2024
8 checks passed

blva deleted the CLOUDP-271223 branch October 24, 2024 10:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set #243

CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set #243

blva commented Oct 8, 2024 •

edited

Loading

andreaangiolillo Oct 9, 2024

blva Oct 10, 2024

andreaangiolillo Oct 9, 2024

blva Oct 11, 2024

blva Oct 11, 2024

andreaangiolillo Oct 9, 2024

andreaangiolillo Oct 9, 2024

blva Oct 11, 2024

andreaangiolillo Oct 9, 2024

blva Oct 9, 2024

andreaangiolillo Oct 9, 2024

blva Oct 11, 2024

andreaangiolillo Oct 9, 2024

blva Oct 11, 2024

andreaangiolillo left a comment

CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set #243

CLOUDP-271223: Skip conflict when x-xgen-soa-migration is set #243

Conversation

blva commented Oct 8, 2024 • edited Loading

Proposed changes

Checklist

Further comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andreaangiolillo left a comment

Choose a reason for hiding this comment

blva commented Oct 8, 2024 •

edited

Loading