Make (some) Ice properties opt-in (C++ only)

.github/workflows/ci.yml

@@ -118,8 +118,9 @@ jobs:
           if-no-files-found: ignore
         if: always()
 
-      # - name: Test Summary
-      #   uses: test-summary/action@v2
-      #   with:
-      #     paths: "${{ matrix.working_directory || '.' }}/test-report.xml"
-      #   if: always()
+      - name: Upload macOS crash diagnostics
+        uses: actions/upload-artifact@v4
+        with:
+          name: crash-diagnostics-${{ matrix.config }}-${{ matrix.os }}
+          path: ~/Library/Logs/DiagnosticReports/*.ips
+        if: runner.os == 'macOS' && always()

config/PropertyNames.xml

@@ -65,7 +65,7 @@
         <property name="Reject.[any]" languages="cpp,csharp,java" />
     </class> -->
 
-    <section name="Ice">
+    <section name="Ice" opt-in="false">
         <property name="AcceptClassCycles" languages="cpp,csharp,java" default="0" />
         <property name="Admin" class="ObjectAdapter" languages="cpp,csharp,java" />
         <property name="Admin.DelayCreation" languages="cpp,csharp,java" default="0" />
@@ -160,7 +160,7 @@
         <property name="ThreadInterruptSafe" languages="java" />
     </section>
 
-    <section name="IceMX">
+    <section name="IceMX" opt-in="false">
         <property name="Metrics.[any].GroupBy" languages="cpp,csharp,java" />
         <property name="Metrics.[any].Map" languages="cpp,csharp,java" />
         <property name="Metrics.[any].RetainDetached" default="10" languages="cpp,csharp,java" />
@@ -169,7 +169,7 @@
         <property name="Metrics.[any]" languages="cpp,csharp,java" />
     </section>
 
-    <section name="IceDiscovery">
+    <section name="IceDiscovery" opt-in="false">
         <property name="Multicast" class="ObjectAdapter" languages="cpp,csharp,java" />
         <property name="Reply" class="ObjectAdapter" languages="cpp,csharp,java"/>
         <property name="Locator" class="ObjectAdapter" languages="cpp,csharp,java" />
@@ -184,7 +184,7 @@
         <property name="DomainId" languages="cpp,csharp,java" default=""/>
     </section>
 
-    <section name="IceLocatorDiscovery">
+    <section name="IceLocatorDiscovery" opt-in="false">
         <property name="Reply" class="ObjectAdapter" languages="cpp,csharp,java" />
         <property name="Locator" class="ObjectAdapter" languages="cpp,csharp,java" />
         <property name="Lookup" languages="cpp,csharp,java"/>
@@ -198,7 +198,7 @@
         <property name="Trace.Lookup" languages="cpp,csharp,java" default="0" />
     </section>
 
-    <section name="IceBox">
+    <section name="IceBox" opt-in="true">
         <property name="InheritProperties" languages="cpp,csharp,java" />
         <property name="LoadOrder" languages="cpp,csharp,java" />
         <property name="PrintServicesReady" languages="cpp,csharp,java" />
@@ -207,17 +207,17 @@
         <property name="UseSharedCommunicator.[any]" languages="cpp,csharp,java" />
     </section>
 
-    <section name="IceBoxAdmin">
+    <section name="IceBoxAdmin" opt-in="true">
         <property name="ServiceManager.Proxy" class="Proxy" languages="cpp,java" />
     </section>
 
-    <section name="IceBridge">
+    <section name="IceBridge" opt-in="true">
         <property name="Source" class="ObjectAdapter" languages="cpp" />
         <property name="Target.Endpoints" languages="cpp" />
         <property name="InstanceName" default="IceBridge" languages="cpp" />
     </section>
 
-    <section name="IceGridAdmin">
+    <section name="IceGridAdmin" opt-in="true">
         <property name="AuthenticateUsingSSL" languages="cpp" />
         <property name="MetricsConfig" languages="java" />
         <property name="Username" languages="cpp" />
@@ -236,7 +236,7 @@
         <property name="Trace.SaveToRegistry" languages="java" />
     </section>
 
-    <section name="IceGrid">
+    <section name="IceGrid" opt-in="true">
         <property name="AdminRouter" class="ObjectAdapter" languages="cpp" />
         <property name="InstanceName" languages="cpp" default="IceGrid" />
         <property name="Node" class="ObjectAdapter" languages="cpp" />
@@ -301,7 +301,7 @@
         <property name="Registry.UserAccounts" languages="cpp" />
     </section>
 
-    <section name="IceSSL">
+    <section name="IceSSL" opt-in="false">
         <property name="Alias" languages="java" />
         <property name="CAs" languages="cpp,csharp"/>
         <property name="CertStore" languages="cpp,csharp" default="My" />
@@ -333,7 +333,7 @@
         <property name="VerifyPeer" languages="cpp,csharp,java" default="2" />
     </section>
 
-    <section name="IceStorm">
+    <section name="IceStorm" opt-in="true">
         <property name="Discard.Interval" languages="cpp" default="60" />
         <property name="Election.ElectionTimeout" languages="cpp" default="10" />
         <property name="Election.MasterTimeout" languages="cpp" default="10" />
@@ -360,18 +360,18 @@
         <property name="Transient" languages="cpp" default="0" />
     </section>
 
-    <section name="IceStormAdmin">
+    <section name="IceStormAdmin" opt-in="true">
         <property name="TopicManager.[any]" languages="cpp" />
         <property name="Host" languages="cpp" />
         <property name="Port" languages="cpp" />
     </section>
 
-    <section name="IceBT">
+    <section name="IceBT" opt-in="false">
         <property name="RcvSize" languages="cpp,java" />
         <property name="SndSize" languages="cpp,java" />
     </section>
 
-    <section name="Glacier2">
+    <section name="Glacier2" opt-in="true">
         <property name="AddConnectionContext" languages="cpp" default="0" />
         <property name="Client" languages="cpp" class="ObjectAdapter"/>
         <property name="Client.ForwardContext" languages="cpp" default="0" />
@@ -398,7 +398,7 @@
         <property name="Trace.Session" languages="cpp" default="0" />
     </section>
 
-    <section name="DataStorm">
+    <section name="DataStorm" opt-in="true">
         <property name="Node.ConnectTo" languages="cpp" />
         <property name="Node.Multicast" class="ObjectAdapter" languages="cpp" />
         <property name="Node.Multicast.Enabled" default="1" languages="cpp" />

config/makeprops.py

@@ -35,9 +35,10 @@ class Language(StrEnum):
 
 
 class PropertyArray:
-    def __init__(self, name: str, prefixOnly: bool, isClass: bool):
+    def __init__(self, name: str, prefixOnly: bool, isClass: bool, isOptIn: bool):
         self.name = name
         self.prefixOnly = prefixOnly
+        self.isOptIn = isOptIn
         self.isClass = isClass
         self.properties = []
 
@@ -180,17 +181,28 @@ def startElement(self, name, attrs):
             case "properties":
                 pass
             case "class":
-                self.validateKnownAttributes(["name", "prefix-only"], attrs)
-                self.parentNodeName = f"{attrs.get("name")}"
+                name = f"{attrs.get("name")}"
                 prefixOnly = attrs.get("prefix-only", "false").lower() == "true"
-                self.propertyArrayDict[self.parentNodeName] = PropertyArray(
-                    self.parentNodeName, prefixOnly, True
+
+                self.validateKnownAttributes(["name", "prefix-only"], attrs)
+                self.parentNodeName = name
+                self.propertyArrayDict[name] = PropertyArray(
+                    name=name,
+                    prefixOnly=prefixOnly,
+                    isClass=True,
+                    isOptIn=False,
                 )
             case "section":
-                self.validateKnownAttributes(["name"], attrs)
-                self.parentNodeName = attrs.get("name")
+                isOptIn = attrs.get("opt-in", "false").lower() == "true"
+                name = attrs.get("name")
+
+                self.validateKnownAttributes(["name", "opt-in"], attrs)
+                self.parentNodeName = name
                 self.propertyArrayDict[self.parentNodeName] = PropertyArray(
-                    self.parentNodeName, False, False
+                    name=name,
+                    prefixOnly=False,
+                    isClass=False,
+                    isOptIn=isOptIn,
                 )
 
             case "property":
@@ -263,6 +275,7 @@ def openFiles(self):
         const bool prefixOnly;
         const Property* properties;
         const int length;
+        const bool isOptIn;
     }};
 
     class PropertyNames
@@ -304,7 +317,7 @@ def fix(self, propertyName):
     def writePropertyArray(self, propertyArray):
         name = propertyArray.name
         prefixOnly = "true" if propertyArray.prefixOnly else "false"
-
+        isOptIn = "true" if propertyArray.isOptIn else "false"
         self.hFile.write(f"        static const PropertyArray {name}Props;\n")
 
         self.cppFile.write(f"""\
@@ -315,10 +328,11 @@ def writePropertyArray(self, propertyArray):
 
 const PropertyArray PropertyNames::{name}Props
 {{
-    "{name}",
-    {prefixOnly},
-    {name}PropsData,
-    {len(propertyArray.properties)}
+    .name="{name}",
+    .prefixOnly={prefixOnly},
+    .properties={name}PropsData,
+    .length={len(propertyArray.properties)},
+    .isOptIn={isOptIn}
 }};
 
 """)

cpp/include/DataStorm/Node.h

@@ -38,47 +38,110 @@ namespace DataStorm
         /**
          * Construct a DataStorm node.
          *
-         * A node is the main DataStorm object. It is required to construct topics. The constructor initializes
-         * the Ice communicator using the given arguments. If the communicator creation fails, an Ice exception is
-         * raised.
+         * A node is the main DataStorm object. It is required to construct topics.
+         *
+         * @param argc The number of arguments in argv.
+         * @param argv The configuration arguments.
+         * @param configFile The path to an optional Ice configuration file.
+         * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
+         * provided the Node will use the default callback executor that executes callback in a dedicated thread.
+         *
+         */
+        Node(
+            int& argc,
+            const char* argv[],
+            std::optional<std::string_view> configFile = std::nullopt,
+            std::function<void(std::function<void()> call)> customExecutor = nullptr);
+
+        /**
+         * Construct a DataStorm node.
+         *
+         * A node is the main DataStorm object. It is required to construct topics.
+         *
+         * @param argc The number of arguments in argv.
+         * @param argv The configuration arguments.
+         * @param configFile The path to an optional Ice configuration file.
+         * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
+         * provided the Node will use the default callback executor that executes callback in a dedicated thread.
          *
-         * @param iceArgs Arguments which are passed to the Ice::initialize function.
          */
