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

Creation of metadata labels model #3288

Conversation

jredrejo
Copy link
Member

Summary

Creation of new fields in the ContentNode model to store labels following the Hybrid Learning design

For this PR to work a contentcuration/contentcuration/constants/le_labels.py file with some examples has been created. This file has to be removed and the definitive labels must be loaded from le-utils.

Reviewer guidance

Run migrations and check tests pass
LABELS_MASSIVE=true pytest -s contentcuration/contentcuration/tests/test_labels.py

References

Closes #3263
Refers learningequality/le-utils#92

Comments

After le-utils has all the needed labels (following up on learningequality/le-utils#92 and possible further work) the model should be modified to add:

  1. Validation of allowed ids
  2. methods to add/delete a label in each of these new fields

Contributor's Checklist

PR process:

  • If this is an important user-facing change, PR or related issue the CHANGELOG label been added to this PR. Note: items with this label will be added to the CHANGELOG at a later time
  • If this includes an internal dependency change, a link to the diff is provided
  • The docs label has been added if this introduces a change that needs to be updated in the user docs?
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • Opportunities for using Google Analytics here are noted
  • Migrations are safe for a large db

Studio-specifc:

  • All user-facing strings are translated properly
  • The notranslate class been added to elements that shouldn't be translated by Google Chrome's automatic translation feature (e.g. icons, user-generated text)
  • All UI components are LTR and RTL compliant
  • Views are organized into pages, components, and layouts directories as described in the docs
  • Users' storage used is recalculated properly on any changes to main tree files
  • If there new ways this uses user data that needs to be factored into our Privacy Policy, it has been noted.

Testing:

  • Code is clean and well-commented
  • 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
  • Any new interactions have been added to the QA Sheet
  • Critical and brittle code paths are covered by unit tests

Reviewer's Checklist

This section is for reviewers to fill out.

  • 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

@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 27, 2021

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 1 Code Smell

No Coverage information No Coverage information
No Duplication information No Duplication information

models.Index(
fields=["learning_activity_labels"], name=LEARNING_ACTIVITY_LABEL_INDEX
),
models.Index(fields=["category_labels"], name=CATEGORY_LABEL_INDEX),
Copy link
Member

Choose a reason for hiding this comment

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

Could you remind me, did you find any benefit with these indices? If we go with a bitmask approach for searching, then perhaps we can avoid adding these and prevent the performance hit on writing to the table.

@rtibbles
Copy link
Member

Closing, proof of concept here, implementation will be done from #3324

@rtibbles rtibbles closed this Feb 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Categorical Metadata: Model fields
3 participants