[Core, Simulation.Core] Registration: (re)enable deprecation warnings #5155

fredroy · 2024-12-10T01:14:27Z

To enforce the new registration mechanism (#4429 )
This PR:

adds compilation deprecation warnings when using RegisterObject
adds runtime (user) messages when using deprecated registration mechanism

⚠️ This will throw a lot of warnings on the CI (because of the plugins) so I think the log file will increase dramatically 😅

[ci-depends-on https://github.com/sofa-framework/BeamAdapter/pull/158]
[ci-depends-on https://github.com/sofa-framework/CGALPlugin/pull/20]

By submitting this pull request, I acknowledge that
I have read, understand, and agree SOFA Developer Certificate of Origin (DCO).

Reviewers will merge this pull-request only if

it builds with SUCCESS for all platforms on the CI.
it does not generate new warnings.
it does not generate new unit test failures.
it does not generate new scene test failures.
it does not break API compatibility.
it is more than 1 week old (or has fast-merge label).

fredroy · 2024-12-10T02:25:49Z

[ci-build][with-all-tests]

fredroy · 2024-12-10T03:52:59Z

[ci-build][with-all-tests][force-full-build]

sofabot · 2024-12-10T03:53:06Z

[ci-depends-on] detected during build #4.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a

sofabot · 2024-12-10T05:56:11Z

[ci-depends-on] detected during build #5.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a

sofabot · 2024-12-11T00:37:48Z

[ci-depends-on] detected during build #6.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a

fredroy · 2024-12-11T01:01:36Z

Sofa/framework/Core/src/sofa/core/ObjectFactory.cpp

@@ -775,7 +775,7 @@ bool ObjectFactory::registerObjectsFromPlugin(const std::string& pluginName)
    // do not register if it was already done before
    if(m_registeredPluginSet.count(pluginName) > 0)
    {
-        // msg_warning("ObjectFactory") << pluginName << " has already registered its components.";
+        msg_warning("ObjectFactory") << pluginName << " has already registered its components.";


This warning is a bit problematic.
It will be displayed if a plugin registers twice (or more) so I felt it could be nice to warn the user somehow.
But in effect, if runSofa uses the "autoloadplugin" feature and the requiredPlugin in the scene, it will try to register twice the components (thus spamming).
Quite problematic as it is quite the default behavior with runSofa...

Should it be removed ?

Maybe to keep it commented indeed with an additional comment:

Suggested change

msg_warning("ObjectFactory") << pluginName << " has already registered its components.";

// msg_warning("ObjectFactory") << pluginName << " has already registered its components."; // Warning to re-activate when runSofa will not auto-load modules/plugins anymore

fredroy · 2024-12-11T01:19:58Z

The fact that no plugin has been ported is also problematic. Just running runSofa with default flags would already throws some warnings:

...
[INFO]    [PluginManager] Loaded plugin: /Users/fred/Work/sofa/build/sandbox-ninja/lib/libSofa.GUI.Qt.dylib
[INFO]    [PluginManager] Loaded plugin: /Users/fred/Work/sofa/build/sandbox-ninja/lib/libSceneCreator.dylib
[WARNING] [RegisterObject] ArticulatedHierarchyContainer: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ArticulationCenter: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] Articulation: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ArticulatedSystemMapping: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ArticulatedHierarchyController: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ArticulatedHierarchyBVHController: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[INFO]    [PluginManager] Loaded plugin: /Users/fred/Work/sofa/build/sandbox-ninja/lib/libArticulatedSystemPlugin.dylib
[WARNING] [RegisterObject] DataExchange: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] MeanComputation: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] AnimationLoopParallelScheduler: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelBVHNarrowPhase: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelBruteForceBroadPhase: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelCGLinearSolver: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] BeamLinearMapping_mt: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelHexahedronFEMForceField: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelTetrahedronFEMForceField: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelSpringForceField: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ParallelMeshSpringForceField: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[INFO]    [PluginManager] Loaded plugin: /Users/fred/Work/sofa/build/sandbox-ninja/lib/libMultiThreading.dylib
[WARNING] [RegisterObject] ComplianceMatrixExporter: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] GlobalSystemMatrixExporter: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] FillReducingOrdering: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] ComplianceMatrixImage: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[WARNING] [RegisterObject] GlobalSystemMatrixImage: Implicit object registration is deprecated since v24.12. Check #4429 for more information.
[INFO]    [PluginManager] Loaded plugin: /Users/fred/Work/sofa/build/sandbox-ninja/lib/libSofaMatrix.dylib
[INFO]    [PluginManager] 72 plugins have been loaded from /Users/fred/Work/sofa/build/sandbox-ninja/lib/plugin_list.conf.default
[INFO]    [SofaPluginManager] Loading automatically plugin list in /Users/fred/Work/sofa/build/sandbox-ninja/config/loadedPlugins.ini
[INFO]    [PluginManager] 0 plugins have been loaded from /Users/fred/Work/sofa/build/sandbox-ninja/config/loadedPlugins.ini

