Merge pull request #5716 from AlexVelezLl/new-channel-details

Add submission details page

Author: rtibbles

contentcuration/contentcuration/frontend/administration/components/sidePanels/ReviewSubmissionSidePanel.vue

@@ -1,6 +1,7 @@
 <template>
 
   <SidePanelModal
+    v-if="isModalVisible"
     alignment="right"
     sidePanelWidth="700px"
     @closePanel="$emit('close')"
@@ -20,7 +21,15 @@
           class="submission-info-text"
         >
           <span class="author-name">{{ authorName }}</span>
-          <div class="editor-chip">Editor</div>
+          <div
+            class="editor-chip"
+            :style="{
+              color: chipTextColor,
+              backgroundColor: chipColor,
+            }"
+          >
+            Editor
+          </div>
           <span>
             submitted
             <ActionLink
@@ -39,7 +48,10 @@
         <div v-else>Error loading submission data.</div>
 
         <div class="details">
-          <span class="detail-annotation">Country(s)</span>
+          <span
+            class="detail-annotation"
+            :style="{ color: annotationColor }"
+          >Country(s)</span>
           <span
             v-if="countriesString"
             data-test="countries"
@@ -49,7 +61,10 @@
           <template v-else>
             <KEmptyPlaceholder />
           </template>
-          <span class="detail-annotation">Language(s)</span>
+          <span
+            class="detail-annotation"
+            :style="{ color: annotationColor }"
+          >Language(s)</span>
           <span
             v-if="languagesString"
             data-test="languages"
@@ -59,7 +74,10 @@
           <template v-else>
             <KEmptyPlaceholder />
           </template>
-          <span class="detail-annotation">Categories</span>
+          <span
+            class="detail-annotation"
+            :style="{ color: annotationColor }"
+          >Categories</span>
           <span
             v-if="categoriesString"
             data-test="categories"
@@ -69,7 +87,10 @@
           <template v-else>
             <KEmptyPlaceholder />
           </template>
-          <span class="detail-annotation">License(s)</span>
+          <span
+            class="detail-annotation"
+            :style="{ color: annotationColor }"
+          >License(s)</span>
           <span
             v-if="licensesString"
             data-test="licenses"
@@ -79,7 +100,10 @@
           <template v-else>
             <KEmptyPlaceholder />
           </template>
-          <span class="detail-annotation">Status</span>
+          <span
+            class="detail-annotation"
+            :style="{ color: annotationColor }"
+          >Status</span>
           <div
             v-if="submissionIsFinished"
             style="display: flex"
@@ -91,8 +115,16 @@
           </template>
         </div>
 
-        <div class="box">
-          <h3 class="box-title">Submission notes</h3>
+        <div
+          class="box"
+          :style="{ backgroundColor: boxBackgroundColor }"
+        >
+          <h3
+            class="box-title"
+            :style="{ color: boxTitleColor }"
+          >
+            Submission notes
+          </h3>
           <span
             v-if="submissionNotes"
             data-test="submission-notes"
@@ -239,6 +271,7 @@
       CommunityLibraryStatusChip,
     },
     setup(props, { emit }) {
+      const isModalVisible = ref(true);
       const tokensTheme = themeTokens();
       const paletteTheme = themePalette();
 
@@ -476,6 +509,8 @@
 
             showSnackbar({ text: snackbarText });
             updateStatusInStore(statusChoice.value);
+            emit('change');
+            emit('close');
           } catch (error) {
             showSnackbar({ text: 'Changing channel status failed' });
           } finally {
@@ -489,13 +524,19 @@
           actionText: 'Cancel',
           actionCallback: () => {
             clearTimeout(timer);
+            // Do not emit close just yet, so that the component isn't unmounted
+            // this will keep the component live until the submit function finishes, allowing
+            // to keep communicating with the parent component, and in particular allowing the
+            // "change" event to be emitted. It also allows us to keep the working information
+            // on the component, and show the side panel in the same state if the user cancels
+            isModalVisible.value = true;
+            currentlySubmitting.value = false;
             showSnackbar({
               text: 'Action cancelled',
             });
           },
         });
-
-        emit('close');
+        isModalVisible.value = false;
       }
 
       const chipColor = computed(() => paletteTheme.grey.v_200);
