Merge pull request #157 from SNT01/release-8.0.0

Upgrade Play Framework 3.0.5 + Apache Pekko 1.0.2 + Scala 2.13.12

Author: pallakartheekreddy

.github/workflows/build.yml

@@ -71,7 +71,7 @@ jobs:
       - name: Build and push Docker image to GHCR
         uses: docker/build-push-action@v4
         with:
-          context: ./service/target
+          context: .
           file: ./Dockerfile
           push: true
           tags: ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}

.gitignore

@@ -82,4 +82,8 @@ RUNNING_PID
 /.target/
 /bin/
 /logs
-*.zip
+*.zip
+
+# Maven build artifacts
+dependency-reduced-pom.xml
+**/dependency-reduced-pom.xml

Dockerfile

@@ -4,7 +4,7 @@ RUN apk update \
     && apk add curl \
     && adduser -u 1001 -h /home/sunbird/ -D sunbird \
     && mkdir -p /home/sunbird/ 
-ADD ./notification-service-1.0.0-dist.zip /home/sunbird/ 
+ADD ./service/target/notification-service-1.0.0-dist.zip /home/sunbird/ 
 RUN unzip /home/sunbird/notification-service-1.0.0-dist.zip -d /home/sunbird/ 
 RUN chown -R sunbird:sunbird /home/sunbird
 USER sunbird

UPGRADE_README.md

@@ -0,0 +1,120 @@
+# Play Framework and Apache Pekko Upgrade
+
+## Overview
+
+This repository has been upgraded from Play Framework 2.7.2 with Akka 2.5.22 to Play Framework 3.0.5 with Apache Pekko 1.0.3.
+
+## Why This Upgrade
+
+**License Compliance**: Akka changed from Apache 2.0 to Business Source License 1.1, requiring commercial licenses for production use. Apache Pekko maintains Apache 2.0 license.
+
+**Security**: Play 2.7.2 and Akka 2.5.22 no longer receive security updates.
+
+**Modernization**: Access to latest features and performance improvements.
+
+## Technology Stack Changes
+
+- Play Framework: 2.7.2 to 3.0.5
+- Actor Framework: Akka 2.5.22 to Apache Pekko 1.0.2
+- Scala: 2.12.11 to 2.13.12
+- Guice: 3.0 to 5.1.0
+- SLF4J: 1.6.1 to 2.0.13
+- Logback: 1.2.3 to 1.4.14
+- Jackson: 2.13.5 to 2.14.3
+- Netty: 4.1.77.Final to 4.1.112.Final
+
+## Key Changes
+
+### Dependencies
+
+All Maven POM files updated with new versions. Play Framework groupId changed from com.typesafe.play to org.playframework. Scala library exclusions added to prevent version conflicts between Scala 2.12 and 2.13.
+
+### Source Code
+
+Akka imports migrated to Pekko across all Java files:
+- akka.actor.* to org.apache.pekko.actor.*
+- akka.pattern.* to org.apache.pekko.pattern.*
+- akka.routing.* to org.apache.pekko.routing.*
+- akka.util.* to org.apache.pekko.util.*
+- akka.testkit.* to org.apache.pekko.testkit.*
+
+Updated FutureConverters for Scala 2.13:
+- scala.compat.java8.FutureConverters to scala.jdk.javaapi.FutureConverters
+- toJava() to asJava()
+
+### Configuration
+
+application.conf files updated with Pekko namespaces:
+- akka {} to pekko {}
+- Actor system configurations migrated
+- Serialization bindings updated
+- Dispatcher references changed
+
+
+### Play 3.0 API Updates
+
+Play 3.0 removed the request() method and Http.Context. All controller methods now inject Http.Request as a parameter.
+
+Controller updates:
+- HealthController
+- NotificationController
+- NotificationTemplateController
+- LogController
+- BaseController helper methods
+
+Routes file updated with request injection for all endpoints.
+
+### Test Framework
+
+Test files updated:
+- Replaced JavaTestKit.duration() with java.time.Duration.ofSeconds()
+- Resolved Duration class ambiguity between java.time and scala.concurrent
+- Fixed import conflicts
+
+### Scala Version Conflicts
+
+Added exclusions to prevent Scala 2.12 transitive dependencies:
+- Excluded scala-library and scala-reflect from dependencies where needed
+- Explicitly declared scala-library 2.13.12 dependency
+
+## Build Instructions
+
+Build all modules:
+```
+mvn clean install -Dmaven.test.skip=true
+```
+
+Build with test compilation:
+```
+mvn clean install -DskipTests
+```
+
+Create distribution package:
+```
+cd service
+mvn play2:dist
+```
+
+## Migration Impact
+
+**Business Logic**: No changes to business logic or functionality
+
+**API Compatibility**: Maintained, as Pekko is API-compatible with Akka 2.6
+
+**Code Changes**: Primarily package name updates from akka to pekko
+
+**License**: Now compliant with Apache 2.0 throughout the stack
+
+## Known Issues
+
+**Scala 2.12/2.13 Conflict**: If you encounter NoClassDefFoundError for scala.collection.GenMap, verify dependency tree to ensure no Scala 2.12 artifacts are present. Run mvn dependency:tree and add exclusions for any scala-library or scala-reflect with version 2.12.
+
+**PowerMock Tests**: PowerMock is incompatible with Java 9+ module system. Tests using PowerMock will need to be updated or JVM arguments added.
+
+## Verification Steps
+
+1. Clean compilation successful
+2. All modules build without errors
+3. Dependency tree verified for no Scala 2.12 conflicts
+4. Configuration files validated
+5. Routes file compiled successfully

all-actors/pom.xml

@@ -79,9 +79,9 @@
         <version>${junit.version}</version>
     </dependency>
     <dependency>
