Handle deletion of a Channel with a related Community Library Submission (#5551)

* Handle deletion of a Channel with a related Community Library Submission

* [pre-commit.ci lite] apply automatic fixes

* fix code

* [pre-commit.ci lite] apply automatic fixes

* fix linting

* fix code

* fix code

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: taoerman

contentcuration/contentcuration/frontend/administration/vuex/channelAdmin/actions.js

@@ -6,10 +6,13 @@ import { Channel } from 'shared/data/resources';
 export function loadChannels({ commit }, params) {
   const extendedParams = {
     ...params,
-    deleted: Boolean(params.deleted) && params.deleted.toString() === 'true',
     page_size: params.page_size || 25,
   };
 
+  if (params.has_community_library_submission === undefined) {
+    extendedParams.deleted = Boolean(params.deleted) && params.deleted.toString() === 'true';
+  }
+
   const paramsSerializer = {
     indexes: null, // Handle arrays by providing the same query param multiple times
   };

contentcuration/contentcuration/frontend/channelEdit/views/TreeView/TreeViewBase.vue

@@ -261,29 +261,14 @@
       @syncing="syncInProgress"
     />
     <QuickEditModal />
-    <MessageDialog
-      v-model="showDeleteModal"
-      :header="$tr('deleteTitle')"
-    >
-      {{ $tr('deletePrompt') }}
-      <template #buttons="{ close }">
-        <VSpacer />
-        <VBtn
-          color="primary"
-          flat
-          @click="close"
-        >
-          {{ $tr('cancel') }}
-        </VBtn>
-        <VBtn
-          color="primary"
-          data-test="delete"
-          @click="handleDelete"
-        >
-          {{ $tr('deleteChannelButton') }}
-        </VBtn>
-      </template>
-    </MessageDialog>
+    <RemoveChannelModal
+      v-if="showDeleteModal && currentChannel"
+      :channel-id="currentChannel.id"
+      :can-edit="canEdit"
+      data-test="delete-modal"
+      @delete="handleDelete"
+      @close="showDeleteModal = false"
+    />
     <VSpeedDial
       v-if="showClipboardSpeedDial"
       v-model="showClipboard"
@@ -359,9 +344,9 @@
   import MainNavigationDrawer from 'shared/views/MainNavigationDrawer';
   import ToolBar from 'shared/views/ToolBar';
   import ChannelTokenModal from 'shared/views/channel/ChannelTokenModal';
+  import RemoveChannelModal from 'shared/views/channel/RemoveChannelModal';
   import OfflineText from 'shared/views/OfflineText';
   import ContentNodeIcon from 'shared/views/ContentNodeIcon';
-  import MessageDialog from 'shared/views/MessageDialog';
   import { RouteNames as ChannelRouteNames } from 'frontend/channelList/constants';
   import { titleMixin } from 'shared/mixins';
   import DraggableRegion from 'shared/views/draggable/DraggableRegion';
@@ -378,12 +363,12 @@
       SubmitToCommunityLibrarySidePanel,
       ProgressModal,
       ChannelTokenModal,
+      RemoveChannelModal,
       SyncResourcesModal,
       Clipboard,
       OfflineText,
       ContentNodeIcon,
       DraggablePlaceholder,
-      MessageDialog,
       SavingIndicator,
       QuickEditModal,
     },
@@ -590,11 +575,6 @@
       inviteCollaborators: 'Invite collaborators',
       shareToken: 'Share token',
 
-      // Delete channel section
-      deleteChannelButton: 'Delete channel',
-      deleteTitle: 'Delete this channel',
-      deletePrompt: 'This channel will be permanently deleted. This cannot be undone.',
-      cancel: 'Cancel',
       channelDeletedSnackbar: 'Channel deleted',
     },
   };

contentcuration/contentcuration/frontend/channelList/views/Channel/ChannelItem.vue

@@ -215,17 +215,14 @@
       </VCardActions>
     </VCard>
     <!-- Delete dialog -->
-    <KModal
+    <RemoveChannelModal
       v-if="deleteDialog"
-      :title="canEdit ? $tr('deleteTitle') : $tr('removeTitle')"
-      :submitText="canEdit ? $tr('deleteChannel') : $tr('removeBtn')"
-      :cancelText="$tr('cancel')"
+      :channel-id="channelId"
+      :can-edit="canEdit"
       data-test="delete-modal"
-      @submit="handleDelete"
-      @cancel="deleteDialog = false"
-    >
-      {{ canEdit ? $tr('deletePrompt') : $tr('removePrompt') }}
-    </KModal>
+      @delete="handleDelete"
+      @close="deleteDialog = false"
+    />
     <!-- Copy dialog -->
     <ChannelTokenModal
       v-if="channel && channel.published"
@@ -244,6 +241,7 @@
   import { RouteNames } from '../../constants';
   import ChannelStar from './ChannelStar';
   import ChannelTokenModal from 'shared/views/channel/ChannelTokenModal';
+  import RemoveChannelModal from 'shared/views/channel/RemoveChannelModal';
   import Thumbnail from 'shared/views/files/Thumbnail';
   import Languages from 'shared/leUtils/Languages';
 
@@ -252,6 +250,7 @@
     components: {
       ChannelStar,
       ChannelTokenModal,
+      RemoveChannelModal,
       Thumbnail,
     },
     props: {
@@ -396,18 +395,11 @@
       goToWebsite: 'Go to source website',
       editChannel: 'Edit channel details',
       copyToken: 'Copy channel token',
-      deleteChannel: 'Delete channel',
-      deleteTitle: 'Delete this channel',
-      removeChannel: 'Remove from channel list',
-      removeBtn: 'Remove',
-      removeTitle: 'Remove from channel list',
-      deletePrompt: 'This channel will be permanently deleted. This cannot be undone.',
-      removePrompt:
-        'You have view-only access to this channel. Confirm that you want to remove it from your list of channels.',
       channelDeletedSnackbar: 'Channel deleted',
       channelRemovedSnackbar: 'Channel removed',
       channelLanguageNotSetIndicator: 'No language set',
-      cancel: 'Cancel',
+      deleteChannel: 'Delete channel',
+      removeChannel: 'Remove channel',
     },
   };
 

contentcuration/contentcuration/frontend/shared/views/channel/RemoveChannelModal.vue

@@ -0,0 +1,108 @@
+<template>
+
+  <KModal
+    :title="canEdit ? $tr('deleteTitle') : $tr('removeTitle')"
+    :submitText="canEdit ? $tr('deleteChannel') : $tr('removeBtn')"
+    :cancelText="$tr('cancel')"
+    :submitDisabled="loading"
+    data-test="remove-channel-modal"
+    @submit="handleSubmit"
+    @cancel="close"
+  >
+    <div
+      v-if="loading"
+      class="py-4 text-center"
+    >
+      <KCircularLoader :size="24" />
+    </div>
+    <template v-else>
+      <div
+        v-if="canEdit && hasCommunityLibrarySubmission"
+        class="mb-3"
+        data-test="cl-warning"
+      >
+        {{ $tr('deleteChannelWithCLWarning') }}
+      </div>
+      {{ canEdit ? $tr('deletePrompt') : $tr('removePrompt') }}
+    </template>
+  </KModal>
+
+</template>
+
+
+<script>
+
+  import { ref, onMounted } from 'vue';
+  import client from 'shared/client';
+  import { Channel } from 'shared/data/resources';
+
+  export default {
+    name: 'RemoveChannelModal',
+    setup(props, { emit }) {
+      const loading = ref(false);
+      const hasCommunityLibrarySubmission = ref(false);
+
+      async function fetchCommunityLibrarySubmissionStatus() {
+        loading.value = true;
+        try {
+          const url = Channel.getUrlFunction('has_community_library_submission')(props.channelId);
+          const response = await client.get(url);
+          hasCommunityLibrarySubmission.value =
+            response.data?.has_community_library_submission ?? false;
+        } catch (error) {
+          hasCommunityLibrarySubmission.value = false;
+        } finally {
+          loading.value = false;
+        }
+      }
+
+      onMounted(() => {
+        if (props.canEdit) {
+          fetchCommunityLibrarySubmissionStatus();
+        }
+      });
+
+      function handleSubmit() {
+        emit('delete');
+      }
+
+      function close() {
+        emit('close');
+      }
+
+      return {
+        loading,
+        hasCommunityLibrarySubmission,
+        handleSubmit,
+        close,
+      };
+    },
+    props: {
+      channelId: {
+        type: String,
+        required: true,
+      },
+      canEdit: {
+        type: Boolean,
+        default: false,
+      },
+    },
+    emits: ['delete', 'close'],
+    $trs: {
+      deleteTitle: 'Delete this channel',
+      removeTitle: 'Remove from channel list',
+      deleteChannel: 'Delete channel',
+      removeBtn: 'Remove',
+      cancel: 'Cancel',
+      deletePrompt: 'This channel will be permanently deleted. This cannot be undone.',
+      removePrompt:
+        'You have view-only access to this channel. Confirm that you want to remove it from your list of channels.',
+      deleteChannelWithCLWarning:
+        'This channel has been shared with the Community Library. Deleting it here will not remove it from the Community Library — it may still be approved or remain available there.',
+    },
+  };
+
+</script>
+
+
+<style lang="scss" scoped></style>