@@ -519,6 +560,7 @@
 
       return {
         isLoading,
+        isModalVisible,
         chipColor,
         chipTextColor,
         annotationColor,
@@ -596,8 +638,6 @@
     height: 20px;
     padding: 2px 5px;
     font-size: 10px;
-    color: v-bind('chipTextColor');
-    background-color: v-bind('chipColor');
     border-radius: 16px;
   }
 
@@ -612,15 +652,13 @@
 
   .detail-annotation {
     grid-column-start: 1;
-    color: v-bind('annotationColor');
   }
 
   .box {
     display: flex;
     flex-direction: column;
     gap: 8px;
     padding: 12px;
-    background-color: v-bind('boxBackgroundColor');
     border-radius: 8px;
   }
 
@@ -634,7 +672,6 @@
   .box-title {
     font-size: 12px;
     font-weight: 600;
-    color: v-bind('boxTitleColor');
   }
 
   .details-box-title {

contentcuration/contentcuration/frontend/administration/components/sidePanels/__tests__/ReviewSubmissionSidePanel.spec.js

@@ -344,15 +344,6 @@ describe('ReviewSubmissionSidePanel', () => {
       jest.useRealTimers();
     });
 
-    it('the panel closes', async () => {
-      jest.useFakeTimers();
-
-      const confirmButton = wrapper.findComponent({ ref: 'confirmButtonRef' });
-      await confirmButton.trigger('click');
-
-      expect(wrapper.emitted('close')).toBeTruthy();
-    });
-
     it('a submission snackbar is shown', async () => {
       jest.useFakeTimers();
       const confirmButton = wrapper.findComponent({ ref: 'confirmButtonRef' });
@@ -403,6 +394,22 @@ describe('ReviewSubmissionSidePanel', () => {
           store.replaceState(origStoreState);
         });
 
+        it('the panel closes', async () => {
+          const origStoreState = store.state;
+          store.commit('channel/ADD_CHANNEL', channel);
+
+          jest.useFakeTimers();
+          const confirmButton = wrapper.findComponent({ ref: 'confirmButtonRef' });
+          await confirmButton.trigger('click');
+
+          jest.runAllTimers();
+          await wrapper.vm.$nextTick();
+
+          store.replaceState(origStoreState);
+
+          expect(wrapper.emitted('close')).toBeTruthy();
+        });
+
         it('the channel latest submission status is updated in the store', async () => {
           const origStoreState = store.state;
           store.commit('channel/ADD_CHANNEL', channel);

contentcuration/contentcuration/frontend/administration/constants.js

@@ -3,6 +3,7 @@ export const RouteNames = {
   CHANNEL: 'CHANNEL',
   USERS: 'USERS',
   USER: 'USER',
+  COMMUNITY_LIBRARY_SUBMISSION: 'COMMUNITY_LIBRARY_SUBMISSION',
 };
 
 export const rowsPerPageItems = [25, 50, 75, 100];

contentcuration/contentcuration/frontend/administration/pages/Channels/ChannelActionsDropdown.vue

@@ -22,16 +22,13 @@
 
     <BaseMenu>
       <template #activator="{ on }">
-        <VBtn
-          v-bind="$attrs"
+        <KButton
+          hasDropdown
+          :primary="primary"
           v-on="on"
         >
           Actions
-          <Icon
-            icon="dropdown"
-            class="ml-1"
-          />
-        </VBtn>
+        </KButton>
       </template>
       <VList>
         <template v-if="channel.deleted">
@@ -115,6 +112,10 @@
         type: String,
         required: true,
       },
+      primary: {
+        type: Boolean,
+        default: false,
+      },
     },
     data: () => ({
       activeDialog: null,

contentcuration/contentcuration/frontend/administration/pages/Channels/ChannelItem.vue

@@ -201,7 +201,7 @@
       <CommunityLibraryStatusButton
         v-if="communityLibraryStatus"
         :status="communityLibraryStatus"
-        @click="submissionToReview = channel.latest_community_library_submission_id"
+        @click="onCommunityLibraryButtonClick"
       />
       <KEmptyPlaceholder v-else />
     </td>
@@ -211,12 +211,6 @@
         flat
       />
     </td>
-    <ReviewSubmissionSidePanel
-      v-if="submissionToReview"
-      :channel="channel"
-      :submissionId="submissionToReview"
-      @close="submissionToReview = null"
-    />
   </tr>
 
 </template>
@@ -226,7 +220,6 @@
 
   import { mapGetters, mapActions } from 'vuex';
   import ClipboardChip from '../../components/ClipboardChip';
-  import ReviewSubmissionSidePanel from '../../components/sidePanels/ReviewSubmissionSidePanel';
   import CommunityLibraryStatusButton from '../../components/CommunityLibraryStatusButton.vue';
   import { RouteNames } from '../../constants';
   import ChannelActionsDropdown from './ChannelActionsDropdown';
@@ -241,7 +234,6 @@
       ClipboardChip,
       Checkbox,
       CommunityLibraryStatusButton,
-      ReviewSubmissionSidePanel,
     },
     mixins: [fileSizeMixin],
     props: {
@@ -254,11 +246,6 @@
         required: true,
       },
     },
-    data() {
-      return {
-        submissionToReview: null,
-      };
-    },
     computed: {
       ...mapGetters('channel', ['getChannel']),
       selected: {
@@ -320,6 +307,15 @@
           this.$store.dispatch('showSnackbarSimple', 'Source URL saved');
         });
       },
+      onCommunityLibraryButtonClick() {
+        this.$router.push({
+          name: RouteNames.COMMUNITY_LIBRARY_SUBMISSION,
+          params: {
+            channelId: this.channelId,
+            submissionId: this.channel.latest_community_library_submission_id.toString(),
+          },
+        });
+      },
     },
   };
 

