feat: System defined taxonomies #551

ChrisChV · 2023-07-12T21:15:02Z

Description

Add the object tags for the system defined taxonomies that will be used in the platform. In addition, a migration has been created that loads the fixtures that create the System defined taxonomies

Testing instructions

Get the master openedx/devstack up and running.
Pull this branch into edx-platform
Install dependencies and update migrations by running paver install_prereqs in the LMS shell (from devstack dir, run make lms-shell) and CMS shell (make studio-shell).
Run the new migrations to create the System defined Taxonomies by running ./manage.py lms migrate in the LMS shell.
Open a shell with ./manage.py lms shell
Check the new created System-defined taxonomies:

>>> from openedx_tagging.core.tagging.models import Taxonomy
>>> Taxonomy.objects.filter(id__lt=0)
<QuerySet [<ContentOrganizationTaxonomy> (-3) Content Authors, <ContentAuthorTaxonomy> (-2) Organizations, <ContentLanguageTaxonomy> (-1) Languages]>
>>> lang = Taxonomy.objects.get(id=-1)
>>> lang
<ContentLanguageTaxonomy> (-1) Languages
>>> lang.tag_set.all()

Revert the migration with ./manage.py lms migrate content_tagging 0001
Check that System-defined taxonomies are deleted:

>>> from openedx_tagging.core.tagging.models import Taxonomy, Tag
>>> Taxonomy.objects.filter(id__lt=0)
<QuerySet []>
>>> Tag.objects.all()
<QuerySet []>

Deadline

None

Other information

Relates to openedx/modular-learning#77

Depends on open-craft/openedx-learning#3

Data migrations added here can be easily rolled back.

pomegranited

Hi @ChrisChV , I've requested some changes here, but as with open-craft/openedx-learning#3 (review), feel free to wait until upstream have weighed in on openedx#32661 before addressing them.

openedx/features/content_tagging/migrations/0002_system_defined_taxonomies.py

openedx/features/content_tagging/system_defined_taxonomies/object_tags.py

pomegranited

Hi @ChrisChV, this is looking so much better. I've suggested some changes with #560, and raised a similar issue with the rules and taxonomy.cast() -- but once these are addressed, this should be ready for upstream :)

openedx/features/content_tagging/migrations/0002_system_defined_taxonomies.py

pomegranited · 2023-07-24T01:31:04Z

openedx/features/content_tagging/fixtures/system_defined.yaml

+    allow_multiple: false
+    allow_free_text: false
+    visible_to_authors: true
+    _taxonomy_class: openedx.features.content_tagging.models.ContentLanguageTaxonomy


Oh bummer.. i don't see a better way to do this right now, but we had hopes that our "system-defined language taxonomy" could be reused by other tagging applications, e.g. "people tags". But I think we'll need to deal with that when we come to it.

openedx/features/content_tagging/models/system_defined.py

openedx/features/content_tagging/tests/test_rules.py

pomegranited · 2023-07-24T02:08:39Z

requirements/edx/kernel.in

@@ -118,7 +118,7 @@ openedx-events>=3.1.0               # Open edX Events from Hooks Extension Frame
 openedx-filters                     # Open edX Filters from Hooks Extension Framework (OEP-50)
 # FIXME Use pip package once created
 # ref https://github.com/openedx/openedx-learning/pull/62
-git+https://github.com/open-craft/openedx-learning.git@jill/smarter-object-tags-rebase#egg=openedx-learning==0.1
+git+https://github.com/open-craft/openedx-learning.git@chris/system-defined-taxonomies#egg=openedx-learning


TODO: merge and tag openedx/openedx-learning#67, then update this dependency.

pomegranited

👍 awesome, looks ready to merge to me, @ChrisChV !

What do you think @bradenmacdonald ?

I tested this using the PR test instructions and ran the automated tests.
I read through the code and checked that the tests cover all the expected functionality.
~~I checked for accessibility issues~~ N/A
Includes documentation -- code comments are great
Commit structure follows OEP-0051

* fix: use student role for zoom in case of global staff. * fix: added request cache to avoid duplicate db calls.

This PR implements much of the static assets rework ADR [1], including: * `npm run build[-dev]`, and its subcommands, * `npm run webpack[-dev]` and * `npm run compile-sass[-dev]`. This is backwards-compatible. `paver update_assets` should not be affected. The new command warns that it is "experimental" for a few reasons: * `npm run build` will fail in the webpack phase unless you first run `xmodule_assets`. This will be changed soon [2]. * We have tested the new build, but not quite so thoroughly that we'd recommend it as the production default yet. Once the xmodule_assets work lands, we'll share this on the forums so early adopters can try it out. * The commands lack some top-level documentation. Once they stabilize more, we'll add a section to the README that explains how and when to use `npm run build` and its subcommands and its env vars. * `npm run watch` is not yet implemented. References: 1. https://github.com/openedx/edx-platform/blob/master/docs/decisions/0017-reimplement-asset-processing.rst 2. openedx#32685 Part of: openedx#31604

* fix: allow missing authOrgId --------- Co-authored-by: Leangseu Kim <[email protected]>

Co-authored-by: Diego Velásquez <[email protected]>

…enedx#32480) As part of the static asset build, JS modules for most built-in XBlocks were unnecessarily copied from the original locations (under xmodule/js and common/static/js) to a git-ignored location (under common/static/xmodule), and then included into the Webpack builld via common/static/xmodule/webpack.xmodule.config.js. With this commit, we stop copying the JS modules. Instead, we have common/static/xmodule/webpack.xmodule.config.js just reference the original source under xmodule/js and common/static/js. This lets us us radically simplify the xmodule/static_content.py build script. It also sets the stage for the next change, in which we will check webpack.xmodule.config.js into the repository, and delete xmodule/static_content.py entirely. common/static/xmodule/webpack.xmodule.config.js before: module.exports = { "entry": { "AboutBlockDisplay": [ "./common/static/xmodule/modules/js/000-b82f6c436159f6bc7ca2513e29e82503.js", "./common/static/xmodule/modules/js/001-3ed86006526f75d6c844739193a84c11.js", "./common/static/xmodule/modules/js/002-3918b2d4f383c04fed8227cc9f523d6e.js", "./common/static/xmodule/modules/js/003-b3206f2283964743c4772b9d72c67d64.js", "./common/static/xmodule/modules/js/004-274b8109ca3426c2a6fde9ec2c56e969.js", "./common/static/xmodule/modules/js/005-26caba6f71877f63a7dd4f6796109bf6.js" ], "AboutBlockEditor": [ "./common/static/xmodule/descriptors/js/000-b82f6c436159f6bc7ca2513e29e82503.js", "./common/static/xmodule/descriptors/js/001-19c4723cecaa5a5a46b8566b3544e732.js" ], // etc } }; common/static/xmodule/webpack.xmodule.config.js after: module.exports = { "entry": { "AboutBlockDisplay": [ "./xmodule/js/src/xmodule.js", "./xmodule/js/src/html/display.js", "./xmodule/js/src/javascript_loader.js", "./xmodule/js/src/collapsible.js", "./xmodule/js/src/html/imageModal.js", "./xmodule/js/common_static/js/vendor/draggabilly.js" ], "AboutBlockEditor": [ "./xmodule/js/src/xmodule.js", "./xmodule/js/src/html/edit.js" ], // etc } }; Part of: openedx#32481

* refactor: moves is_content_creator from cms.djangoapps.contentstore.helpers to common.djangoapps.student.auth * feat: adds content tagging app Adds models and APIs to support tagging content objects (e.g. XBlocks, content libraries) by content authors. Content tags can be thought of as "name:value" fields, though underneath they are a bit more complicated. * adds dependency on openedx-learning<=0.1.0 * adds tagging app to LMS and CMS * adds content tagging models, api, rules, admin, and tests. * content taxonomies and tags can be maintained per organization by content creators for that organization.

…2686) * fix: push docker multi-arch images --------- Co-authored-by: Salman Nawaz <[email protected]>

Co-authored-by: Diego Velásquez <[email protected]>

* fix: include new assets.txt file in make upgrade * test: update click version to resolve upgrade job failure * chore: Updating Python Requirements (openedx#32861)

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

…x#32863) Co-authored-by: adeel.tajamul <[email protected]>

…x-enterprise-34f9fc4 feat: Upgrade Python dependency edx-enterprise

…ts` (openedx#32685) The Webpack configuration file for built-in XBlock JS used to be generated at build time and git-ignored. It lived at common/static/xmodule/webpack.xmodule.config.js. It was generated because the JS that it referred to was also generated at build-time, and the filenames of those JS modules were not static. Now that its contents have been made entirely static [1], there is no reason we need to continue generating this Webpack configuration file. So, we check it into edx-platform under the name ./webpack.builtinblocks.config.js. We choose to put it in the repo's root directory because the paths contained in the config file are relative to the repo's root. This allows us to behead both the xmodule/static_content.py (`xmodule_assets`) script andthe `process_xmodule_assets` paver task, a major step in removing the need for Python in the edx-platform asset build [2]. It also allows us to delete the `HTMLSnippet` class and all associated attributes, which were exclusively used by xmodule/static_content.py.. We leave `xmodule_assets` and `process_xmodule_assets` in as stubs for now in order to avoid breaking external code (like Tutor) which calls Paver; the entire pavelib/assets.py function will be eventually removed soon anyway [3]. Further, to avoid extraneous refactoring, we keep one method of `HTMLSnippet` around on a few of its former subclasses: `get_html`. This method was originally part of the XModule framework; now, it is left over on a few classes as a simple internal helper method. References: 1. openedx#32480 2. openedx#31800 3. openedx#31895 Part of: openedx#32481

bradenmacdonald · 2023-07-27T17:05:15Z

@ChrisChV could you please rebase this PR or merge master into it, then ping me for a look?

ChrisChV · 2023-07-27T17:42:33Z

Closed in favor of openedx#32869

ChrisChV force-pushed the chris/smart-system-defined-taxonomies branch 2 times, most recently from b30e79a to 5a8580f Compare July 12, 2023 22:53

pomegranited requested changes Jul 13, 2023

View reviewed changes

pomegranited force-pushed the jill/add-content-tagging-smart-objecttags branch from d780cc7 to 180a29c Compare July 18, 2023 07:23

ChrisChV force-pushed the chris/smart-system-defined-taxonomies branch 4 times, most recently from d3a045e to ecd8e07 Compare July 22, 2023 19:37

pomegranited requested changes Jul 24, 2023

View reviewed changes

pomegranited approved these changes Jul 25, 2023

View reviewed changes

pomegranited requested a review from bradenmacdonald July 25, 2023 07:04

pomegranited force-pushed the jill/add-content-tagging-smart-objecttags branch 2 times, most recently from 1a3c38f to 6206316 Compare July 26, 2023 05:14

AhtishamShahid and others added 17 commits July 26, 2023 14:19

fix: use student role for zoom in case of global staff. (openedx#32818)

f4616f0

* fix: use student role for zoom in case of global staff. * fix: added request cache to avoid duplicate db calls.

chore: replace memcachecache with pymemcache backend (openedx#32845)

23d6966

fix: learner home serializer key error (openedx#32842)

4331ee2

* fix: allow missing authOrgId --------- Co-authored-by: Leangseu Kim <[email protected]>

chore: remove warnings from defusedxml package (openedx#32652)

547e5b1

Co-authored-by: Diego Velásquez <[email protected]>

feat: upd batch enrollment email msg (openedx#32837)

370ea80

fix: remove record exception to avoid error rate on NR (openedx#32850)

51079e5

chore: geoip2: update maxmind geolite country database

06e738e

Docker multi-arch images push for linux/amd64, linux/arm64 (openedx#3…

e4a1039

…2686) * fix: push docker multi-arch images --------- Co-authored-by: Salman Nawaz <[email protected]>

chore: remove warnings for assertNotRegexpMatches method (openedx#32753)

e92e0e2

Co-authored-by: Diego Velásquez <[email protected]>

fix: include new assets.txt file in make upgrade (openedx#32860)

34f9fc4

* fix: include new assets.txt file in make upgrade * test: update click version to resolve upgrade job failure * chore: Updating Python Requirements (openedx#32861)

feat: Upgrade Python dependency edx-enterprise

6c1db43

Commit generated by workflow `openedx/edx-platform/.github/workflows/upgrade-one-python-dependency.yml@refs/heads/master`

chore: upgrading deprecated import. (openedx#32864)

5f7d82e

Merge branch 'master' into jajjibhai008/upgrade-edx-enterprise-34f9fc4

06d8a79

fix: fixed provider not setting in course discussion settings (opened…

54467b4

…x#32863) Co-authored-by: adeel.tajamul <[email protected]>

jajjibhai008 and others added 7 commits July 27, 2023 18:56

Merge pull request openedx#32865 from openedx/jajjibhai008/upgrade-ed…

c0e9dc9

…x-enterprise-34f9fc4 feat: Upgrade Python dependency edx-enterprise

feat: System defined taxonomies

49eb3dd

style: models.py moved to models/base.py

bf8f2cc

feat: New Content System defined models

3bb0495

style: Lint and migration

9585005

fix: Fix migration error

c8f3280

chore: Rebase and compile requirements

9dd2a2a

ChrisChV force-pushed the chris/smart-system-defined-taxonomies branch from 6a4a19a to 9dd2a2a Compare July 27, 2023 17:36

ChrisChV closed this Jul 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: System defined taxonomies #551

feat: System defined taxonomies #551

ChrisChV commented Jul 12, 2023 •

edited

Loading

pomegranited left a comment

pomegranited left a comment

pomegranited Jul 24, 2023

pomegranited Jul 24, 2023

pomegranited left a comment

bradenmacdonald commented Jul 27, 2023

ChrisChV commented Jul 27, 2023

feat: System defined taxonomies #551

feat: System defined taxonomies #551

Conversation

ChrisChV commented Jul 12, 2023 • edited Loading

Description

Testing instructions

Deadline

Other information

pomegranited left a comment

Choose a reason for hiding this comment

pomegranited left a comment

Choose a reason for hiding this comment

pomegranited Jul 24, 2023

Choose a reason for hiding this comment

pomegranited Jul 24, 2023

Choose a reason for hiding this comment

pomegranited left a comment

Choose a reason for hiding this comment

bradenmacdonald commented Jul 27, 2023

ChrisChV commented Jul 27, 2023

ChrisChV commented Jul 12, 2023 •

edited

Loading