refactor: bind policy scope to policy context hierarchy #4535

ndr-brt · 2024-10-10T08:44:50Z

What this PR changes/adds

NOTE: wait for #4542 to be merged before reviewing

Sorry for the big PR but this is quite an impactful change.
Highlights:

PolicyContext is bound to the string scope
PolicyContext hierarchy reflects the scope one
PolicyEngine no more accepts (or better, only methods that been deprecated do) String scope but it relies on the PolicyContext hierarchy to filter out validators and functions to be applied.

all the other changes are related to that.

note: no breaking changes in the API, as the new interfaces have been set as older ones superinterfaces. Deprecations annotations have been put in place.

Upcoming work:

adapt RuleBindingRegistry to the PolicyEngine hierarchy (maybe it could also be inlined in the PolicyEngine, as it is only used internally by the latter.

Why it does that

Briefly state why the change was necessary.

Further notes

List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc.

Linked Issue(s)

Closes #3511

Please be sure to take a look at the contributing guidelines and our etiquette for pull requests.

...itor-core/src/main/java/org/eclipse/edc/connector/policy/monitor/PolicyMonitorExtension.java

...st-core/src/main/java/org/eclipse/edc/iam/identitytrust/core/DcpScopeExtractorExtension.java

...engine-spi/src/main/java/org/eclipse/edc/policy/engine/spi/AtomicConstraintRuleFunction.java

spi/common/policy-engine-spi/src/main/java/org/eclipse/edc/policy/engine/spi/PolicyEngine.java

wolf4ood

🚀

paullatzelsperger · 2024-10-17T05:00:09Z

...rc/main/java/org/eclipse/edc/connector/controlplane/policy/contract/ContractExpiryCheck.java

+                                .plus(duration)
+                        )
+                ).map(bound -> checkFixedPeriod(now, operator, bound))
+                .map(it -> it ? Result.success() : Result.<Void>failure(""))


To me, returning a Result<Boolean> from this method would feel more natural. There is a semantic difference between the check failing "structurally" (e.g. because malformed right-operand), and failing "semantically" (contract expired). WDYT?

Anyway, there should be some information on the failure:

Suggested change

.map(it -> it ? Result.success() : Result.<Void>failure(""))

.map(it -> it ? Result.success() : Result.<Void>failure("Contract expired!"))

yes, in fact I think I modeled this in an overcomplicated way (I was on a rush focusing to have everything working 😅 ), now I re-refactored in a single "function" class and it works in the same way as before (in case of expiration false is returned without messages), but maybe a message would be appreciated (e.g. to be appended to the transfer error detail).

...main/java/org/eclipse/edc/connector/controlplane/contract/policy/ContractExpiryFunction.java

...in/java/org/eclipse/edc/protocol/dsp/http/dispatcher/DspHttpRemoteMessageDispatcherImpl.java

paullatzelsperger · 2024-10-17T05:03:45Z

...in/java/org/eclipse/edc/protocol/dsp/http/spi/dispatcher/DspHttpRemoteMessageDispatcher.java

