Issue 5449 show license audit and special permissions checks by taoerman · Pull Request #5563 · learningequality/studio

taoerman · 2025-11-19T23:59:02Z

Summary

Introduces a license audit and special permissions verification workflow to the "Submit to Community Library" side panel.

It includes a new backend AuditedSpecialPermissionsLicenseViewSet to expose permission details and a frontend implementation that triggers a background audit task via useLicenseAudit.

Key UI additions include a LicenseStatus component to display audit results (success/warning) and a SpecialPermissionsList that requires users to explicitly confirm granular before submission is enabled.

References

Fixed #5449

Reviewer guidance

Test the changes manually.

AlexVelezLl

Just a few initial thoughts!

AlexVelezLl · 2025-11-20T19:41:50Z

contentcuration/contentcuration/celery.py

 # of setting it as an attribute on our custom Celery class
 app = CeleryApp("contentcuration", task_cls=CeleryTask)
 app.config_from_object(settings.CELERY)
+app.autodiscover_tasks(["contentcuration"])


Was there any reason to include this here? In theory it shouldn't be necessary 🤔

Initially, the page failed to load, which led me to suspect that the tasks weren't being registered. I added app.autodiscover_tasks(["contentcuration"]), and that seemed to resolve the issue.

However, upon further testing, I realized the explicit argument is redundant. When app.autodiscover_tasks() is called without arguments, Celery automatically scans all apps in INSTALLED_APPS. Since contentcuration is already listed there, the default configuration handles it correctly without the manual override

AlexVelezLl · 2025-11-20T19:49:34Z

...lEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/composables/useLicenseNames.js

+    const names = licenseNames.value;
+    if (names.length === 0) return '';
+    if (names.length === 1) return names[0];
+    return names.join(', ');


Just flagging that this is the same as having licenseNames.value.join(", "), .join will return an empty string if the array is empty, and will return just the first element if it just has one element.

Thanks, Alex, the code is now cleaner and more concise!

AlexVelezLl · 2025-11-20T19:51:10Z

...lEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/composables/useLicenseNames.js

+  const isLoading = ref(false);
+  const error = ref(null);


Here, we don't actually need these properties. And without them, we don't actually need this to be a composable, since it would only be a util function that formats the license IDs, without needing any state or other reactive behavior.

Thanks, removed them!

AlexVelezLl · 2025-11-20T19:55:54Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+      const invalidLicenseIds = computed(() => {
+        if (!props.invalidLicenses || props.invalidLicenses.length === 0) {
+          return [];
+        }
+        return props.invalidLicenses;
+      });


Mostly nitpick, but still want to flag that this could be simplified to be just:

const invalidLicenseIds = computed(() => props.invalidLicenses || []);

And with this simplification ⬆️, we can see that the only thing these computed properties are doing is to set a default value, then thi means that instead of creating these invalidLicenseIds and includedLicenseIds, a most straightforward way to handle it is to modify the default value of the props definition to be:

invalidLicenses: { type: Array, required: false, default: () => [], }, includedLicenses: { type: Array, required: false, default:() => [], },

with the default value set.

Thanks, I used const invalidLicenseIds = computed(() => props.invalidLicenses || []) instead!

AlexVelezLl · 2025-11-20T19:57:49Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+      const {
+        formattedLicenseNames: invalidLicenseNames,
+        isLoading: isLoadingInvalid,
+      } = useLicenseNames(invalidLicenseIds);
+
+      const {
+        formattedLicenseNames: includedLicenseNames,
+        isLoading: isLoadingIncluded,
+      } = useLicenseNames(includedLicenseIds);


Here we don't necessarily need a composable for this transformation, we could only create a helper function and do something like:

const invalidLicenseNames = computed(() => formatLicenseNames(props.invalidLicenses)); const includedLicenseNames = computed(() => formatLicenseNames(props.includedLicenses));

Got it, fixed!

AlexVelezLl · 2025-11-20T20:37:03Z

...components/sidePanels/SubmitToCommunityLibrarySidePanel/composables/useSpecialPermissions.js

+  watchEffect(() => {
+    const ids = resolvedPermissionIds.value;
+
+    if (ids.length === 0) {
+      permissions.value = [];
+      return;
+    }
+    fetchPermissions(ids);
+  });


I think here we can use watch instead, as we can explicitly define the dependencies of the watch.

Thanks! Fixed!

AlexVelezLl · 2025-11-20T20:38:23Z

