refactor: remove code for migrating site parser configuration from file to database.

Addressed to #975

Author: php-coder

src/main/java/ru/mystamps/web/feature/series/importing/event/DownloadingSucceededEventListener.java

@@ -17,8 +17,6 @@
  */
 package ru.mystamps.web.feature.series.importing.event;
 
-import java.util.List;
-
 import javax.annotation.PostConstruct;
 
 import org.slf4j.Logger;
@@ -30,12 +28,9 @@
 
 import ru.mystamps.web.feature.series.importing.RawParsedDataDto;
 import ru.mystamps.web.feature.series.importing.SeriesImportService;
-import ru.mystamps.web.feature.series.importing.extractor.JsoupSiteParser;
 import ru.mystamps.web.feature.series.importing.extractor.SeriesInfo;
 import ru.mystamps.web.feature.series.importing.extractor.SiteParser;
-import ru.mystamps.web.feature.series.importing.extractor.SiteParserConfiguration;
 import ru.mystamps.web.feature.series.importing.extractor.SiteParserService;
-import ru.mystamps.web.feature.series.importing.extractor.TimedSiteParser;
 
 /**
  * Listener of the {@link DownloadingSucceeded} event.
@@ -54,14 +49,10 @@ public class DownloadingSucceededEventListener
 	private final Logger log;
 	private final SeriesImportService seriesImportService;
 	private final SiteParserService siteParserService;
-	private final List<SiteParser> siteParsers;
 	private final ApplicationEventPublisher eventPublisher;
 
 	@PostConstruct
 	public void init() {
-		// TODO: remove migration logic after finishing migration
-		siteParsers.forEach(this::migrateParser);
-		
 		log.info("Registered site parsers: {}", siteParserService.findParserNames());
 	}
 
@@ -107,43 +98,4 @@ public void onApplicationEvent(DownloadingSucceeded event) {
 		seriesImportService.saveParsedData(requestId, data);
 	}
 
-	@SuppressWarnings({ "PMD.AvoidReassigningParameters", "checkstyle:parameterassignment" })
-	private void migrateParser(SiteParser parser) {
-		if (parser instanceof TimedSiteParser) {
-			parser = ((TimedSiteParser)parser).getOrigin();
-		}
-		
-		if (!(parser instanceof JsoupSiteParser)) {
-			log.warn(
-				"Could not migrate unknown (non-Jsoup based) parser: {}",
-				parser.getClass().getName()
-			);
-			return;
-		}
-		
-		JsoupSiteParser jsoupParser = (JsoupSiteParser)parser;
-		
-		SiteParserConfiguration cfg = jsoupParser.toConfiguration();
-		String url = cfg.getMatchedUrl();
-		String name = cfg.getName();
-		if (siteParserService.findForUrl(url) != null) {
-			log.warn(
-				"Parser '{}': already exist in database and "
-				+ "can be removed from application*.properties file",
-				name
-			);
-			return;
-		}
-		
-		log.info("Parser '{}': migrating to database", name);
-		
-		siteParserService.add(cfg);
-		
-		log.warn(
-			"Parser '{}': successfully migrated and "
-			+ "can be removed from application*.properties file",
-			name
-		);
-	}
-	
 }

src/main/java/ru/mystamps/web/feature/series/importing/event/EventsConfig.java

@@ -17,11 +17,8 @@
  */
 package ru.mystamps.web.feature.series.importing.event;
 
-import java.util.Collections;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 
 import javax.annotation.PostConstruct;
 
@@ -35,7 +32,6 @@
 import org.springframework.context.ApplicationListener;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.context.annotation.DependsOn;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.EnumerablePropertySource;
 import org.springframework.core.env.PropertySource;
@@ -104,21 +100,15 @@ public ApplicationListener<ImportRequestCreated> getImportRequestCreatedEventLis
 		);
 	}
 
-	// This bean has logic that modifies database. To ensure that all migrations have been applied
-	// we need this dependency. This annotation shouldn't be needed in Spring Boot 2.
-	// TODO: remove this annotation when migration will be completed
-	@DependsOn("liquibase")
 	@Bean
 	public ApplicationListener<DownloadingSucceeded> getDownloadingSucceededEventListener(
-		Optional<List<SiteParser>> siteParsers,
 		SiteParserService siteParserService
 		) {
 
 		return new DownloadingSucceededEventListener(
 			LoggerFactory.getLogger(DownloadingSucceededEventListener.class),
 			seriesImportService,
 			siteParserService,
-			siteParsers.orElse(Collections.emptyList()),
 			eventPublisher
 		);
 	}