contentcuration/contentcuration/frontend/administration/pages/Channels/__tests__/channelItem.spec.js

@@ -1,6 +1,5 @@
 import { mount } from '@vue/test-utils';
 import CommunityLibraryStatusButton from '../../../components/CommunityLibraryStatusButton.vue';
-import ReviewSubmissionSidePanel from '../../../components/sidePanels/ReviewSubmissionSidePanel';
 import router from '../../../router';
 import { factory } from '../../../store';
 import { RouteNames } from '../../../constants';
@@ -185,10 +184,11 @@ describe('channelItem', () => {
     const statusCell = wrapper.find('[data-test="community-library-status"]');
     const statusButton = statusCell.findComponent(CommunityLibraryStatusButton);
 
-    expect(wrapper.findComponent(ReviewSubmissionSidePanel).exists()).toBe(false);
-
     await statusButton.trigger('click');
+    await wrapper.vm.$nextTick();
 
-    expect(wrapper.findComponent(ReviewSubmissionSidePanel).exists()).toBe(true);
+    // assert that page is redirected to PageNames.COMMUNITY_LIBRARY_SUBMISSION
+    expect(wrapper.vm.$route.name).toEqual(RouteNames.COMMUNITY_LIBRARY_SUBMISSION);
+    expect(wrapper.vm.$route.params.submissionId).toEqual(submissionId);
   });
 });

contentcuration/contentcuration/frontend/administration/router.js

@@ -4,6 +4,7 @@ import ChannelTable from './pages/Channels/ChannelTable';
 import ChannelDetails from './pages/Channels/ChannelDetails';
 import UserTable from './pages/Users/UserTable';
 import UserDetails from './pages/Users/UserDetails';
+import SubmissionDetailsModal from 'shared/views/communityLibrary/SubmissionDetailsModal/index.vue';
 
 const router = new VueRouter({
   routes: [
@@ -29,6 +30,16 @@ const router = new VueRouter({
       props: true,
       component: UserDetails,
     },
+    {
+      name: RouteNames.COMMUNITY_LIBRARY_SUBMISSION,
+      path: '/community-library/:channelId/:submissionId',
+      component: SubmissionDetailsModal,
+      props: route => ({
+        channelId: route.params.channelId,
+        submissionId: route.params.submissionId,
+        adminReview: true,
+      }),
+    },
     // Catch-all redirect to channels tab
     {
       path: '*',

contentcuration/contentcuration/frontend/channelList/constants.js

@@ -26,6 +26,7 @@ export const RouteNames = {
   CATALOG_DETAILS: 'CATALOG_DETAILS',
   CATALOG_FAQ: 'CATALOG_FAQ',
   NEW_CHANNEL: 'NEW_CHANNEL',
+  COMMUNITY_LIBRARY_SUBMISSION: 'COMMUNITY_LIBRARY_SUBMISSION',
 };
 
 export const ListTypeToRouteMapping = {