Moreover we have to think that the install version comes with much more plugins as well.... There will be quite a lot of warnings.
And it seems weird to me to ship a version where we allow (lots of) warnings to be thrown 🤔

I guess we should ignore outputting warnings for the moment... (or only in dev mode maybe ?)

bakpaul · 2024-12-11T09:59:09Z

Messages should be addressed to developer only (using dmsg based on the CMake flag SOFA_WITH_DEVTOOLS)

sofabot · 2024-12-12T23:24:25Z

[ci-depends-on] detected during build #8.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a

sofabot · 2024-12-17T07:50:23Z

[ci-depends-on] detected during build #9.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a

bakpaul · 2024-12-17T14:13:37Z

[ci-build][with-all-tests][force-full-build]

sofabot · 2024-12-17T14:13:47Z

[ci-depends-on] detected during build #10.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a
Merge or close Fix number of jobs to one for CGAL CGALPlugin#20
For this build, CGALPlugin/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/CGALPlugin
GIT_TAG 7f79d065aaf4413a0f3e9f8cfe8fcaa63297969e

fredroy · 2024-12-17T23:00:33Z

[ci-build][with-all-tests][force-full-build]

sofabot · 2024-12-17T23:00:43Z

[ci-depends-on] detected during build #11.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a
Merge or close Fix number of jobs to one for CGAL CGALPlugin#20
For this build, CGALPlugin/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/CGALPlugin
GIT_TAG 55d123a490c8372b972a49e6cef394b0fc9cd69e

sofabot · 2024-12-18T09:54:04Z

[ci-depends-on] detected during build #12.

To unlock the merge button, you must

Merge or close Unit Tests: Fix loading plugins BeamAdapter#158
For this build, BeamAdapter/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/BeamAdapter
GIT_TAG 7e759945ebadc9ee2c95106921b8ac7ba81ea87a
Merge or close Fix number of jobs to one for CGAL CGALPlugin#20
For this build, CGALPlugin/ExternalProjectConfig.cmake.in will be edited by builders with
GIT_REPOSITORY https://github.com/sofa-framework/CGALPlugin
GIT_TAG 55d123a490c8372b972a49e6cef394b0fc9cd69e

…#5155) * enable deprecation warnings for RegisterObject * enable runtime deprecation warnings * re enable disabled tests * fix typo * fix units tests * expect a warning when loading pluginA * load plugins once (avoiding registering several times) * add more info when warning the user of a deprecated registration * set warnings only if dev mode is enabled (SOFA_WITH_DEVTOOLS enabled) * apply new mechanism registration to AugmentedLagrangianConstraint

fredroy added pr: status to review To notify reviewers to review this pull-request pr: clean Cleaning the code deprecated About a deprecated code labels Dec 10, 2024

fredroy added this to the v24.12 milestone Dec 10, 2024

fredroy mentioned this pull request Dec 10, 2024

Unit Tests: Fix loading plugins sofa-framework/BeamAdapter#158

Merged

fredroy added pr: status wip Development in the pull-request is still in progress and removed pr: status to review To notify reviewers to review this pull-request labels Dec 10, 2024

fredroy force-pushed the registration_enable_deprecation_warnings branch from b34767b to 4338187 Compare December 10, 2024 03:50

fredroy added pr: status to review To notify reviewers to review this pull-request and removed pr: status wip Development in the pull-request is still in progress labels Dec 10, 2024

fredroy added the pr: based on previous PR PR based on a previous PR, therefore to be merged ONLY subsequently label Dec 10, 2024