@@ -41,10 +42,10 @@ <M extends RemoteMessage, R> void registerMessage(Class<M> clazz, DspHttpRequest
    /**
     * Registers a {@link Policy} scope to be evaluated for certain types of messages
     *
-     * @param messageClass the message type for which evaluate the policy.
-     * @param scope the scope to be used.
+     * @param <M>            the message type.


this will almost certainly trip up the javadoc task. avoid chevrons ("<") in javadoc

~~looks like javadoc is not angry at it, anyway no problem in removing it~~

I just fixed the spacing, but the line was already there

paullatzelsperger · 2024-10-17T05:07:26Z

...icy-engine-lib/src/main/java/org/eclipse/edc/policy/engine/plan/PolicyEvaluationPlanner.java

-import org.eclipse.edc.policy.engine.spi.PolicyValidatorFunction;
-import org.eclipse.edc.policy.engine.spi.RuleFunction;
+import org.eclipse.edc.policy.engine.spi.PolicyValidatorRule;
+import org.eclipse.edc.policy.engine.spi.RulePolicyFunction;


I guess i missed this in the other PR review (or actually, I missed the other review :/), but I find the name RulePolicyFunction a bit ... clunky... How about PolicyRuleFunction?

I guess it's because "policy function" can be considered an entity on its own, so this is a PolicyFunction that targets a Rule.
rename makes sense anyway

ndr-brt · 2024-10-17T07:06:11Z

...in/java/org/eclipse/edc/protocol/dsp/http/spi/dispatcher/DspHttpRemoteMessageDispatcher.java

     * @param policyProvider function that extracts the Policy from the message.
-     * @param <M> the message type.


@paullatzelsperger , in fact it was already there before, I will not remove it

so long as javadoc doesn't vomit all over itself i'm fine with it :)

ndr-brt added the refactoring Cleaning up code and dependencies label Oct 10, 2024

ndr-brt requested review from wolf4ood and jimmarino October 10, 2024 08:44

github-advanced-security bot found potential problems Oct 10, 2024

View reviewed changes

ndr-brt force-pushed the 3511-typed-policy-context branch from d38eb1d to 20f7bb5 Compare October 10, 2024 09:02

ndr-brt marked this pull request as ready for review October 10, 2024 09:23

ndr-brt requested review from paullatzelsperger, ronjaquensel and juliapampus as code owners October 10, 2024 09:23

ndr-brt force-pushed the 3511-typed-policy-context branch from 20f7bb5 to c8679e7 Compare October 11, 2024 12:36

ndr-brt mentioned this pull request Oct 11, 2024

refactor(policy): provide new contexts and function interfaces for policy engine #4542

Merged

ndr-brt marked this pull request as draft October 11, 2024 12:51

refactor: bind policy scope to policy context hierarchy

246d235

ndr-brt force-pushed the 3511-typed-policy-context branch from c8679e7 to 246d235 Compare October 15, 2024 09:06

ndr-brt marked this pull request as ready for review October 15, 2024 09:06

wolf4ood approved these changes Oct 16, 2024

View reviewed changes

paullatzelsperger reviewed Oct 17, 2024

View reviewed changes

ndr-brt commented Oct 17, 2024

View reviewed changes

ndr-brt requested a review from paullatzelsperger October 17, 2024 07:49

PR remarks

6ea58d2

ndr-brt force-pushed the 3511-typed-policy-context branch from 630cab3 to 6ea58d2 Compare October 17, 2024 07:52

paullatzelsperger approved these changes Oct 17, 2024

View reviewed changes

ndr-brt merged commit faf3c95 into eclipse-edc:main Oct 17, 2024
21 checks passed

ndr-brt deleted the 3511-typed-policy-context branch October 17, 2024 08:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: bind policy scope to policy context hierarchy #4535

refactor: bind policy scope to policy context hierarchy #4535

ndr-brt commented Oct 10, 2024 •

edited

Loading

wolf4ood left a comment

paullatzelsperger Oct 17, 2024

ndr-brt Oct 17, 2024

paullatzelsperger Oct 17, 2024

ndr-brt Oct 17, 2024 •

edited

Loading

paullatzelsperger Oct 17, 2024

ndr-brt Oct 17, 2024 •

edited

Loading

ndr-brt Oct 17, 2024

paullatzelsperger Oct 17, 2024

	.map(it -> it ? Result.success() : Result.<Void>failure(""))
	.map(it -> it ? Result.success() : Result.<Void>failure("Contract expired!"))

		* @param policyProvider function that extracts the Policy from the message.
		* @param <M> the message type.

refactor: bind policy scope to policy context hierarchy #4535

refactor: bind policy scope to policy context hierarchy #4535

Conversation

ndr-brt commented Oct 10, 2024 • edited Loading

What this PR changes/adds

Why it does that

Further notes

Linked Issue(s)

wolf4ood left a comment

Choose a reason for hiding this comment

paullatzelsperger Oct 17, 2024

Choose a reason for hiding this comment

ndr-brt Oct 17, 2024

Choose a reason for hiding this comment

paullatzelsperger Oct 17, 2024

Choose a reason for hiding this comment

ndr-brt Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

paullatzelsperger Oct 17, 2024

Choose a reason for hiding this comment

ndr-brt Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

ndr-brt Oct 17, 2024

Choose a reason for hiding this comment

paullatzelsperger Oct 17, 2024

Choose a reason for hiding this comment

ndr-brt commented Oct 10, 2024 •

edited

Loading

ndr-brt Oct 17, 2024 •

edited

Loading

ndr-brt Oct 17, 2024 •

edited

Loading