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 node details query to use CTE and more robust tests #4824

Merged
merged 3 commits into from
Nov 15, 2024

Conversation

bjester
Copy link
Member

@bjester bjester commented Nov 15, 2024

Summary

Description of the change(s) you made

  • Updates the query that's used for validating the cache when querying a node's details
  • No change in behavior was intended (even though there are lots of questions about this code Channel details - The channel info is not getting updated correctly #4123)
  • Adds more robust tests to verify all scenarios of affected code
  • Also adds some explicit analytics since the URL fragment for the frontend details view is not available in GA

Manual verification steps performed

  1. Created regression tests
  2. Verified new tests passed
  3. Implemented changes
  4. Verified tests passed
  5. Updated tests and some logic further to simplify some queries, like repeated queries for the channel object

Reviewer guidance

How can a reviewer test these changes?

  • Can you load the channel details?

Are there any risky areas that deserve extra testing?

  • Do the tests make sense?

References

Fixes #4795

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

Copy link

sentry-io bot commented Nov 15, 2024

🔍 Existing Issues For Review

Your pull request is modifying functions with the following pre-existing issues:

📄 File: contentcuration/contentcuration/models.py

Function Unhandled Issue
get_details TypeError: 'NoneType' object is not iterable /api...
Event Count: 22
📄 File: contentcuration/contentcuration/views/nodes.py (Click to Expand)
Function Unhandled Issue
get_channel_details TypeError: 'NoneType' object is not iterable /api...
Event Count: 22
---

Did you find this useful? React with a 👍 or 👎

@bjester bjester requested review from rtibbles and ozer550 November 15, 2024 16:48
@bjester bjester added this to the Studio: Q4 patch release 1 milestone Nov 15, 2024
Copy link
Member

@rtibbles rtibbles left a comment

Choose a reason for hiding this comment

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

Test cases look like good coverage and inspire confidence (and all pass)! No regressions spotted in manual testing.

@@ -114,14 +114,26 @@
},
mounted() {
this.load();
this.$analytics.trackAction('channel_details', 'View', {
Copy link
Member

Choose a reason for hiding this comment

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

👍

@@ -493,6 +493,14 @@
return this.categories.join(', ');
},
},
mounted() {
if (!this.isChannel) {
// Track node details view when not a channel-- is this happening?
Copy link
Member

Choose a reason for hiding this comment

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

I really think not!

@rtibbles rtibbles merged commit e349e81 into learningequality:hotfixes Nov 15, 2024
13 checks passed
@pcenov
Copy link
Member

pcenov commented Nov 22, 2024

No regressions observed while viewing the channel details.

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

Successfully merging this pull request may close these issues.

3 participants