reintroduce --cluster.index-create-timeout for testing (#14678)

jsteemann · web-flow · commit f36462986b95 · 2021-08-24T18:59:22.000+02:00
we want the timeout to be configurable for arangosync testing.
diff --git a/CHANGELOG b/CHANGELOG
@@ -24,9 +24,11 @@ devel
 * Do not block a scheduler thread on the coordinator while an index is being 
   created. Instead, start a background thread for the actual index 
   fill-up work. The original thread can then be relinquished until the index
-  is completely filled or index creation has failed. This also allows
-  obsoleting the startup option `--cluster.index-create-timeout`, which from
-  now on is ignored when set.
+  is completely filled or index creation has failed. 
+  The default index creation timeout on coordinators has also been 
+  extended from 1 hour to 4 days, but it is still configurable via the
+  startup parameter `--cluster.index-create-timeout` in case this is
+  necessary.
 
 * Fix wrong assertion in fuerte and move it to where the TLA+ model says
   it should be. This fixes a unit test failure occurring on newer Macs
diff --git a/arangod/Cluster/ClusterFeature.cpp b/arangod/Cluster/ClusterFeature.cpp
@@ -115,11 +115,6 @@ void ClusterFeature::collectOptions(std::shared_ptr<ProgramOptions> options) {
 
   options->addObsoleteOption("--cluster.agency-prefix", "agency prefix", false);
   
-  options->addObsoleteOption("--cluster.index-create-timeout",
-      "amount of time (in seconds) the coordinator will wait for an index to "
-      "be created before giving up", true);
-
-
   options->addOption(
       "--cluster.require-persisted-id",
       "if set to true, then the instance will only start if a UUID file is "
@@ -223,6 +218,15 @@ void ClusterFeature::collectOptions(std::shared_ptr<ProgramOptions> options) {
                                    arangodb::options::Flags::OnDBServer,
                                    arangodb::options::Flags::Hidden));
 
+  options->addOption(
+      "--cluster.index-create-timeout",
+      "amount of time (in seconds) the coordinator will wait for an index to "
+      "be created before giving up",
+      new DoubleParameter(&_indexCreationTimeout),
+      arangodb::options::makeFlags(arangodb::options::Flags::DefaultNoComponents,
+                                   arangodb::options::Flags::OnCoordinator,
+                                   arangodb::options::Flags::Hidden));
+
   options
       ->addOption("--cluster.api-jwt-policy",
                   "access permissions required for accessing /_admin/cluster REST APIs "
diff --git a/arangod/Cluster/ClusterFeature.h b/arangod/Cluster/ClusterFeature.h
@@ -86,7 +86,7 @@ class ClusterFeature : public application_features::ApplicationFeature {
   bool forceOneShard() const { return _forceOneShard; }
   /// @brief index creation timeout in seconds. note: this used to be
   /// a configurable parameter in previous versions, but is now hard-coded.
-  double indexCreationTimeout() const noexcept { return 72.0 * 3600.0; }
+  double indexCreationTimeout() const { return _indexCreationTimeout; }
 
   std::shared_ptr<HeartbeatThread> heartbeatThread();
 
@@ -170,6 +170,8 @@ class ClusterFeature : public application_features::ApplicationFeature {
   bool _unregisterOnShutdown = false;
   bool _enableCluster = false;
   bool _requirePersistedId = false;
+  /// @brief coordinator timeout for index creation. defaults to 4 days
+  double _indexCreationTimeout = 72.0 * 3600.0;
   std::unique_ptr<ClusterInfo> _clusterInfo;
   std::shared_ptr<HeartbeatThread> _heartbeatThread;
   std::unique_ptr<AgencyCache> _agencyCache;
