Merge branch 'release/24.01.0'

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [24.01.0] - 2024-01-05
+### Added
+- Support for Disease and Data Type CollectionProvider metadata
+- data-test-* tags for Preprints Selenium tests
+
 ## [23.15.0] - 2023-11-10
 ### Added
 - Preprint detail and landing page rewrite

app/models/collection-submission.ts

@@ -21,6 +21,8 @@ export const choiceFields = tuple(
     'volume',
     'studyDesign',
     'schoolType',
+    'dataType',
+    'disease',
 );
 
 export enum CollectionSubmissionReviewStates {
@@ -76,9 +78,11 @@ export default class CollectionSubmissionModel extends OsfModel.extend(Validatio
     @attr('string') programArea?: string;
     @attr('string') status?: string;
     @attr('string') volume?: string;
-    @attr('string') reviewsState?: CollectionSubmissionReviewStates;
     @attr('string') studyDesign?: string; // custom field for Character Lab
     @attr('string') schoolType?: string; // custom field for Character Lab
+    @attr('string') dataType?: string;
+    @attr('string') disease?: string;
+    @attr('string') reviewsState?: CollectionSubmissionReviewStates;
 
     @belongsTo('collection') collection!: Collection;
     @belongsTo('node') guid!: Node;

app/models/collection.ts

@@ -14,7 +14,9 @@ export type ChoicesFields =
     'statusChoices' |
     'volumeChoices' |
     'studyDesignChoices' |
-    'schoolTypeChoices';
+    'schoolTypeChoices' |
+    'dataTypeChoices' |
+    'diseaseChoices';
 
 export const choicesFields = choiceFields.map(field => `${field}Choices`) as ChoicesFields[];
 
@@ -32,6 +34,8 @@ export default class CollectionModel extends OsfModel {
     @attr('array') volumeChoices!: string[];
     @attr('array') studyDesignChoices!: string[]; // custom field for Character Lab
     @attr('array') schoolTypeChoices!: string[]; // custom field for Character Lab
+    @attr('array') dataTypeChoices!: string[];
+    @attr('array') diseaseChoices!: string[];
 
     @belongsTo('collection-provider')
     provider!: AsyncBelongsTo<CollectionProviderModel> & CollectionProviderModel;

app/preprints/-components/preprint-discipline/template.hbs

@@ -1,6 +1,8 @@
 <div>
     <h4>{{t 'preprints.detail.disciplines'}}</h4>
-    {{#each this.disciplineReduced as |subject|}}
-        <span local-class='subject-preview'>{{subject.text}}</span>
-    {{/each}}
+    <span data-test-subjects>
+        {{#each this.disciplineReduced as |subject|}}
+            <span local-class='subject-preview'>{{subject.text}}</span>
+        {{/each}}
+    </span>
 </div>

app/preprints/-components/preprint-status-banner/template.hbs

@@ -12,8 +12,8 @@
                 {{else}}
                     <div>
                         <FaIcon @icon='{{this.icon}}' @prefix='far' local-class='status-icon' aria-hidden='true'/>
-                        <strong>{{t this.status }}:</strong>
-                        <span>{{this.bannerContent}}</span>
+                        <strong data-test-status>{{t this.status }}:</strong>
+                        <span data-test-status-explanation>{{this.bannerContent}}</span>
                     </div>
                     {{#if (and this.reviewerComment (not this.submission.provider.reviewsCommentsPrivate))}}
                         <div local-class='reviewer-feedback'>

app/preprints/-components/preprint-tag/template.hbs

@@ -1,9 +1,11 @@
 <div>
     <h4>{{t 'preprints.detail.tags'}}</h4>
     {{#if @preprint.tags.length}}
-        {{#each @preprint.tags as |tag|}}
-            <span local-class='badge'>{{tag}}</span>
-        {{/each}}
+        <span data-test-tags>
+            {{#each @preprint.tags as |tag|}}
+                <span local-class='badge'>{{tag}}</span>
+            {{/each}}
+        </span>
     {{else}}
         {{t 'preprints.detail.none'}}
     {{/if}}

app/preprints/-components/preprint-tombstone/template.hbs

@@ -1,8 +1,8 @@
 <div local-class='withdrawn-container'>
     {{#if @preprint.withdrawalJustification}}
-        <div>
+        <div data-test-withdrawal-justification>
             <h4>{{t 'preprints.detail.reason_for_withdrawal'}}</h4>
-            <p>
+            <p data-test-justification>
                 {{@preprint.withdrawalJustification}}
             </p>
         </div>

app/preprints/detail/template.hbs

@@ -5,10 +5,11 @@
     local-class='preprints-details-page-container {{if this.isMobile 'mobile'}}'
     {{with-branding this.model.brand}}
     data-analytics-scope='preprints detail page'
+    data-test-preprint-header
 >
     <div local-class='header-container'>
         <div local-class='preprint-title-container'>
-            <h1>{{this.model.preprint.title}}</h1>
+            <h1 data-test-preprint-title>{{this.model.preprint.title}}</h1>
             {{#unless this.model.preprint.isWithdrawn}}
                 <div class='edit-preprint-button'>
                     {{#if (and this.userIsContrib (not this.isPendingWithdrawal))}}
@@ -122,7 +123,14 @@
                             </OsfLink>
                         </div>
                         <div>
-                            {{t 'preprints.detail.share.views'}}: {{this.model.preprint.apiMeta.metrics.views}} | {{t 'preprints.detail.share.downloads'}}: {{this.model.preprint.apiMeta.metrics.downloads}}
+                            <span data-test-view-count-label>
+                                {{t 'preprints.detail.share.views'}}: 
+                            </span>
+                            <span data-test-view-count> {{this.model.preprint.apiMeta.metrics.views}} </span> | 
+                            <span data-test-download-count-label>
+                                {{t 'preprints.detail.share.downloads'}}: 
+                            </span>
+                            <span data-test-download-count>{{this.model.preprint.apiMeta.metrics.downloads}}</span>
                             <EmberTooltip>
                                 {{t 'preprints.detail.share.metrics_disclaimer'}} {{moment-format this.metricsStartDate 'YYYY-MM-DD'}}
                             </EmberTooltip>

lib/collections/addon/components/discover-page/active-filters/data-type/template.hbs

@@ -0,0 +1,8 @@
+{{#each @context.activeFilter as |item|}}
+    <DiscoverPage::ActiveFilters::Filter
+        @item={{item}}
+        @text={{item}}
+        @ariaLabel={{t 'collections.discover_page.active_filters.remove_data_type'}}
+        @removeFilterItem={{action this.removeFilterItem item}}
+    />
+{{/each}}

lib/collections/addon/components/discover-page/active-filters/disease/template.hbs

@@ -0,0 +1,8 @@
+{{#each @context.activeFilter as |item|}}
+    <DiscoverPage::ActiveFilters::Filter
+        @item={{item}}
+        @text={{item}}
+        @ariaLabel={{t 'collections.discover_page.active_filters.remove_disease'}}
+        @removeFilterItem={{action this.removeFilterItem item}}
+    />
+{{/each}}

lib/collections/addon/components/discover-page/facets/data-type/component.ts

@@ -0,0 +1,13 @@
+import Collection from 'ember-osf-web/models/collection';
+import SearchFacetChecklist from '../checklist/component';
+
+class DataType extends SearchFacetChecklist {
+    get modelAttribute(): keyof Collection {
+        return 'dataTypeChoices';
+    }
+    get filterProperty() {
+        return 'dataType';
+    }
+}
+
+export default DataType;

lib/collections/addon/components/discover-page/facets/disease/component.ts

@@ -0,0 +1,13 @@
+import Collection from 'ember-osf-web/models/collection';
+import SearchFacetChecklist from '../checklist/component';
+
+class Disease extends SearchFacetChecklist {
+    get modelAttribute(): keyof Collection {
+        return 'diseaseChoices';
+    }
+    get filterProperty() {
+        return 'disease';
+    }
+}
+
+export default Disease;

lib/collections/addon/discover/controller.ts

@@ -73,6 +73,8 @@ export default class Discover extends Controller {
                     ['volume', 'volume'],
                     ['study-design', 'study-design'],
                     ['school-type', 'school-type'],
+                    ['data-type', 'data-type'],
+                    ['disease', 'disease'],
                 ]
         ).map(([key, component, options = {}]: [string, string, any]) => ({
             key,
@@ -105,6 +107,8 @@ export default class Discover extends Controller {
     volume = '';
     studyDesign = '';
     schoolType = '';
+    dataType = '';
+    disease = '';
 
     // Pass in the list of queryParams for this component
     queryParams = [

mirage/factories/collection-submission.ts

@@ -80,6 +80,14 @@ export default Factory.extend<MirageCollectionSubmission>({
             const schoolType = faker.random.arrayElement(collectionSubmission.collection.schoolTypeChoices);
             collectionSubmission.update({ schoolType });
         }
+        if (!collectionSubmission.dataType) {
+            const dataType = faker.random.arrayElement(collectionSubmission.collection.dataTypeChoices);
+            collectionSubmission.update({ dataType });
+        }
+        if (!collectionSubmission.disease) {
+            const disease = faker.random.arrayElement(collectionSubmission.collection.diseaseChoices);
+            collectionSubmission.update({ disease });
+        }
         /**
          * Autogenerate the necessary collection submission action business
          * logic

mirage/factories/collection.ts

@@ -24,6 +24,8 @@ export default Factory.extend<MirageCollection>({
     programAreaChoices: [faker.lorem.word(), faker.lorem.word()],
     studyDesignChoices: [faker.lorem.word(), faker.lorem.word()],
     schoolTypeChoices: [faker.lorem.word(), faker.lorem.word()],
+    dataTypeChoices: [faker.lorem.word(), faker.lorem.word()],
+    diseaseChoices: [faker.lorem.word(), faker.lorem.word()],
 });
 
 declare module 'ember-cli-mirage/types/registries/model' {

mirage/views/collection-search.ts

@@ -19,6 +19,8 @@ export function searchCollections(this: HandlerContext, schema: Schema, request:
                 volume,
                 schoolType,
                 studyDesign,
+                dataType,
+                disease,
                 provider,
             },
         },
@@ -83,6 +85,20 @@ export function searchCollections(this: HandlerContext, schema: Schema, request:
             ),
         );
     }
+    if (dataType) {
+        collectionSubmissions = collectionSubmissions.filter(
+            (item: ModelInstance<CollectionSubmission>) => dataType.any(
+                (value: string) => item.attrs.dataType === value,
+            ),
+        );
+    }
+    if (disease) {
+        collectionSubmissions = collectionSubmissions.filter(
+            (item: ModelInstance<CollectionSubmission>) => disease.any(
+                (value: string) => item.attrs.disease === value,
+            ),
+        );
+    }
     if (request.queryParams.sort) {
         switch (request.queryParams.sort) {
         case 'modified':

mirage/views/collection-submission.ts

@@ -46,6 +46,8 @@ export function createCollectionSubmission(this: HandlerContext, schema: Schema)
         volume,
         schoolType,
         studyDesign,
+        dataType,
+        disease,
     } = attrs;
     const userId = schema.roots.first().currentUserId;
     const currentUser = schema.users.find(userId!);
@@ -61,6 +63,8 @@ export function createCollectionSubmission(this: HandlerContext, schema: Schema)
         volume,
         schoolType,
         studyDesign,
+        dataType,
+        disease,
         guid: guidModel,
         collection: collectionModel,
         creator: currentUser,
@@ -78,6 +82,8 @@ export function createCollectionSubmission(this: HandlerContext, schema: Schema)
         volume,
         schoolType,
         studyDesign,
+        dataType,
+        disease,
     });
 
     schema.collectionSubmissionActions.create({

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-osf-web",
-  "version": "23.15.3",
+  "version": "24.01.0",
   "private": true,
   "description": "Ember front-end for the Open Science Framework",
   "homepage": "https://github.com/CenterForOpenScience/ember-osf-web#readme",

tests/engines/collections/acceptance/submit/submit-test.ts

@@ -185,6 +185,22 @@ module('Collections | Acceptance | submit', hooks => {
             throw new Error('could not find study design option');
         }
 
+        await untrackedClick('[data-test-metadata-field="data_type_label"] .ember-power-select-trigger');
+        const firstDataTypeOption = document.querySelector('.ember-power-select-option');
+        if (firstDataTypeOption) {
+            await untrackedClick(firstDataTypeOption);
+        } else {
+            throw new Error('could not find data type option');
+        }
+
+        await untrackedClick('[data-test-metadata-field="disease_label"] .ember-power-select-trigger');
+        const firstDiseaseOption = document.querySelector('.ember-power-select-option');
+        if (firstDiseaseOption) {
+            await untrackedClick(firstDiseaseOption);
+        } else {
+            throw new Error('could not find disease option');
+        }
+
         assert.dom('[data-test-collection-metadata] [data-test-submit-section-continue]')
             .isNotDisabled('metadata continue is not disabled');
         await untrackedClick('[data-test-collection-metadata] [data-test-submit-section-continue]');
@@ -233,6 +249,8 @@ module('Collections | Acceptance | submit', hooks => {
             programAreaChoices: [],
             studyDesignChoices: [],
             schoolTypeChoices: [],
+            dataTypeChoices: [],
+            diseaseChoices: [],
         });
         const nodeAlreadyAdded = server.create('node', {
             title: 'Node to be added to collection',

translations/en-us.yml

@@ -990,6 +990,8 @@ collections:
             volume: Volume
             study_design: 'Study Design'
             school_type: 'School Type'
+            data_type: 'Data Type'
+            disease: Disease
     collections_submission:
         title: Submit
         add_header: 'Add to Collection'
@@ -1043,6 +1045,8 @@ collections:
         volume_label: 'Volume:'
         study_design_label: 'Study Design:'
         school_type_label: 'School Type:'
+        data_type_label: 'Data Type:'
+        disease_label: 'Disease:'
     collection_search_result:
         expand: 'Expand search result'
         collapse: 'Collapse search result'
@@ -1058,6 +1062,8 @@ collections:
             remove_school_type: 'Remove school type'
             remove_study_design: 'Remove study design'
             remove_volume: 'Remove volume'
+            remove_data_type: 'Remove data type'
+            remove_disease: 'Remove disease'
         asOf: 'as of'
         broadenSearch: 'Try broadening your search terms'
         date: Date