thiagotnunes commented on code in PR #17222: URL: https://github.com/apache/beam/pull/17222#discussion_r872070115
########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/spanner/changestreams/restriction/PartitionRestrictionTracker.java: ########## @@ -0,0 +1,171 @@ +/* + * 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.beam.sdk.io.gcp.spanner.changestreams.restriction; + +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.DONE; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.QUERY_CHANGE_STREAM; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.STOP; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.TimestampUtils.next; +import static org.apache.beam.vendor.guava.v26_0_jre.com.google.common.base.Preconditions.checkState; + +import com.google.cloud.Timestamp; +import java.math.BigDecimal; +import java.util.Optional; +import java.util.function.Supplier; +import org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker; +import org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker.HasProgress; +import org.apache.beam.sdk.transforms.splittabledofn.SplitResult; +import org.apache.beam.vendor.guava.v26_0_jre.com.google.common.annotations.VisibleForTesting; +import org.checkerframework.checker.nullness.qual.Nullable; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +// TODO: Add java docs +// TODO: Implement duration waiting for returning false on try claim +public class PartitionRestrictionTracker + extends RestrictionTracker<PartitionRestriction, PartitionPosition> implements HasProgress { + + private static final Logger LOG = LoggerFactory.getLogger(PartitionRestrictionTracker.class); + private final PartitionRestrictionSplitter splitter; + private final PartitionRestrictionClaimer claimer; + private final PartitionRestrictionProgressChecker progressChecker; + protected PartitionRestriction restriction; + private @Nullable PartitionPosition lastClaimedPosition; + protected Supplier<Timestamp> timeSupplier; + + public PartitionRestrictionTracker(PartitionRestriction restriction) { + this( + restriction, + new PartitionRestrictionSplitter(), + new PartitionRestrictionClaimer(), + new PartitionRestrictionProgressChecker()); + } + + PartitionRestrictionTracker( + PartitionRestriction restriction, + PartitionRestrictionSplitter splitter, + PartitionRestrictionClaimer claimer, + PartitionRestrictionProgressChecker progressChecker) { + this.splitter = splitter; + this.claimer = claimer; + this.restriction = restriction; + this.progressChecker = progressChecker; + this.timeSupplier = () -> Timestamp.now(); + } + + @VisibleForTesting + public void setTimeSupplier(Supplier<Timestamp> timeSupplier) { + this.timeSupplier = timeSupplier; + } + + @Override + public @Nullable SplitResult<PartitionRestriction> trySplit(double fractionOfRemainder) { + final SplitResult<PartitionRestriction> splitResult = + splitter.trySplit(fractionOfRemainder, lastClaimedPosition, restriction); + if (splitResult != null) { + PartitionRestriction restrictionFromSplit = + Optional.ofNullable(splitResult.getPrimary()).orElse(this.restriction); + this.restriction = restrictionFromSplit; + } + return splitResult; + } + + @Override + public boolean tryClaim(PartitionPosition position) { + final boolean canClaim = claimer.tryClaim(restriction, lastClaimedPosition, position); + + if (canClaim) { + this.lastClaimedPosition = position; + } + + return canClaim; + } + + @Override + public Progress getProgress() { + final String token = + Optional.ofNullable(restriction.getMetadata()) + .map(PartitionRestrictionMetadata::getPartitionToken) + .orElse(null); + BigDecimal end; + if (restriction.getEndTimestamp().compareTo(Timestamp.MAX_VALUE) == 0) { + // When the given end timestamp equals to Timestamp.MAX_VALUE, this means that + // the end timestamp is not specified which should be a streaming job. So we + // use now() as the end timestamp. + end = BigDecimal.valueOf(timeSupplier.get().getSeconds()); + } else { + end = BigDecimal.valueOf(restriction.getEndTimestamp().getSeconds()); + } + final Progress progress = progressChecker.getProgress(restriction, lastClaimedPosition, end); + LOG.debug("[" + token + "] Progress is " + progress); + return progress; + } + + @Override + public PartitionRestriction currentRestriction() { + return restriction; + } + + @Override + public void checkDone() throws IllegalStateException { + if (restriction.getMode() == STOP) { + return; + } + if (lastClaimedPosition != null) { + final PartitionMode currentMode = lastClaimedPosition.getMode(); + if (currentMode == QUERY_CHANGE_STREAM) { + // If the mode is QUERY_CHANGE_STREAM, and the end of the timestamp range wasn't attempted, + // throw an exception + final Timestamp nextPosition = next(lastClaimedPosition.getTimestamp().get()); + if (nextPosition.compareTo(restriction.getEndTimestamp()) < 0) { + throw new IllegalStateException( + String.format( + "Last attempted key was %s in range %s, claiming work in [%s, %s) was not" + + " attempted", + lastClaimedPosition.getTimestamp().get(), + restriction, + nextPosition, + restriction.getEndTimestamp())); + } Review Comment: Do I understand it correctly that for the modes != {STOP, QUERY_CHANGE_STREAM, DONE} we will always succeed if we claimed a position? ########## sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/spanner/changestreams/restriction/PartitionRestrictionProgressChecker.java: ########## @@ -0,0 +1,100 @@ +/* + * 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.beam.sdk.io.gcp.spanner.changestreams.restriction; + +import static java.math.MathContext.DECIMAL128; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.DONE; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.QUERY_CHANGE_STREAM; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.STOP; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.UPDATE_STATE; +import static org.apache.beam.sdk.io.gcp.spanner.changestreams.restriction.PartitionMode.WAIT_FOR_CHILD_PARTITIONS; + +import com.google.cloud.Timestamp; +import java.math.BigDecimal; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import org.apache.beam.sdk.transforms.splittabledofn.RestrictionTracker.Progress; +import org.checkerframework.checker.nullness.qual.Nullable; + +public class PartitionRestrictionProgressChecker { + + private static final BigDecimal TOTAL_MODE_TRANSITIONS = BigDecimal.valueOf(3L); + + /** + * Indicates how many mode transitions have been completed for the current mode. The transitions + * are as follows: * (1) QUERY_CHANGE_STREAM, (2) WAIT_FOR_CHILD_PARTITIONS, (3) FINISH_PARTITION, + * (4) WAIT_FOR_PARENT_PARTITIONS, (5) DELETE_PARTITION, (6) DONE. + * + * <p>This is used to calculate the units of work left, meaning that 1 transition = 1 unit of + * work. + */ + private final Map<PartitionMode, BigDecimal> modeToTransitionsCompleted; + + public PartitionRestrictionProgressChecker() { + modeToTransitionsCompleted = new HashMap<>(); + modeToTransitionsCompleted.put(UPDATE_STATE, BigDecimal.valueOf(0L)); + modeToTransitionsCompleted.put(QUERY_CHANGE_STREAM, BigDecimal.valueOf(1L)); + modeToTransitionsCompleted.put(WAIT_FOR_CHILD_PARTITIONS, BigDecimal.valueOf(2L)); + modeToTransitionsCompleted.put(DONE, BigDecimal.valueOf(3L)); + } + + public Progress getProgress( Review Comment: Ah, you are doing this in the restriction tracker instead of in this class right? I think I missed that. Is there anyway we could have the full logic encapsulated in this class? We should also include @hengfengli into the discussion, since he is the expert in this area. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
