Feat coverage profiles (#2217)

* add coverage profiles resource

STT-144

* add profile field to coverage schema

* validation

* WIP - coverage profiles UI

* Handle old profile, coverage profile id

* Fix types

* Fix unit test

* fix failing behave tests

* Small changes

* Rework field validation, remove unused embeddedProfile

* Cleanup

* fix failing tests due to mongo indexes

* fix failing tests due to mongo indexes

* fix client tests

* release 2.9.0rc1

* fix spelling

* use less width for buttons

* add behave to server requirements

* fix e2e client compile

* update e2e client core

---------

Co-authored-by: Petr Jasek <jasekpetr@gmail.com>
Co-authored-by: Tomas Kikutis <t.kikutis@gmail.com>

client/actions/coverages.ts

@@ -0,0 +1,9 @@
+import {ICoverageContentProfile} from '../interfaces';
+import {COVERAGES} from '../constants';
+
+export function updateCoverageProfiles(profiles: Array<ICoverageContentProfile>) {
+    return {
+        type: COVERAGES.UPDATE_PROFILES,
+        payload: profiles,
+    };
+}

client/api/contentProfiles.ts

@@ -7,6 +7,7 @@ import {
     IPlanningCoverageItem,
     IProfileMultilingualDetails,
     IProfileSchemaTypeString,
+    ICoverageContentProfile,
 } from '../interfaces';
 import {planningApi, superdeskApi} from '../superdeskApi';
 
@@ -18,9 +19,10 @@ import {sortProfileGroups} from '../utils/contentProfiles';
 import {showModalConnectedToStore} from '../utils/ui';
 import {ContentProfileModal} from '../components/ContentProfiles/ContentProfileModal';
 import {getUsersDefaultLanguage} from '../utils/users';
-import {PLANNING_ITEM_SYSTEM_REQUIRED_FIELDS} from './utils/constants';
+import {EVENT_ITEM_SYSTEM_REQUIRED_FIELDS, PLANNING_ITEM_SYSTEM_REQUIRED_FIELDS} from './utils/constants';
 
 const RESOURCE = 'planning_types';
+const COVERAGE_PROFILES_RESOURCE = 'coverage_profiles';
 
 function getAll(): Promise<Array<IPlanningContentProfile>> {
     return superdeskApi.dataApi.query<IPlanningContentProfile>(
@@ -139,6 +141,35 @@ function patch(original: IPlanningContentProfile, updates: IPlanningContentProfi
     }
 }
 
+function patchCoverageProfile(
+    original: ICoverageContentProfile,
+    updates: ICoverageContentProfile,
+): Promise<ICoverageContentProfile> {
+    delete updates._created;
+    delete updates._updated;
+    delete updates._etag;
+    delete updates._links;
+
+    if (updates._id != null) {
+        return superdeskApi.dataApi.patch<ICoverageContentProfile>(COVERAGE_PROFILES_RESOURCE, original, updates);
+    }
+
+    return superdeskApi.dataApi.create<ICoverageContentProfile>(COVERAGE_PROFILES_RESOURCE, updates);
+}
+
+function getAllCoverageProfiles(): Promise<Array<ICoverageContentProfile>> {
+    return superdeskApi.dataApi.query<ICoverageContentProfile>(
+        COVERAGE_PROFILES_RESOURCE,
+        1,
+        {field: 'name', direction: 'ascending'},
+        {},
+        200
+    )
+        .then((response) => {
+            return response._items;
+        });
+}
+
 function showManagePlanningProfileModal(): Promise<void> {
     const {gettext} = superdeskApi.localization;
 
@@ -162,25 +193,6 @@ function showManagePlanningProfileModal(): Promise<void> {
                     'associated_event',
                 ],
             },
-            embeddedProfile: {
-                label: gettext('Coverage Fields'),
-                profile: getProfile('coverage'),
-                systemRequiredFields: [
-                    ['g2_content_type'],
-                    ['scheduled'],
-                    ['add_coverage_to_workflow']
-                ],
-                disableMinMaxFields: [
-                    'g2_content_type',
-                    'language',
-                    'genre',
-                    'news_coverage_status',
-                    'no_content_linking',
-                ],
-                disableRequiredFields: [
-                    'no_content_linking',
-                ],
-            },
         }
     );
 }
