From 2cf94f5c90140ddbfef2bee1a032834c60c4608f Mon Sep 17 00:00:00 2001 From: JanardhanBS-SyncByte Date: Wed, 30 Sep 2026 15:49:59 +0530 Subject: [PATCH] [issue-1633] common wired compoenent exclusion Signed-off-by: JanardhanBS-SyncByte --- pre-registration-booking-service/AGENTS.md | 4 +- pre-registration-booking-service/pom.xml | 8 ++- .../booking/BookingApplication.java | 60 +++++++++++++------ .../resources/application-local.properties | 3 + .../BookingApplicationComponentScanTest.java | 44 ++++++++++++++ 5 files changed, 95 insertions(+), 24 deletions(-) create mode 100644 pre-registration-booking-service/src/main/resources/application-local.properties create mode 100644 pre-registration-booking-service/src/test/java/io/mosip/preregistration/booking/config/BookingApplicationComponentScanTest.java diff --git a/pre-registration-booking-service/AGENTS.md b/pre-registration-booking-service/AGENTS.md index 8e7973c9ca..914301d5c6 100644 --- a/pre-registration-booking-service/AGENTS.md +++ b/pre-registration-booking-service/AGENTS.md @@ -19,9 +19,9 @@ pre-registration-booking-service/ │ ├── errorcodes/ErrorCodes.java ErrorMessages.java │ ├── dto/ │ └── exception/ util/BookingExceptionCatcher.java BookingExceptionHandler.java - ├── main/resources/ bootstrap.properties logback.xml + ├── main/resources/ bootstrap.properties application-local.properties logback.xml └── test/ - ├── java/.../booking/config/BookingConfigOpenApiTest.java + ├── java/.../booking/config/BookingApplicationComponentScanTest.java BookingConfigOpenApiTest.java ├── java/.../booking/test/BookingApplicationTest.java ├── java/.../test/config/TestConfig.java TestSecurityConfig.java ├── java/.../test/controller/BookingControllerTest.java diff --git a/pre-registration-booking-service/pom.xml b/pre-registration-booking-service/pom.xml index d9f0a11422..671b750ef8 100644 --- a/pre-registration-booking-service/pom.xml +++ b/pre-registration-booking-service/pom.xml @@ -23,7 +23,8 @@ pre-registration-booking-service MOSIP Pre-registration appointment booking REST service. BookingApplication - scans io.mosip.* (kernel crypto and keymanager packages excluded) and serves + allow-lists scanBasePackages (booking, pre-registration-core, auth adapter, + logger config, idobjectvalidator) like kernel-notification-service and serves BookingController under /appointment/** on context /preregistration/v1: slot availability, single and multi book, get by pre-registration id, cancel, batch cancel, delete, and centre/date queries. Roles come from the @@ -35,8 +36,9 @@ logstash-logback-encoder) live in this pom — not in README.md or AGENTS.md. kernel-auth-adapter and kernel-ref-idobjectvalidator are packaged in the service JAR; do not wget them at container start. Logging is in kernel-core - (commons); do not depend on kernel-logger-logback. The io.mosip.* scan loads - SleuthLoggingAutoConfiguration, which autowires io.micrometer.tracing.Tracer; + (commons); do not depend on kernel-logger-logback. scanBasePackages includes + io.mosip.kernel.core.logger.config so SleuthLoggingAutoConfiguration loads; + it autowires io.micrometer.tracing.Tracer; spring-boot-micrometer-tracing-brave registers that bean (the Brave bridge is already on kernel-core). Jackson 2 via spring-boot-jackson2 because Boot 4 defaults to Jackson 3. Spring Cloud diff --git a/pre-registration-booking-service/src/main/java/io/mosip/preregistration/booking/BookingApplication.java b/pre-registration-booking-service/src/main/java/io/mosip/preregistration/booking/BookingApplication.java index 33dcc92df6..6be41def9c 100644 --- a/pre-registration-booking-service/src/main/java/io/mosip/preregistration/booking/BookingApplication.java +++ b/pre-registration-booking-service/src/main/java/io/mosip/preregistration/booking/BookingApplication.java @@ -5,18 +5,22 @@ package io.mosip.preregistration.booking; import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.EnableConfigurationProperties; -import org.springframework.context.annotation.ComponentScan; -import org.springframework.context.annotation.FilterType; import io.mosip.preregistration.booking.config.BookingConfig; /** * Starts the Pre-registration booking REST service (Spring Boot 4.1.1). *

- * Component scan is {@code io.mosip.*} with kernel crypto/keymanager packages excluded. - * Swagger UI Authorize is wired in {@link BookingConfig}. + * Component scan is an allow-list (same pattern as kernel-notification-service + * {@code NotificationBootApplication}): booking, pre-registration-core, auth + * adapter, logger config, and the packaged idobjectvalidator SPI. Do not scan + * {@code io.mosip.*} — kernel-core {@code DataMapperImpl} is a {@code @Component} + * whose {@code Class} constructor Boot 4 cannot autowire. Kernel-core sidecar + * auto-configs are excluded by name; DataSource/JPA stay enabled. Swagger UI + * Authorize is wired in {@link BookingConfig}. *

* * @author Kishan Rathore @@ -25,21 +29,39 @@ * @since 1.0.0 * */ -@SpringBootApplication -@ComponentScan(basePackages = "io.mosip.*", excludeFilters = { - @ComponentScan.Filter(type = FilterType.REGEX, - pattern = {"io\\.mosip\\.kernel\\.zkcryptoservice\\..*", - "io\\.mosip\\.kernel\\.tokenidgenerator\\..*", - "io\\.mosip\\.kernel\\.signature\\..*", - "io\\.mosip\\.kernel\\.partnercertservice\\..*", - "io\\.mosip\\.kernel\\.lkeymanager\\..*", - "io\\.mosip\\.kernel\\.keymanagerservice\\..*", - "io\\.mosip\\.kernel\\.keymanager\\..*", - "io\\.mosip\\.kernel\\.keygenerator\\..*", - "io\\.mosip\\.kernel\\.cryptomanager\\..*", - "io\\.mosip\\.kernel\\.crypto\\..*", - "io\\.mosip\\.kernel\\.clientcrypto\\..*", - }) }) +@SpringBootApplication(scanBasePackages = { + "io.mosip.preregistration.booking.*", + "io.mosip.preregistration.core.*", + "${mosip.auth.adapter.impl.basepackage}", + "io.mosip.kernel.core.logger.config", + "io.mosip.kernel.idobjectvalidator.*" +}) +@EnableAutoConfiguration(excludeName = { + "io.mosip.kernel.idgenerator.vid.impl.VidGeneratorImpl", + "io.mosip.kernel.idgenerator.vid.util.VidFilterUtils", + "io.mosip.kernel.idgenerator.tokenid.impl.TokenIdGeneratorImpl", + "io.mosip.kernel.idgenerator.machineid.impl.MachineIdGeneratorImpl", + "io.mosip.kernel.idgenerator.regcenterid.impl.RegistrationCenterIdGeneratorImpl", + "io.mosip.kernel.idgenerator.mispid.impl.MispIdGeneratorImpl", + "io.mosip.kernel.licensekeygenerator.misp.impl.MISPLicenseKeyGeneratorImpl", + "io.mosip.kernel.licensekeygenerator.misp.util.MISPLicenseKeyGeneratorUtil", + "io.mosip.kernel.idgenerator.rid.impl.RidGeneratorImpl", + "io.mosip.kernel.idvalidator.prid.impl.PridValidatorImpl", + "io.mosip.kernel.idvalidator.rid.impl.RidValidatorImpl", + "io.mosip.kernel.idvalidator.uin.impl.UinValidatorImpl", + "io.mosip.kernel.idvalidator.vid.impl.VidValidatorImpl", + "io.mosip.kernel.idvalidator.mispid.impl.MispIdValidatorImpl", + "io.mosip.kernel.templatemanager.velocity.builder.TemplateManagerBuilderImpl", + "io.mosip.kernel.pdfgenerator.impl.PDFGeneratorImpl", + "io.mosip.kernel.qrcode.generator.zxing.QrcodeGeneratorImpl", + "io.mosip.kernel.transliteration.icu4j.impl.TransliterationImpl", + "io.mosip.kernel.applicanttype.api.impl.ApplicantTypeImpl", + "io.mosip.kernel.idobjectvalidator.config.IdObjectValidatorConfig", + "io.mosip.kernel.websub.api.config.IntentVerificationConfig", + "io.mosip.kernel.websub.api.config.WebSubClientConfig", + "io.mosip.kernel.websub.api.config.publisher.WebSubPublisherClientConfig", + "io.mosip.kernel.websub.api.config.publisher.RestTemplateHelper" +}) @EnableConfigurationProperties(BookingConfig.class) public class BookingApplication { /** diff --git a/pre-registration-booking-service/src/main/resources/application-local.properties b/pre-registration-booking-service/src/main/resources/application-local.properties new file mode 100644 index 0000000000..474cbe2a6c --- /dev/null +++ b/pre-registration-booking-service/src/main/resources/application-local.properties @@ -0,0 +1,3 @@ +# Local profile. Activate with: -Dspring.profiles.active=local +# Cluster gets this from mosip-config; bootstrap leaves it commented on purpose. +mosip.auth.adapter.impl.basepackage=io.mosip.kernel.auth.defaultadapter diff --git a/pre-registration-booking-service/src/test/java/io/mosip/preregistration/booking/config/BookingApplicationComponentScanTest.java b/pre-registration-booking-service/src/test/java/io/mosip/preregistration/booking/config/BookingApplicationComponentScanTest.java new file mode 100644 index 0000000000..bfbd1ad941 --- /dev/null +++ b/pre-registration-booking-service/src/test/java/io/mosip/preregistration/booking/config/BookingApplicationComponentScanTest.java @@ -0,0 +1,44 @@ +package io.mosip.preregistration.booking.config; + +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; + +import java.util.Arrays; +import java.util.List; + +import org.junit.Test; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +import io.mosip.preregistration.booking.BookingApplication; + +/** + * Same pattern as kernel-notification-service {@code NotificationBootApplication}: + * allow-list {@code scanBasePackages} instead of {@code io.mosip.*}, and + * {@code excludeName} for kernel-core sidecar auto-configs. DataSource/JPA stay + * enabled because booking persists slots. + */ +public class BookingApplicationComponentScanTest { + + @Test + public void scanBasePackagesIsAllowListNotIoMosipStar() { + List packages = Arrays.asList( + BookingApplication.class.getAnnotation(SpringBootApplication.class).scanBasePackages()); + assertFalse(packages.contains("io.mosip.*")); + assertTrue(packages.contains("io.mosip.preregistration.booking.*")); + assertTrue(packages.contains("io.mosip.preregistration.core.*")); + assertTrue(packages.contains("${mosip.auth.adapter.impl.basepackage}")); + assertTrue(packages.contains("io.mosip.kernel.core.logger.config")); + assertTrue(packages.contains("io.mosip.kernel.idobjectvalidator.*")); + } + + @Test + public void autoConfigurationExcludesKernelCoreSidecarsNotDataSource() { + List names = Arrays.asList( + BookingApplication.class.getAnnotation(EnableAutoConfiguration.class).excludeName()); + assertTrue(names.contains("io.mosip.kernel.idgenerator.vid.impl.VidGeneratorImpl")); + assertTrue(names.contains("io.mosip.kernel.websub.api.config.WebSubClientConfig")); + assertFalse(names.contains("org.springframework.boot.jdbc.autoconfigure.DataSourceAutoConfiguration")); + assertFalse(names.contains("org.springframework.boot.hibernate.autoconfigure.HibernateJpaAutoConfiguration")); + } +}