fix: @SchemaSwap can only be used once #4354

xRodney · 2022-08-26T08:23:06Z

Description

@SchemaSwap is now repeatable, so multiple modifications can be applied from the same resource root.
Fixed a bug when the swap was "used up" after just one usage, meaning that if the referenced type was used multiple times in object hierarchy, only the first one was swapped.

Fixes #4350

Type of change

Bug fix (non-breaking change which fixes an issue)
Feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change
Chore (non-breaking change which doesn't affect codebase;
test, version modification, documentation, etc.)

Checklist

Code contributed by me aligns with current project license: Apache 2.0
I Added CHANGELOG entry regarding this change
I have implemented unit tests to cover my changes
I have added/updated the javadocs and other documentation accordingly
No new bugs, code smells, etc. in SonarCloud report
I tested my code in Kubernetes
I tested my code in OpenShift

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java

andreaTP

@xRodney Thanks a lot for this PR!
I really like the overall changes that you did 🙂 , I added a few notes to be discussed.

A few additional requests, since you are fixing a bug can you add test cases for the relevant situations where the current implementation is failing (what you already described in the issue):

SchemaSwap should be applied to all occurrences in the hierarchy
SchemaSwap should be applied to deeply nested structures (e.g. 3 or more levels down)
SchemaSwap should fail if the field name is not matched

andreaTP · 2022-08-26T09:29:38Z

crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

@@ -239,11 +256,9 @@ private T internalFromImpl(TypeDef definition, Set<String> visited, List<Interna
        continue;
      }

-      final PropertyFacade facade = new PropertyFacade(property, accessors, currentSchemaSwaps);
+      ClassRef potentialSchemaSwap = schemaSwaps.lookupAndMark(definition.toReference(), name).orElse(null);


If I correctly follow this change, here you cannot mark just yet the SchemaSwap as used, as it will mark the annotation to be "used" even in this condition:

Matched Class

The Class doesn't have the specified Property (e.g. a matching field)

This operation should be performed only after process has been called on the PropertyFacade (and the SchemaSwap has been matched).

schemaSwapt.lookupAndMark accepts two arguments, the second being the property name. (Line 253: String name = property.getName();)
So I'm not sure I understand your concern?
Btw, I thought the case of "matched class, unmatched field" is being tested in JsonSchemaTest.shouldThrowIfSchemaSwapHasUnmatchedField. This test is still passing and I only extended it with assert on the error message. But the error is still thrown.

Or is your concern that the name could be overriden by @JsonProperty & friends? IMHO it makes more sense for the fieldName parameter to reference the fields as is defined in Java, but that's just my opinion.

it makes more sense for the fieldName parameter to reference the fields as is defined in Java, but that's just my opinion.

This makes sense, but, using name might not be the name extracted by the PropertyFacade constructor:

kubernetes-client/crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

Lines 414 to 426 in 808084e

propertyOrAccessors.add(PropertyOrAccessor.fromProperty(property));

Method method = potentialAccessors.get("is" + capitalized);

if (method != null) {

propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));

}

method = potentialAccessors.get("get" + capitalized);

if (method != null) {

propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));

}

method = potentialAccessors.get("set" + capitalized);

if (method != null) {

propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));

}

in some cases, the PropertyFacade is extracting the field name from constructor/getter/setter
and this implementation will not respect the extracted name as opposed to the underlying field name.
We can either refactor the logic and use the PropertyFacade name extraction logic everywhere or simply document this different behavior.

I see, and the only way how that can happen is a @JsonProperty on the field itself or getter (get* or is*) or setter.
I can only say that to me, as the user of the library, would never occur that fieldName could reference the name after transformations.
Maybe it's because the word "field" is used, whose meaning in Java is well defined and is different from the term "property". (Field is a class variable, property is a getter/setter pair - which often is backed by a field). Also the annotation is @JsonProperty, not "JsonField".
Or maybe it's because the reason I am dealing with @SchemaSwaps in the first place is that I cannot place annotations (like @JsonProperty) on the field directly.
So with your permission, I will add Javadocs on @SchemaSwap, describing the currently implemented behaviour.