@@ -195,10 +207,7 @@ function showManageEventProfileModal(): Promise<void> {
             mainProfile: {
                 label: gettext('Event Fields'),
                 profile: getProfile('event'),
-                systemRequiredFields: [
-                    ['dates'],
-                    ['slugline', 'name'],
-                ],
+                systemRequiredFields: EVENT_ITEM_SYSTEM_REQUIRED_FIELDS,
                 disableMinMaxFields: [
                     'language',
                     'location',
@@ -243,6 +252,10 @@ export const contentProfiles: IPlanningAPI['contentProfiles'] = {
     get: getProfile,
     getDefaultValues: getDefaultValues,
     patch: patch,
+    coverages: {
+        patch: patchCoverageProfile,
+        getAll: getAllCoverageProfiles,
+    },
     showManagePlanningProfileModal: showManagePlanningProfileModal,
     showManageEventProfileModal: showManageEventProfileModal,
     updateProfilesInStore: updateProfilesInStore,

client/api/coverages.ts

@@ -1,11 +1,6 @@
 import {PLANNING, WORKFLOW_STATE} from '../constants';
 import {ICoverageScheduledUpdate, IPlanningAPI, IPlanningCoverageItem} from '../interfaces';
-import {coverageProfile} from '../selectors/forms';
-import {planningApi, superdeskApi} from '../superdeskApi';
-
-function getCoverageEditorProfile() {
-    return coverageProfile(planningApi.redux.store.getState());
-}
+import {superdeskApi} from '../superdeskApi';
 
 function cancelCoverageOrScheduledUpdate<T extends IPlanningCoverageItem | ICoverageScheduledUpdate>(
     item: T,
@@ -67,7 +62,6 @@ function cancelScheduledUpdate(
 }
 
 export const coverages: IPlanningAPI['coverages'] = {
-    getEditorProfile: getCoverageEditorProfile,
     cancelCoverage: cancelCoverage,
     cancelScheduledUpdate: cancelScheduledUpdate,
 };

client/api/editor/item_planning.ts

@@ -1,9 +1,11 @@
 import {createRef, RefObject} from 'react';
-import {cloneDeep} from 'lodash';
+import {cloneDeep, omit} from 'lodash';
 
 import {
     BOOKMARK_TYPE,
     EDITOR_TYPE,
+    ICoverageContentProfile,
+    ICoverageType,
     IEditorAPI,
     IEditorBookmark,
     IEditorFormGroup,
@@ -21,22 +23,29 @@ import {
 
 import {CoveragesBookmark, AddCoverageBookmark} from '../../components/Editor/bookmarks';
 import {AssociatedEventItem} from '../../components/fields/editor/AssociatedEventItem';
+import {coverageProfiles, oldProfile} from '../../selectors/coverageProfiles';
 
-export function getCoverageFields(): ISearchProfile {
-    const fields = getGroupFieldsSorted(planningApi.contentProfiles.get('coverage'))
-        .filter((item) => item.field.enabled);
-    const profile: ISearchProfile = {};
+export function getCoverageFields(
+    type: ICoverageType,
+): {searchProfile: ISearchProfile; profile: ICoverageContentProfile} {
+    const storeState = planningApi.redux.store.getState();
+    const allProfiles = coverageProfiles(storeState);
+    const newProfile = allProfiles.find((x) => x.content_type === type);
+    const profile = newProfile ? newProfile : omit(oldProfile(storeState), '_id');
+
+    const fields = getGroupFieldsSorted(profile).filter((item) => item.field.enabled);
+    const searchProfile: ISearchProfile = {};
 
     fields.forEach(
         (field, index) => {
-            profile[field.name] = {
+            searchProfile[field.name] = {
                 enabled: true,
                 index: index,
             };
         },
     );
 
-    return profile;
+    return {searchProfile, profile};
 }
 
 export function getPlanningInstance(type: EDITOR_TYPE): IEditorAPI['item']['planning'] {

client/api/utils/constants.ts

@@ -1,13 +1,3 @@
-import {flatMap} from 'lodash';
-
-export const PLANNING_ITEM_SYSTEM_REQUIRED_FIELDS = [
-    ['planning_date'],
-    ['slugline', 'headline', 'name'],
-    ['coverages'],
-];
-
-export const isSystemRequiredField = (() => {
-    const SYSTEM_REQUIRED_FIELDS_SET = new Set(flatMap(PLANNING_ITEM_SYSTEM_REQUIRED_FIELDS));
-
-    return (fieldId: string) => SYSTEM_REQUIRED_FIELDS_SET.has(fieldId);
-})();
+export const COVERAGE_SYSTEM_REQUIRED_FIELDS = ['g2_content_type', 'scheduled', 'add_coverage_to_workflow'];
+export const PLANNING_ITEM_SYSTEM_REQUIRED_FIELDS = ['planning_date', 'coverages'];
+export const EVENT_ITEM_SYSTEM_REQUIRED_FIELDS = ['dates'];