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

Re-parse command refactor #3205

Open
2 of 9 tasks
raftmsohani opened this issue Oct 1, 2024 · 3 comments · May be fixed by #3361
Open
2 of 9 tasks

Re-parse command refactor #3205

raftmsohani opened this issue Oct 1, 2024 · 3 comments · May be fixed by #3361
Assignees
Labels
backend dev P3 Needed – Routine Refined Ticket has been refined at the backlog refinement

Comments

@raftmsohani
Copy link

raftmsohani commented Oct 1, 2024

Description:
Follow up on #3106, re-parse command button shares reparse logic with management command. Basically, the command button calls the management command.

We want to create a new utility function to share part of reparsing command logic and create a reparse admin command logic which enables us to customize logic between the two.

Acceptance Criteria:
Create a list of functional outcomes that must be achieved to complete this issue

  • Reparse admin command runs from a function and not management command
  • Reparse management command is simplified
  • A utility function is created as a help function for both management and admin command reparse
  • Testing Checklist has been run and all tests pass
  • README is updated, if necessary

Tasks:
Create a list of granular, specific work items that must be completed to deliver the desired outcomes of this issue

  • Refactor clean_and_reparse command and decompose management command from admin action reparse command
  • Create a utility function and move body of reparsing code to utility function
  • Create a separate function for parsing admin command which performs reparsing when called by reaprse command from admin button. This function uses the same utility function created in the step above
  • Run Testing Checklist and confirm all tests pass

Notes:
Add additional useful information, such as related issues and functionality that isn't covered by this specific issue, and other considerations that will be helpful for anyone reading this

  • Note 1
  • Note 2
  • Note 3

Supporting Documentation:
Please include any relevant log snippets/files/screen shots

  • Doc 1
  • Doc 2

Open Questions:
Please include any questions or decisions that must be made before beginning work or to confidently call this issue complete

  • What error handling updates to we want to add to django admin action?
  • Do we want to sunset management command?
@vlasse86 vlasse86 added the P3 Needed – Routine label Oct 1, 2024
@raftmsohani raftmsohani self-assigned this Oct 4, 2024
@vlasse86 vlasse86 added the Refined Ticket has been refined at the backlog refinement label Oct 15, 2024
@jtimpe
Copy link

jtimpe commented Oct 17, 2024

per comment thread on 3106, we may also revisit logging when separating the action and management command

@lhuxraft
Copy link
Collaborator

12/11: 35-40% done with code changes

@lhuxraft
Copy link
Collaborator

12/16: Tests are passing, need to clean up management command. 50% complete

@raftmsohani raftmsohani linked a pull request Dec 19, 2024 that will close this issue
28 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend dev P3 Needed – Routine Refined Ticket has been refined at the backlog refinement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants