') + ')', '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('^' + ".*" + ', '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" + ', '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('^' + ".*" + ', '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); } })(); })(); Feature flag support by bjester · Pull Request #3129 · learningequality/studio · GitHub
Skip to content

Feature flag support - #3129

Merged
rtibbles merged 10 commits into
learningequality:unstablefrom
bjester:feature-flags
May 3, 2021
Merged

Feature flag support#3129
rtibbles merged 10 commits into
learningequality:unstablefrom
bjester:feature-flags

Conversation

@bjester

@bjesterbjester commented Apr 29, 2021•
edited
Loading

Copy link
Copy Markdown
Member

Summary

Allows for customization of Studio behavior on per-user basis through features defined in a static JSON file and granted through the admin interface.

Description of the change(s) you made

  • Adds feature_flags JSONB column to the User model
  • Adds jsonschema dependency and resolves cross-dependency versioning conflicts
  • Adds JSON file in form of a JSON schema to itemize available feature flags and validate feature flag data prior to saving
  • Adds static alias to Webpack for loading JSON schema on frontend
  • Exposes table of feature flags using the JSON schema in the Studio admin UI for toggling the features
  • Refactors older user details API view into the AdminUserViewSet
  • Fixes/refactors permissions for editing user record
  • Adds function to garbage collect that cleans up lingering feature flags in the database

Manual verification steps performed

  1. Log into Studio admin
  2. Click "Users" tab
  3. View a user's details
  4. Enable the dev feature
  5. Verify the feature's state for the user in the database
  6. Disable the dev feature
  7. Verify the feature's state for the user in the database
  8. Manually add non-existent feature flag to the user record in the database
  9. Run python manage.py garbage_collect
  10. Verify the user in the database no longer has the feature flag manually added

Screenshots (if applicable)

Screenshot from 2021-05-03 11-33-39

EnablingDisabling
Screenshot from 2021-05-03 11-31-15Screenshot from 2021-05-03 11-30-55

References

Resolves#3120

Comments

In the above issue it has the following deliverable:

Add under setting disk space section, to allow reuse of Save Changes button already present

I did not follow the above deliverable because the save button is contained in a standalone component which would either require additional refactoring or would otherwise not be nominally understandable. Instead I added it below and used a KSwitch which is expected to apply the change immediately (without the need for a save button).

Contributor's Checklist

PR process:

  • If this includes an internal dependency change, a link to the diff is provided
  • If any Python requirements have changed, the updated requirements.txt files also included in this PR
  • 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
  • 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
  • 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

@bjester
bjester marked this pull request as ready for review May 3, 2021 19:45
bjester
bjester commented May 3, 2021
View reviewed changes
Comment threadcontentcuration/contentcuration/viewsets/user.py
annotations["editable_channels__ids"] = NotNullArrayAgg("editable_channels__id")
annotations["view_only_channels__ids"] = NotNullArrayAgg(
"view_only_channels__id"
)

@bjesterbjesterMay 3, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

These fields weren't used anywhere

rtibbles
rtibbles approved these changes May 3, 2021
View reviewed changes

@rtibblesrtibbles 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.

Works precisely as I would expect!

Comment threadcontentcuration/contentcuration/urls.py
from django.conf.urls import include
from django.conf.urls import url
from django.conf.urls.i18n import i18n_patterns
from django.contrib import admin

@rtibblesrtibblesMay 3, 2021

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.

Hah, my linter also just picked this up.

@rtibbles
rtibbles merged commit 9dde3fd into learningequality:unstableMay 3, 2021
@bjesterbjester mentioned this pull request May 11, 2021
Merged
@bjesterbjester mentioned this pull request Jan 26, 2024
Merged
24 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rtibblesrtibblesrtibbles approved these changes

Assignees

No one assigned

Labels

TODO: needs review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Basic user scoped feature flags

2 participants

@bjester@rtibbles