-
Notifications
You must be signed in to change notification settings - Fork 746
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[GOBBLIN-236] Add a ControlMessage injector as a RecordStreamProcessor
Closes #2090 from htran1/control_message_injection
- Loading branch information
Showing
17 changed files
with
628 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
gobblin-api/src/main/java/org/apache/gobblin/metadata/GlobalMetadata.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * 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.gobblin.metadata; | ||
|
|
||
| import org.apache.gobblin.fork.CopyHelper; | ||
| import org.apache.gobblin.fork.CopyNotSupportedException; | ||
| import org.apache.gobblin.fork.Copyable; | ||
|
|
||
| import com.google.common.base.Optional; | ||
|
|
||
| import lombok.AccessLevel; | ||
| import lombok.AllArgsConstructor; | ||
| import lombok.Builder; | ||
| import lombok.EqualsAndHashCode; | ||
| import lombok.Getter; | ||
|
|
||
|
|
||
| /** | ||
| * Global metadata | ||
| * @param <S> schema type | ||
| */ | ||
| @AllArgsConstructor(access=AccessLevel.PRIVATE) | ||
| @EqualsAndHashCode | ||
| @Builder | ||
| public class GlobalMetadata<S> implements Copyable<GlobalMetadata<S>> { | ||
| @Getter | ||
| private S schema; | ||
|
|
||
| @Override | ||
| public GlobalMetadata<S> copy() throws CopyNotSupportedException { | ||
| if (CopyHelper.isCopyable(schema)) { | ||
| return new GlobalMetadata((S)CopyHelper.copy(schema)); | ||
| } | ||
|
|
||
| throw new CopyNotSupportedException("Type is not copyable: " + schema.getClass().getName()); | ||
| } | ||
|
|
||
| /** | ||
| * Builder that takes in an input {@GlobalMetadata} to use as a base. | ||
| * @param inputMetadata input metadata | ||
| * @param outputSchema output schema to set in the builder | ||
| * @param <SI> input schema type | ||
| * @param <SO> output schema type | ||
| * @return builder | ||
| */ | ||
| public static <SI, SO> GlobalMetadataBuilder<SO> builderWithInput(GlobalMetadata<SI> inputMetadata, Optional<SO> outputSchema) { | ||
| GlobalMetadataBuilder<SO> builder = (GlobalMetadataBuilder<SO>) builder(); | ||
|
|
||
| if (outputSchema.isPresent()) { | ||
| builder.schema(outputSchema.get()); | ||
| } | ||
|
|
||
| return builder; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
gobblin-api/src/main/java/org/apache/gobblin/stream/ControlMessageInjector.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| /* | ||
| * 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.gobblin.stream; | ||
|
|
||
| import java.io.Closeable; | ||
| import java.io.IOException; | ||
|
|
||
| import org.apache.gobblin.configuration.WorkUnitState; | ||
| import org.apache.gobblin.metadata.GlobalMetadata; | ||
| import org.apache.gobblin.records.ControlMessageHandler; | ||
| import org.apache.gobblin.records.RecordStreamProcessor; | ||
| import org.apache.gobblin.records.RecordStreamWithMetadata; | ||
|
|
||
| import io.reactivex.Flowable; | ||
|
|
||
| /** | ||
| * A {@link RecordStreamProcessor} that inspects an input record and outputs control messages before, after, or around | ||
| * the input record | ||
| * @param <SI> | ||
| * @param <DI> | ||
| */ | ||
| public abstract class ControlMessageInjector<SI, DI> implements Closeable, | ||
| RecordStreamProcessor<SI, SI, DI, DI> { | ||
|
|
||
| /** | ||
| * Initialize this {@link ControlMessageInjector}. | ||
| * | ||
| * @param workUnitState a {@link WorkUnitState} object carrying configuration properties | ||
| * @return an initialized {@link ControlMessageInjector} instance | ||
| */ | ||
| protected ControlMessageInjector<SI, DI> init(WorkUnitState workUnitState) { | ||
| return this; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() throws IOException { | ||
| } | ||
|
|
||
| /** | ||
| * Set the global metadata of the input messages. The base implementation is empty and should be overridden by | ||
| * the subclasses that need to store the input {@link GlobalMetadata} | ||
| * @param inputGlobalMetadata the global metadata for input messages | ||
| * @param workUnitState | ||
| */ | ||
| protected void setInputGlobalMetadata(GlobalMetadata<SI> inputGlobalMetadata, WorkUnitState workUnitState) { | ||
| } | ||
|
|
||
| /** | ||
| * Inject {@link ControlMessage}s before the record | ||
| * @param inputRecordEnvelope | ||
| * @param workUnitState | ||
| * @return The {@link ControlMessage}s to inject before the record | ||
| */ | ||
| protected abstract Iterable<ControlMessage<DI>> injectControlMessagesBefore(RecordEnvelope<DI> inputRecordEnvelope, | ||
| WorkUnitState workUnitState); | ||
|
|
||
| /** | ||
| * Inject {@link ControlMessage}s after the record | ||
| * @param inputRecordEnvelope | ||
| * @param workUnitState | ||
| * @return The {@link ControlMessage}s to inject after the record | ||
| */ | ||
| protected abstract Iterable<ControlMessage<DI>> injectControlMessagesAfter(RecordEnvelope<DI> inputRecordEnvelope, | ||
| WorkUnitState workUnitState); | ||
|
|
||
| /** | ||
| * Apply injections to the input {@link RecordStreamWithMetadata}. | ||
| * {@link ControlMessage}s may be injected before, after, or around the input record. | ||
| * A {@link MetadataUpdateControlMessage} will update the current input {@link GlobalMetadata} and pass the | ||
| * updated input {@link GlobalMetadata} to the next processor to propagate the metadata update down the pipeline. | ||
| */ | ||
| @Override | ||
| public RecordStreamWithMetadata<DI, SI> processStream(RecordStreamWithMetadata<DI, SI> inputStream, | ||
| WorkUnitState workUnitState) throws StreamProcessingException { | ||
| init(workUnitState); | ||
|
|
||
| setInputGlobalMetadata(inputStream.getGlobalMetadata(), workUnitState); | ||
|
|
||
| Flowable<StreamEntity<DI>> outputStream = | ||
| inputStream.getRecordStream() | ||
| .flatMap(in -> { | ||
| if (in instanceof ControlMessage) { | ||
| if (in instanceof MetadataUpdateControlMessage) { | ||
| setInputGlobalMetadata(((MetadataUpdateControlMessage) in).getGlobalMetadata(), workUnitState); | ||
| } | ||
|
|
||
| getMessageHandler().handleMessage((ControlMessage) in); | ||
| return Flowable.just(in); | ||
| } else if (in instanceof RecordEnvelope) { | ||
| RecordEnvelope<DI> recordEnvelope = (RecordEnvelope<DI>) in; | ||
| Iterable<ControlMessage<DI>> injectedBeforeIterable = | ||
| injectControlMessagesBefore(recordEnvelope, workUnitState); | ||
| Iterable<ControlMessage<DI>> injectedAfterIterable = | ||
| injectControlMessagesAfter(recordEnvelope, workUnitState); | ||
|
|
||
| if (injectedBeforeIterable == null && injectedAfterIterable == null) { | ||
| // nothing injected so return the record envelope | ||
| return Flowable.just(recordEnvelope); | ||
| } else { | ||
| Flowable<StreamEntity<DI>> flowable; | ||
|
|
||
| if (injectedBeforeIterable != null) { | ||
| flowable = Flowable.<StreamEntity<DI>>fromIterable(injectedBeforeIterable) | ||
| .concatWith(Flowable.just(recordEnvelope)); | ||
| } else { | ||
| flowable = Flowable.just(recordEnvelope); | ||
| } | ||
|
|
||
| if (injectedAfterIterable != null) { | ||
| flowable.concatWith(Flowable.fromIterable(injectedAfterIterable)); | ||
| } | ||
| return flowable; | ||
| } | ||
| } else { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
| }, 1); | ||
| outputStream = outputStream.doOnComplete(this::close); | ||
| return inputStream.withRecordStream(outputStream, inputStream.getGlobalMetadata()); | ||
| } | ||
|
|
||
| /** | ||
| * @return {@link ControlMessageHandler} to call for each {@link ControlMessage} received. | ||
| */ | ||
| protected ControlMessageHandler getMessageHandler() { | ||
| return ControlMessageHandler.NOOP; | ||
| } | ||
| } |
Oops, something went wrong.