Skip to content

DRAFT! CMR-10049: deprecated some group apis #2227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jceaser
Copy link
Contributor

@jceaser jceaser commented Mar 7, 2025

NOTE, I have not decided if I want to go forward with this as of now, I will decide before the sprint ends.

Overview

While doing some investigations into APIs that use ACL and groups I marked several APIs as deprecated to visually confirm that some functions were not being used. I want to contribute these to CMR to ensure that everyone knows what will need to be removed. I'm wanting to start marking more functions as deprecated going forward to make it easy to remove these latter.

What is the feature/fix?

I added deprecated to functions and in one case made a function private.

What is the Solution?

to use ^{:deprecated "No replacment, use EDL instead"} on functions

What areas of the application does this impact?

This should only impact group functions which are behind a feature toggle, so no impact should be seen on a normal installation of CMR

Checklist

TBD:

  • I have updated/added unit and int tests that prove my fix is effective or that my feature works
  • New and existing unit and int tests pass locally and remotely
  • clj-kondo has been run locally and all errors corrected
  • I have removed unnecessary/dead code and imports in files I have changed
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have cleaned up integration tests by doing one or more of the following:
    • migrated any are2 tests to are3 in files I have changed
    • de-duped, consolidated, removed dead int tests
    • transformed applicable int tests into unit tests
    • refactored to reduce number of system state resets by updating fixtures (use-fixtures :each (ingest/reset-fixture {})) to be :once instead of :each

jceaser added 2 commits March 3, 2025 14:28
… down these APIs as using and generating some of the Group records. These I marked as deprecated while confirming that nothing in CMR used these functions outside of the feature toggel. Commiting my findings to aid in future work to remove these calls.
…nsure that no one uses these apis which should be removed at some poit
@jceaser jceaser changed the title CMR-10049: deprecated some group apis DRAFT! CMR-10049: deprecated some group apis Mar 7, 2025
@jceaser jceaser added the code-quality Effort to improve the quality of the code label Mar 7, 2025
@codecov-commenter
Copy link

codecov-commenter commented Mar 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.23%. Comparing base (752d8ea) to head (0e32167).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2227      +/-   ##
==========================================
- Coverage   58.23%   58.23%   -0.01%     
==========================================
  Files        1056     1056              
  Lines       71142    71142              
  Branches     2067     2060       -7     
==========================================
- Hits        41433    41431       -2     
- Misses      27784    27785       +1     
- Partials     1925     1926       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-quality Effort to improve the quality of the code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants