rdblue commented on code in PR #6706: URL: https://github.com/apache/iceberg/pull/6706#discussion_r1093402518
########## core/src/main/java/org/apache/iceberg/SnapshotOperations.java: ########## @@ -0,0 +1,202 @@ +/* + * 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.iceberg; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collectors; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; + +/** + * SnapshotOperations abstracts access to snapshots for table metadata. This allows a subset of + * snapshots to be loaded initially for operations that do not require all snapshots to be present + * (e.g. table scans of the current snapshot). + * + * <p>In the event that snapshots need to be accessed, the provided supplier will be invoked, which + * must provide all addressable snapshots for the table. + */ +class SnapshotOperations implements Serializable { + + private List<Snapshot> snapshots; + private Supplier<List<Snapshot>> snapshotsSupplier; + private Map<Long, Snapshot> snapshotsById; + private Map<String, SnapshotRef> refs; Review Comment: I think that this should be split into two classes, one that is immutable and a builder class that can be used by `TableMetadata.Builder`. That's a more common pattern in Iceberg and I think really helps us keep the code clean. Mutable objects make things a lot more complex to reason about and we avoid them when there is no need to combine the behaviors. ########## core/src/main/java/org/apache/iceberg/SnapshotOperations.java: ########## @@ -0,0 +1,202 @@ +/* + * 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.iceberg; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collectors; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; + +/** + * SnapshotOperations abstracts access to snapshots for table metadata. This allows a subset of + * snapshots to be loaded initially for operations that do not require all snapshots to be present + * (e.g. table scans of the current snapshot). + * + * <p>In the event that snapshots need to be accessed, the provided supplier will be invoked, which + * must provide all addressable snapshots for the table. + */ +class SnapshotOperations implements Serializable { + + private List<Snapshot> snapshots; + private Supplier<List<Snapshot>> snapshotsSupplier; + private Map<Long, Snapshot> snapshotsById; + private Map<String, SnapshotRef> refs; + + SnapshotOperations() { + snapshots = Lists.newArrayList(); + snapshotsById = Maps.newHashMap(); + refs = Maps.newHashMap(); + } + + SnapshotOperations(List<Snapshot> snapshots, Map<String, SnapshotRef> refs) { + this(snapshots, null, refs); + } + + SnapshotOperations(SnapshotOperations fromCopy) { + this(fromCopy.snapshots, fromCopy.snapshotsSupplier, fromCopy.refs); + } + + SnapshotOperations( + List<Snapshot> snapshots, + Supplier<List<Snapshot>> snapshotsSupplier, + Map<String, SnapshotRef> refs) { + this.snapshots = Lists.newArrayList(snapshots); + this.snapshotsSupplier = snapshotsSupplier; + this.refs = Maps.newHashMap(refs); + + this.snapshotsById = indexSnapshotsById(snapshots); + } + + List<Snapshot> snapshots() { + ensureLoaded(); + + return Collections.unmodifiableList(snapshots); + } + + Snapshot snapshot(long id) { + if (!snapshotsById.containsKey(id)) { + ensureLoaded(); + } + + return snapshotsById.get(id); + } + + boolean contains(long id) { + if (!snapshotsById.containsKey(id)) { + ensureLoaded(); + } + + return snapshotsById.containsKey(id); + } + + void add(Snapshot snapshot) { + ValidationException.check( + !contains(snapshot.snapshotId()), + "Snapshot already exists for id: %s", + snapshot.snapshotId()); + + snapshots.add(snapshot); + snapshotsById.put(snapshot.snapshotId(), snapshot); + } + + List<Snapshot> remove(Collection<Long> idsToRemove) { + List<Snapshot> retainedSnapshots = + Lists.newArrayListWithExpectedSize(snapshots.size() - idsToRemove.size()); + List<Snapshot> removedSnapshots = Lists.newArrayListWithExpectedSize(idsToRemove.size()); + + for (Snapshot snapshot : snapshots) { + long snapshotId = snapshot.snapshotId(); + if (idsToRemove.contains(snapshotId)) { + Snapshot removed = snapshotsById.remove(snapshotId); + removedSnapshots.add(removed); + } else { + retainedSnapshots.add(snapshot); + } + } + + this.snapshots = retainedSnapshots; + + // remove any refs that are no longer valid + Set<String> danglingRefs = Sets.newHashSet(); + for (Map.Entry<String, SnapshotRef> refEntry : refs.entrySet()) { + if (!snapshotsById.containsKey(refEntry.getValue().snapshotId())) { + danglingRefs.add(refEntry.getKey()); + } + } + + danglingRefs.forEach(this::removeRef); + + return removedSnapshots; + } + + Map<String, SnapshotRef> refs() { + return Collections.unmodifiableMap(refs); + } + + SnapshotRef ref(String name) { + return refs.get(name); + } + + void addRef(String name, SnapshotRef ref) { + refs.put(name, ref); + } + + SnapshotRef removeRef(String name) { + return refs.remove(name); + } + + private void ensureLoaded() { + if (snapshotsSupplier != null) { + snapshots.addAll(snapshotsSupplier.get()); Review Comment: This can potentially reorder snapshots, which would be a problem for checks in the `TableMetadata` constructor. I think we should revisit that check, since branching probably makes it obsolete. ########## core/src/main/java/org/apache/iceberg/SnapshotOperations.java: ########## @@ -0,0 +1,190 @@ +/* + * 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.iceberg; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collectors; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; + +class SnapshotOperations implements Serializable { Review Comment: +1 for serializable tests, including one for Kryo. ########## core/src/main/java/org/apache/iceberg/SnapshotOperations.java: ########## @@ -0,0 +1,202 @@ +/* + * 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.iceberg; + +import java.io.Serializable; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.function.Function; +import java.util.function.Supplier; +import java.util.stream.Collectors; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.relocated.com.google.common.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; + +/** + * SnapshotOperations abstracts access to snapshots for table metadata. This allows a subset of + * snapshots to be loaded initially for operations that do not require all snapshots to be present + * (e.g. table scans of the current snapshot). + * + * <p>In the event that snapshots need to be accessed, the provided supplier will be invoked, which + * must provide all addressable snapshots for the table. + */ +class SnapshotOperations implements Serializable { + + private List<Snapshot> snapshots; + private Supplier<List<Snapshot>> snapshotsSupplier; + private Map<Long, Snapshot> snapshotsById; + private Map<String, SnapshotRef> refs; + + SnapshotOperations() { + snapshots = Lists.newArrayList(); + snapshotsById = Maps.newHashMap(); + refs = Maps.newHashMap(); + } + + SnapshotOperations(List<Snapshot> snapshots, Map<String, SnapshotRef> refs) { + this(snapshots, null, refs); + } + + SnapshotOperations(SnapshotOperations fromCopy) { + this(fromCopy.snapshots, fromCopy.snapshotsSupplier, fromCopy.refs); + } + + SnapshotOperations( + List<Snapshot> snapshots, + Supplier<List<Snapshot>> snapshotsSupplier, + Map<String, SnapshotRef> refs) { + this.snapshots = Lists.newArrayList(snapshots); + this.snapshotsSupplier = snapshotsSupplier; + this.refs = Maps.newHashMap(refs); + + this.snapshotsById = indexSnapshotsById(snapshots); + } + + List<Snapshot> snapshots() { + ensureLoaded(); + + return Collections.unmodifiableList(snapshots); + } + + Snapshot snapshot(long id) { + if (!snapshotsById.containsKey(id)) { + ensureLoaded(); + } + + return snapshotsById.get(id); + } + + boolean contains(long id) { + if (!snapshotsById.containsKey(id)) { + ensureLoaded(); + } + + return snapshotsById.containsKey(id); + } + + void add(Snapshot snapshot) { + ValidationException.check( + !contains(snapshot.snapshotId()), + "Snapshot already exists for id: %s", + snapshot.snapshotId()); + + snapshots.add(snapshot); + snapshotsById.put(snapshot.snapshotId(), snapshot); + } + + List<Snapshot> remove(Collection<Long> idsToRemove) { + List<Snapshot> retainedSnapshots = + Lists.newArrayListWithExpectedSize(snapshots.size() - idsToRemove.size()); + List<Snapshot> removedSnapshots = Lists.newArrayListWithExpectedSize(idsToRemove.size()); + + for (Snapshot snapshot : snapshots) { + long snapshotId = snapshot.snapshotId(); + if (idsToRemove.contains(snapshotId)) { + Snapshot removed = snapshotsById.remove(snapshotId); + removedSnapshots.add(removed); + } else { + retainedSnapshots.add(snapshot); + } + } + + this.snapshots = retainedSnapshots; + + // remove any refs that are no longer valid + Set<String> danglingRefs = Sets.newHashSet(); + for (Map.Entry<String, SnapshotRef> refEntry : refs.entrySet()) { + if (!snapshotsById.containsKey(refEntry.getValue().snapshotId())) { + danglingRefs.add(refEntry.getKey()); + } + } + + danglingRefs.forEach(this::removeRef); + + return removedSnapshots; + } + + Map<String, SnapshotRef> refs() { + return Collections.unmodifiableMap(refs); + } + + SnapshotRef ref(String name) { + return refs.get(name); + } + + void addRef(String name, SnapshotRef ref) { + refs.put(name, ref); + } + + SnapshotRef removeRef(String name) { + return refs.remove(name); + } + + private void ensureLoaded() { + if (snapshotsSupplier != null) { + snapshots.addAll(snapshotsSupplier.get()); + snapshotsSupplier = null; + + this.snapshotsById = indexSnapshotsById(snapshots); + } + } + + void validate(long currentSnapshotId, long lastSequenceNumber) { + validateSnapshots(lastSequenceNumber); + validateRefs(currentSnapshotId); + } + + private void validateSnapshots(long lastSequenceNumber) { + for (Snapshot snap : snapshots) { + ValidationException.check( + snap.sequenceNumber() <= lastSequenceNumber, + "Invalid snapshot with sequence number %s greater than last sequence number %s", + snap.sequenceNumber(), + lastSequenceNumber); Review Comment: I think there's a potential problem here. The supplier can return snapshots that have been committed but aren't in the local node's loaded metadata file. If that happens, this check might fail. Maybe we should filter the snapshots that are loaded from the supplier based on the last sequence number from the loaded metadata file. -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org