-        <groupId>com.typesafe.akka</groupId>
-        <artifactId>akka-testkit_${scala.major.version}</artifactId>
-        <version>${typesafe.akka.version}</version>
+        <groupId>org.apache.pekko</groupId>
+        <artifactId>pekko-testkit_${scala.major.version}</artifactId>
+        <version>${pekko.version}</version>
         <scope>test</scope>
     </dependency>
     <dependency>
@@ -126,6 +126,9 @@
                                         <exclude>META-INF/*.SF</exclude>
                                         <exclude>META-INF/*.DSA</exclude>
                                         <exclude>META-INF/*.RSA</exclude>
+                                        <exclude>org/slf4j/**</exclude>
+                                        <exclude>ch/qos/logback/**</exclude>
+                                        <exclude>META-INF/services/org.slf4j.spi.SLF4JServiceProvider</exclude>
                                     </excludes>
                                 </filter>
                             </filters>

all-actors/src/main/java/org/sunbird/Application.java

@@ -1,6 +1,6 @@
 package org.sunbird;
 
-import akka.actor.ActorRef;
+import org.apache.pekko.actor.ActorRef;
 import org.sunbird.actor.core.ActorCache;
 import org.sunbird.actor.core.ActorService;
 

all-actors/src/main/java/org/sunbird/BaseActor.java

@@ -1,6 +1,6 @@
 package org.sunbird;
 
-import akka.actor.UntypedAbstractActor;
+import org.apache.pekko.actor.UntypedAbstractActor;
 import org.sunbird.common.exception.ActorServiceException;
 import org.sunbird.common.exception.BaseException;
 import org.sunbird.common.message.IResponseMessage;

all-actors/src/main/java/org/sunbird/NotificationValidator.java

@@ -130,6 +130,10 @@ private static void validatePresence(String key, Object value, Class<?> type, St
   }
 
   public static boolean isInstanceOf(Class objClass, Class targetClass) {
+    // Handle Scala collections - Scala Seq should be treated as List
+    if (targetClass == List.class && scala.collection.Seq.class.isAssignableFrom(objClass)) {
+      return true;
+    }
     return targetClass.isAssignableFrom(objClass);
   }
 

all-actors/src/main/java/org/sunbird/notification/actor/CreateNotificationActor.java

@@ -19,6 +19,7 @@
 import org.sunbird.request.LoggerUtil;
 import org.sunbird.telemetry.TelemetryEnvKey;
 import org.sunbird.telemetry.util.TelemetryUtil;
+import scala.collection.JavaConverters;
 
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -43,8 +44,14 @@ public void onReceive(Request request) throws Throwable {
         try {
             Response response = new Response();
             ObjectMapper mapper = new ObjectMapper();
-            List<Map<String, Object>> notifications =
-                    (List<Map<String, Object>>) request.getRequest().get(JsonKey.NOTIFICATIONS);
+            // Convert Scala collection to Java List to avoid ClassCastException
+            Object notificationsObject = request.getRequest().get(JsonKey.NOTIFICATIONS);
+            List<Map<String, Object>> notifications;
+            if (notificationsObject instanceof scala.collection.Seq) {
+                notifications = new ArrayList<>(JavaConverters.asJavaCollectionConverter((scala.collection.Seq<Map<String, Object>>) notificationsObject).asJavaCollection());
+            } else {
+                notifications = (List<Map<String, Object>>) notificationsObject;
+            }
 
             String deliveryMode = request.getManagerName();
             if (StringUtils.isNotBlank(deliveryMode) && "sync".equalsIgnoreCase(deliveryMode)) {

all-actors/src/main/java/org/sunbird/notification/actor/DeleteNotificationActor.java

@@ -15,8 +15,10 @@
 import org.sunbird.service.NotificationServiceImpl;
 import org.sunbird.util.RequestHandler;
 import org.sunbird.utils.PropertiesCache;
+import scala.collection.JavaConverters;
 
 import java.text.MessageFormat;
+import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -63,7 +65,14 @@ private void deleteV1Feed(Request request) {
 
     private void deleteFeed(Request request, String requestedBy){
         String userId = (String) request.getRequest().get(JsonKey.USER_ID);
-        List<String> feedIds = (List<String>)request.getRequest().get(JsonKey.IDS);
+        // Convert Scala collection to Java List to avoid ClassCastException
+        Object idsObject = request.getRequest().get(JsonKey.IDS);
+        List<String> feedIds;
+        if (idsObject instanceof scala.collection.Seq) {
+            feedIds = new ArrayList<>(JavaConverters.asJavaCollectionConverter((scala.collection.Seq<String>) idsObject).asJavaCollection());
+        } else {
+            feedIds = (List<String>) idsObject;
+        }
         try {
             if (StringUtils.isEmpty(userId)) {
                 throw new BaseException(IResponseMessage.Key.MANDATORY_PARAMETER_MISSING,
@@ -77,7 +86,7 @@ private void deleteFeed(Request request, String requestedBy){
             NotificationService notificationService = NotificationServiceImpl.getInstance();
             boolean isSupportEnabled = Boolean.parseBoolean(PropertiesCache.getInstance().getProperty(JsonKey.VERSION_SUPPORT_CONFIG_ENABLE));
             if(isSupportEnabled) {
-                List<Map<String, Object>> mappedFeedIdLists = notificationService.getFeedMap((List<String>) request.getRequest().get(JsonKey.IDS), request.getContext());
+                List<Map<String, Object>> mappedFeedIdLists = notificationService.getFeedMap(feedIds, request.getContext());
                 getOtherVersionUpdatedFeedList(mappedFeedIdLists,feedIds);
             }
             Response response = notificationService.deleteNotificationFeed(Collections.singletonMap(requestedBy,feedIds), request.getContext());