fix: fix serialization issues (#438)

Fixes #436 Fixes #437
vaadin · Jun 28, 2023 · 3643693 · 3643693
1 parent a36596e
commit 3643693
Show file tree

Hide file tree

Showing 7 changed files with 162 additions and 33 deletions.
diff --git a/pom.xml b/pom.xml
@@ -52,7 +52,7 @@
         <weld.version>2.4.6.Final</weld.version>
         <arquillian.version>1.1.15.Final</arquillian.version>
     </properties>
-         
+
     <repositories>
         <!-- The order of definitions matters. Explicitly defining central here to make sure it has the highest priority. -->
         <repository>

diff --git a/vaadin-cdi/src/main/java/com/vaadin/cdi/CdiVaadinServletService.java b/vaadin-cdi/src/main/java/com/vaadin/cdi/CdiVaadinServletService.java
@@ -39,6 +39,7 @@
 import com.vaadin.flow.server.VaadinService;
 import com.vaadin.flow.server.VaadinServletService;
 import com.vaadin.flow.server.VaadinSession;
+import com.vaadin.flow.server.WrappedSession;
 
 import javax.enterprise.context.spi.Context;
 import javax.enterprise.context.spi.CreationalContext;
@@ -86,7 +87,7 @@ public CdiVaadinServletService(CdiVaadinServlet servlet,
 
     @Override
     public void init() throws ServiceException {
-        delegate.init();
+        delegate.init(this);
         super.init();
     }
 
@@ -96,6 +97,20 @@ public void fireUIInitListeners(UI ui) {
         super.fireUIInitListeners(ui);
     }
 
+    @Override
+    protected VaadinSession loadSession(WrappedSession wrappedSession) {
+        return super.loadSession(wrappedSession);
+    }
+
+    @Override
+    protected void storeSession(VaadinSession session, WrappedSession wrappedSession) {
+        super.storeSession(session, wrappedSession);
+    }
+
+    private void restoreDelegate(VaadinSession session) {
+
+    }
+
     public Optional<Instantiator> loadInstantiators() throws ServiceException {
         BeanManager beanManager = delegate.getBeanManager();
 
@@ -146,21 +161,17 @@ public CdiVaadinServlet getServlet() {
      */
     public static class CdiVaadinServiceDelegate implements Serializable {
 
-        private final VaadinService vaadinService;
-
         private transient BeanManager beanManager;
 
         private final UIEventListener uiEventListener;
 
         public CdiVaadinServiceDelegate(VaadinService vaadinService,
                 BeanManager beanManager) {
             this.beanManager = beanManager;
-            this.vaadinService = vaadinService;
-
             uiEventListener = new UIEventListener(this);
         }
 
-        public void init() throws ServiceException {
+        public void init(VaadinService vaadinService) throws ServiceException {
             lookup(SystemMessagesProvider.class)
                     .ifPresent(vaadinService::setSystemMessagesProvider);
             vaadinService.addUIInitListener(e -> getBeanManager().fireEvent(e));

diff --git a/vaadin-cdi/src/test/java/com/vaadin/cdi/CdiVaadinServletServiceTest.java b/vaadin-cdi/src/test/java/com/vaadin/cdi/CdiVaadinServletServiceTest.java
@@ -16,38 +16,47 @@
 
 package com.vaadin.cdi;
 
-import com.vaadin.cdi.annotation.VaadinServiceEnabled;
-import com.vaadin.cdi.annotation.VaadinServiceScoped;
-import com.vaadin.cdi.context.ServiceUnderTestContext;
-import com.vaadin.flow.di.Instantiator;
-import com.vaadin.flow.server.CustomizedSystemMessages;
-import com.vaadin.flow.server.DefaultSystemMessagesProvider;
-import com.vaadin.flow.server.ServiceException;
-import com.vaadin.flow.server.SystemMessages;
-import com.vaadin.flow.server.SystemMessagesInfo;
-import com.vaadin.flow.server.SystemMessagesProvider;
-
-import org.apache.deltaspike.testcontrol.api.junit.CdiTestRunner;
-import org.junit.After;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-
 import javax.enterprise.context.spi.Context;
 import javax.enterprise.context.spi.CreationalContext;
+import javax.enterprise.event.Observes;
 import javax.enterprise.inject.AmbiguousResolutionException;
 import javax.enterprise.inject.spi.Bean;
 import javax.enterprise.inject.spi.BeanManager;
 import javax.inject.Inject;
+import javax.inject.Singleton;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Optional;
 import java.util.Set;
 
+import org.apache.deltaspike.testcontrol.api.junit.CdiTestRunner;
+import org.junit.After;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mockito;
+
+import com.vaadin.cdi.annotation.VaadinServiceEnabled;
+import com.vaadin.cdi.annotation.VaadinServiceScoped;
+import com.vaadin.cdi.context.ServiceUnderTestContext;
+import com.vaadin.flow.component.ComponentUtil;
+import com.vaadin.flow.component.PollEvent;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.di.Instantiator;
+import com.vaadin.flow.server.CustomizedSystemMessages;
+import com.vaadin.flow.server.DefaultSystemMessagesProvider;
+import com.vaadin.flow.server.ServiceException;
+import com.vaadin.flow.server.SystemMessages;
+import com.vaadin.flow.server.SystemMessagesInfo;
+import com.vaadin.flow.server.SystemMessagesProvider;
+import com.vaadin.flow.server.VaadinSession;
+
+import static com.vaadin.cdi.SerializationUtils.serializeAndDeserialize;
 import static org.hamcrest.CoreMatchers.instanceOf;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.assertEquals;
 import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.eq;
 import static org.mockito.Mockito.mock;
@@ -72,6 +81,15 @@ public SystemMessages getSystemMessages(
 
     }
 
+    @Singleton
+    public static class UIListenerEventReceiver {
+
+        private UI pollEventUI;
+        void onPollEvent(@Observes PollEvent pollEvent) {
+            pollEventUI = pollEvent.getSource();
+        }
+    }
+
     @Inject
     private BeanManager beanManager;
 
@@ -182,6 +200,25 @@ public void loadInstantiators_serviceInitialized_instantiatorInstanceCreated()
         assertEquals(mockInstantiator, maybeInstantiator.get());
     }
 
+    @Test
+    public void fireUIInitListeners_serialization_UIserializableAndListenersWork() throws Exception {
+        initService(beanManager);
+
+        UIListenerEventReceiver uiListenerEventReceiver = service.getInstantiator().getOrCreate(UIListenerEventReceiver.class);
+        UI ui = new UI();
+        ui.getInternals().setSession(Mockito.mock(VaadinSession.class, Mockito.withSettings().serializable()));
+        service.fireUIInitListeners(ui);
+
+        ComponentUtil.fireEvent(ui, new PollEvent(ui, false));
+        assertEquals(ui, uiListenerEventReceiver.pollEventUI);
+
+        UI ui2 = serializeAndDeserialize(ui);
+        assertNotNull(ui2);
+
+        ComponentUtil.fireEvent(ui2, new PollEvent(ui2, false));
+        assertEquals(ui2, uiListenerEventReceiver.pollEventUI);
+    }
+
     private void initService(BeanManager beanManager) throws ServiceException {
         ServiceUnderTestContext serviceUnderTestContext = new ServiceUnderTestContext(beanManager);
         serviceUnderTestContext.activate();

diff --git a/vaadin-cdi/src/test/java/com/vaadin/cdi/SerializationUtils.java b/vaadin-cdi/src/test/java/com/vaadin/cdi/SerializationUtils.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2000-2023 Vaadin Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.vaadin.cdi;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.ObjectInputStream;
+import java.io.ObjectOutputStream;
+import java.io.Serializable;
+
+public final class SerializationUtils {
+
+    private SerializationUtils() {
+    }
+
+    @SuppressWarnings("unchecked")
+    public static <S extends Serializable> S serializeAndDeserialize(S obj)
+            throws Exception {
+        // Serialize and deserialize
+        ByteArrayOutputStream bs = new ByteArrayOutputStream();
+        try (ObjectOutputStream out = new ObjectOutputStream(bs)) {
+            out.writeObject(obj);
+        }
+        byte[] data = bs.toByteArray();
+        try (ObjectInputStream in = new ObjectInputStream(
+                new ByteArrayInputStream(data))) {
+            return (S) in.readObject();
+        }
+    }
+
+}
diff --git a/vaadin-cdi/src/test/java/com/vaadin/cdi/context/RouteContextNormalTest.java b/vaadin-cdi/src/test/java/com/vaadin/cdi/context/RouteContextNormalTest.java
@@ -16,18 +16,27 @@
 
 package com.vaadin.cdi.context;
 
-import com.vaadin.cdi.annotation.NormalRouteScoped;
-import com.vaadin.flow.router.Route;
+import java.io.Serializable;
+
+import org.apache.deltaspike.core.api.provider.BeanProvider;
 import org.apache.deltaspike.testcontrol.api.junit.CdiTestRunner;
+import org.junit.Test;
 import org.junit.runner.RunWith;
 
+import com.vaadin.cdi.annotation.NormalRouteScoped;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.router.Route;
+
+import static com.vaadin.cdi.SerializationUtils.serializeAndDeserialize;
+import static org.junit.Assert.assertNotNull;
+
 @RunWith(CdiTestRunner.class)
 public class RouteContextNormalTest
         extends AbstractContextTest<RouteContextNormalTest.RouteScopedTestBean> {
 
     @NormalRouteScoped
     @Route("")
-    public static class RouteScopedTestBean extends TestBean {
+    public static class RouteScopedTestBean extends TestBean implements Serializable {
     }
 
     @Override
@@ -46,4 +55,14 @@ protected boolean isNormalScoped() {
         return true;
     }
 
+    @Test
+    public void activeContext_UISerializable() throws Exception {
+        UIUnderTestContext context = (UIUnderTestContext) createContext();
+        context.activate();
+        BeanProvider.getContextualReference(getBeanType());
+        UI ui = context.getUi();
+        UI ui2 = serializeAndDeserialize(ui);
+        assertNotNull(ui2);
+    }
+
 }
diff --git a/vaadin-cdi/src/test/java/com/vaadin/cdi/context/RouteContextPseudoTest.java b/vaadin-cdi/src/test/java/com/vaadin/cdi/context/RouteContextPseudoTest.java
@@ -16,18 +16,27 @@
 
 package com.vaadin.cdi.context;
 
-import com.vaadin.cdi.annotation.RouteScoped;
-import com.vaadin.flow.router.Route;
+import java.io.Serializable;
+
+import org.apache.deltaspike.core.api.provider.BeanProvider;
 import org.apache.deltaspike.testcontrol.api.junit.CdiTestRunner;
+import org.junit.Test;
 import org.junit.runner.RunWith;
 
+import com.vaadin.cdi.annotation.RouteScoped;
+import com.vaadin.flow.component.UI;
+import com.vaadin.flow.router.Route;
+
+import static com.vaadin.cdi.SerializationUtils.serializeAndDeserialize;
+import static org.junit.Assert.assertNotNull;
+
 @RunWith(CdiTestRunner.class)
 public class RouteContextPseudoTest
         extends AbstractContextTest<RouteContextPseudoTest.RouteScopedTestBean> {
 
     @RouteScoped
     @Route("")
-    public static class RouteScopedTestBean extends TestBean {
+    public static class RouteScopedTestBean extends TestBean implements Serializable {
     }
 
     @Override
@@ -46,4 +55,14 @@ protected boolean isNormalScoped() {
         return false;
     }
 
+    @Test
+    public void activeContext_UISerializable() throws Exception {
+        UIUnderTestContext context = (UIUnderTestContext) createContext();
+        context.activate();
+        BeanProvider.getContextualReference(getBeanType());
+        UI ui = context.getUi();
+        UI ui2 = serializeAndDeserialize(ui);
+        assertNotNull(ui2);
+    }
+
 }
diff --git a/vaadin-cdi/src/test/java/com/vaadin/cdi/context/SessionUnderTestContext.java b/vaadin-cdi/src/test/java/com/vaadin/cdi/context/SessionUnderTestContext.java
@@ -17,7 +17,6 @@
 package com.vaadin.cdi.context;
 
 import javax.enterprise.inject.spi.CDI;
-
 import java.util.Properties;
 
 import org.mockito.Mockito;
@@ -41,7 +40,7 @@ private void mockSession() {
             serviceUnderTestContext.activate();
         }
         session = Mockito.mock(TestSession.class,
-                Mockito.withSettings().useConstructor());
+                Mockito.withSettings().useConstructor().serializable());
         doCallRealMethod().when(session).setAttribute(Mockito.any(String.class),
                 Mockito.any());
         doCallRealMethod().when(session)
@@ -52,7 +51,7 @@ private void mockSession() {
 
         when(session.hasLock()).thenReturn(true);
         DeploymentConfiguration configuration = Mockito
-                .mock(DeploymentConfiguration.class);
+                .mock(DeploymentConfiguration.class, Mockito.withSettings().serializable());
         when(session.getConfiguration()).thenReturn(configuration);
         when(configuration.isBowerMode()).thenReturn(true);
         Properties props = new Properties();