improve(sitemap.xml): add a list of non-empty collections to make them indexable by search engines

Part of #1605

Author: php-coder

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

@@ -18,6 +18,7 @@
 package ru.mystamps.web.feature.collection;
 
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -28,6 +29,7 @@ public interface CollectionDao {
 	List<LinkEntityDto> findLastCreated(int quantity);
 	List<SeriesInCollectionDto> findSeriesByCollectionId(Integer collectionId, String lang);
 	List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(String slug, String lang);
+	List<SitemapInfoDto> findAllForSitemap();
 	long countCollectionsOfUsers();
 	long countUpdatedSince(Date date);
 	long countSeriesOfCollection(Integer collectionId);

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

@@ -18,6 +18,7 @@
 package ru.mystamps.web.feature.collection;
 
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 
 import java.util.Date;
 import java.util.List;
@@ -38,4 +39,5 @@ public interface CollectionService {
 	List<SeriesInCollectionDto> findSeriesInCollection(Integer collectionId, String lang);
 	List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(String slug, String lang);
 	CollectionInfoDto findBySlug(String slug);
+	List<SitemapInfoDto> findAllForSitemap();
 }

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

@@ -24,6 +24,7 @@
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.transaction.annotation.Transactional;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 import ru.mystamps.web.common.SlugUtils;
 import ru.mystamps.web.support.spring.security.HasAuthority;
 
@@ -208,6 +209,13 @@ public CollectionInfoDto findBySlug(String slug) {
 
 		return collectionDao.findCollectionInfoBySlug(slug);
 	}
+
+	// @todo #1605 CollectionService.findAllForSitemap(): add unit tests
+	@Override
+	@Transactional(readOnly = true)
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return collectionDao.findAllForSitemap();
+	}
 
 	private static String formatSeriesInfo(AddToCollectionDbDto collectionDto) {
 		StringBuilder sb = new StringBuilder();

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

@@ -29,6 +29,7 @@
 import org.springframework.jdbc.support.KeyHolder;
 import ru.mystamps.web.common.JdbcUtils;
 import ru.mystamps.web.common.LinkEntityDto;
+import ru.mystamps.web.common.SitemapInfoDto;
 import ru.mystamps.web.support.spring.jdbc.MapIntegerIntegerResultSetExtractor;
 
 import java.util.Collections;
@@ -37,7 +38,7 @@
 import java.util.List;
 import java.util.Map;
 
-@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods" })
+@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods", "PMD.TooManyFields" })
 public class JdbcCollectionDao implements CollectionDao {
 	private static final Logger LOG = LoggerFactory.getLogger(JdbcCollectionDao.class);
 
@@ -48,6 +49,7 @@ public class JdbcCollectionDao implements CollectionDao {
 	private final String findLastCreatedCollectionsSql;
 	private final String findSeriesByCollectionIdSql;
 	private final String findSeriesWithPricesBySlugSql;
+	private final String findAllForSitemapSql;
 	private final String countCollectionsOfUsersSql;
 	private final String countUpdatedSinceSql;
 	private final String countSeriesOfCollectionSql;
@@ -66,6 +68,7 @@ public JdbcCollectionDao(Environment env, NamedParameterJdbcTemplate jdbcTemplat
 		this.findLastCreatedCollectionsSql = env.getRequiredProperty("collection.find_last_created");
 		this.findSeriesByCollectionIdSql   = env.getRequiredProperty("collection.find_series_by_collection_id");
 		this.findSeriesWithPricesBySlugSql = env.getRequiredProperty("collection.find_series_with_prices_by_slug");
+		this.findAllForSitemapSql          = env.getRequiredProperty("collection.find_all_for_sitemap");
 		this.countCollectionsOfUsersSql    = env.getRequiredProperty("collection.count_collections_of_users");
 		this.countUpdatedSinceSql          = env.getRequiredProperty("collection.count_updated_since");
 		this.countSeriesOfCollectionSql    = env.getRequiredProperty("collection.count_series_of_collection");
@@ -117,6 +120,15 @@ public List<SeriesInCollectionWithPriceDto> findSeriesWithPricesBySlug(
 		);
 	}
 
+	@Override
+	public List<SitemapInfoDto> findAllForSitemap() {
+		return jdbcTemplate.query(
+			findAllForSitemapSql,
+			Collections.emptyMap(),
+			ru.mystamps.web.common.RowMappers::forSitemapInfoDto
+		);
+	}
+	
 	@Override
 	public long countCollectionsOfUsers() {
 		return jdbcTemplate.queryForObject(

src/main/java/ru/mystamps/web/feature/site/SiteConfig.java

@@ -81,7 +81,10 @@ public SiteController siteController() {
 
 		@Bean
 		public SitemapController sitemapController() {
-			return new SitemapController(seriesService);
+			return new SitemapController(
+				collectionService,
+				seriesService
+			);
 		}
 
 		@Bean

src/main/java/ru/mystamps/web/feature/site/SitemapController.java

@@ -24,6 +24,8 @@
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
 import ru.mystamps.web.common.SitemapInfoDto;
+import ru.mystamps.web.feature.collection.CollectionService;
+import ru.mystamps.web.feature.collection.CollectionUrl;
 import ru.mystamps.web.feature.series.SeriesService;
 import ru.mystamps.web.feature.series.SeriesUrl;
 
@@ -48,6 +50,7 @@ public class SitemapController {
 		+ SiteUrl.PUBLIC_URL + SiteUrl.INDEX_PAGE
 		+ "</loc></url>\n";
 
+	private final CollectionService collectionService;
 	private final SeriesService seriesService;
 
 	@GetMapping(SiteUrl.SITEMAP_XML)
@@ -66,6 +69,11 @@ public void generateSitemapXml(HttpServletResponse response) {
 
 			writer.print(INDEX_URL_ENTRY);
 
+			for (SitemapInfoDto item : collectionService.findAllForSitemap()) {
+				// CheckStyle: ignore LineLength for next 1 line
+				writer.print(createUrlEntry(dateFormatter, item, CollectionUrl.INFO_COLLECTION_PAGE, "{slug}"));
+			}
+			
 			for (SitemapInfoDto item : seriesService.findAllForSitemap()) {
 				// CheckStyle: ignore LineLength for next 1 line
 				writer.print(createUrlEntry(dateFormatter, item, SeriesUrl.INFO_SERIES_PAGE, "{id}"));

src/main/resources/sql/collection_dao_queries.properties

@@ -59,6 +59,15 @@ LEFT JOIN countries count \
        ON count.id = s.country_id \
     WHERE c.slug = :slug
 
+collection.find_all_for_sitemap = \
+  SELECT c.slug AS id \
+       , c.updated_at \
+    FROM collections_series cs \
+    JOIN collections c \
+      ON c.id = cs.collection_id \
+GROUP BY c.id \
+ORDER BY c.updated_at DESC
+
 collection.count_collections_of_users = \
    SELECT COUNT(DISTINCT c.id) \
      FROM collections c \