Sort config types by their load dependencies once #10148

yhabteab · 2024-09-10T07:58:28Z

This PR is basically the same as #10003, but since @Al2Klimov is out for this week, we need to get it done. So I've cherry-picked the commits from there and added some additional commits to address the requested changes in that PR.

Loosely depends on Type#GetLoadDependencies(): VERIFY() that only config object types are returned #10169

closes #10003

julianbrost

Compared to #10003, this PR has no cycle detection (at least I believe the purpose of some of the code might be cycle detection, it's not entirely clear though: #10003 (comment)). When I intentionally introduced a dependency in the *.ti files, nothing in mkclass stopped me from doing so and all I got was a not very helpful error message in a test (see inline comment). So some more explicit "this failed due to a cycle" error reporting/VERIFY() might be a good idea.

test/base-type.cpp

lib/base/type.cpp

test/base-type.cpp

lib/base/type.cpp

test/base-type.cpp

lib/base/type.cpp

test/base-type.cpp

test/CMakeLists.txt

lib/base/type.hpp

julianbrost

Looks fine and should do the job, I just don't want to do a quick approve + merge right before leaving for vacation and another pair of eyes shouldn't hurt. But I'd say you can optimistically adapt #10000 already.

I'm not 100% happy regarding the needs for the test changes including the CMakeLists changes, but that's probably what happens when relying on linker/loader magic for the type registration (the alternative would be to perform an extra self check within the implementation, so that it's checked every single time, but that's also not too nice).

No more open requests for changes, see previous comment.

lib/base/type.cpp

Al2Klimov · 2024-09-17T16:08:16Z

test/base-type.cpp

+	// The magic number 12 is the sum of host,service,comment,downtime and endpoint load_after dependencies.
+	BOOST_CHECK_MESSAGE(totalDependencies >= 12, "total size of load dependency must be at least 12");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Host::TypeInstance.get()) != previousTypes.end(), "Host type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Service::TypeInstance.get()) != previousTypes.end(), "Service type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Downtime::TypeInstance.get()) != previousTypes.end(), "Downtime type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Comment::TypeInstance.get()) != previousTypes.end(), "Comment type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Notification::TypeInstance.get()) != previousTypes.end(), "Notification type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Zone::TypeInstance.get()) != previousTypes.end(), "Zone type should be in the list");
+	BOOST_CHECK_MESSAGE(previousTypes.find(Endpoint::TypeInstance.get()) != previousTypes.end(), "Endpoint type should be in the list");


What about just comparing to all types|grep config type? 🙈

I am looking for config types that have to be always there, and unlike other types they cannot be disabled with cmake build flags like -DICINGA2_WITH_ICINGADB=OFF.

yhabteab · 2024-09-20T10:00:45Z

Oh! We can't backport this to 2.13.x due to 33e609d.

Al2Klimov · 2024-09-20T10:15:38Z

Do you mean "We can't backport this to 2.13.x without 33e609d"?

yhabteab · 2024-09-20T10:35:30Z

Just rebased it!

…es once to avoid complicated nested loops, iterating over the same types and checking dependencies over and over, skipping already completed ones.

