Sed 3921 introduced settings with multitenancy capabilities #433

iegorov777 · 2025-04-15T16:18:21Z

No description provided.

…or and manager)

...ase-plugins/src/main/java/step/plugins/parametermanager/EncryptedEntityExportBiConsumer.java

...ase-plugins/src/main/java/step/plugins/parametermanager/EncryptedEntityImportBiConsumer.java

...ase-plugins/src/main/java/step/plugins/parametermanager/EncryptedEntityExportBiConsumer.java

...ase-plugins/src/main/java/step/plugins/parametermanager/EncryptedEntityImportBiConsumer.java

step-core-model/src/main/java/step/usersettings/UserSetting.java

step-core/src/main/java/step/parameter/AbstractEncryptedValuesManager.java

step-core/src/main/java/step/usersettings/UserSettingAccessorImpl.java

…-Settings-with-multitenancy-capabilities

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml

…ersion)

david-stephan

@iegorov777 please check the individual comments

...tion-packages-junit5/src/test/java/step/junit5/runner/StepRunnerWithPlansAnnotationTest.java

david-stephan · 2025-05-22T10:36:12Z

...mation-packages-manager/src/main/java/step/automation/packages/AutomationPackageManager.java

        // schedules will be deleted in deleteAdditionalData via hooks
        deleteResources(automationPackage);
-        deleteAdditionalData(automationPackage, new AutomationPackageContext(operationMode, resourceManager, null,  null,null, extensions));
+        // TODO: archive, packageContent, enricher and validator are only used in AutomationPackageContext for save/update - maybe it is better to create separate class AutomationPackageContextForSave rather then use nulls here


to be clarified

We can discuss this. I'm not very happy with this constructor for AutomationPackageContext, where pass many parameters and many of them are null in the most of cases

david-stephan · 2025-05-22T10:42:25Z

