improve: show last added series first on the pages with a collection info, series info and collection estimation

Fix #1621

Author: php-coder

NEWS.txt

@@ -4,6 +4,7 @@
 - (infrastructure) discontinue usage of Danger
 - (infrastructure) discontinue usage of 0pdd
 - (infrastructure) migrate CI from Travis to GitHub Actions
+- (improvement) show last added series first on the pages with a collection info, series info and collection estimation
 
 0.4.6
 - (feature)        users can add a comment to a series

src/main/config/spotbugs-filter.xml

@@ -282,5 +282,16 @@
 		<Class name="ru.mystamps.web.feature.site.SuspiciousActivityDto" />
 		<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
 	</Match>
+	<Match>
+		<!--
+			@todo #1621 AddToCollectionDbDto: port to a new datetime API
+		-->
+		<Class name="ru.mystamps.web.feature.collection.AddToCollectionDbDto" />
+		<Or>
+			<Method name="getAddedAt" />
+			<Method name="setAddedAt" />
+		</Or>
+		<Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2" />
+	</Match>
 
 </FindBugsFilter>

src/main/java/ru/mystamps/web/feature/collection/AddToCollectionDbDto.java

@@ -21,6 +21,7 @@
 import lombok.Setter;
 
 import java.math.BigDecimal;
+import java.util.Date;
 
 @Getter
 @Setter
@@ -30,4 +31,5 @@ public class AddToCollectionDbDto {
 	private Integer numberOfStamps;
 	private BigDecimal price;
 	private String currency;
+	private Date addedAt;
 }

src/main/java/ru/mystamps/web/feature/collection/CollectionServiceImpl.java

@@ -65,6 +65,7 @@ public void createCollection(Integer ownerId, String ownerLogin) {
 		log.info("Collection #{} has been created ({})", id, collection);
 	}
 
+	// @todo #1621 Add 3 integration tests to check that the last added series is shown first
 	@Override
 	@Transactional
 	@PreAuthorize(HasAuthority.UPDATE_COLLECTION)