To me, this "limitation" is totally fine, please just make it explicit in this doc:
https://github.com/fabric8io/kubernetes-client/blob/master/doc/CRD-generator.md#iofabric8crdgeneratorannotationschemaswap

mentioning something along the lines:

the name of the field is restricted to the original fieldName and should be backed by a matching concrete field of the matching class. Getters, setters, and constructors are not taken into consideration.

cc. @metacosm to check if he is on board with this decision.

I think that should be fine but this should be documented as a breaking change, though…

I agree that it "might" be breaking, but, at the same time, this PR is solving some fundamental issues with the implementation and I doubt anyone else is using it just yet.

Maybe we can add a line to the Changelog for reference, wdyt?

crd-generator/api/src/main/java/io/fabric8/crd/generator/InternalSchemaSwaps.java

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java

xRodney · 2022-08-26T11:36:26Z

I have pushed one more test for deeply nested hierarchies, which also tests that the Swap is applied multiple times.
As for the third case you mentioned, when name is not matched, I believe that case is already covered by a pre-existing test, but let's discuss that in that other thread.

andreaTP

Thanks again for this effort @xRodney !
LGTM, but let's wait for a little to see if @metacosm wanna chip in.

andreaTP · 2022-08-26T16:00:16Z

@xRodney can you please fix the issues with the CI? mvn spotless:apply -f crd-generator/pom.xml should make it automatically.

xRodney · 2022-08-26T20:05:24Z

Hey @andreaTP, thanks to you, too for your help.
I did the reformat and also at the last minute I noticed I forgot to delete the now unused InternalSchemaSwap inner class. And that led to realization that I can move the logic of validateRemainingSchemaSwaps into the new class InternalSchemaSwaps, so its inner class no longer leaks out and can be renamed back to Value.
And last but not least, I squashed everything into one commit.
So I'll wait for the CI to finish and for @metacosm's review and we're ready to take off.

xRodney · 2022-08-30T07:16:53Z

Hi @andreaTP, it appears that you need to run the CI for me, with me being a first-time contributor? If so, could you please do it, so that we know if we are in the green?

metacosm · 2022-09-02T08:54:50Z

crd-generator/api/src/main/java/io/fabric8/crd/generator/AbstractJsonSchema.java

@@ -239,11 +256,9 @@ private T internalFromImpl(TypeDef definition, Set<String> visited, List<Interna
        continue;
      }

-      final PropertyFacade facade = new PropertyFacade(property, accessors, currentSchemaSwaps);
+      ClassRef potentialSchemaSwap = schemaSwaps.lookupAndMark(definition.toReference(), name).orElse(null);


I think that should be fine but this should be documented as a breaking change, though…

xRodney · 2022-09-03T20:29:43Z

I have updated the changelog and added the breaking change as requested. In the latest iteration I have also added a few more tests about the case when targetType is void. And also rebased.
Please, run the CI one more time and if it passes, I think we are ready for merge.

andreaTP · 2022-09-05T09:27:04Z

@xRodney we merged another PR slightly conflicting with the changes in this PR.
Would you mind rebasing? Please keep your JavaDoc style as it's much better 🙂

Ping me and I will run the CI to validate and eventually move this forward 👍 thanks a lot for your effort!

xRodney · 2022-09-05T10:29:54Z

Sure, it's done

andreaTP · 2022-09-05T14:09:06Z

Unfortunately, the CI failure seems to be legit, @xRodney can you have a look?

@SchemaSwap is now repeatable, so multiple modifications can be applied from the same resource root. Fixed a bug when the swap was "used up" after just one usage, meaning that if the referenced type was used multiple times in object hierarchy, only the first one was swapped. Fixes fabric8io#4350

xRodney · 2022-09-06T06:39:11Z

Oops, missing import. Sorry about that, it's fixed now.

andreaTP

LGTM, thanks!

sonarcloud · 2022-09-07T17:47:27Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
4 Code Smells

81.1% Coverage
0.0% Duplication

andreaTP · 2022-09-08T08:56:08Z

thanks @xRodney !

xRodney commented Aug 26, 2022

View reviewed changes

crd-generator/api/src/test/java/io/fabric8/crd/generator/v1/JsonSchemaTest.java Show resolved Hide resolved

xRodney marked this pull request as ready for review August 26, 2022 08:27