...components/sidePanels/SubmitToCommunityLibrarySidePanel/composables/useSpecialPermissions.js

+  const currentPage = ref(1);
+
+  const nonDistributablePermissions = computed(() => {
+    return permissions.value.filter(p => !p.distributable);


In theory all permissions here are not distributable because in the fetch request we filter by distributable: false, right?

Yes, I wanted to make sure we got nonDistributablePermissions. But It looks redundant, removed!

AlexVelezLl · 2025-11-20T20:40:06Z

...ation/frontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/index.vue

+      watch(specialPermissions, (newVal) => {
+        if (newVal && newVal.length > 0) {
+          allSpecialPermissionsChecked.value = false;
+        } else {
+          allSpecialPermissionsChecked.value = true;
+        }
+      }, { immediate: true });


I think we can just rely on the @update:allChecked event to set this value instead of adding this watcher, what do you think?

Yes, this watch is redundant, removed!

AlexVelezLl · 2025-11-20T20:41:46Z

...ation/frontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/index.vue

+        if (!licenseAuditIsFinished.value) return false;
+
+        const baseCondition =
+          canBeEdited.value && publishedDataIsFinished.value && description.value.length >= 1;
+
+        if (needsReplacementConfirmation.value) {
+          return baseCondition && replacementConfirmed.value && allSpecialPermissionsChecked.value;
+        }
+
+        return baseCondition && allSpecialPermissionsChecked.value;


Since we will be checking allSpecialPermissionsChecked for all cases anyway, then we can just add another if at the beginning of the computed property, right?

Make sense!

AlexVelezLl · 2025-11-20T20:43:50Z

contentcuration/contentcuration/viewsets/audited_special_permissions_license.py

+    Supports filtering by IDs and distributable status.
+    """
+
+    by_ids = CharFilter(method="filter_by_ids")


We can use the UUIDInFilter here too!

AlexVelezLl · 2025-11-21T21:36:48Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+      const { formattedLicenseNames: invalidLicenseNames, isLoading: isLoadingInvalid } =
+        useLicenseNames(invalidLicenseIds);
+
+      const { formattedLicenseNames: includedLicenseNames, isLoading: isLoadingIncluded } =


Looking at the Figma designs, it seems that we should not be displaying the "Special permissions" as an included license in the license check passed notice here. So, just an additional request -- could you please filter out this license before formatting the license names? Thanks!

AlexVelezLl

Thanks @taoerman! Found some more things that can be improved. Let me know if you have any questions. Thanks! 👐

AlexVelezLl · 2025-11-29T15:45:46Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+      Box,
+    },
+    setup(props) {
+      const invalidLicenseNames = computed(() => formatLicenseNames(props.invalidLicenses));


For displaying the license names, we should also translate them using this translateConstant function

Fixed, Thanks!

AlexVelezLl · 2025-11-29T15:45:54Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+    setup(props) {
+      const invalidLicenseNames = computed(() => formatLicenseNames(props.invalidLicenses));
+
+      const includedLicenseNames = computed(() => {


Here, we will need to translate these licenses, too.

Fixed it. I added the logic into useLicenseNames.js for less duplications.

AlexVelezLl · 2025-11-29T15:48:42Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+        return props.includedLicenses
+          .map(id => {
+            const license = findLicense(id);
+            return license.license_name;
+          })
+          .filter(name => name !== 'Special Permissions')
+          .join(', ');


This is pretty much the same logic we have in the formatLicenseNames function. An idea to prevent this duplicated logic would be to extend the formatLicenseNames function to receive an options object, and if it has an excludes option, it will exclude the licenses specified by this option. And we can potentially manage the common need for translating the licenses in that function, too.

cool, I extended the formatLicenseNames function to receive an options object exactly!

AlexVelezLl · 2025-11-29T15:49:56Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+      });
+
+      const hasInvalidLicenses = computed(() => {
+        return props.invalidLicenses && props.invalidLicenses.length > 0;


A more direct way for null checking is using the optional chaining operator: ?.

props.invalidLicenses?.length > 0

AlexVelezLl · 2025-11-29T15:53:44Z

...ontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/LicenseStatus.vue

+        if (hasInvalidLicenses.value) {
+          return `"${invalidLicenseNames.value}" - ${channelCannotBeDistributed$()} ${fixLicensingBeforeSubmission$()}`;
+        }
+
+        return `${includedLicenseNames.value} - ${allLicensesCompatible$()}`;


We should always try to avoid concatenating the user-facing text with multiple different translations. Different languages have different ways to separate sentences, which is why we can't just rely on separating by spaces.

For this, for example, we can have two different strings that receive the license names to show as prop, and the translation will be the one in charge of separating the sentences.

Fixed, Thanks!

AlexVelezLl · 2025-11-29T16:47:05Z

...ation/frontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/index.vue

+      const canBeSubmitted = computed(() => {
+        if (!allSpecialPermissionsChecked.value) return false;
+        if (isPublishing.value) return false;
+        if (hasInvalidLicenses.value) return false;
+        if (!licenseAuditIsFinished.value) return false;
+
+        const baseCondition =
+          canBeEdited.value && publishedDataIsFinished.value && description.value.length >= 1;
+
+        if (needsReplacementConfirmation.value) {
+          return baseCondition && replacementConfirmed.value;
+        }
+
+        return baseCondition;
+      });


Now that we are adding each time more conditions so that canBeSubmitted is true, we can replace all of this with an array of conditions that needs to be met to return true. This way, we make the conditions to be met more explicit:

const conditions = [ allSpecialPermissionsChecked.value, !isPublishing.value, !hasInvalidLicenses.value, licenseAuditIsFinished.value, canBeEdited.value, publishedDataIsFinished.value, description.value.length >= 1, ]; if (needsReplacementConfirmation.value) { conditions.push(replacementConfirmed.value); } return conditions.every(condition => condition);

Fixed, Thanks!

AlexVelezLl · 2025-11-29T16:49:24Z

contentcuration/contentcuration/frontend/shared/data/resources.js

+  auditLicenses(id) {
+    return client.post(window.Urls.channel_audit_licenses(id)).then(response => {
+      return response.data;
+    });
+  },


We tend to prefer async/await instead.

async auditLicenses(id) { const response = await client.post(window.Urls.channel_audit_licenses(id)); return response.data; },

Fixed, Thanks!

AlexVelezLl · 2025-11-29T16:49:34Z

contentcuration/contentcuration/frontend/shared/data/resources.js

+
+export const AuditedSpecialPermissionsLicense = new APIResource({
+  urlName: 'audited_special_permissions_license',
+  fetchCollection(params) {


Fixed, Thanks!

AlexVelezLl · 2025-11-29T16:51:17Z

contentcuration/contentcuration/frontend/shared/strings/communityChannelsStrings.js

+  previousPage: {
+    message: 'Previous',
+    context: 'Button text to navigate to the previous page in pagination',
+  },
+  nextPage: {
+    message: 'Next',
+    context: 'Button text to navigate to the next page in pagination',
+  },


Could we add an Action suffix for these? Thanks!

AlexVelezLl · 2025-11-29T16:51:55Z

contentcuration/contentcuration/viewsets/audited_special_permissions_license.py

+from contentcuration.viewsets.base import ReadOnlyValuesViewset
+
+
+class UUIDInFilter(BaseInFilter, UUIDFilter):


We already have a UUIDInFilter defined in from contentcuration.viewsets.common import UUIDInFilter

Fixed Thanks!

…mmunity Library Side Panel merge#

merge#

AlexVelezLl

Getting closer! Found a couple of things that can still be improved!

AlexVelezLl · 2025-12-01T21:11:37Z

...Panels/SubmitToCommunityLibrarySidePanel/__tests__/SubmitToCommunityLibrarySidePanel.spec.js

+  useLicenseAudit.mockReturnValue({
+    isLoading: ref(false),
+    isFinished: ref(true),
+    invalidLicenses: ref([]),
+    specialPermissions: ref([]),
+    includedLicenses: ref([]),
+    checkAndTriggerAudit: jest.fn(),
+  });


Now that we have the mock in the __mocks__ folder, we can safely remove these mockReturnValue!

...bmitToCommunityLibrarySidePanel/composables/__mocks__/useLatestCommunityLibrarySubmission.js

...onents/sidePanels/SubmitToCommunityLibrarySidePanel/composables/__mocks__/useLicenseAudit.js

...nents/sidePanels/SubmitToCommunityLibrarySidePanel/composables/__mocks__/usePublishedData.js

AlexVelezLl · 2025-12-01T21:23:33Z

...lEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/composables/useLicenseNames.js

+
+      return constantStrings.$tr(licenseName);
+    })
+    .filter(name => name !== null && name !== undefined && name !== '')


Here we can also do just .filter(Boolean) and would have the same desired effect!

Fixed, Thanks!

AlexVelezLl · 2025-12-01T22:02:46Z

...annelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/SpecialPermissionsList.vue

+
+  <div data-test="special-permissions-list">
+    <div class="header-section">
+      <div class="title">


It seems that there is a title class in vuetify that is affecting this node. Could you please rename this class to prevent the conflict? thanks!

Thanks Alex. For const ITEMS_PER_PAGE = 5, You suggested changing to 3. But the figma shows it should be 5.

Hey @taoerman! That five refers to the number of pages 😅, but the specs only show 3 per page.

AlexVelezLl · 2025-12-01T22:03:28Z

...ponents/sidePanels/SubmitToCommunityLibrarySidePanel/licenseCheck/SpecialPermissionsList.vue

+    font-weight: bold;
+  }
+
+  .description {


To match the figma specs, we should have the color of this class set to gray.v_700.

Fixed it, Thanks!

AlexVelezLl · 2025-12-01T22:07:44Z

...annelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/SpecialPermissionsList.vue

+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    padding-top: 8px;


Lets remove this padding-top and only use the marging-top to match the figma specs!

Fixed it, Thanks!

AlexVelezLl · 2025-12-01T22:11:11Z

...ation/frontend/channelEdit/components/sidePanels/SubmitToCommunityLibrarySidePanel/index.vue

One last change here: I know this isn't in the scope of this PR, but could you please hide the languages and/or categories rendering if we don't have any? It'd be better to not render them instead of rendering the optional text character:

Relatedly, could we make the separation between these two rows (if both are present) 4px instead of 16px? thanks!

Good idea, fixed!

AlexVelezLl · 2025-12-01T22:18:15Z

...nents/sidePanels/SubmitToCommunityLibrarySidePanel/licenseCheck/CompatibleLicensesNotice.vue

Since this folder is starting to get too bloated, could we include these three new components inside a "licenseCheck" (in camel case) folder?

Good idea, Thanks!

…l-permissions-checks merge# the commit.

AlexVelezLl

This looks really excellent, thanks a lot @taoerman for this incredible PR!! 💯 💯 One step closer! Merging!! 🎉

AlexVelezLl reviewed Nov 20, 2025

View reviewed changes

AlexVelezLl reviewed Nov 21, 2025

View reviewed changes

AlexVelezLl mentioned this pull request Nov 25, 2025

Compute license audit task results during publish workflow #5568

Closed

AlexVelezLl requested changes Nov 29, 2025

View reviewed changes

taoerman and others added 6 commits November 30, 2025 19:46

Show license audit and special permissions checks in the Submit to Co…

7f440fc

…mmunity Library Side Panel merge#

[pre-commit.ci lite] apply automatic fixes

e2601ef

fix linting

6dfe37b

fix bug

ce62b6f

[pre-commit.ci lite] apply automatic fixes

0a77563

fix linting

c4f5167

merge#

taoerman force-pushed the issue-5449-Show-license-audit-and-special-permissions-checks branch from 8356d59 to c4f5167 Compare December 1, 2025 03:52

[pre-commit.ci lite] apply automatic fixes

93cc4ad

AlexVelezLl added this to the Studio: Easy Sharing of Community Channels milestone Dec 1, 2025

AlexVelezLl self-assigned this Dec 1, 2025

taoerman and others added 5 commits December 1, 2025 09:38

fix code

c44d667

fix conflict

0de5ef7

[pre-commit.ci lite] apply automatic fixes

2aafe21

fix linting

3345082

[pre-commit.ci lite] apply automatic fixes

778b79c

AlexVelezLl requested changes Dec 1, 2025

View reviewed changes

taoerman added 3 commits December 2, 2025 10:46

Merge branch 'unstable' into issue-5449-Show-license-audit-and-specia…

414a918

…l-permissions-checks merge# the commit.

fix code

5d929ea

fix code

0f726f6

AlexVelezLl approved these changes Dec 3, 2025

View reviewed changes

AlexVelezLl merged commit 47b5fd7 into learningequality:unstable Dec 3, 2025
13 checks passed

		from contentcuration.viewsets.base import ReadOnlyValuesViewset


		class UUIDInFilter(BaseInFilter, UUIDFilter):

Conversation

taoerman commented Nov 19, 2025

Summary

References

Reviewer guidance

Uh oh!

AlexVelezLl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexVelezLl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

AlexVelezLl left a comment •

edited

Loading