Skip to content

Don't use jsonfield JSONField as it results in double JSON encoding - #3189

Merged
bjester merged 2 commits into
learningequality:hotfixesfrom
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged

Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom
rtibbles:publish_json_no_dumps

Conversation

@rtibbles

@rtibblesrtibbles commented Jun 3, 2021•
edited
Loading

Copy link
Copy Markdown
Member

Summary

Description of the change(s) you made

  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously

Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.

Manual verification steps performed

  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly

Screenshots (if applicable)

Does this introduce any tech-debt items?

Reviewer guidance

How can a reviewer test these changes?

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

@rtibbles
rtibbles requested a review from bjesterJune 3, 2021 15:43
@rtibblesrtibbles changed the title Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed the publish_json_no_dumps branch from 4cfc151 to 23d53f9CompareJune 3, 2021 15:49
bjester
bjester approved these changes Jun 3, 2021
View reviewed changes

@bjesterbjester left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good

@bjester
bjester merged commit f57d830 into learningequality:hotfixesJun 3, 2021
@bjesterbjester mentioned this pull request Jun 3, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Don't use jsonfield JSONField as it results in double JSON encoding by rtibbles · Pull Request #3189 · learningequality/studio · GitHub
Skip to content
Don't use jsonfield JSONField as it results in double JSON encoding - #3189
Merged
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Jun 3, 2021
Merged
Don't use jsonfield JSONField as it results in double JSON encoding#3189
bjester merged 2 commits into
learningequality:hotfixesfrom 
rtibbles:publish_json_no_dumps
Conversation
@rtibbles
@rtibblesrtibbles
commented
Jun 3, 2021•

edited

Loading

Copy link


Copy Markdown

Member
Summary
Description of the change(s) you made
  • jsonfield JSONField doesn't seem to act as expected in a Django 3 env (unsurprising as it doesn't support it)
  • Migrate all kolibri model JSONFields to TextFields, maintain the current json.dumps behaviour to replicate a jsonfield JSONField
  • Adds an assertion that published JSON fields for assessment metadata are actually of their expected type - this should have caught this regression previously
Note: I originally tried just removing the json.dumps that we do in publish, rather than changing the field type, and it didn't seem to make any difference, which was most odd. Have retested with this change instead, and it does indeed not seem to make a jot of difference.
Manual verification steps performed
  1. Created an exercise
  2. Published the channel with the exercise in
  3. Imported to Kolibri
  4. Verified that the exercise renders properly
Screenshots (if applicable)
Does this introduce any tech-debt items?
Reviewer guidance
How can a reviewer test these changes?
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
@rtibbles
rtibbles
requested a review
from bjesterJune 3, 2021 15:43
@rtibblesrtibbles
changed the title
Don't use json.dumps for JSONField as it results in double JSON encodingDon't use jsonfield JSONField as it results in double JSON encodingJun 3, 2021
@rtibbles
rtibblesforce-pushed
the
publish_json_no_dumps
branch
from
4cfc151 to
23d53f9CompareJune 3, 2021 15:49
bjester
bjester
approved these changes
Jun 3, 2021
View reviewed changes
@bjesterbjester
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Looks good
@bjester
bjester
merged commit f57d830
into
learningequality:hotfixesJun 3, 2021
@bjesterbjester
mentioned this pull request
Jun 3, 2021
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@bjesterbjesterbjester approved these changes

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@rtibbles@bjester