Merge branch 'GH-39126' into 'master'

Replace Vue key=index in licenses list table

See merge request gitlab-org/gitlab!21566

ee/app/assets/javascripts/project_licenses/components/licenses_table.vue

@@ -32,8 +32,8 @@ export default {
   <div>
     <div class="gl-responsive-table-row table-row-header text-2 bg-secondary-50 px-2" role="row">
       <div
-        v-for="(header, index) in tableHeaders"
-        :key="index"
+        v-for="header in tableHeaders"
+        :key="header.label"
         class="table-section"
         :class="header.className"
         role="rowheader"
@@ -43,8 +43,8 @@ export default {
     </div>
 
     <licenses-table-row
-      v-for="(license, index) in licenses"
-      :key="index"
+      v-for="license in licenses"
+      :key="license.key"
       :license="license"
       :is-loading="isLoading"
     />

ee/app/assets/javascripts/project_licenses/store/modules/list/mutations.js

 import * as types from './mutation_types';
+import { toLicenseObject } from '../../../utils/mappers';
 
 export default {
   [types.SET_LICENSES_ENDPOINT](state, payload) {
@@ -9,7 +10,7 @@ export default {
     state.errorLoading = false;
   },
   [types.RECEIVE_LICENSES_SUCCESS](state, { licenses, reportInfo, pageInfo }) {
-    state.licenses = licenses;
+    state.licenses = licenses.map(toLicenseObject);
     state.pageInfo = pageInfo;
     state.isLoading = false;
     state.errorLoading = false;

ee/app/assets/javascripts/project_licenses/utils/mappers.js

+import _ from 'underscore';
+
+export const getLicenseKey = ({ id }) => {
+  if (id) {
+    return `id_${id}`;
+  }
+
+  return `client_${_.uniqueId()}`;
+};
+
+/**
+ * Maps an individual license response entity into the license object we'll store in our Vuex state
+ * @param {Object} license
+ */
+export const toLicenseObject = license => ({
+  ...license,
+  key: getLicenseKey(license),
+});

ee/changelogs/unreleased/GH-39126.yml

+---
+title: Generate appropriate Vue key for licenses list table
+merge_request: 21566
+author: allenlai18
+type: other

ee/spec/frontend/project_licenses/components/paginated_licenses_table_spec.js

 import { createLocalVue, shallowMount } from '@vue/test-utils';
 import createStore from 'ee/project_licenses/store';
 import LicensesTable from 'ee/project_licenses/components/licenses_table.vue';
+import { toLicenseObject } from 'ee/project_licenses/utils/mappers';
 import { LICENSE_LIST } from 'ee/project_licenses/store/constants';
 import PaginatedLicensesTable from 'ee/project_licenses/components/paginated_licenses_table.vue';
 import Pagination from '~/vue_shared/components/pagination_links.vue';
 import mockLicensesResponse from '../store/modules/list/data/mock_licenses';
 
+jest.mock('underscore', () => ({
+  uniqueId: () => 'fakeUniqueId',
+}));
+
 describe('PaginatedLicensesTable component', () => {
   const localVue = createLocalVue();
   const namespace = LICENSE_LIST;
@@ -48,7 +53,7 @@ describe('PaginatedLicensesTable component', () => {
 
   it('passes the correct props to the licenses table', () => {
     expectComponentWithProps(LicensesTable, {
-      licenses: mockLicensesResponse.licenses,
+      licenses: mockLicensesResponse.licenses.map(toLicenseObject),
       isLoading: store.state[namespace].isLoading,
     });
   });

ee/spec/frontend/project_licenses/store/modules/list/mutations_spec.js

 import * as types from 'ee/project_licenses/store/modules/list/mutation_types';
 import mutations from 'ee/project_licenses/store/modules/list/mutations';
+import { toLicenseObject } from 'ee/project_licenses/utils/mappers';
 import getInitialState from 'ee/project_licenses/store/modules/list/state';
 import { REPORT_STATUS } from 'ee/project_licenses/store/modules/list/constants';
 import { TEST_HOST } from 'helpers/test_constants';
@@ -31,7 +32,7 @@ describe('Licenses mutations', () => {
   });
 
   describe(types.RECEIVE_LICENSES_SUCCESS, () => {
-    const licenses = [];
+    const licenses = [{ id: 1 }, { id: 2 }];
     const pageInfo = {};
     const reportInfo = {
       status: REPORT_STATUS.jobFailed,
@@ -45,7 +46,7 @@ describe('Licenses mutations', () => {
     it('correctly mutates the state', () => {
       expect(state.isLoading).toBe(false);
       expect(state.errorLoading).toBe(false);
-      expect(state.licenses).toBe(licenses);
+      expect(state.licenses).toEqual(licenses.map(toLicenseObject));
       expect(state.pageInfo).toBe(pageInfo);
       expect(state.initialized).toBe(true);
       expect(state.reportInfo).toEqual({

ee/spec/frontend/project_licenses/utils/mappers_spec.js

+import { toLicenseObject } from 'ee/project_licenses/utils/mappers';
+
+const UNIQUE_ID = 'fakeUniqueId';
+jest.mock('underscore', () => ({
+  uniqueId: () => 'fakeUniqueId',
+}));
+
+describe('ee/project_licenses/utils/mappers', () => {
+  describe('toLicenseObject', () => {
+    describe.each`
+      input                         | key
+      ${{ id: 1, name: 'TEST' }}    | ${'id_1'}
+      ${{ id: 2001, name: 'TEST' }} | ${'id_2001'}
+      ${{ name: 'TEST' }}           | ${`client_${UNIQUE_ID}`}
+    `('with object $input', ({ input, key }) => {
+      it(`sets the key to ${key}`, () => {
+        const result = toLicenseObject(input);
+
+        expect(result).toEqual({
+          ...input,
+          key,
+        });
+      });
+    });
+  });
+});