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

update django_bulk_update with inbuilt bulk_update #4417

Merged
merged 5 commits into from
Feb 2, 2024

Conversation

FidalMathew
Copy link
Contributor

@FidalMathew FidalMathew commented Jan 25, 2024

Summary

Description of the change(s) you made

I have remove django_bulk_update function in 2 files:

  • contentcuration/contentcuration/utils/sync.py
  • contentcuration/contentcuration/viewsets/assessmentitem.py

Manual verification steps performed

  1. pytest command used for testing

Screenshots (if applicable)

Does this introduce any tech-debt items?


Reviewer guidance

How can a reviewer test these changes?

  • Pytest command to check whether functionalities are working

Are there any risky areas that deserve extra testing?

References

Comments


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

@FidalMathew
Copy link
Contributor Author

FidalMathew commented Jan 25, 2024

@rtibbles Could you take a look at the PR?

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

When I add or edit assessment items, or otherwise known as 'Exercises' in the UI, I see this error in my logs:

[2024-01-26 23:06:26,135: ERROR/ForkPoolWorker-1] Field names must be given to bulk_update().
Traceback (most recent call last):
  File "/home/bjester/Projects/learningequality/studio2/contentcuration/contentcuration/viewsets/base.py", line 863, in update_from_changes
    self.perform_bulk_update(serializer)
  File "/home/bjester/Projects/learningequality/studio2/contentcuration/contentcuration/viewsets/base.py", line 850, in perform_bulk_update
    serializer.save()
  File "/home/bjester/Projects/learningequality/studio2/contentcuration/contentcuration/viewsets/base.py", line 363, in save
    instance = super(BulkListSerializer, self).save(**kwargs)
  File "/home/bjester/Projects/learningequality/pyenv/versions/3.9.13/envs/studio-3.9.13/lib/python3.9/site-packages/rest_framework/serializers.py", line 703, in save
    self.instance = self.update(self.instance, validated_data)
  File "/home/bjester/Projects/learningequality/studio2/contentcuration/contentcuration/viewsets/assessmentitem.py", line 70, in update
    all_objects = super(AssessmentListSerializer, self).update(
  File "/home/bjester/Projects/learningequality/studio2/contentcuration/contentcuration/viewsets/base.py", line 325, in update
    self.child.Meta.model.objects.bulk_update(updated_objects, list(properties_to_update))
  File "/home/bjester/Projects/learningequality/pyenv/versions/3.9.13/envs/studio-3.9.13/lib/python3.9/site-packages/django/db/models/manager.py", line 85, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/home/bjester/Projects/learningequality/pyenv/versions/3.9.13/envs/studio-3.9.13/lib/python3.9/site-packages/django/db/models/query.py", line 534, in bulk_update
    raise ValueError('Field names must be given to bulk_update().')
ValueError: Field names must be given to bulk_update().
``

@FidalMathew FidalMathew requested a review from bjester January 27, 2024 07:56
@FidalMathew
Copy link
Contributor Author

@bjester I'm working on a few changes, please wait before reviewing it. I'll let you know when the changes are ready.

@FidalMathew
Copy link
Contributor Author

@bjester could you check the PR out?

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

The prior issue is resolved! Although a change to contentcuration/contentcuration/utils/sync.py looks questionable. Although, I was unable to get it to fail using the 'sync channel' mechanism

Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks @FidalMathew !

@bjester bjester merged commit 9180549 into learningequality:unstable Feb 2, 2024
13 checks passed
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
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.

3 participants