@@ -74,10 +75,12 @@ public void addToCollection(Integer userId, AddToCollectionDto dto) {
 		Validate.isTrue(dto.getNumberOfStamps() != null, "Number of stamps must be non null");
 		Validate.isTrue(dto.getSeriesId() != null, "Series id must be non null");
 
+		Date now = new Date();
 		AddToCollectionDbDto collectionDto = new AddToCollectionDbDto();
 		collectionDto.setOwnerId(userId);
 		collectionDto.setSeriesId(dto.getSeriesId());
 		collectionDto.setNumberOfStamps(dto.getNumberOfStamps());
+		collectionDto.setAddedAt(now);
 
 		if (dto.getPrice() != null) {
 			Validate.validState(
@@ -89,7 +92,7 @@ public void addToCollection(Integer userId, AddToCollectionDto dto) {
 		}
 
 		Integer seriesInstanceId = collectionDao.addSeriesToUserCollection(collectionDto);
-		collectionDao.markAsModified(userId, new Date());
+		collectionDao.markAsModified(userId, now);
 
 		log.info(
 			"Series #{} ({}) has been added to collection: #{}",

src/main/java/ru/mystamps/web/feature/collection/JdbcCollectionDao.java

@@ -248,6 +248,7 @@ public Integer addSeriesToUserCollection(AddToCollectionDbDto dto) {
 		params.put("number_of_stamps", dto.getNumberOfStamps());
 		params.put("price", dto.getPrice());
 		params.put("currency", dto.getCurrency());
+		params.put("added_at", dto.getAddedAt());
 
 		KeyHolder holder = new GeneratedKeyHolder();
 

src/main/java/ru/mystamps/web/support/spring/jdbc/MapIntegerIntegerResultSetExtractor.java

@@ -24,7 +24,7 @@
 
 import java.sql.ResultSet;
 import java.sql.SQLException;
-import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.Map;
 
 @RequiredArgsConstructor
@@ -38,7 +38,7 @@ public class MapIntegerIntegerResultSetExtractor
 	public Map<Integer, Integer> extractData(ResultSet rs)
 		throws SQLException, DataAccessException {
 
-		Map<Integer, Integer> result = new HashMap<>();
+		Map<Integer, Integer> result = new LinkedHashMap<>();
 
 		while (rs.next()) {
 			Integer key   = JdbcUtils.getInteger(rs, keyFieldName);

src/main/resources/liquibase/version/0.4.7.xml

@@ -8,5 +8,6 @@
 	<include file="0.4.7/2021-07-18--series_import_parsed_image_urls.xml" relativeToChangelogFile="true" />
 	<include file="0.4.7/2021-11-28--series_and_nullable_perforated_field.xml" relativeToChangelogFile="true" />
 	<include file="0.4.7/2022-09-08--re_apply_column_comments.xml" relativeToChangelogFile="true" />
+	<include file="0.4.7/2023-07-27--collection_added_at.xml" relativeToChangelogFile="true" />
 
 </databaseChangeLog>

src/main/resources/liquibase/version/0.4.7/2023-07-27--collection_added_at.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+	xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.3.xsd">
+	
+	<changeSet id="add-added_at-field-to-collections_series" author="php-coder" context="scheme">
+		
+		<addColumn tableName="collections_series">
+			<column name="added_at" type="DATETIME" />
+		</addColumn>
+
+		<!-- Unfortunately, H2 doesn't support UPDATE with JOIN -->
+		<sql>
+			UPDATE collections_series cs
+			SET added_at = (
+				SELECT c.updated_at
+				FROM collections c
+				WHERE c.id = cs.collection_id
+			)
+		</sql>
+		
+		<addNotNullConstraint
+			tableName="collections_series"
+			columnDataType="DATETIME"
+			columnName="added_at" />
+		
+	</changeSet>
+	
+</databaseChangeLog>

src/main/resources/sql/collection_dao_queries.properties

@@ -39,7 +39,9 @@ collection.find_series_by_collection_id = \
        ON cat.id = s.category_id \
 LEFT JOIN countries count \
        ON count.id = s.country_id \
-    WHERE cs.collection_id = :collection_id
+    WHERE cs.collection_id = :collection_id \
+ ORDER BY cs.added_at DESC \
+        , cs.id DESC
 
 collection.find_series_with_prices_by_slug = \
    SELECT s.id \
@@ -57,7 +59,9 @@ collection.find_series_with_prices_by_slug = \
        ON s.id = cs.series_id \
 LEFT JOIN countries count \
        ON count.id = s.country_id \
-    WHERE c.slug = :slug
+    WHERE c.slug = :slug \
+ ORDER BY cs.added_at DESC \
+        , cs.id DESC
 
 collection.find_all_for_sitemap = \
   SELECT c.slug AS id \
@@ -122,12 +126,14 @@ SELECT COUNT(*) \
    AND cs.series_id = :series_id
 
 collection.find_series_instances = \
-SELECT cs.id, cs.number_of_stamps \
-  FROM collections c \
-  JOIN collections_series cs \
-    ON cs.collection_id = c.id \
- WHERE c.user_id = :user_id \
-   AND cs.series_id = :series_id
+  SELECT cs.id, cs.number_of_stamps \
+    FROM collections c \
+    JOIN collections_series cs \
+      ON cs.collection_id = c.id \
+   WHERE c.user_id = :user_id \
+     AND cs.series_id = :series_id \
+ORDER BY cs.added_at DESC \
+       , cs.id DESC
 
 collection.add_series_to_collection = \
 INSERT \
@@ -137,12 +143,14 @@ INSERT \
      , number_of_stamps \
      , price \
      , currency \
+     , added_at \
      ) \
 SELECT c.id AS collection_id \
       , :series_id AS series_id \
       , :number_of_stamps AS number_of_stamps \
       , :price as price \
       , :currency as currency \
+      , :added_at as added_at \
   FROM collections c \
  WHERE c.user_id = :user_id
 

src/test/groovy/ru/mystamps/web/feature/collection/CollectionServiceImplTest.groovy

@@ -193,6 +193,7 @@ class CollectionServiceImplTest extends Specification {
 				assert dto.ownerId == expectedUserId
 				assert dto.seriesId == expectedSeriesId
 				assert dto.numberOfStamps == expectedNumberOfStamps
+				assert DateUtils.roughlyEqual(dto.addedAt, new Date())
 				return true
 			}) >> Random.id()
 		and: