[GOBBLIN-236] Add a ControlMessage injector as a RecordStreamProcessor #2090
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
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; | ||
|
|
||
|
There was a problem hiding this comment. It would be good to provide more functional methods: /** Generate a copy of this object with a new schema. */
public GlobalMetadata<S> withSchema(S newSchema);That way, when we add new attributes to There was a problem hiding this comment. Okay, added a builder. |
||
| @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
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,154 @@ | ||
| /* | ||
| * 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; | ||
| import lombok.AccessLevel; | ||
| import lombok.Getter; | ||
| import lombok.Setter; | ||
|
|
||
| /** | ||
| * 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> { | ||
|
|
||
| @Setter(AccessLevel.PROTECTED) | ||
| @Getter(AccessLevel.PROTECTED) | ||
| private GlobalMetadata<SI> inputGlobalMetadata; | ||
|
|
||
| /** | ||
| * 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 | ||
| * @param inputGlobalMetadata the global metadata for input messages | ||
| * @param workUnitState | ||
| */ | ||
| protected void setInputGlobalMetadata(GlobalMetadata<SI> inputGlobalMetadata, WorkUnitState workUnitState) { | ||
| this.inputGlobalMetadata = inputGlobalMetadata; | ||
| } | ||
|
|
||
| /** | ||
| * 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) { | ||
| ControlMessage out = (ControlMessage) in; | ||
| if (in instanceof MetadataUpdateControlMessage) { | ||
| setInputGlobalMetadata(((MetadataUpdateControlMessage) in).getGlobalMetadata(), | ||
| workUnitState); | ||
| out = new MetadataUpdateControlMessage<SI, DI>(this.inputGlobalMetadata); | ||
|
There was a problem hiding this comment. Why do you need a new output message? It seems to be identical to the input message. There was a problem hiding this comment. setInputGlobalMetadata() can set this.inputGlobalMetadata to something other than the input metadata. There was a problem hiding this comment. Removed inputGlobalMetadata from this class so that there is no confusion over the propagation of metadata. A |
||
| } | ||
|
|
||
| getMessageHandler().handleMessage((ControlMessage) in); | ||
| return Flowable.just(((ControlMessage<DI>) out)); | ||
|
|
||
| } 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, this.inputGlobalMetadata); | ||
| } | ||
|
|
||
| /** | ||
| * @return {@link ControlMessageHandler} to call for each {@link ControlMessage} received. | ||
| */ | ||
| protected ControlMessageHandler getMessageHandler() { | ||
| return ControlMessageHandler.NOOP; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this be
GlobalMetadata.builderWithInput(in.getMetadata, Optional.of...)? (instead ofinputStream)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently there are no other fields, so it either works. The original idea was to start with the inputStream GlobalMetadata and then overlay from
in. But I think the suggestion of usingin.getGlobalMetadata()is good since the copy will be handled inbuilderWithInput.