Skip to content
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

engine/ Improve Readability and Maintainability of Data Purge Function (purge()) #2529

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

itstanany
Copy link

IMPORTANT: All PRs must be linked to an issue (except for extremely trivial and straightforward changes).

Fixes #2528

Description

Refactor purge() function for improved readability and maintainability

This pull request refactors the purge function to enhance code clarity and maintainability. The current implementation utilizes nested conditionals for resource presence, local changes, and force purge checks. This refactoring separates these concerns for improved readability.

Changes:

  • Combined Local Changes and Force Purge Check: Combines the checks for local changes (localChanges.isNotEmpty()) and the forcePurge flag within a single condition.
  • Concise Comments: Adds concise comments to explain the logic behind each step.
  • Reduced Redundancy:

These improvements promote better code understanding and maintainability for future developers.

Alternative(s) considered
Have you considered any alternatives? And if so, why have you chosen the approach in this PR?

Type
Choose one: Code health

Screenshots (if applicable)

Checklist

  • I have read and acknowledged the Code of conduct.
  • I have read the Contributing page.
  • I have signed the Google Individual CLA, or I am covered by my company's Corporate CLA.
  • I have discussed my proposed solution with code owners in the linked issue(s) and we have agreed upon the general approach.
  • I have run ./gradlew spotlessApply and ./gradlew spotlessCheck to check my code follows the style guide of this project.
  • I have run ./gradlew check and ./gradlew connectedCheck to test my changes locally.
  • I have built and run the demo app(s) to verify my change fixes the issue and/or does not break the demo app(s).

@itstanany itstanany requested review from santosh-pingle and a team as code owners April 28, 2024 23:45
Copy link

google-cla bot commented Apr 28, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Copy link
Collaborator

@MJ1998 MJ1998 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: PR under Review
Development

Successfully merging this pull request may close these issues.

Improve Readability and Maintainability of Data Purge Function (purge())
4 participants