sofa-framework deleted a comment from sofabot Dec 10, 2024

bakpaul approved these changes Dec 10, 2024

View reviewed changes

fredroy force-pushed the registration_enable_deprecation_warnings branch from adffeea to 346459f Compare December 11, 2024 00:37

fredroy removed the pr: based on previous PR PR based on a previous PR, therefore to be merged ONLY subsequently label Dec 11, 2024

fredroy commented Dec 11, 2024

View reviewed changes

sofa-framework deleted a comment from sofabot Dec 11, 2024

fredroy added the pr: dev meeting topic PR to be discussed in sofa-dev meeting label Dec 11, 2024

bakpaul approved these changes Dec 16, 2024

View reviewed changes

alxbilger approved these changes Dec 16, 2024

View reviewed changes

fredroy force-pushed the registration_enable_deprecation_warnings branch from a09d4d3 to a822c44 Compare December 17, 2024 07:49

hugtalbot added the pr: backport todo This PR will be backported into the release preceeding its milestone. label Dec 17, 2024

hugtalbot removed the pr: dev meeting topic PR to be discussed in sofa-dev meeting label Dec 18, 2024

fredroy and others added 10 commits December 18, 2024 18:53

enable deprecation warnings for RegisterObject

36bf359

enable runtime deprecation warnings

723d385

re enable disabled tests

dd78fb5

fix typo

90435aa

fix units tests

1efec34

expect a warning when loading pluginA

a374c18

load plugins once (avoiding registering several times)

23c0fed

add more info when warning the user of a deprecated registration

69a3d73

set warnings only if dev mode is enabled (SOFA_WITH_DEVTOOLS enabled)

9ef38af

apply new mechanism registration to AugmentedLagrangianConstraint

adcd311

fredroy force-pushed the registration_enable_deprecation_warnings branch from a822c44 to adcd311 Compare December 18, 2024 09:53

bakpaul merged commit 4aca268 into sofa-framework:master Dec 18, 2024
10 of 11 checks passed

bakpaul added pr: backport done This PR has been backported into the release before its milestone. and removed pr: backport todo This PR will be backported into the release preceeding its milestone. labels Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Core, Simulation.Core] Registration: (re)enable deprecation warnings #5155

[Core, Simulation.Core] Registration: (re)enable deprecation warnings #5155

fredroy commented Dec 10, 2024 •

edited by bakpaul

Loading

fredroy commented Dec 10, 2024

fredroy commented Dec 10, 2024

sofabot commented Dec 10, 2024

sofabot commented Dec 10, 2024

sofabot commented Dec 11, 2024

fredroy Dec 11, 2024

hugtalbot Dec 11, 2024

fredroy commented Dec 11, 2024

bakpaul commented Dec 11, 2024

sofabot commented Dec 12, 2024

sofabot commented Dec 17, 2024

bakpaul commented Dec 17, 2024

sofabot commented Dec 17, 2024

fredroy commented Dec 17, 2024

sofabot commented Dec 17, 2024

sofabot commented Dec 18, 2024

	msg_warning("ObjectFactory") << pluginName << " has already registered its components.";
	// msg_warning("ObjectFactory") << pluginName << " has already registered its components."; // Warning to re-activate when runSofa will not auto-load modules/plugins anymore

[Core, Simulation.Core] Registration: (re)enable deprecation warnings #5155

[Core, Simulation.Core] Registration: (re)enable deprecation warnings #5155

Conversation

fredroy commented Dec 10, 2024 • edited by bakpaul Loading

fredroy commented Dec 10, 2024

fredroy commented Dec 10, 2024

sofabot commented Dec 10, 2024

sofabot commented Dec 10, 2024

sofabot commented Dec 11, 2024

fredroy Dec 11, 2024

Choose a reason for hiding this comment

hugtalbot Dec 11, 2024

Choose a reason for hiding this comment

fredroy commented Dec 11, 2024

bakpaul commented Dec 11, 2024

sofabot commented Dec 12, 2024

sofabot commented Dec 17, 2024

bakpaul commented Dec 17, 2024

sofabot commented Dec 17, 2024

fredroy commented Dec 17, 2024

sofabot commented Dec 17, 2024

sofabot commented Dec 18, 2024

fredroy commented Dec 10, 2024 •

edited by bakpaul

Loading