rohanKanojia requested a review from andreaTP August 26, 2022 08:42

andreaTP requested changes Aug 26, 2022

View reviewed changes

andreaTP mentioned this pull request Aug 26, 2022

Use SchemaSwap instead of shell script for Realm CRD generatio keycloak/keycloak#10736

Closed

andreaTP approved these changes Aug 26, 2022

View reviewed changes

andreaTP requested a review from metacosm August 26, 2022 15:42

xRodney force-pushed the bugfix/schema-swap branch from 0d15b10 to 671e70d Compare August 26, 2022 19:50

xRodney mentioned this pull request Aug 29, 2022

Stack overflow on multi maps (and other non-trivial generic classes) #4357

Closed

xRodney force-pushed the bugfix/schema-swap branch from 7025175 to 5280859 Compare August 30, 2022 11:52

metacosm approved these changes Sep 2, 2022

View reviewed changes

xRodney force-pushed the bugfix/schema-swap branch from 5280859 to 8595d41 Compare September 3, 2022 20:25

xRodney force-pushed the bugfix/schema-swap branch from 8595d41 to c7bcba4 Compare September 5, 2022 10:27

xRodney force-pushed the bugfix/schema-swap branch from c7bcba4 to 74d533b Compare September 6, 2022 06:38

andreaTP approved these changes Sep 6, 2022

View reviewed changes

andreaTP requested review from manusa and rohanKanojia September 6, 2022 15:50

Merge branch 'master' into bugfix/schema-swap

2b44a7f

andreaTP merged commit caabb75 into fabric8io:master Sep 8, 2022

manusa added this to the 6.2.0 milestone Sep 8, 2022

xRodney deleted the bugfix/schema-swap branch September 12, 2022 14:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: @SchemaSwap can only be used once #4354

fix: @SchemaSwap can only be used once #4354

xRodney commented Aug 26, 2022

andreaTP left a comment

andreaTP Aug 26, 2022

xRodney Aug 26, 2022 •

edited

xRodney Aug 26, 2022 •

edited

andreaTP Aug 26, 2022

xRodney Aug 26, 2022

andreaTP Aug 26, 2022

metacosm Sep 2, 2022

andreaTP Sep 2, 2022

andreaTP Sep 2, 2022

xRodney commented Aug 26, 2022

andreaTP left a comment

andreaTP commented Aug 26, 2022

xRodney commented Aug 26, 2022

xRodney commented Aug 30, 2022

metacosm Sep 2, 2022

xRodney commented Sep 3, 2022

andreaTP commented Sep 5, 2022

xRodney commented Sep 5, 2022

andreaTP commented Sep 5, 2022

xRodney commented Sep 6, 2022

andreaTP left a comment

sonarcloud bot commented Sep 7, 2022

andreaTP commented Sep 8, 2022

	propertyOrAccessors.add(PropertyOrAccessor.fromProperty(property));
	Method method = potentialAccessors.get("is" + capitalized);
	if (method != null) {
	propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));
	}
	method = potentialAccessors.get("get" + capitalized);
	if (method != null) {
	propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));
	}
	method = potentialAccessors.get("set" + capitalized);
	if (method != null) {
	propertyOrAccessors.add(PropertyOrAccessor.fromMethod(method, name));
	}

fix: @SchemaSwap can only be used once #4354

fix: @SchemaSwap can only be used once #4354

Conversation

xRodney commented Aug 26, 2022

Description

Type of change

Checklist

andreaTP left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xRodney Aug 26, 2022 • edited

Choose a reason for hiding this comment

xRodney Aug 26, 2022 • edited

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

xRodney commented Aug 26, 2022

andreaTP left a comment

Choose a reason for hiding this comment

andreaTP commented Aug 26, 2022

xRodney commented Aug 26, 2022

xRodney commented Aug 30, 2022

Choose a reason for hiding this comment

xRodney commented Sep 3, 2022

andreaTP commented Sep 5, 2022

xRodney commented Sep 5, 2022

andreaTP commented Sep 5, 2022

xRodney commented Sep 6, 2022

andreaTP left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Sep 7, 2022

andreaTP commented Sep 8, 2022

xRodney Aug 26, 2022 •

edited

xRodney Aug 26, 2022 •

edited