Skip to content

Commit

Permalink
feat(#3280): Add support for pipeline templates (#3281)
Browse files Browse the repository at this point in the history
* feat(#3266): Add API to programmatically create pipelines

* Fix checkstyle

* feat(#3280): Add support for pipeline templates

* Fix validation

* Remove obsolete stylesheet

* Fix dependency

* Add default template to setup

* feat(#3292): Show adapter and pipeline configuration in UI (#3293)

* feat(#3292): Add code tab to adapter view

* Show pipeline code in UI

* Add header

* Fix checkstyle

* Fix checkstyle

* Fix template visitor

* Remove empty css class
  • Loading branch information
dominikriemer authored Oct 11, 2024
1 parent 59773aa commit 359b863
Show file tree
Hide file tree
Showing 94 changed files with 2,435 additions and 1,364 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,72 +18,93 @@

package org.apache.streampipes.connect.management.compact;

import org.apache.streampipes.manager.template.PipelineTemplateManagement;
import org.apache.streampipes.manager.pipeline.PipelineManager;
import org.apache.streampipes.manager.pipeline.compact.CompactPipelineManagement;
import org.apache.streampipes.model.connect.adapter.AdapterDescription;
import org.apache.streampipes.model.connect.adapter.compact.CreateOptions;
import org.apache.streampipes.model.pipeline.PipelineOperationStatus;
import org.apache.streampipes.model.pipeline.compact.CompactPipeline;
import org.apache.streampipes.model.pipeline.compact.CompactPipelineElement;
import org.apache.streampipes.model.schema.EventProperty;
import org.apache.streampipes.model.schema.EventPropertyPrimitive;
import org.apache.streampipes.model.staticproperty.FreeTextStaticProperty;
import org.apache.streampipes.model.staticproperty.MappingPropertyUnary;
import org.apache.streampipes.model.staticproperty.OneOfStaticProperty;
import org.apache.streampipes.model.template.PipelineTemplateInvocation;
import org.apache.streampipes.model.schema.PropertyScope;
import org.apache.streampipes.model.template.CompactPipelineTemplate;
import org.apache.streampipes.storage.api.CRUDStorage;
import org.apache.streampipes.vocabulary.SO;

public class PersistPipelineHandler {
import java.util.List;
import java.util.Map;

import static org.apache.streampipes.manager.template.instances.PersistDataLakePipelineTemplate.DATA_LAKE_CONNECTOR_ID;
import static org.apache.streampipes.manager.template.instances.PersistDataLakePipelineTemplate.DATA_LAKE_DIMENSIONS_FIELD;
import static org.apache.streampipes.manager.template.instances.PersistDataLakePipelineTemplate.DATA_LAKE_MEASUREMENT_FIELD;
import static org.apache.streampipes.manager.template.instances.PersistDataLakePipelineTemplate.DATA_LAKE_TEMPLATE_ID;
import static org.apache.streampipes.manager.template.instances.PersistDataLakePipelineTemplate.DATA_LAKE_TIMESTAMP_FIELD;

private static final String templateId = "org.apache.streampipes.manager.template.instances.DataLakePipelineTemplate";
private static final String configPrefix = "jsplumb_domId2";
public class PersistPipelineHandler {

private final PipelineTemplateManagement pipelineTemplateManagement;
private final CRUDStorage<CompactPipelineTemplate> templateStorage;
private final CompactPipelineManagement pipelineManagement;
private final String authenticatedUserSid;

public PersistPipelineHandler(PipelineTemplateManagement pipelineTemplateManagement,
public PersistPipelineHandler(CRUDStorage<CompactPipelineTemplate> templateStorage,
CompactPipelineManagement pipelineManagement,
String authenticatedUserSid) {
this.pipelineTemplateManagement = pipelineTemplateManagement;
this.templateStorage = templateStorage;
this.pipelineManagement = pipelineManagement;
this.authenticatedUserSid = authenticatedUserSid;
}

public PipelineOperationStatus createAndStartPersistPipeline(AdapterDescription adapterDescription) {
var pipelineTemplateInvocation = pipelineTemplateManagement.prepareInvocation(
adapterDescription.getCorrespondingDataStreamElementId(),
templateId
);

applyPipelineName(pipelineTemplateInvocation, adapterDescription.getName());
applyDataLakeConfig(pipelineTemplateInvocation, adapterDescription);

return pipelineTemplateManagement.createAndStartPipeline(pipelineTemplateInvocation, authenticatedUserSid);
public PipelineOperationStatus createAndStartPersistPipeline(AdapterDescription adapterDescription) throws Exception {
var template = getTemplate();
if (template != null) {
var compactPipeline = new CompactPipeline(
String.format("persist-%s", adapterDescription.getName().replaceAll(" ", "-")),
String.format("Persist %s", adapterDescription.getName()),
null,
makeTemplateConfig(adapterDescription, template.getPipeline()),
new CreateOptions(false, true)
);
var pipelineGenerationResult = pipelineManagement.makePipeline(compactPipeline);
if (pipelineGenerationResult.allPipelineElementsValid()) {
String pipelineId = PipelineManager.addPipeline(authenticatedUserSid, pipelineGenerationResult.pipeline());
if (compactPipeline.createOptions().start()) {
return PipelineManager.startPipeline(pipelineId);
}
}
}
throw new IllegalArgumentException("Could not start persist pipeline");
}

private void applyPipelineName(PipelineTemplateInvocation pipelineTemplateInvocation,
String adapterName) {
pipelineTemplateInvocation.setPipelineTemplateId(templateId);
pipelineTemplateInvocation.setKviName(adapterName);
private CompactPipelineTemplate getTemplate() {
return this.templateStorage.getElementById(DATA_LAKE_TEMPLATE_ID);
}

private void applyDataLakeConfig(PipelineTemplateInvocation pipelineTemplateInvocation,
AdapterDescription adapterDescription) {
pipelineTemplateInvocation.getStaticProperties().forEach(sp -> {
if (sp.getInternalName().equalsIgnoreCase(withPrefix("db_measurement"))) {
((FreeTextStaticProperty) sp).setValue(adapterDescription.getName());
}
if (sp.getInternalName().equalsIgnoreCase(withPrefix("timestamp_mapping"))) {
((MappingPropertyUnary) sp).setSelectedProperty(
String.format("s0::%s", getTimestampField(adapterDescription)
));
}
if (sp.getInternalName().equalsIgnoreCase(withPrefix("schema_update"))) {
((OneOfStaticProperty) sp).getOptions().forEach(o -> {
if (o.getName().equals("Update schema")) {
o.setSelected(true);
}
});
}
});
private List<CompactPipelineElement> makeTemplateConfig(AdapterDescription adapterDescription,
List<CompactPipelineElement> pipelineElements) {
pipelineElements.get(0).configuration().addAll(
List.of(
Map.of(DATA_LAKE_MEASUREMENT_FIELD, adapterDescription.getName()),
Map.of(DATA_LAKE_TIMESTAMP_FIELD, String.format("s0::%s", getTimestampField(adapterDescription))),
Map.of(DATA_LAKE_DIMENSIONS_FIELD, getDimensions(adapterDescription))
)
);
pipelineElements.add(new CompactPipelineElement(
"stream",
DATA_LAKE_CONNECTOR_ID,
adapterDescription.getCorrespondingDataStreamElementId(),
null,
null
));
return pipelineElements;
}

private String withPrefix(String config) {
return configPrefix + config;
private List<String> getDimensions(AdapterDescription adapterDescription) {
return adapterDescription.getEventSchema().getEventProperties()
.stream()
.filter(ep -> ep.getPropertyScope().equalsIgnoreCase(PropertyScope.DIMENSION_PROPERTY.name()))
.map(EventProperty::getRuntimeName)
.toList();
}

private String getTimestampField(AdapterDescription adapterDescription) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@

public class AdapterEnrichmentRuleGenerator implements AdapterModelGenerator {

public static final String TIMESTAMP_FIELD = "timestamp";

@Override
public void apply(AdapterDescription adapterDescription,
CompactAdapter compactAdapter) throws Exception {
Expand All @@ -33,7 +35,7 @@ public void apply(AdapterDescription adapterDescription,
var timestampRule = new AddTimestampRuleDescription(compactAdapter.enrich().timestamp());
adapterDescription.getRules().add(timestampRule);
adapterDescription.getEventSchema().addEventProperty(
EpProperties.timestampProperty("timestamp")
EpProperties.timestampProperty(TIMESTAMP_FIELD)
);
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.streampipes.connect.management.compact.generator;

import org.apache.streampipes.connect.shared.preprocessing.convert.ToOriginalSchemaConverter;
import org.apache.streampipes.manager.template.CompactConfigGenerator;
import org.apache.streampipes.model.connect.adapter.AdapterDescription;
import org.apache.streampipes.model.connect.adapter.compact.CompactEventProperty;
import org.apache.streampipes.model.connect.adapter.compact.CreateOptions;
import org.apache.streampipes.model.connect.adapter.compact.EnrichmentConfig;
import org.apache.streampipes.model.connect.adapter.compact.TransformationConfig;
import org.apache.streampipes.model.connect.rules.TransformationRuleDescription;
import org.apache.streampipes.model.connect.rules.schema.RenameRuleDescription;
import org.apache.streampipes.model.connect.rules.value.AddTimestampRuleDescription;
import org.apache.streampipes.model.connect.rules.value.UnitTransformRuleDescription;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class CompactAdapterGenerator {

private final AdapterDescription adapterDescription;

public CompactAdapterGenerator(AdapterDescription adapterDescription) {
this.adapterDescription = adapterDescription;
}

public List<Map<String, Object>> getConfig() {
var configs = new ArrayList<Map<String, Object>>();
adapterDescription.getConfig().forEach(c -> {
configs.add(new CompactConfigGenerator(c).toTemplateValue());
});
return configs;
}

public Map<String, CompactEventProperty> getSchema() {
var map = new HashMap<String, CompactEventProperty>();
var originalProperties = new ToOriginalSchemaConverter(
adapterDescription.getEventSchema().getEventProperties()
).getTransformedProperties();
originalProperties
.forEach(ep -> map.put(ep.getRuntimeName(), new CompactEventProperty(
ep.getLabel(),
ep.getDescription(),
ep.getPropertyScope(),
ep.getSemanticType()
)));
return map;
}

public EnrichmentConfig getEnrichmentConfig() {
if (hasTimestampEnrichmentRule()) {
return new EnrichmentConfig(AdapterEnrichmentRuleGenerator.TIMESTAMP_FIELD);
} else {
return null;
}
}

public TransformationConfig getTransformationConfig() {
var renameRules = new HashMap<String, String>();
var unitTransformRules = new HashMap<String, String>();
if (hasTransformationRule()) {
if (hasRule(RenameRuleDescription.class)) {
var rules = getRules(RenameRuleDescription.class);
rules.forEach(rule -> {
renameRules.put(rule.getOldRuntimeKey(), rule.getNewRuntimeKey());
});
} else if (hasRule(UnitTransformRuleDescription.class)) {
var rules = getRules(UnitTransformRuleDescription.class);
rules.forEach(rule -> {
unitTransformRules.put(rule.getRuntimeKey(), rule.getToUnitRessourceURL());
});
}
}
return new TransformationConfig(renameRules, unitTransformRules);
}

public CreateOptions getCreateOptions() {
return new CreateOptions(
true,
true
);
}

private boolean hasTimestampEnrichmentRule() {
return hasRule(AddTimestampRuleDescription.class);
}

private boolean hasTransformationRule() {
return adapterDescription.getRules().stream()
.anyMatch(r -> hasRule(RenameRuleDescription.class) || hasRule(UnitTransformRuleDescription.class));
}

private boolean hasRule(Class<? extends TransformationRuleDescription> rule) {
return adapterDescription.getRules().stream().anyMatch(r -> r.getClass().equals(rule));
}

private <T extends TransformationRuleDescription> List<T> getRules(Class<T> rule) {
return adapterDescription.getRules()
.stream()
.filter(rule::isInstance)
.map(rule::cast)
.toList();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
package org.apache.streampipes.connect.management.management;

import org.apache.streampipes.connect.management.compact.generator.AdapterModelGenerator;
import org.apache.streampipes.connect.management.compact.generator.CompactAdapterGenerator;
import org.apache.streampipes.model.connect.adapter.AdapterDescription;
import org.apache.streampipes.model.connect.adapter.compact.CompactAdapter;
import org.apache.streampipes.storage.api.IAdapterStorage;
Expand All @@ -45,6 +46,22 @@ public AdapterDescription convertToAdapterDescription(CompactAdapter compactAdap
return adapterDescription;
}

public CompactAdapter convertToCompactAdapter(AdapterDescription adapterDescription) throws Exception {
var generator = new CompactAdapterGenerator(adapterDescription);

return new CompactAdapter(
adapterDescription.getElementId(),
adapterDescription.getName(),
adapterDescription.getDescription(),
adapterDescription.getAppId(),
generator.getConfig(),
generator.getSchema(),
generator.getEnrichmentConfig(),
generator.getTransformationConfig(),
generator.getCreateOptions()
);
}

public AdapterDescription convertToAdapterDescription(CompactAdapter compactAdapter,
AdapterDescription existingAdapter) throws Exception {
var adapterDescription = convertToAdapterDescription(compactAdapter);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@

package org.apache.streampipes.model.connect.adapter.compact;

import org.apache.streampipes.model.shared.annotation.TsModel;

import java.util.List;
import java.util.Map;

@TsModel
public record CompactAdapter(
String id,
String name,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

package org.apache.streampipes.model.connect.adapter.compact;

import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public record CompactEventProperty(
String label,
String description,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@

package org.apache.streampipes.model.connect.adapter.compact;

public record CreateOptions(boolean persist,
boolean start) {
import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public record CreateOptions(Boolean persist,
Boolean start) {
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,11 @@
package org.apache.streampipes.model.pipeline.compact;

import org.apache.streampipes.model.connect.adapter.compact.CreateOptions;
import org.apache.streampipes.model.shared.annotation.TsModel;

import java.util.List;

@TsModel
public record CompactPipeline(
String id,
String name,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@

package org.apache.streampipes.model.pipeline.compact;

import com.fasterxml.jackson.annotation.JsonInclude;

import java.util.List;
import java.util.Map;

@JsonInclude(JsonInclude.Include.NON_NULL)
public record CompactPipelineElement(String type,
String ref,
String id,
Expand Down
Loading

0 comments on commit 359b863

Please sign in to comment.