Move client-core import to SuperdeskAPI

Also: * Fix search language for Belga archive * Use appConfig.planning.event_related_item_search_provider_name instead of hard coded url for search_provider * Remove all fields from related_items that aren't in the db schema * Add search_provider ID to article when adding it to list of articles to add
superdesk · Mar 28, 2024 · 68ae907 · 68ae907
1 parent 8cde1e5
commit 68ae907
Show file tree

Hide file tree

Showing 12 changed files with 296 additions and 227 deletions.
diff --git a/client/components/ContentProfiles/FieldTab/index.tsx b/client/components/ContentProfiles/FieldTab/index.tsx
@@ -36,7 +36,6 @@ interface IState {
 }
 
 export class FieldTab extends React.Component<IProps, IState> {
-    profile: any;
     constructor(props) {
         super(props);
 
@@ -51,13 +50,6 @@ export class FieldTab extends React.Component<IProps, IState> {
         this.updateFieldOrder = this.updateFieldOrder.bind(this);
         this.insertField = this.insertField.bind(this);
         this.removeField = this.removeField.bind(this);
-        this.profile = {
-            ...this.props.profile,
-            editor: {
-                ...this.props.profile.editor,
-                related_items: {enabled: false}
-            }
-        };
     }
 
     openEditor(field: IProfileFieldEntry) {

diff --git a/client/components/fields/editor/EventRelatedArticles/EditorFieldEventRelatedItems.tsx b/client/components/fields/editor/EventRelatedArticles/EditorFieldEventRelatedItems.tsx
@@ -1,14 +1,18 @@
 import * as React from 'react';
+
+import {IArticle} from 'superdesk-api';
+import {IEditorFieldProps, IEventItem, IProfileSchemaTypeList} from 'interfaces';
+import {superdeskApi} from '../../../../superdeskApi';
+
+import {cleanArticlesFields} from './utils';
+
 import {ButtonGroup, Button, Spacer} from 'superdesk-ui-framework/react';
-import '../EventRelatedPlannings/style.scss';
 import {showModal} from '@superdesk/common';
 import {EventsRelatedArticlesModal} from './EventsRelatedArticlesModal';
-import {IArticle} from 'superdesk-api';
-import {cleanArticlesFields} from './utils';
 import {RelatedArticlesListComponent} from './RelatedArticlesListComponent';
-import {IEditorFieldProps, IEventItem, IProfileSchemaTypeList} from 'interfaces';
-import {Row} from 'superdesk-core/scripts/core/ui/components/List';
-import {gettext} from 'superdesk-core/scripts/core/utils';
+import {Row} from '../../../UI/Form';
+
+import '../EventRelatedPlannings/style.scss';
 
 interface IProps extends IEditorFieldProps {
     item: IEventItem;
@@ -41,6 +45,7 @@ export class EditorFieldEventRelatedItems extends React.PureComponent<IProps, IS
 
     render() {
         const disabled = this.props.disabled || this.props.schema?.read_only;
+        const {gettext} = superdeskApi.localization;
 
         return (
             <div className="related-plannings">

diff --git a/client/components/fields/editor/EventRelatedArticles/EventsRelatedArticlesModal.tsx b/client/components/fields/editor/EventRelatedArticles/EventsRelatedArticlesModal.tsx
@@ -1,4 +1,12 @@
 import React from 'react';
+
+import {IArticle, IRestApiResponse, ISuperdeskQuery} from 'superdesk-api';
+import {IPlanningConfig} from '../../../../interfaces';
+import {superdeskApi} from '../../../../superdeskApi';
+import {appConfig as config} from 'appConfig';
+
+import {cleanArticlesFields} from './utils';
+
 import {
     SearchBar,
     Modal,
@@ -17,15 +25,12 @@ import {
     RightPanel,
     SubNav,
 } from 'superdesk-ui-framework/react';
-import {getProjectedFieldsArticle, gettext} from 'superdesk-core/scripts/core/utils';
-import {httpRequestJsonLocal} from 'superdesk-core/scripts/core/helpers/network';
-import {toElasticQuery} from 'superdesk-core/scripts/core/query-formatting';
-import {IArticle, IRestApiResponse, ISuperdeskQuery} from 'superdesk-api';
-import {cleanArticlesFields} from './utils';
 import {RelatedArticlesListComponent} from './RelatedArticlesListComponent';
-import '../../../../components/Archive/ArchivePreview/style.scss';
 import {PreviewArticle} from './PreviewArticle';
-import {getLanguageVocabulary} from 'superdesk-core/scripts/core/helpers/business-logic';
+
+import '../../../../components/Archive/ArchivePreview/style.scss';
+
+const appConfig = config as IPlanningConfig;
 
 interface IProps {
     closeModal: () => void;
@@ -62,27 +67,34 @@ export class EventsRelatedArticlesModal extends React.Component<IProps, IState>
     }
 
     componentDidMount() {
-        httpRequestJsonLocal<IRestApiResponse<any>>({
-            method: 'GET',
-            path: '/search_providers',
-            urlParams: {
-                manage: 1,
-            }
-        }).then((result) => {
-            const repoId = result._items.find((provider) =>
-                provider.source === 'http://wss-01.staging.belga.be:9000/archivenewsobjects')._id;
+        const {httpRequestJsonLocal} = superdeskApi;
+        const {getLanguageVocabulary} = superdeskApi.entities.vocabulary;
+        const searchProviderName = appConfig.planning.event_related_item_search_provider_name;
 
-            this.setState({
-                repo: repoId,
-                languages: [
-                    ...getLanguageVocabulary().items.map(({name, qcode}) => ({label: name, code: qcode})),
-                    {
-                        label: 'All languages',
-                        code: ''
-                    }
-                ]
+        if (searchProviderName != null) {
+            httpRequestJsonLocal<IRestApiResponse<any>>({
+                method: 'GET',
+                path: '/search_providers',
+                urlParams: {
+                    manage: 1,
+                }
+            }).then((result) => {
+                const repoId = result._items.find((provider) => (
+                    provider.search_provider === searchProviderName
+                ))?._id;
+
+                this.setState({
+                    repo: repoId,
+                    languages: [
+                        ...getLanguageVocabulary().items.map(({name, qcode}) => ({label: name, code: qcode})),
+                        {
+                            label: 'All languages',
+                            code: ''
+                        }
+                    ]
+                });
             });
-        });
+        }
     }
 
     componentDidUpdate(_prevProps: Readonly<IProps>, prevState: Readonly<IState>): void {
@@ -99,6 +111,10 @@ export class EventsRelatedArticlesModal extends React.Component<IProps, IState>
 
     render(): React.ReactNode {
         const {closeModal} = this.props;
+        const {gettext} = superdeskApi.localization;
+        const {getProjectedFieldsArticle} = superdeskApi.entities.article;
+        const {httpRequestJsonLocal} = superdeskApi;
+        const {superdeskToElasticQuery} = superdeskApi.helpers;
 
         return (
             <Modal
@@ -172,33 +188,38 @@ export class EventsRelatedArticlesModal extends React.Component<IProps, IState>
                             key={this.state.activeLanguage.code + this.state.searchQuery + this.state.repo}
                             pageSize={20}
                             getItems={(pageNo, pageSize, signal) => {
-                                const query: Partial<ISuperdeskQuery> = {
+                                if (this.state.repo == null) {
+                                    return Promise.resolve({items: [], itemCount: 0});
+                                }
+
+                                const query: ISuperdeskQuery = {
+                                    filter: {},
                                     page: pageNo,
                                     max_results: pageSize,
                                     sort: [{versioncreated: 'desc'}],
                                 };
+                                const urlParams: {[key: string]: any} = {
+                                    aggregations: 0,
+                                    es_highlight: 1,
+                                    repo: this.state.repo,
+                                    projections: JSON.stringify(getProjectedFieldsArticle()),
+                                };
 
                                 if (this.state.activeLanguage.code !== '') {
-                                    query.filter = {$and: [{language: {$eq: this.state.activeLanguage.code}}]};
+                                    query.filter.language = {$eq: this.state.activeLanguage.code};
+                                    urlParams.params = {languages: this.state.activeLanguage.code};
                                 }
 
                                 if (this.state.searchQuery !== '') {
                                     query.fullTextSearch = this.state.searchQuery.toLowerCase();
                                 }
 
-                                if (this.state.repo == null) {
-                                    return Promise.resolve({items: [], itemCount: 0});
-                                }
-
                                 return httpRequestJsonLocal<IRestApiResponse<Partial<IArticle>>>({
                                     method: 'GET',
                                     path: '/search_providers_proxy',
                                     urlParams: {
-                                        aggregations: 0,
-                                        es_highlight: 1,
-                                        repo: this.state.repo,
-                                        projections: JSON.stringify(getProjectedFieldsArticle()),
-                                        ...toElasticQuery(query as ISuperdeskQuery),
+                                        ...urlParams,
+                                        ...superdeskToElasticQuery(query),
                                     },
                                     abortSignal: signal,
                                 })
@@ -246,7 +267,10 @@ export class EventsRelatedArticlesModal extends React.Component<IProps, IState>
                                                         this.setState({
                                                             currentlySelectedArticles: [
                                                                 ...(this.state.currentlySelectedArticles ?? []),
-                                                                article,
+                                                                {
+                                                                    ...article,
+                                                                    search_provider: this.state.repo,
+                                                                },
                                                             ]
                                                         });
                                                     }}

diff --git a/client/components/fields/editor/EventRelatedArticles/PreviewArticle.tsx b/client/components/fields/editor/EventRelatedArticles/PreviewArticle.tsx
@@ -1,14 +1,11 @@
 import React from 'react';
+
 import {IArticle, IVocabulary} from 'superdesk-api';
-import {PreviewFieldType} from 'superdesk-core/scripts/apps/authoring/preview/previewFieldByType';
-import {getCustomFieldVocabularies} from 'superdesk-core/scripts/core/helpers/business-logic';
-import {getLabelNameResolver} from 'superdesk-core/scripts/apps/workspace/helpers/getLabelForFieldId';
-import {appConfig} from 'superdesk-core/scripts/appConfig';
-import {gettext} from 'superdesk-core/scripts/core/utils';
-import {formatDate} from 'superdesk-core/scripts/core/get-superdesk-api-implementation';
-import {getSortedFields, getSortedFieldsFiltered} from 'superdesk-core/scripts/apps/authoring/preview/utils';
-import {fakeEditor} from './utils';
+import {superdeskApi} from '../../../../superdeskApi';
+import {appConfig} from 'appConfig';
+
 import {ContentDivider, Heading} from 'superdesk-ui-framework/react';
+import {fakeEditor} from './utils';
 
 interface IProps {
     item: Partial<IArticle>;
@@ -34,6 +31,9 @@ export class PreviewArticle extends React.PureComponent<IProps, IState> {
     }
 
     componentDidMount(): void {
+        const {getLabelNameResolver} = superdeskApi.entities.article;
+        const {getCustomFieldVocabularies} = superdeskApi.entities.vocabulary;
+
         getLabelNameResolver().then((getLabel: (fieldId: string) => string) => {
             const customFieldVocabularies = getCustomFieldVocabularies();
 
@@ -47,6 +47,10 @@ export class PreviewArticle extends React.PureComponent<IProps, IState> {
     }
 
     render() {
+        const {gettext, formatDate} = superdeskApi.localization;
+        const {PreviewFieldType} = superdeskApi.components.authoring;
+        const {getSortedFields, getSortedFieldsFiltered} = superdeskApi.entities.article;
+
         const {allFields, extractedFields} = getSortedFieldsFiltered(
             'content',
             fakeEditor,

diff --git a/client/components/fields/editor/EventRelatedArticles/RelatedArticlesListComponent.tsx b/client/components/fields/editor/EventRelatedArticles/RelatedArticlesListComponent.tsx
@@ -1,7 +1,8 @@
 import React from 'react';
-import {ReactNode} from 'react';
+
 import {IArticle} from 'superdesk-api';
-import {gettext} from 'superdesk-core/scripts/core/utils';
+import {superdeskApi} from '../../../../superdeskApi';
+
 import {ContentListItem, IconButton, Label, Spacer} from 'superdesk-ui-framework/react';
 
 interface IProps {
@@ -33,7 +34,8 @@ export class RelatedArticlesListComponent extends React.PureComponent<IProps, IS
         };
     }
 
-    render(): ReactNode {
+    render() {
+        const {gettext} = superdeskApi.localization;
         const {
             article,
             editorPreview,

diff --git a/client/components/fields/editor/EventRelatedArticles/utils.ts b/client/components/fields/editor/EventRelatedArticles/utils.ts
@@ -157,40 +157,30 @@ export const fakeEditor: any = {
 };
 
 export function cleanArticlesFields(articles: Array<Partial<IArticle>>) {
-    const fieldsToCleanup: Array<keyof IArticle> = [
-        '_created',
-        '_etag',
-        '_fetchable',
-        '_id',
-        '_links',
-        '_type',
-        '_updated',
-        'authors',
-        'body_html',
-        'creditline',
-        'description_text',
-        'ednote',
-        'extra',
-        'fetch_endpoint',
-        'firstcreated',
-        'ingest_provider',
-        'keywords',
-
-        // needed because proxy preprocessing adds mimetype to
-        // each article, while technically it's not a part of its interface
-        'mimetype' as any,
-        'profile',
-        'renditions',
-        'sign_off',
-        'profile',
-        'subject',
+    const fieldsToKeep: Array<keyof IArticle> = [
+        'guid',
+        'type',
+        'state',
+        'version',
+        'headline',
+        'slugline',
+        'versioncreated',
+        'source',
+        'pubstatus',
+        'language',
+        'word_count',
+        'search_provider',
     ];
 
-    fieldsToCleanup.forEach((field) => {
-        articles.forEach((article) => {
-            delete article[field];
-        });
-    });
+    for (let i = 0; i < articles.length; i++) {
+        let field: keyof IArticle;
+
+        for (field in articles[i]) {
+            if (!fieldsToKeep.includes(field)) {
+                delete articles[i][field];
+            }
+        }
+    }
 
     return articles;
 }

diff --git a/client/components/fields/index.tsx b/client/components/fields/index.tsx
@@ -280,7 +280,6 @@ const PREVIEW_GROUPS: IPreviewGroups = {
             'definition_long',
             'internal_note',
             'ednote',
-            'related_items',
             'registration_details',
             'invitation_details',
             'accreditation_info',

diff --git a/client/components/fields/preview/index.ts b/client/components/fields/preview/index.ts
@@ -198,10 +198,6 @@ const fieldOptions: {[key: string]: IPreviewHocOptions} = {
         getValue: getValueFromCV('news_coverage_status'),
         mapStateToProps: (state) => ({news_coverage_status: selectors.general.newsCoverageStatus(state)}),
     },
-    related_items: {
-        props: () => ({label: superdeskApi.localization.gettext('Related Articles')}),
-        getValue: getPreviewString,
-    },
 };
 
 const multilingualFieldOptions: {[key: string]: IPreviewHocOptions} = {