Merge pull request #154 from CSCfi/CSCTTV-4013-co-publications

CSCTTV-4013 co-publication handling

aspnetcore/src/ApiModels/Publication/Publication.cs

@@ -283,4 +283,14 @@ public class Publication
     /// Modification time
     /// </summary>
     public DateTime? Modified { get; set; }
+
+    /// <summary>
+    /// Combined information of co-publications based on national publication data collection 
+    /// </summary>
+    public string? CoPublicationID { get; set; }
+
+    /// <summary>
+    /// Publication information sent by individual organisations related to co-publications as part of national publication data collection
+    /// </summary>
+    public List<String>? OrgPublicationIDs { get; set; }   
 }

aspnetcore/src/ApiModels/Query/GetPublicationsQueryParameters.cs

@@ -184,4 +184,16 @@ public class GetPublicationsQueryParameters : PaginationQueryParameters
     /// </summary>
     /// <see cref="Publication.Modified"/>
     public string? ModifiedTo { get; set; }
+
+    /// <summary>
+    /// If the selection is true, publication information sent by individual organisations related to co-publications as part of national publication data collection will be returned. Not returned by default.
+    /// </summary>
+    /// <see cref="Publication.ShowOrganisationPartofCoPublication"/>
+    public bool? ShowOrganisationPartofCoPublication { get; set; }
+
+    /// <summary>
+    /// If the selection is true, combined information of co-publications based on national publication data collection will be filtered out. Returned by default.
+    /// </summary>
+    /// <see cref="Publication.HideCoPublications"/>
+    public bool? HideCoPublications { get; set; }
 }

aspnetcore/src/ElasticService/ElasticSearchQueryGenerators/PublicationQueryGenerator.cs