src/main/java/ru/mystamps/web/feature/series/importing/extractor/AddParserParameterDbDto.java

@@ -18,19 +18,13 @@
 package ru.mystamps.web.feature.series.importing.extractor;
 
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import org.apache.commons.lang3.Validate;
-
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.dao.EmptyResultDataAccessException;
 import org.springframework.jdbc.core.ResultSetExtractor;
-import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
-import org.springframework.jdbc.support.GeneratedKeyHolder;
-import org.springframework.jdbc.support.KeyHolder;
 
 import lombok.RequiredArgsConstructor;
 
@@ -42,12 +36,6 @@ public class JdbcSiteParserDao implements SiteParserDao {
 
 	private final NamedParameterJdbcTemplate jdbcTemplate;
 
-	@Value("${site_parser.create}")
-	private String addParserSql;
-	
-	@Value("${site_parser_param.create}")
-	private String addParserParameterSql;
-	
 	@Value("${site_parser.find_like_matched_url}")
 	private String findParserIdByMatchedUrlSql;
 
@@ -58,41 +46,6 @@ public class JdbcSiteParserDao implements SiteParserDao {
 	@Value("${site_parser_param.find_all_with_parser_name}")
 	private String findParametersWithParserNameSql;
 
-	@Override
-	public Integer addParser(String name) {
-		KeyHolder holder = new GeneratedKeyHolder();
-		
-		int affected = jdbcTemplate.update(
-			addParserSql,
-			new MapSqlParameterSource("name", name),
-			holder
-		);
-		
-		Validate.validState(
-			affected == 1,
-			"Unexpected number of affected rows after creation of site parser: %d",
-			affected
-		);
-		
-		return holder.getKey().intValue();
-	}
-
-	@Override
-	public void addParserParameter(AddParserParameterDbDto param) {
-		Map<String, Object> params = new HashMap<>();
-		params.put("parser_id", param.getParserId());
-		params.put("name", param.getName());
-		params.put("value", param.getValue());
-		
-		int affected = jdbcTemplate.update(addParserParameterSql, params);
-		
-		Validate.validState(
-			affected == 1,
-			"Unexpected number of affected rows after adding parser parameter: %d",
-			affected
-		);
-	}
-	
 	@Override
 	public Integer findParserIdForUrl(String url) {
 		try {

src/main/java/ru/mystamps/web/feature/series/importing/extractor/JdbcSiteParserDao.java

@@ -80,21 +80,6 @@ public JsoupSiteParser(SiteParserConfiguration cfg) {
 		currencyValue           = cfg.getCurrencyValue();
 	}
 
-	// TODO: remove because it's only needed for migrating configuration from file to database
-	public SiteParserConfiguration toConfiguration() {
-		SiteParserConfiguration cfg = new SiteParserConfiguration(name, matchedUrl);
-		cfg.setCategoryLocator(categoryLocator);
-		cfg.setCountryLocator(countryLocator);
-		cfg.setShortDescriptionLocator(shortDescriptionLocator);
-		cfg.setImageUrlLocator(imageUrlLocator);
-		cfg.setImageUrlAttribute(imageUrlAttribute);
-		cfg.setIssueDateLocator(issueDateLocator);
-		cfg.setSellerLocator(sellerLocator);
-		cfg.setPriceLocator(priceLocator);
-		cfg.setCurrencyValue(currencyValue);
-		return cfg;
-	}
-	
 	@Override
 	public boolean setField(String name, String value) {
 		Validate.validState(StringUtils.isNotBlank(name), "Field name must be non-blank");

src/main/java/ru/mystamps/web/feature/series/importing/extractor/JsoupSiteParser.java

@@ -17,7 +17,6 @@
  */
 package ru.mystamps.web.feature.series.importing.extractor;
 
-import java.util.HashMap;
 import java.util.Map;
 
 import lombok.EqualsAndHashCode;
@@ -62,26 +61,4 @@ public class SiteParserConfiguration {
 		currencyValue           = params.get("currency-value");
 	}
 
-	/* default */ Map<String, String> toMap() {
-		Map<String, String> map = new HashMap<>();
-		addIfNotNull(map, "name", name);
-		addIfNotNull(map, "matched-url", matchedUrl);
-		addIfNotNull(map, "category-locator", categoryLocator);
-		addIfNotNull(map, "country-locator", countryLocator);
-		addIfNotNull(map, "short-description-locator", shortDescriptionLocator);
-		addIfNotNull(map, "image-url-locator", imageUrlLocator);
-		addIfNotNull(map, "image-url-attribute", imageUrlAttribute);
-		addIfNotNull(map, "issue-date-locator", issueDateLocator);
-		addIfNotNull(map, "seller-locator", sellerLocator);
-		addIfNotNull(map, "price-locator", priceLocator);
-		addIfNotNull(map, "currency-value", currencyValue);
-		return map;
-	}
-
-	private static void addIfNotNull(Map<String, String> map, String name, String value) {
-		if (value != null) {
-			map.put(name, value);
-		}
-	}
-
 }

src/main/java/ru/mystamps/web/feature/series/importing/extractor/SiteParserConfiguration.java

@@ -20,8 +20,6 @@
 import java.util.List;
 
 public interface SiteParserDao {
-	Integer addParser(String name);
-	void addParserParameter(AddParserParameterDbDto param);
 	Integer findParserIdForUrl(String url);
 	List<String> findParserNames();
 	SiteParserConfiguration findConfigurationForParser(Integer parserId);

src/main/java/ru/mystamps/web/feature/series/importing/extractor/SiteParserDao.java

@@ -20,7 +20,6 @@
 import java.util.List;
 
 public interface SiteParserService {
-	void add(SiteParserConfiguration cfg);
 	SiteParser findForUrl(String url);
 	List<String> findParserNames();
 }

src/main/java/ru/mystamps/web/feature/series/importing/extractor/SiteParserService.java

@@ -18,7 +18,6 @@
 package ru.mystamps.web.feature.series.importing.extractor;
 
 import java.util.List;
-import java.util.Map;
 
 import org.apache.commons.lang3.Validate;
 
@@ -34,32 +33,6 @@ public class SiteParserServiceImpl implements SiteParserService {
 	private final Logger log;
 	private final SiteParserDao siteParserDao;
 
-	// TODO: remove after finishing migration
-	@Override
-	@Transactional
-	@SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops")
-	public void add(SiteParserConfiguration cfg) {
-		Validate.isTrue(cfg != null, "Site parser configuration must be non null");
-		
-		Integer id = siteParserDao.addParser(cfg.getName());
-		log.info("Site parser #{} ({}) has been created", id, cfg.getName());
-		
-		for (Map.Entry<String, String> param : cfg.toMap().entrySet()) {
-			String name  = param.getKey();
-			if ("name".equals(name)) {
-				// "name" belongs to the parser itself and has been already saved above
-				continue;
-			}
-
-			String value = param.getValue();
-			AddParserParameterDbDto paramDto = new AddParserParameterDbDto(id, name, value);
-			
-			siteParserDao.addParserParameter(paramDto);
-			
-			log.info("Site parser #{}: parameter '{}' has been added", id, name);
-		}
-	}
-	
 	// @todo #975 SiteParserServiceImpl.findForUrl(): add unit tests
 	@Override
 	@Transactional(readOnly = true)

src/main/java/ru/mystamps/web/feature/series/importing/extractor/SiteParserServiceImpl.java

@@ -31,11 +31,6 @@ public class TimedSiteParser implements SiteParser {
 	private final Logger log;
 	private final SiteParser parser;
 
-	// TODO: remove after finishing migration of the site parsers
-	public SiteParser getOrigin() {
-		return parser;
-	}
-	
 	@Override
 	public boolean setField(String name, String value) {
 		return parser.setField(name, value);

src/main/java/ru/mystamps/web/feature/series/importing/extractor/TimedSiteParser.java

@@ -1,21 +1,3 @@
-site_parser.create = \
-INSERT \
-  INTO site_parsers(name) \
-VALUES (:name)
-
-site_parser_param.create = \
-INSERT \
-  INTO site_parser_params \
-     ( parser_id \
-     , name \
-     , value \
-     ) \
-VALUES \
-     ( :parser_id \
-     , :name \
-     , :value \
-     )
-
 site_parser.find_like_matched_url = \
 SELECT parser_id AS id \
   FROM site_parser_params \