Implemented a definitive list that includes unsupported data types

Author: JohannesRabauer

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/exceptions/DataTypeNotSupportedException.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright © 2023 XDEV Software (https://xdev.software)
+ *
+ * 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 software.xdev.spring.data.eclipse.store.exceptions;
+
+import software.xdev.spring.data.eclipse.store.util.StringUtil;
+
+
+public class DataTypeNotSupportedException extends RuntimeException
+{
+	public DataTypeNotSupportedException(final String message)
+	{
+		super(message);
+	}
+	
+	public DataTypeNotSupportedException(final Class<?> clazz)
+	{
+		this(
+			String.format(
+				"Datatype %s is not supported right now. Please open a ticket at %s if you feel that this type should "
+					+ "be supported.",
+				clazz.getSimpleName(),
+				StringUtil.REPOSITORY_URL
+			)
+		);
+	}
+}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/importer/EclipseStoreDataImporter.java

@@ -30,6 +30,7 @@
 import org.slf4j.LoggerFactory;
 
 import software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage;
+import software.xdev.spring.data.eclipse.store.repository.SupportedChecker;
 import software.xdev.spring.data.eclipse.store.repository.support.SimpleEclipseStoreRepository;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.working.RecursiveWorkingCopier;
 
@@ -201,7 +202,8 @@ private <T> void createRepositoryForType(
 				domainClass,
 				this.eclipseStoreStorage.getRegistry(),
 				this.eclipseStoreStorage,
-				this.eclipseStoreStorage),
+				this.eclipseStoreStorage,
+				new SupportedChecker.Implementation()),
 			domainClass);
 	}
 

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/PersistableChecker.java

@@ -15,8 +15,16 @@
  */
 package software.xdev.spring.data.eclipse.store.repository;
 