…s()`

Al2Klimov · 2024-09-20T15:10:57Z

test/CMakeLists.txt

+    types/instantiate
+    types/sort_by_load_after
+)
+


This is fine. 🎩🐶☕🔥🏠

cla-bot bot added the cla/signed label Sep 10, 2024

icinga-probot bot added the core/quality Improve code, libraries, algorithms, inline docs label Sep 10, 2024

yhabteab requested a review from julianbrost September 10, 2024 07:58

yhabteab self-assigned this Sep 10, 2024

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from 8a2ee5a to f78108d Compare September 10, 2024 09:19

julianbrost requested changes Sep 11, 2024

View reviewed changes

test/base-type.cpp Outdated Show resolved Hide resolved

lib/base/type.cpp Outdated Show resolved Hide resolved

lib/base/type.cpp Outdated Show resolved Hide resolved

lib/base/type.cpp Outdated Show resolved Hide resolved

test/base-type.cpp Outdated Show resolved Hide resolved

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from f78108d to 7c56ec3 Compare September 11, 2024 16:25

yhabteab requested a review from julianbrost September 11, 2024 16:25

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch 3 times, most recently from bfcfe80 to e019556 Compare September 11, 2024 17:04

julianbrost requested changes Sep 12, 2024

View reviewed changes

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from e019556 to e011597 Compare September 12, 2024 10:56

yhabteab requested a review from julianbrost September 12, 2024 10:56

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch 2 times, most recently from b21a41f to 2c308dd Compare September 12, 2024 13:50

yhabteab requested review from julianbrost and removed request for julianbrost September 12, 2024 13:50

julianbrost previously requested changes Sep 12, 2024

View reviewed changes

test/CMakeLists.txt Outdated Show resolved Hide resolved

lib/base/type.hpp Outdated Show resolved Hide resolved

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from 2c308dd to 9442803 Compare September 12, 2024 15:05

yhabteab requested a review from julianbrost September 12, 2024 15:06

julianbrost reviewed Sep 12, 2024

View reviewed changes

julianbrost requested a review from Al2Klimov September 12, 2024 16:11

yhabteab mentioned this pull request Sep 16, 2024

Fix broken downtime comment sync #10000

Draft

2 tasks

Al2Klimov mentioned this pull request Sep 16, 2024

ConfigItem::CommitNewItems(): pre-sort types by their load dependencies once #10003

Open

Al2Klimov reviewed Sep 17, 2024

View reviewed changes

yhabteab mentioned this pull request Sep 18, 2024

Type#GetLoadDependencies(): VERIFY() that no nullptr is returned #10155

Merged

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from 9442803 to abb068e Compare September 20, 2024 09:51

yhabteab requested a review from Al2Klimov September 20, 2024 09:51

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from abb068e to b85fc9f Compare September 20, 2024 10:34

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from b85fc9f to cb4fe57 Compare September 20, 2024 13:32

Al2Klimov and others added 4 commits September 20, 2024 16:18

Introduce Type::GetConfigTypesSortedByLoadDependencies()

b848934

ConfigItem::CommitNewItems(): pre-sort types by their load dependenci…

31f3aca

…es once to avoid complicated nested loops, iterating over the same types and checking dependencies over and over, skipping already completed ones.

Type: Simplify sort by load dependencies algorithm

467e8b1

Add basic test cases for `Type::GetConfigTypesSortedByLoadDependencie…

eb97676

…s()`

yhabteab force-pushed the enhanced-sort-types-by-load-dependencies branch from cb4fe57 to eb97676 Compare September 20, 2024 14:18

yhabteab requested review from Al2Klimov and removed request for Al2Klimov September 20, 2024 14:18

Al2Klimov approved these changes Sep 20, 2024

View reviewed changes

test/CMakeLists.txt

types/instantiate

types/sort_by_load_after

)

Copy link

Member

Al2Klimov Sep 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine. 🎩🐶☕🔥🏠

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort config types by their load dependencies once #10148

Sort config types by their load dependencies once #10148

yhabteab commented Sep 10, 2024 •

edited

Loading

julianbrost left a comment

julianbrost left a comment

Al2Klimov Sep 17, 2024

yhabteab Sep 18, 2024

yhabteab commented Sep 20, 2024

Al2Klimov commented Sep 20, 2024

yhabteab commented Sep 20, 2024

Al2Klimov Sep 20, 2024

Sort config types by their load dependencies once #10148

Are you sure you want to change the base?

Sort config types by their load dependencies once #10148

Conversation

yhabteab commented Sep 10, 2024 • edited Loading

julianbrost left a comment

Choose a reason for hiding this comment

julianbrost left a comment

Choose a reason for hiding this comment

Al2Klimov Sep 17, 2024

Choose a reason for hiding this comment

yhabteab Sep 18, 2024

Choose a reason for hiding this comment

yhabteab commented Sep 20, 2024

Al2Klimov commented Sep 20, 2024

yhabteab commented Sep 20, 2024

Al2Klimov Sep 20, 2024

Choose a reason for hiding this comment

yhabteab commented Sep 10, 2024 •

edited

Loading