Adds deprecator

[mtrezza]

New Pull Request Checklist

• I am not disclosing a vulnerability.
• I am creating this PR in reference to an issue.

Issue Description

Currently, there is no mechanism provided to deprecate Parse Server settings.

Related issue: closes #7302

Approach

Adds a new Deprecator in ./Deprecator directory.

Features:

• Covers the following deprecation scenarios:
  • renaming / refactoring of option name
  • change of option default value
  • removal of option
• All deprecations defined in ./Deprecator/Deprecations.js in a standardized way to
  • make it easy to manage deprecations
  • make it easy for contributors to identify features that are being phased out
• Minimal effort required to log a warning
• Deprecations logged as warnings at Parse Server launch
• Deprecator works for launching Parse Server via CLI or as module (new ParseServer(...))

Examples

• Log that someFeature option default will change from false to true:

  { optionKey: 'someFeature', changeNewDefault: 'true' }
  

  DeprecationWarning: The Parse Server option 'someFeature' default will change to 'true' in a future version.

• Log that someFeature option name will change to somethingElse:

  { optionKey: 'someFeature', changeNewKey: 'somethingElse' }
  

  DeprecationWarning: The Parse Server option 'someFeature' is deprecated and will be renamed to 'sometimeElse' in a future version.

• Log that someFeature option name will be removed:

  { optionKey: 'someFeature', changeNewKey: '' }
  

  DeprecationWarning: The Parse Server option 'someFeature' is deprecated and will be removed in a future version.

TODOs before merging

• Add test cases
• Add entry to changelog
• [ ] Add changes to documentation (guides, repository pages, in-code descriptions) to be added in Add deprecation policy #7199

[codecov]

Codecov Report

Merging #7303 (6e087dc) into master (bc08b54) will decrease coverage by 7.66%.
The diff coverage is 92.10%.

❗ Current head 6e087dc differs from pull request most recent head 627f66d. Consider uploading reports for the commit 627f66d to get more accurate results

@@            Coverage Diff             @@
##           master    #7303      +/-   ##
==========================================
- Coverage   93.93%   86.26%   -7.67%     
==========================================
  Files         179      181       +2     
  Lines       13153    13190      +37     
==========================================
- Hits        12355    11379     -976     
- Misses        798     1811    +1013     

Impacted Files	Coverage Δ
src/GraphQL/loaders/usersMutations.js	91.20% <80.00%> (-2.22%)	⬇️
src/Deprecator/Deprecations.js	100.00% <100.00%> (ø)
src/Deprecator/Deprecator.js	100.00% <100.00%> (ø)
src/ParseServer.js	89.88% <100.00%> (+0.11%)	⬆️
src/cli/utils/commander.js	100.00% <100.00%> (ø)
src/Adapters/Storage/Mongo/MongoCollection.js	4.76% <0.00%> (-92.86%)	⬇️
src/Adapters/Storage/Mongo/MongoStorageAdapter.js	12.20% <0.00%> (-80.40%)	⬇️
src/Adapters/Cache/RedisCacheAdapter.js	12.28% <0.00%> (-75.44%)	⬇️
src/Adapters/Files/GridFSBucketAdapter.js	10.65% <0.00%> (-69.68%)	⬇️
...rc/Adapters/Storage/Mongo/MongoSchemaCollection.js	37.07% <0.00%> (-60.68%)	⬇️
... and 26 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bc08b54...627f66d. Read the comment docs.

[davimacedo]

LGTM!

[mtrezza]

I changed the log message from

⚠️ The Parse Server option 'someFeature' default will change to 'true' in a future version.

to

DeprecationWarning: The Parse Server option 'someFeature' default will change to 'true' in a future version.

This is according to the Node.js deprecation warnings and makes it easier so search log files by term DeprecationWarning.

[mtrezza]

@dplewis If there is no objection, I'll merge this later today.

The coverage change is actually 0%; just with the last commit it seems that cov is reporting false negatives.

[parseplatformorg]

🎉 This change has been released in version 5.0.0-beta.1

[parseplatformorg]

🎉 This change has been released in version 5.0.0