+/**
+ * Checks if a class is persistable by EclipseStore through the
+ * {@link org.eclipse.store.storage.embedded.types.EmbeddedStorage}.
+ */
 @FunctionalInterface
 public interface PersistableChecker
 {
+	/**
+	 * Checks if a class is persistable by EclipseStore through the
+	 * {@link org.eclipse.store.storage.embedded.types.EmbeddedStorage}.
+	 */
 	boolean isPersistable(Class<?> clazz);
 }

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/SupportedChecker.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright © 2023 XDEV Software (https://xdev.software)
+ *
+ * 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 software.xdev.spring.data.eclipse.store.repository;
+
+import java.util.Calendar;
+import java.util.EnumMap;
+import java.util.List;
+import java.util.WeakHashMap;
+
+import org.eclipse.serializer.reference.Lazy;
+
+
+/**
+ * Checks if a class is supported by the Spring-Data-Eclipse-Store library.
+ * <p>
+ * Some classes are not supported, because Eclipse Store doesn't support them.
+ * </p>
+ * <p>
+ * {@link Lazy} is not supported, because a lot of hidden stuff must be done to keep Lazy-References really Lazy when
+ * creating a working copy.
+ * </p>
+ */
+@FunctionalInterface
+public interface SupportedChecker
+{
+	/**
+	 * Checks if a class is supported by the Spring-Data-Eclipse-Store library.
+	 * <p>
+	 * Some classes are not supported, because Eclipse Store doesn't support them.
+	 * </p>
+	 * <p>
+	 * {@link Lazy} is not supported, because a lot of hidden stuff must be done to keep Lazy-References really Lazy
+	 * when creating a working copy.
+	 * </p>
+	 */
+	boolean isSupported(Class<?> clazz);
+	
+	class Implementation implements SupportedChecker
+	{
+		private static final List<Class<?>> UNSUPPORTED_DATA_TYPES = List.of(
+			// Is difficult to handle when creating working copies
+			Lazy.class,
+			// Here EclipseStore has problems: https://github.com/microstream-one/microstream/issues/173
+			Calendar.class,
+			WeakHashMap.class,
+			// Here EclipseStore has problems too: https://github.com/microstream-one/microstream/issues/204
+			EnumMap.class
+		);
+		
+		@Override
+		public boolean isSupported(final Class<?> clazz)
+		{
+			return !UNSUPPORTED_DATA_TYPES.stream().anyMatch(
+				unsupportedClazz -> unsupportedClazz.isAssignableFrom(clazz)
+			);
+		}
+	}
+}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/EclipseStoreRepositoryFactory.java

@@ -32,6 +32,7 @@
 import org.springframework.lang.Nullable;
 
 import software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage;
+import software.xdev.spring.data.eclipse.store.repository.SupportedChecker;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.working.RecursiveWorkingCopier;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.working.WorkingCopier;
 
@@ -80,7 +81,13 @@ private <T> WorkingCopier<T> createWorkingCopier(
 		final Class<T> domainType,
 		final EclipseStoreStorage storage)
 	{
-		return new RecursiveWorkingCopier<>(domainType, storage.getRegistry(), storage, storage);
+		return new RecursiveWorkingCopier<>(
+			domainType,
+			storage.getRegistry(),
+			storage,
+			storage,
+			new SupportedChecker.Implementation()
+		);
 	}
 
 	@Override

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/copier/object/EclipseSerializerRegisteringCopier.java

@@ -32,6 +32,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import software.xdev.spring.data.eclipse.store.exceptions.DataTypeNotSupportedException;
+import software.xdev.spring.data.eclipse.store.repository.SupportedChecker;
 import software.xdev.spring.data.eclipse.store.repository.WorkingCopyRegistry;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.DataTypeUtil;
 
@@ -45,16 +47,20 @@ public class EclipseSerializerRegisteringCopier implements RegisteringObjectCopi
 	private static final Logger LOG = LoggerFactory.getLogger(EclipseSerializerRegisteringCopier.class);
 	private final SerializerFoundation<?> foundation;
 	private PersistenceManager<Binary> persistenceManager;
+	private final SupportedChecker supportedChecker;
 
 	private final WorkingCopyRegistry registry;
 
-	public EclipseSerializerRegisteringCopier(final WorkingCopyRegistry registry)
+	public EclipseSerializerRegisteringCopier(
+		final WorkingCopyRegistry registry,
+		final SupportedChecker supportedChecker)
 	{
 		final SerializerFoundation<?> newFoundation = SerializerFoundation.New();
 		newFoundation.registerCustomTypeHandler(BinaryHandlerImmutableCollectionsSet12.New());
 		newFoundation.registerCustomTypeHandler(BinaryHandlerImmutableCollectionsList12.New());
 		this.foundation = newFoundation;
 		this.registry = registry;
+		this.supportedChecker = supportedChecker;
 	}
 
 	@Override
@@ -134,6 +140,10 @@ public synchronized <T> T copy(final T source, final boolean invertRegistering)
 		loader.iterateEntries(
 			(id, copiedObject) ->
 			{
+				if(copiedObject != null && !this.supportedChecker.isSupported(copiedObject.getClass()))
+				{
+					throw new DataTypeNotSupportedException(copiedObject.getClass());
+				}
 				summarizer.incrementCopiedObjectsCount();
 				if(DataTypeUtil.isPrimitiveType(copiedObject.getClass()))
 				{

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/copier/working/RecursiveWorkingCopier.java

@@ -33,6 +33,7 @@
 import software.xdev.spring.data.eclipse.store.exceptions.MergeFailedException;
 import software.xdev.spring.data.eclipse.store.repository.IdSetterProvider;
 import software.xdev.spring.data.eclipse.store.repository.PersistableChecker;
+import software.xdev.spring.data.eclipse.store.repository.SupportedChecker;
 import software.xdev.spring.data.eclipse.store.repository.WorkingCopyRegistry;
 import software.xdev.spring.data.eclipse.store.repository.access.AccessHelper;
 import software.xdev.spring.data.eclipse.store.repository.access.modifier.FieldAccessModifier;
@@ -57,11 +58,12 @@ public RecursiveWorkingCopier(
 		final Class<T> domainClass,
 		final WorkingCopyRegistry registry,
 		final IdSetterProvider idSetterProvider,
-		final PersistableChecker persistableChecker)
+		final PersistableChecker persistableChecker,
+		final SupportedChecker supportedChecker)
 	{
 		this.domainClass = domainClass;
 		this.registry = registry;
-		this.objectCopier = new EclipseSerializerRegisteringCopier(registry);
+		this.objectCopier = new EclipseSerializerRegisteringCopier(registry, supportedChecker);
 		this.idSetterProvider = idSetterProvider;
 		this.persistableChecker = persistableChecker;
 	}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/util/StringUtil.java

@@ -22,6 +22,8 @@
 
 public final class StringUtil
 {
+	public static final String REPOSITORY_URL = "https://github.com/xdev-software/spring-data-eclipse-store";
+	
 	private StringUtil()
 	{
 	}

spring-data-eclipse-store/src/test/java/software/xdev/spring/data/eclipse/store/integration/isolated/tests/special/types/TypesData.java

@@ -44,6 +44,7 @@
 import java.util.function.Function;
 import java.util.stream.Stream;
 
+import org.eclipse.serializer.reference.Lazy;
 import org.junit.jupiter.params.provider.Arguments;
 
 import software.xdev.spring.data.eclipse.store.repository.interfaces.EclipseStoreRepository;
@@ -382,21 +383,25 @@ public static Stream<Arguments> generateData()
 		).toArguments();
 	}
 
+	/**
+	 * Should be identical to
+	 * {@link
+	 * software.xdev.spring.data.eclipse.store.repository.SupportedChecker.Implementation#UNSUPPORTED_DATA_TYPES}
+	 */
 	public static Stream<Arguments> generateNotWorkingData()
 	{
 		return new ListOfTestArguments(
 			List.of(
 				new TestArguments<>(
 					LazyRepository.class,
-					id -> new LazyDaoObject(id, org.eclipse.serializer.reference.Lazy.Reference("1")),
-					object -> object.setValue(org.eclipse.serializer.reference.Lazy.Reference("2"))
+					id -> new LazyDaoObject(id, Lazy.Reference("1")),
+					object -> object.setValue(Lazy.Reference("2"))
 				),
 				new TestArguments<>(
 					LazyRepository.class,
-					id -> new LazyDaoObject(id, org.eclipse.serializer.reference.Lazy.Reference("1")),
+					id -> new LazyDaoObject(id, Lazy.Reference("1")),
 					object -> object.getValue().clear()
 				),
-				// Here EclipseStore has problems too: https://github.com/microstream-one/microstream/issues/204
 				new TestArguments<>(
 					EnumMapRepository.class,
 					id -> new EnumMapDaoObject(id, new EnumMap<>(EnumMapDaoObject.Album.class)),
@@ -427,7 +432,6 @@ public static Stream<Arguments> generateNotWorkingData()
 					id -> new MapDaoObject(id, new WeakHashMap<>(Map.of("1", "1", "2", "2"))),
 					set -> set.getValue().put("3", "3")
 				),
-				// Here EclipseStore has problems: https://github.com/microstream-one/microstream/issues/173
 				new TestArguments<>(
 					CalendarRepository.class,
 					id -> new CalendarDaoObject(id, Calendar.getInstance()),

spring-data-eclipse-store/src/test/java/software/xdev/spring/data/eclipse/store/integration/isolated/tests/special/types/TypesTest.java

@@ -28,6 +28,7 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.test.context.TestPropertySource;
 
+import software.xdev.spring.data.eclipse.store.exceptions.DataTypeNotSupportedException;
 import software.xdev.spring.data.eclipse.store.helper.TestUtil;
 import software.xdev.spring.data.eclipse.store.integration.isolated.tests.IsolatedTestAnnotations;
 import software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage;
@@ -78,7 +79,7 @@ <T extends ComplexObject<?>> void simpleStoreAndReadForNotWorkingTypes(
 		@Autowired final ApplicationContext context)
 	{
 		Assertions.assertThrows(
-			Exception.class,
+			DataTypeNotSupportedException.class,
 			() -> this.simpleChangeAfterStore(repositoryClass, objectCreator, ignoredObjectChanger, context));
 	}