com.regnosys.rosetta.common.translation.MappingProcessorStep Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rosetta-common Show documentation
Show all versions of rosetta-common Show documentation
Rune Common is a java library that is utilised by Rosetta Code Generators and models expressed in the Rosetta DSL.
package com.regnosys.rosetta.common.translation;
/*-
* ==============
* Rune Common
* ==============
* Copyright (C) 2018 - 2024 REGnosys
* ==============
* 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.
* ==============
*/
import com.google.common.base.Stopwatch;
import com.google.common.util.concurrent.Uninterruptibles;
import com.rosetta.lib.postprocess.PostProcessorReport;
import com.rosetta.model.lib.RosettaModelObject;
import com.rosetta.model.lib.RosettaModelObjectBuilder;
import com.rosetta.model.lib.path.RosettaPath;
import com.rosetta.model.lib.process.AttributeMeta;
import com.rosetta.model.lib.process.BuilderProcessor;
import com.rosetta.model.lib.process.PostProcessStep;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.*;
import java.util.concurrent.*;
@SuppressWarnings("unused") // Used in rosetta-translate
public class MappingProcessorStep implements PostProcessStep {
private static final Logger LOGGER = LoggerFactory.getLogger(MappingProcessorStep.class);
private final int mappingMaxTimeout;
private final List mappingDelegates;
private final ExecutorService executor;
private final List> invokedTasks;
private final MappingContext context;
public MappingProcessorStep(Collection mappingProcessors, MappingContext context) {
this.context = context;
this.mappingDelegates = new ArrayList<>(mappingProcessors);
this.mappingDelegates.sort(MAPPING_DELEGATE_COMPARATOR);
this.executor = context.getExecutor();
this.invokedTasks = context.getInvokedTasks();
this.mappingMaxTimeout = 3000;
}
public MappingProcessorStep(Collection mappingProcessors, MappingContext context, int mappingMaxTimeout) {
this.context = context;
this.mappingDelegates = new ArrayList<>(mappingProcessors);
this.mappingDelegates.sort(MAPPING_DELEGATE_COMPARATOR);
this.executor = context.getExecutor();
this.invokedTasks = context.getInvokedTasks();
this.mappingMaxTimeout = mappingMaxTimeout;
}
@Override
public Integer getPriority() {
return 1;
}
@Override
public String getName() {
return "Mapping Processor";
}
@Override
public PostProcessorReport runProcessStep(Class topClass, T instance) {
LOGGER.debug("About to run {} mappingDelegates", mappingDelegates.size());
Stopwatch stopwatch = Stopwatch.createStarted();
RosettaModelObjectBuilder builder = instance.toBuilder();
Future mappingsFuture = executor.submit(() -> {
RosettaPath path = RosettaPath.valueOf(topClass.getSimpleName());
for (MappingDelegate mapper : mappingDelegates) {
LOGGER.debug("Running mapper {} for model path {}", mapper.getClass().getSimpleName(), mapper.getModelPath());
MappingBuilderProcessor processor = new MappingBuilderProcessor(mapper);
processor.processRosetta(path, topClass, builder, null);
builder.process(path, processor);
}
// Mapper thread waits for invoked tasks to complete before continuing (subject to timeout before)
awaitCompletion(invokedTasks);
});
LOGGER.debug("Main thread waits for the mappers to complete before continuing");
try {
Uninterruptibles.getUninterruptibly(mappingsFuture, mappingMaxTimeout, TimeUnit.MILLISECONDS);
} catch (ExecutionException e1) {
LOGGER.error("Error running mapping processor", e1);
this.context.getMappingErrors().add("Error running mapping processors: " + e1.getMessage());
} catch (TimeoutException e1) {
LOGGER.error("Timeout running mapping processor");
this.context.getMappingErrors().add("Timeout running mapping processors");
}
LOGGER.info("Mappers completed in {}", stopwatch.stop());
LOGGER.debug("Shutdown mapper thread pool");
executor.shutdown();
try {
if (!executor.awaitTermination(200, TimeUnit.MILLISECONDS)) {
LOGGER.info("Failed to shutdown mapper executor in 200ms, force shutdown now");
executor.shutdownNow();
} else {
LOGGER.debug("All mapper threads terminated");
}
} catch (InterruptedException e) {
LOGGER.warn("Caught interrupted exception whilst running shutdownNow");
executor.shutdownNow();
}
// Nothing to return
return null;
}
private void awaitCompletion(List> invokedTasks) {
try {
CompletableFuture.allOf(invokedTasks.toArray(new CompletableFuture[0])).get();
} catch (InterruptedException e) {
LOGGER.debug("Interrupt during mapping invokedTasks", e);
} catch (ExecutionException e) {
throw new RuntimeException(e.getCause().getMessage(), e.getCause());
}
}
/**
* Sort by model path so mapping processors are invoked in a consistent logical order.
*/
private static class PathComparator implements Comparator {
@Override
public int compare(MappingDelegate o1, MappingDelegate o2) {
String path1 = o1.getModelPath().buildPath();
String path2 = o2.getModelPath().buildPath();
return o1.getModelPath().compareTo(o2.getModelPath());
}
}
// Sort by path, then if there's multiple mappers on the same path, sort by mapper name.
static final Comparator MAPPING_DELEGATE_COMPARATOR = new PathComparator().thenComparing(p -> p.getClass().getName());
/**
* Implements BuilderProcessor and delegates to the given MappingProcessor when the path matches.
*/
private static class MappingBuilderProcessor implements BuilderProcessor {
private final MappingDelegate delegate;
private final RosettaPath modelPath;
private final List synonymPaths;
MappingBuilderProcessor(MappingDelegate delegate) {
this.delegate = delegate;
this.modelPath = delegate.getModelPath();
this.synonymPaths = delegate.getSynonymPaths();
}
@Override
public boolean processRosetta(RosettaPath currentPath,
Class rosettaType,
RosettaModelObjectBuilder builder,
RosettaModelObjectBuilder parent,
AttributeMeta... meta) {
if (currentPath.equals(modelPath)) {
synonymPaths.forEach(p -> delegate.map(p, Optional.ofNullable(builder), parent));
}
return true;
}
@Override
public boolean processRosetta(RosettaPath currentPath,
Class rosettaType,
List builder,
RosettaModelObjectBuilder parent,
AttributeMeta... meta) {
if (currentPath.equals(modelPath)) {
synonymPaths.forEach(p -> delegate.map(p, Optional.ofNullable(builder).orElse(Collections.emptyList()), parent));
}
return true;
}
@Override
public void processBasic(RosettaPath currentPath, Class rosettaType, T instance, RosettaModelObjectBuilder parent, AttributeMeta... meta) {
if (currentPath.equals(modelPath)) {
synonymPaths.forEach(p -> delegate.mapBasic(p, Optional.ofNullable(instance), parent));
}
}
@Override
public void processBasic(RosettaPath currentPath, Class rosettaType, Collection instance, RosettaModelObjectBuilder parent, AttributeMeta... meta) {
if (currentPath.equals(modelPath)) {
synonymPaths.forEach(p -> delegate.mapBasic(p, Optional.ofNullable(instance).orElse(Collections.emptyList()), parent));
}
}
@Override
public BuilderProcessor.Report report() {
return null;
}
}
}