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

Use Kolibri hooks for storage hooks. #10383

Merged
merged 2 commits into from
Apr 5, 2023

Conversation

rtibbles
Copy link
Member

@rtibbles rtibbles commented Apr 5, 2023

Summary

  • Final update for hooking into the Job storage class
  • Adds the ability to hook into jobs being cleared
  • Also cleans up the way that hooks are registered to use a proper Kolibri hook rather than creating parallel mechanisms

References

In support of learningequality/kolibri-installer-android#119

Reviewer guidance

Create a mock hook derived from the StorageHook and register it somewhere, for example:

@register_hook
class StorageHookExample(StorageHook):
    def schedule(self, job, orm_job):
        print("Job {} scheduled".format(job.job_id))
    
    def update(self, job, orm_job, state=None, **kwargs):
        print("Job {} updated".format(job.job_id))
    
    def clear(self, job, orm_job):
        print("Job {} cleared".format(orm_job.id))

Then run Kolibri and see that the hook properly does these print statements.

Testing checklist

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

PR process

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Reviewer checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

@github-actions github-actions bot added DEV: backend Python, databases, networking, filesystem... SIZE: small labels Apr 5, 2023
@rtibbles rtibbles marked this pull request as ready for review April 5, 2023 22:15
Copy link
Member

@marcellamaki marcellamaki left a comment

Choose a reason for hiding this comment

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

Approving following code walk through with @rtibbles

@rtibbles rtibbles merged commit ac9118a into learningequality:develop Apr 5, 2023
@rtibbles rtibbles deleted the storage_hook branch April 5, 2023 23:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DEV: backend Python, databases, networking, filesystem... SIZE: small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants