Add ability to conditionally apply [[deprecated]]

[Dr15Jones]

PR description:

• added conditional CMS_DEPRECATED macro which is only turned on if USE_CMS_DEPRECATED is set
• made non esConsumes related EventSetup get calls CMS_DEPRECATED. Some minor code changes were applied to reduce redundant warning messages (e.g. a deprecated function internally calling another deprecated function).
• made use of legacy module types CMS_DEPRECATED

PR validation:

Code was compiles with and without USE_CMS_DEPRECATED set. When deprecations are turned on, expected warnings were generated.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-35390/25491

• This PR adds an extra 28KB to repository

[cmsbuild]

A new Pull Request was created by @Dr15Jones (Chris Jones) for master.

It involves the following packages:

• FWCore/Framework (core)
• FWCore/Utilities (core)

@makortel, @smuzaffar, @cmsbuild, @Dr15Jones can you please review it and eventually sign? Thanks.
@makortel, @felicepantaleo, @wddgit this is something you requested to watch as well.
@perrotta, @dpiparo, @qliphy you are the release manager for this.

cms-bot commands are listed here

[Dr15Jones]

please test

NOTE the conditional is off so will not show up in the test

[makortel]

Effectively implements #31021, even if still turned off.

[makortel]

What about legacy edm::OutputModule that is being flagged by the static analyzer?

[Dr15Jones]

What about legacy edm::OutputModule that is being flagged by the static analyzer?

When I did a very quick check on that file, I didn't find it. I'm not sure we have legacy OutputModules anymore.

[makortel]

Ah right, was removed already in #29633.

[Dr15Jones]

This is just the old get call renamed. I did this to avoid having multiple "deprecated" messages happening in the case someone called a deprecated function that then called the deprecated get. In that case you'd get one warning at the callers site and a second one in EventSetupRecord.h itself. Moving the implementation to a private function that isn't annotated avoids that.

[cmsbuild]

+1

Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-d68ae9/18875/summary.html
COMMIT: 4c91e9d
CMSSW: CMSSW_12_1_X_2021-09-23-1100/slc7_amd64_gcc900
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/35390/18875/install.sh to create a dev area with all the needed externals and cmssw changes.

The following merge commits were also included on top of IB + this PR after doing git cms-merge-topic:

• @mmusich Migrating away from deprecated edm::EDAnalyzer API in CalibTracker/SiStripLorentzAngle #35381
• @mmusich simplify logic for AndOr in DetStatus #35378
• @francescobrivio Add logic in OnlineBeamSpotESProducer #35333
• @CMSTrackerDPG Migrating away from deprecated edm::EDAnalyzer API in CalibTracker/SiPixelESProducers #35375

You can see more details here:
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-d68ae9/18875/git-recent-commits.json
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-d68ae9/18875/git-merge-result

Found compilation warnings

Comparison Summary

Summary:

• No significant changes to the logs found
• Reco comparison results: 12 differences found in the comparisons
• DQMHistoTests: Total files compared: 40
• DQMHistoTests: Total histograms compared: 3211080
• DQMHistoTests: Total failures: 17
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 3211040
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: -0.004 KiB( 39 files compared)
• DQMHistoSizes: changed ( 312.0 ): -0.004 KiB MessageLogger/Warnings
• Checked 169 log files, 37 edm output root files, 40 DQM output files
• TriggerResults: no differences found

[makortel]

@smuzaffar Do you have any comments? The changes look good to me.

[smuzaffar]

@makortel looks good, with -DUSE_CMS_DEPRECATED it generates nearly 4K warnings (1238 unique warnings) [a]. Once this is merge then I can enable the USE_CMS_DEPRECATED macro for dev area only.

[a]

FWCore/ParameterSet/interface/ParameterSetDescriptionFillerBase.h:106:65: warning: 'EDAnalyzer' is deprecated [-Wdeprecated-declarations]
  106 |     static const std::string& extendedBaseType(EDAnalyzer const*) { return kExtendedBaseForEDAnalyzer; }

[makortel]

Hmh, that makes me wonder if warnings from FWCore headers (as opposed to user code) that needs to use legacy module types (until we actually remove the support) could cause more confusion than help in getting code migrated.

[Dr15Jones]

Hmh, that makes me wonder if warnings from FWCore headers (as opposed to user code) that needs to use legacy module types (until we actually remove the support) could cause more confusion than help in getting code migrated.

My thinking is to see how it goes and if it is causing an issue, we can try to do a bit of code rearranging to see if they can be avoided for compliant code. [I did a bit of that already.]

[Dr15Jones]

Also, I separated the esConsumes from the legacy module into two different commits so we could easily undo to the legacy one if it proves to be to verbose.

[Dr15Jones]

@makortel @smuzaffar so what is the verdict?

[makortel]

Let's try it out. Anyway this PR alone doesn't change behavior even in the dev areas.

[makortel]

+1

[cmsbuild]

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @perrotta, @dpiparo, @qliphy (and backports should be raised in the release meeting by the corresponding L2)

[qliphy]

+1