@@ -150,6 +150,20 @@ private static IEnumerable<Func<QueryContainerDescriptor<Publication>, QueryCont
     {
         var filters = new List<Func<QueryContainerDescriptor<Publication>, QueryContainer>>();
 
+        if (parameters.ShowOrganisationPartofCoPublication is null || (bool)parameters.ShowOrganisationPartofCoPublication == false)
+        {
+            filters.Add(t =>
+                t.Term(s => s.Field(f => f.IsOrgPublication)
+                    .Value(false)));
+        }
+
+        if (parameters.HideCoPublications is not null && (bool)parameters.HideCoPublications == true)
+        {
+            filters.Add(t =>
+                t.Term(s => s.Field(f => f.IsCoPublication)
+                    .Value(false)));
+        }
+
         if (parameters.CreatedFrom is not null)
         {
             filters.Add(x => x

aspnetcore/src/ElasticService/SearchParameters/PublicationSearchParameters.cs

@@ -55,4 +55,8 @@ public class PublicationSearchParameters
     public string? ModifiedFrom { get; set; }
 
     public string? ModifiedTo { get; set; }
+
+    public bool? ShowOrganisationPartofCoPublication { get; set; }
+
+    public bool? HideCoPublications { get; set; }
 }

aspnetcore/src/Repositories/Maps/PublicationProfile.cs

@@ -28,6 +28,7 @@ public PublicationProfile()
             .ForMember(dst => dst.ApcPaymentYear, opt =>opt.MapFrom(src => (DateTime?)(src.ApcPaymentYear.HasValue ? new DateTime(src.ApcPaymentYear.Value,1,1,0,0,0,DateTimeKind.Utc) : null)))
             .ForMember(dst => dst.AuthorsText, opt => opt.MapFrom(src => src.AuthorsText))
             .ForMember(dst => dst.DatabaseContributions, opt => opt.MapFrom(src => src.FactContributions))
+            .ForMember(dst => dst.orgPublicationDTOs, opt => opt.MapFrom(src => src.InverseDimPublicationNavigation))
             .ForMember(dst => dst.Format, opt => opt.MapFrom(src => src.PublicationTypeCode2Navigation))
             .ForMember(dst => dst.ParentPublicationType, opt => opt.MapFrom(src => src.ParentPublicationTypeCodeNavigation))
             .ForMember(dst => dst.DatabasePeerReviewed, opt => opt.MapFrom(src => src.PeerReviewed))
@@ -78,7 +79,10 @@ public PublicationProfile()
             .ForMember(dst => dst.Authors, opt => opt.Ignore())  // Handled during in memory operations in the index repository
             .ForMember(dst => dst.PeerReviewed, opt => opt.Ignore())  // Handled during in memory operations in the index repository
             .ForMember(dst => dst.ParentPublication, opt => opt.Ignore())  // Handled during in memory operations in the index repository
-            ;
+            .ForMember(dst => dst.IsOrgPublication, opt => opt.MapFrom(src => src.DimPublicationId != null && src.DimPublicationId > 0)) // Publication is an organization publication, when DimPublicationId references co-publication. This property is used in query filter.
+            .ForMember(dst => dst.IsCoPublication, opt => opt.MapFrom(src => src.InverseDimPublicationNavigation.Count > 0)) // Publication is a co-publication, when InverseDimPublicationNavigation references one or more organization publications. This property is used in query filter.
+            .ForMember(dst => dst.CoPublicationID, opt => opt.MapFrom(src => src.DimPublicationId != null && src.DimPublicationId > 0  ? src.DimPublicationNavigation.PublicationId : null))
+            .ForMember(dst => dst.OrgPublicationIDs, opt => opt.MapFrom(src => src.InverseDimPublicationNavigation.Select(t => t.PublicationId)));
 
         CreateProjection<DimReferencedatum, ReferenceData>()
             .AddTransform<string?>(s => string.IsNullOrWhiteSpace(s) ? null : s)
@@ -133,6 +137,10 @@ public PublicationProfile()
             .ForMember(dst => dst.ArtPublicationRole, opt => opt.MapFrom(src => src.DimReferencedataActorRole))
             .ForMember(dst => dst.ContributionType, opt => opt.MapFrom(src => src.ContributionType));
 
+        CreateProjection<DatabaseContext.Entities.DimPublication, OrgPublicationDTO>()
+            .ForMember(dst => dst.Id, opt => opt.MapFrom(src => src.Id))
+            .ForMember(dst => dst.DatabaseContributions, opt => opt.MapFrom(src => src.FactContributions));
+
         CreateProjection<DimName, Name>()
             .AddTransform<string?>(s => string.IsNullOrWhiteSpace(s) ? null : s)
             .ForMember(dst => dst.NameId, opt => opt.MapFrom(src => src.Id))

aspnetcore/src/Repositories/PublicationIndexRepository.cs

@@ -81,6 +81,14 @@ public override List<object> PerformInMemoryOperations(List<object> entities)
     public override object PerformInMemoryOperation(object entity)
     {
         Publication publication = (Publication)entity;
+
+        if (publication.orgPublicationDTOs != null && publication.orgPublicationDTOs.Count > 0)
+        {
+            foreach (OrgPublicationDTO op in publication.orgPublicationDTOs.AsEnumerable().ToList())
+            {
+                publication.DatabaseContributions.AddRange(op.DatabaseContributions);
+            }
+        }
 
         HandleIssnAndIsbn(publication);
         HandleEmptyCollections(publication);

aspnetcore/src/Service.Models/Publication/OrgPublicationDTO.cs

@@ -0,0 +1,9 @@
+namespace CSC.PublicApi.Service.Models.Publication;
+
+// DTO used when collecting DatabaseContributions from OrgPublications (yhteisjulkaisu/osajulkaisu).
+public class OrgPublicationDTO
+{
+    public string? Id { get; set; }
+
+    public List<FactContribution>? DatabaseContributions { get; set; }
+}

aspnetcore/src/Service.Models/Publication/Publication.cs

@@ -259,6 +259,26 @@ public class Publication
     /// </summary>
     public DateTime? Modified { get; set; }
 
+    /// <summary>
+    /// Onko julkaisu yhteisjulkaisu
+    /// </summary>
+    public bool IsCoPublication { get; set; }
+
+    /// <summary>
+    /// Onko julkaisu osajulkaisu
+    /// </summary>
+    public bool IsOrgPublication { get; set; }
+
+    /// <summary>
+    /// Osajulkaisun yhteisjulkaisu
+    /// </summary>
+    public string? CoPublicationID { get; set; }
+
+    /// <summary>
+    /// Yhteisjulkaisuun liittyvät osajulkaisut
+    /// </summary>
+    public List<String>? OrgPublicationIDs { get; set; }   
+
     [Ignore]
     public string? Isbn1 { get; set; }
 
@@ -274,6 +294,9 @@ public class Publication
     [Ignore]
     public List<FactContribution>? DatabaseContributions { get; set; }
 
+    [Ignore]
+    public List<OrgPublicationDTO>? orgPublicationDTOs { get; set; }
+
     [Ignore]
     public bool? DatabasePeerReviewed { get; set; }
 

aspnetcore/test/Indexer.Tests/Maps/PublicationProfileTest.cs

@@ -39,6 +39,148 @@ public void ProjectTo_DimPublication_ShouldBeMappedToPublication()
         result.Should().BeEquivalentTo(model, options => options);
     }
 
+    [Fact]
+    public void ProjectTo_DimPublication_ShouldBeMappedToPublication_Not_IsOrgPublication_When_DimPublicationId_Null()
+    {
+        // Arrange
+        var entity = GetEntity();
+        entity.DimPublicationId = null;
+        var model = GetModel();
+        model.IsOrgPublication = false;
+
+        // Act
+        var result = Act_Map(entity);
+
+        // Assert
+        result.Should().BeEquivalentTo(model, options => options);
+    }
+
+    [Fact]
+    public void ProjectTo_DimPublication_ShouldBeMappedToPublication_Not_IsOrgPublication_When_DimPublicationId_MinusOne()
+    {
+        // Arrange
+        var entity = GetEntity();
+        entity.DimPublicationId = -1;
+        var model = GetModel();
+        model.IsOrgPublication = false;
+
+        // Act
+        var result = Act_Map(entity);
+
+        // Assert
+        result.Should().BeEquivalentTo(model, options => options);
+    }
+
+/*
+    [Fact]
+    public void ProjectTo_DimPublication_ShouldBeMappedToPublication_IsOrgPublication_IsCoPublication()
+    {
+        // Arrange
+        var entity_coPublication = GetEntity();
+        var entity_orgPublication = GetEntity();
+        // Entity - Yhteisjulkaisu
+        entity_coPublication.PublicationId = "co-publication id";
+        entity_coPublication.Id = 1;
+        entity_coPublication.InverseDimPublicationNavigation.Add(entity_orgPublication);
+        // Entity - Osajulkaisu
+        entity_orgPublication.PublicationId = "org publication id";
+        entity_orgPublication.DimPublicationNavigation = entity_coPublication;
+        entity_orgPublication.DimPublicationId = entity_coPublication.Id;
+        // Model - Yhteisjulkaisu
+        var model_coPublication = GetModel();
+        model_coPublication.Id = "co-publication id";
+        model_coPublication.IsCoPublication = true;
+        model_coPublication.IsOrgPublication = false;
+        model_coPublication.OrgPublicationIDs = new List<string> { "org publication id" };
+        model_coPublication.orgPublicationDTOs = new List<OrgPublicationDTO> {
+            new OrgPublicationDTO {
+                Id = "org publication id",
+                DatabaseContributions = new () {
+                    new CSC.PublicApi.Service.Models.Publication.FactContribution() {
+                        ArtPublicationRole = new () {    
+                            Code = 
+                            "roleCode", 
+                            NameEn = 
+                            "roleNameEn", 
+                            NameFi = 
+                            "roleNameFi", 
+                            NameSv = 
+                            "roleNameSv"
+                        },
+                        ContributionType = "publication_author_organization",
+                        Name = new()
+                        {
+                            FirstNames = 
+                            "personFirstName", 
+                            LastName = 
+                            "personLastName", 
+                            NameId = 23, 
+                            Orcid = 
+                            "pidContent"
+                        },
+                        OrganizationId = 42
+                    },
+                    new CSC.PublicApi.Service.Models.Publication.FactContribution() {
+                        ArtPublicationRole = null, 
+                        ContributionType = 
+                        "publication_organization", 
+                        Name = null, 
+                        OrganizationId = 41
+                    },
+                }
+            }
+        };
+        // Model - Osajulkaisu
+        var model_orgPublication = GetModel();
+        model_orgPublication.Id = "org publication id";
+        model_orgPublication.IsCoPublication = false;
+        model_orgPublication.IsOrgPublication = true;
+        model_orgPublication.CoPublicationID = "co-publication id";
+
+        // Act
+        var resultCoPublication = Act_Map(entity_coPublication);
+        var resultOrgPublication = Act_Map(entity_orgPublication);
+
+        // Assert
+        resultCoPublication.Should().BeEquivalentTo(model_coPublication, options => options);
+        resultOrgPublication.Should().BeEquivalentTo(model_orgPublication, options => options);
+    }
+*/
+/*
+    [Fact]
+    public void ProjectTo_DimPublication_ShouldBeMappedToPublication_MainPublication_Lists_CoPublications()
+    {
+        // Arrange
+        // Yhteisjulkaisu
+        var entity_mainPublication = GetEntity();
+        entity_mainPublication.PublicationId = "yhteisjulkaisu";
+        entity_mainPublication.Id = 1;
+        // Osajulkaisu 1
+        var entity_coPublication1 = GetEntity();
+        entity_coPublication1.PublicationId = "osajulkaisu1";
+        entity_coPublication1.DimPublicationNavigation = entity_mainPublication;
+        entity_coPublication1.DimPublicationId = 1;
+        entity_mainPublication.InverseDimPublicationNavigation.Add(entity_coPublication1);
+        // Osajulkaisu 2
+        var entity_coPublication2 = GetEntity();
+        entity_coPublication2.PublicationId = "osajulkaisu2";
+        entity_coPublication2.DimPublicationNavigation = entity_mainPublication;
+        entity_coPublication2.DimPublicationId = 1;
+        entity_mainPublication.InverseDimPublicationNavigation.Add(entity_coPublication2);
+
+        var model = GetModel();
+        model.Id = "yhteisjulkaisu";
+        model.IsMainPublication = true;
+        model.IsCoPublication = false;
+        model.OrgPublicationIDs = new List<string> { "osajulkaisu1", "osajulkaisu2" };
+
+        // Act
+        var result = Act_Map(entity_mainPublication);
+
+        // Assert
+        result.Should().BeEquivalentTo(model, options => options);
+    }
+*/
     private Publication Act_Map(DimPublication dbEntity)
     {
         var entityQueryable = new List<DimPublication>
@@ -505,8 +647,11 @@ private Publication GetModel()
                 NameSv = "publisherOpenAccessCodeSv",
                 NameEn = "publisherOpenAccessCodeEn"
             },
+            CoPublicationID = null,
+            OrgPublicationIDs = new List<string> {},
             Created = new DateTime(2023, 3, 10, 10, 43, 00),
-            Modified = new DateTime(2023, 3, 10, 10, 44, 00)
+            Modified = new DateTime(2023, 3, 10, 10, 44, 00),
+            orgPublicationDTOs = new()
         };
     }
 }

aspnetcore/test/Interface.Tests/Maps/PublicationProfileTest.cs

@@ -294,6 +294,7 @@ private static object GetServiceModel()
                     NameEn = "artPublicationTypeNameEn"
                 }
             },
+            OrgPublicationIDs = new List<string> {},
             Created = new DateTime(2023, 3, 10, 10, 43, 00),
             Modified = new DateTime(2023, 3, 10, 10, 44, 00)
         };
@@ -495,6 +496,7 @@ private static object GetApiModel()
                     NameEn = "artPublicationTypeNameEn"
                 }
             },
+            OrgPublicationIDs = new(),
             Created = new DateTime(2023, 3, 10, 10, 43, 00),
             Modified = new DateTime(2023, 3, 10, 10, 44, 00)
         };