...src/main/java/step/automation/packages/execution/RepositoryWithAutomationPackageSupport.java

        try (FileInputStream fis = new FileInputStream(apFile.getFile())) {
            // the apVersion is null (we always use the actual version), because we only create the isolated in-memory AP here
-            inMemoryPackageManager.createAutomationPackage(fis, apFile.getFile().getName(), null, null, enricher, predicate);
+            inMemoryPackageManager.createAutomationPackage(fis, apFile.getFile().getName(), null, null, enricher, predicate, null);


might not be possible, but since predicate enricher and validator all comes from the objectHookRegistry maybe we could just pass it here somehow.

@david-stephan to be clarified

david-stephan · 2025-05-22T10:43:46Z

...mation-packages-manager/src/main/java/step/automation/packages/AutomationPackageManager.java

     */
-    public ObjectId createAutomationPackage(InputStream packageStream, String fileName, String apVersion, String activationExpr, ObjectEnricher enricher, ObjectPredicate objectPredicate) throws AutomationPackageManagerException {
-        return createOrUpdateAutomationPackage(false, true, null, packageStream, fileName, apVersion, activationExpr, enricher, objectPredicate, false).getId();
+    public ObjectId createAutomationPackage(InputStream packageStream, String fileName, String apVersion, String activationExpr,


might not be possible, but since predicate enricher and validator all comes from the objectHookRegistry maybe we could just pass it here somehow.

@david-stephan for now I keep separate parameters for enricher, predicate and validator

step-core-model/src/main/java/step/projectsettings/ProjectSetting.java

step-core-model/src/main/java/step/multitenancy/TenantUniqueEntity.java

step-core-model/src/main/java/step/parameter/Parameter.java

step-core/src/main/java/step/projectsettings/ProjectSettingManager.java

…ique entities)

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml # step-automation-packages/step-automation-packages-junit5/src/test/java/step/junit5/runner/StepRunnerWithPlansAnnotationTest.java # step-automation-packages/step-automation-packages-manager/src/main/java/step/automation/packages/AutomationPackageManager.java # step-automation-packages/step-automation-packages-manager/src/main/java/step/automation/packages/execution/RepositoryWithAutomationPackageSupport.java

pom.xml

...-base-plugins/src/main/java/step/plugins/projectsettings/ProjectSettingControllerPlugin.java

step-core/src/main/java/step/encryption/AbstractEncryptedValuesManager.java

step-core/src/main/java/step/projectsettings/ProjectSettingManager.java

step-core/src/main/java/step/core/settings/AbstractSettingAccessorWithHook.java

david-stephan · 2025-06-16T08:55:57Z

step-core/src/main/java/step/unique/EntityWithUniqueAttributesAccessor.java

+        super((Collection<T>) collectionDriver);
+    }
+
+    public Optional<T> findDuplicate(EntityWithUniqueAttributes e){


I think the trick to make this properly work is to use getObjectFilter to get the filters in context, as commented on EE PR we should not need any custom / specific validator in EE. Also this should not be specific to project settings and should be reusable for any entity for which we want to ensure uniqueness based on the set of attributes.
So again in EE getObjectFilter will automatically return the OR filters with the current project id + all other global projects which is used to retrieve all entities accessible in the current session context. So In this case any settings with the same set of attributes will be a duplicate, no need of the implementation in multitenancy manager.

@david-stephan
Sorry, maybe I misunderstand how the QLFilters work, but it seems like current (old) ObjectFilter in MultitenancyManager:

doesn't filter entities in case user works from global context:

protected String getOQLFilterForTenant(TenantContext tenantContext) { if(tenantContext == null || tenantContext.getTenant().isGlobal()) { return ""; }

for non-global context, as you say, it returns all entities linked with global project OR with current project

So in both cases after this filter we can have entities (project settings) linked with several global projects. Taking into account that the project is also an attribute it seems like without special validator in EE we cannot cover the situation, when user tries to save a project setting already linked with ANOTHER global project.
The common check by uniqueness of all attributes in this case won't work, because project attribute will be different.

@iegorov777 I get the confusion as we use "global" wording for both the tenant and the projects, but it is not the same thing. There is only one tenant which is global (tenantContext.getTenant().isGlobal())), this is the [All] tenant that you can select in Step EE, in that case there is no filters and you see data for all projects together. When you are in a non global tenant, you always see data from all global projects (that is the or clause built in the else of getOQLFilterForTenant) + data from the current project (global project or not).

@david-stephan understood, thank you.

Now I've changed the implementation and in OS we have a common validator, which can check the uniqueness by ALL attriubtes, and also it can be externally configured (in Step EE) to validate attirubes exluding projectId and taking priority attribute into account.

Unfortunatelly we cannot just remove the project attribute from this validation, because in this case for LOCAL products we will have the identical set of attributes (priority will be the same), but we should allow create the same setting for several local products. So the solution is a little more tricky than I expected.

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml

…th-multitenancy-capabilities # Conflicts: # pom.xml # step-automation-packages/step-automation-packages-manager/src/main/java/step/automation/packages/AutomationPackageManager.java

iegorov777 added 5 commits April 12, 2025 14:01

SED-3921: new settings with multitenancy capabilities (entity, access…

c8ba4e5

…or and manager)

SED-3921: hooks for user settings (draft)

b9103ae

SED-3921: hooks for user settings

92639ae

SED-3921: fix

9edffe6

SED-3921: rename

9d6d20c

iegorov777 requested a review from david-stephan April 15, 2025 16:18

SED-3921: change path for services

0424cfb

david-stephan requested changes Apr 22, 2025

View reviewed changes

iegorov777 added 11 commits April 23, 2025 00:22

SED-3921: project settings (improvements, part #1)

9a7d99b

SED-3921: fix warn messages

4c492f6

Merge remote-tracking branch 'origin/master' into SED-3921-Introduced…

e0637af

…-Settings-with-multitenancy-capabilities

SED-3921: move classes

a13677e

SED-3921: object overlapper for project settings (draft)

e59fafc

SED-3921: object overlapper for project settings

227f90d

Merge remote-tracking branch 'origin/master' into SED-3921-Introduced…

9594f39

…-Settings-with-multitenancy-capabilities

Merge remote-tracking branch 'origin/master' into SED-3921-Introduced…

42229e3

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml

SED-3921: support multitenancy for project settings

7129af6

SED-3921: support multitenancy for project settings (step framework v…

e6cb62a

…ersion)

SED-3921: support multitenancy for project settings (step framework v…

6449132

…ersion)

david-stephan requested changes May 22, 2025

View reviewed changes

iegorov777 added 8 commits May 27, 2025 09:15

SED-3921: support multitenancy for project settings (validator for un…

4f40c9d

…ique entities)

SED-3921: support multitenancy for project settings (fix remarks)

58f0b86

SED-3921: unit test on validator

1981efe

SED-3921: accessors

8ef55a2

SED-3921: fix ProjectSettingAccessorImpl

885b9e8

SED-3921: object filter in ProjectSettingAccessor

2f7f7d1

SED-3921: new step-framework.version

323c22c

david-stephan requested changes Jun 16, 2025

View reviewed changes

SED-3921: fix remarks

9de0991

iegorov777 and others added 7 commits June 24, 2025 04:57

Merge remote-tracking branch 'origin/master' into SED-3921-Introduced…

385c735

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml

SED-3921: step-framework.version

a81592e

SED-3921: fixes

32e45b5

SED-3921: configurable validator

293e178

Merge remote-tracking branch 'origin/master' into SED-3921-Introduced…

1192250

…-Settings-with-multitenancy-capabilities # Conflicts: # pom.xml

Merge branch 'refs/heads/master' into SED-3921-Introduced-Settings-wi…

81e3593

…th-multitenancy-capabilities # Conflicts: # pom.xml # step-automation-packages/step-automation-packages-manager/src/main/java/step/automation/packages/AutomationPackageManager.java

SED-3921 resolving merge issues

9f13da3

Sed 3921 introduced settings with multitenancy capabilities #433

Are you sure you want to change the base?

Sed 3921 introduced settings with multitenancy capabilities #433

Uh oh!

Conversation

iegorov777 commented Apr 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

david-stephan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants