Merge pull request #32270 from makortel/throwEsConsumesOutsideConstru…

…ctor Throw an exception if esConsumes() is called outside EDModule constructors
cms-sw · Nov 25, 2020 · aacba62 · aacba62
2 parents dd492f7 + 4dd952a
commit aacba62
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 0 deletions.
diff --git a/FWCore/Framework/interface/EDConsumerBase.h b/FWCore/Framework/interface/EDConsumerBase.h
@@ -245,6 +245,9 @@ namespace edm {
     void throwBranchMismatch(BranchType, EDGetToken) const;
     void throwBadToken(edm::TypeID const& iType, EDGetToken iToken) const;
     void throwConsumesCallAfterFrozen(TypeToGet const&, InputTag const&) const;
+    void throwESConsumesCallAfterFrozen(eventsetup::EventSetupRecordKey const&,
+                                        eventsetup::heterocontainer::HCTypeTag const&,
+                                        edm::ESInputTag const&) const;
     void throwESConsumesInProcessBlock() const;
 
     edm::InputTag const& checkIfEmpty(edm::InputTag const& tag);

diff --git a/FWCore/Framework/src/EDConsumerBase.cc b/FWCore/Framework/src/EDConsumerBase.cc
@@ -168,7 +168,10 @@ void EDConsumerBase::updateLookup(BranchType iBranchType,
 }
 
 void EDConsumerBase::updateLookup(eventsetup::ESRecordsToProxyIndices const& iPI) {
+  // temporarily unfreeze to allow late EventSetup consumes registration
+  frozen_ = false;
   registerLateConsumes(iPI);
+  frozen_ = true;
 
   unsigned int index = 0;
   for (auto it = m_esTokenInfo.begin<kESLookupInfo>(); it != m_esTokenInfo.end<kESLookupInfo>(); ++it, ++index) {
@@ -210,6 +213,10 @@ ESTokenIndex EDConsumerBase::recordESConsumes(Transition iTrans,
                                               eventsetup::EventSetupRecordKey const& iRecord,
                                               eventsetup::heterocontainer::HCTypeTag const& iDataType,
                                               edm::ESInputTag const& iTag) {
+  if (frozen_) {
+    throwESConsumesCallAfterFrozen(iRecord, iDataType, iTag);
+  }
+
   //m_tokenLabels first entry is a null. Since most ES data requests have
   // empty labels we will assume we can reuse the first entry
   unsigned int startOfComponentName = 0;
@@ -392,6 +399,16 @@ void EDConsumerBase::throwConsumesCallAfterFrozen(TypeToGet const& typeToGet, In
                                      << "and " << inputTag << "\n";
 }
 
+void EDConsumerBase::throwESConsumesCallAfterFrozen(eventsetup::EventSetupRecordKey const& iRecord,
+                                                    eventsetup::heterocontainer::HCTypeTag const& iDataType,
+                                                    edm::ESInputTag const& iTag) const {
+  throw cms::Exception("LogicError") << "A module declared it consumes an EventSetup product after its constructor.\n"
+                                     << "This must be done in the contructor\n"
+                                     << "The product type was: " << iDataType.name() << " in record "
+                                     << iRecord.type().name() << "\n"
+                                     << "and ESInputTag was " << iTag << "\n";
+}
+
 void EDConsumerBase::throwESConsumesInProcessBlock() const {
   throw cms::Exception("LogicError")
       << "A module declared it consumes an EventSetup product during a ProcessBlock transition.\n"

diff --git a/FWCore/Integration/test/ESTestAnalyzers.cc b/FWCore/Integration/test/ESTestAnalyzers.cc
@@ -232,6 +232,21 @@ namespace edmtest {
                                         << ": ED value " << intData.value << ": ES value = " << dataJ.value();
   }
 
+  class ESTestAnalyzerIncorrectConsumes : public edm::stream::EDAnalyzer<> {
+  public:
+    explicit ESTestAnalyzerIncorrectConsumes(edm::ParameterSet const& iConfig){};
+    void analyze(const edm::Event&, const edm::EventSetup&) override;
+
+  private:
+    edm::ESGetToken<ESTestDataJ, ESTestRecordJ> esToken_;
+  };
+
+  void ESTestAnalyzerIncorrectConsumes::analyze(edm::Event const& ev, edm::EventSetup const& es) {
+    esToken_ = esConsumes();
+    edm::LogAbsolute("ESTestAnalyzerIncorrectConsumes")
+        << "Succeeded to call esConsumes() in analyze(), should not happen!";
+  }
+
 }  // namespace edmtest
 using namespace edmtest;
 DEFINE_FWK_MODULE(ESTestAnalyzerA);
@@ -240,3 +255,4 @@ DEFINE_FWK_MODULE(ESTestAnalyzerK);
 DEFINE_FWK_MODULE(ESTestAnalyzerAZ);
 DEFINE_FWK_MODULE(ESTestAnalyzerJ);
 DEFINE_FWK_MODULE(ESTestAnalyzerL);
+DEFINE_FWK_MODULE(ESTestAnalyzerIncorrectConsumes);
diff --git a/FWCore/Integration/test/eventSetupTest.sh b/FWCore/Integration/test/eventSetupTest.sh
@@ -33,4 +33,7 @@ cmsRun --parameter-set ${LOCAL_TEST_DIR}/testConcurrentIOVsESSource_cfg.py || di
 echo EventSetupTestCurrentProcess_cfg.py
 cmsRun ${LOCAL_TEST_DIR}/EventSetupTestCurrentProcess_cfg.py || die 'Failed in EventSetupTestCurrentProcess_cfg.py' $?
 
+echo EventSetupIncorrectConsumes_cfg.py
+cmsRun ${LOCAL_TEST_DIR}/EventSetupIncorrectConsumes_cfg.py && die 'Failed in EventSetupIncorrectConsumes_cfg.py' 1
+
 popd