-        template<class... T> Node(T&&... iceArgs) : _ownsCommunicator(true)
+        Node(
+            int& argc,
+            char* argv[],
+            std::optional<std::string_view> configFile = std::nullopt,
+            std::function<void(std::function<void()> call)> customExecutor = nullptr)
+            : Node(argc, const_cast<const char**>(argv), configFile, customExecutor)
         {
-            init(Ice::initialize(std::forward<T>(iceArgs)...), nullptr);
         }
 
+#ifdef _WIN32
         /**
          * Construct a DataStorm node.
          *
-         * A node is the main DataStorm object. It is required to construct topics. The node uses the given Ice
-         * communicator.
+         * A node is the main DataStorm object. It is required to construct topics.
          *
-         * @param communicator The Ice communicator used by the topic factory for its configuration and communications.
+         * @param argc The number of arguments in argv.
+         * @param argv The configuration arguments.
+         * @param configFile The path to an optional Ice configuration file.
          * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
          * provided the Node will use the default callback executor that executes callback in a dedicated thread.
+         *
          */
         Node(
-            Ice::CommunicatorPtr communicator,
+            int& argc,
+            const wchar_t* argv[],
+            std::optional<std::string_view> configFile = std::nullopt,
             std::function<void(std::function<void()> call)> customExecutor = nullptr);
 
         /**
          * Construct a DataStorm node.
          *
-         * A node is the main DataStorm object. It is required to construct topics. The constructor initializes
-         * the Ice communicator using the given arguments. If the communicator creation fails, an Ice exception is
-         * raised.
+         * A node is the main DataStorm object. It is required to construct topics.
          *
+         * @param argc The number of arguments in argv.
+         * @param argv The configuration arguments.
+         * @param configFile The path to an optional Ice configuration file.
          * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
          * provided the Node will use the default callback executor that executes callback in a dedicated thread.
-         * @param iceArgs Arguments which are passed to the Ice::initialize function.
+         *
          */