contentcuration/contentcuration/tests/viewsets/test_channel.py

@@ -819,25 +819,43 @@ def test_admin_channel_filter__community_library_live(self):
             [submission1.channel.id],
         )
 
-    def test_admin_channel_filter__has_community_library_submission(self):
-        self.client.force_authenticate(user=self.admin_user)
-
+    def test_has_community_library_submission_endpoint(self):
+        """Test the on-demand has_community_library_submission endpoint"""
+        user = testdata.user()
+        channel_with_submission = testdata.channel()
+        channel_with_submission.editors.add(user)
+        channel_with_submission.version = 1
+        channel_with_submission.save()
         submission = testdata.community_library_submission()
+        submission.channel = channel_with_submission
+        submission.author = user
+        submission.channel_version = channel_with_submission.version
+        submission.save()
+
+        channel_without_submission = testdata.channel()
+        channel_without_submission.editors.add(user)
 
-        testdata.channel()  # Another channel without submission
+        self.client.force_authenticate(user=user)
 
         response = self.client.get(
-            reverse_with_query(
-                "admin-channels-list",
-                query={"has_community_library_submission": True},
+            reverse(
+                "channel-has-community-library-submission",
+                kwargs={"pk": channel_with_submission.id},
             ),
             format="json",
         )
         self.assertEqual(response.status_code, 200, response.content)
-        self.assertCountEqual(
-            [ch["id"] for ch in response.data],
-            [submission.channel.id],
+        self.assertTrue(response.data["has_community_library_submission"])
+
+        response = self.client.get(
+            reverse(
+                "channel-has-community-library-submission",
+                kwargs={"pk": channel_without_submission.id},
+            ),
+            format="json",
         )
+        self.assertEqual(response.status_code, 200, response.content)
+        self.assertFalse(response.data["has_community_library_submission"])
 
     def test_create_channel(self):
         user = testdata.user()

contentcuration/contentcuration/viewsets/channel.py

@@ -900,6 +900,19 @@ def get_published_data(self, request, pk=None) -> Response:
 
         return Response(channel.published_data)
 
+    @action(
+        detail=True,
+        methods=["get"],
+        url_path="has_community_library_submission",
+        url_name="has-community-library-submission",
+    )
+    def has_community_library_submission(self, request, pk=None) -> Response:
+        channel = self.get_object()
+        has_submission = CommunityLibrarySubmission.objects.filter(
+            channel_id=channel.id
+        ).exists()
+        return Response({"has_community_library_submission": has_submission})
+
     def _channel_exists(self, channel_id) -> bool:
         """
         Check if a channel exists.
@@ -1051,6 +1064,7 @@ def annotate_queryset(self, queryset):
 
 
 class AdminChannelFilter(BaseChannelFilter):
+
     latest_community_library_submission_status = CharFilter(
         method="filter_latest_community_library_submission_status"
     )