-        template<class... T>
-        Node(std::function<void(std::function<void()> call)> customExecutor, T&&... iceArgs) : _ownsCommunicator(true)
+        Node(
+            int& argc,
+            wchar_t* argv[],
+            std::optional<std::string_view> configFile = std::nullopt,
+            std::function<void(std::function<void()> call)> customExecutor = nullptr)
+            : Node(argc, const_cast<const wchar_t**>(argv), configFile, customExecutor)
         {
-            init(Ice::initialize(std::forward<T>(iceArgs)...), std::move(customExecutor));
         }
+#endif
+
+        /**
+         * Construct a DataStorm node.
+         *
+         * A node is the main DataStorm object. It is required to construct topics.
+         *
+         * @param configFile The path to an optional Ice configuration file.
+         * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
+         * provided the Node will use the default callback executor that executes callback in a dedicated thread.
+         */
+        Node(
+            std::optional<std::string_view> configFile = std::nullopt,
+            std::function<void(std::function<void()> call)> customExecutor = nullptr);
+
+        /**
+         * Construct a DataStorm node.
+         *
+         * A node is the main DataStorm object. It is required to construct topics. The node uses the given Ice
+         * communicator.
+         *
+         * @param communicator The Ice communicator used by the topic factory for its configuration and communications.
+         * This communicator must be initialized with a property set to use the "DataStorm" opt-in prefix.
+         * @param customExecutor An optional executor used to execute user callbacks, if no callback executor is
+         * provided the Node will use the default callback executor that executes callback in a dedicated thread.
+         */
+        Node(
+            Ice::CommunicatorPtr communicator,
+            std::function<void(std::function<void()> call)> customExecutor = nullptr);
 
         /**
          * Construct a new Node by taking ownership of the given node.
@@ -133,7 +196,10 @@ namespace DataStorm
         Ice::ConnectionPtr getSessionConnection(const std::string& ident) const noexcept;
 
     private:
-        void init(const Ice::CommunicatorPtr&, std::function<void(std::function<void()> call)> customExecutor);
+        Node(
+            Ice::CommunicatorPtr,
+            std::function<void(std::function<void()> call)> customExecutor,
+            bool ownsCommunicator);
 
         std::shared_ptr<DataStormI::Instance> _instance;
         std::shared_ptr<DataStormI::TopicFactory> _factory;

cpp/include/Ice/LocalExceptions.h

@@ -934,9 +934,10 @@ namespace Ice
     };
 
     /**
-     * An unknown property was used when trying to get or set an unknown property.
+     * This exception is raised when there is an error while getting or setting a property. For example, when
+     * trying to set an unknown Ice property.
      */
-    class ICE_API UnknownPropertyException final : public LocalException
+    class ICE_API PropertyException final : public LocalException
     {
     public:
         using LocalException::LocalException;