-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AWS, Core, Hive: Extract FileIO closing into separate FileIOTracker c…
…lass (#10893)
- Loading branch information
Showing
6 changed files
with
173 additions
and
71 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
65 changes: 65 additions & 0 deletions
65
core/src/main/java/org/apache/iceberg/io/FileIOTracker.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,65 @@ | ||
/* | ||
* 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.io; | ||
|
||
import com.github.benmanes.caffeine.cache.Cache; | ||
import com.github.benmanes.caffeine.cache.Caffeine; | ||
import com.github.benmanes.caffeine.cache.RemovalListener; | ||
import java.io.Closeable; | ||
import org.apache.iceberg.TableOperations; | ||
import org.apache.iceberg.relocated.com.google.common.annotations.VisibleForTesting; | ||
import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
|
||
/** | ||
* Keeps track of the {@link FileIO} instance of the given {@link TableOperations} instance and | ||
* closes the {@link FileIO} when {@link FileIOTracker#close()} gets called | ||
*/ | ||
public class FileIOTracker implements Closeable { | ||
private final Cache<TableOperations, FileIO> tracker; | ||
|
||
public FileIOTracker() { | ||
this.tracker = | ||
Caffeine.newBuilder() | ||
.weakKeys() | ||
.removalListener( | ||
(RemovalListener<TableOperations, FileIO>) | ||
(ops, fileIO, cause) -> { | ||
if (null != fileIO) { | ||
fileIO.close(); | ||
} | ||
}) | ||
.build(); | ||
} | ||
|
||
public void track(TableOperations ops) { | ||
Preconditions.checkArgument(null != ops, "Invalid table ops: null"); | ||
tracker.put(ops, ops.io()); | ||
} | ||
|
||
@VisibleForTesting | ||
Cache<TableOperations, FileIO> tracker() { | ||
return tracker; | ||
} | ||
|
||
@Override | ||
public void close() { | ||
tracker.invalidateAll(); | ||
tracker.cleanUp(); | ||
} | ||
} |
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
72 changes: 72 additions & 0 deletions
72
core/src/test/java/org/apache/iceberg/io/TestFileIOTracker.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,72 @@ | ||
/* | ||
* 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.io; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
import static org.mockito.Mockito.times; | ||
|
||
import java.io.File; | ||
import java.util.concurrent.TimeUnit; | ||
import org.apache.iceberg.TestTables; | ||
import org.awaitility.Awaitility; | ||
import org.junit.jupiter.api.Test; | ||
import org.junit.jupiter.api.io.TempDir; | ||
import org.mockito.Mockito; | ||
|
||
public class TestFileIOTracker { | ||
|
||
@TempDir private File tableDir; | ||
|
||
@SuppressWarnings("resource") | ||
@Test | ||
public void nullTableOps() { | ||
assertThatThrownBy(() -> new FileIOTracker().track(null)) | ||
.isInstanceOf(IllegalArgumentException.class) | ||
.hasMessage("Invalid table ops: null"); | ||
} | ||
|
||
@SuppressWarnings("unchecked") | ||
@Test | ||
public void fileIOGetsClosed() throws NoSuchFieldException, IllegalAccessException { | ||
FileIOTracker fileIOTracker = new FileIOTracker(); | ||
|
||
FileIO firstFileIO = Mockito.spy(new TestTables.LocalFileIO()); | ||
TestTables.TestTableOperations firstOps = | ||
new TestTables.TestTableOperations("x", tableDir, firstFileIO); | ||
fileIOTracker.track(firstOps); | ||
assertThat(fileIOTracker.tracker().estimatedSize()).isEqualTo(1); | ||
|
||
FileIO secondFileIO = Mockito.spy(new TestTables.LocalFileIO()); | ||
TestTables.TestTableOperations secondOps = | ||
new TestTables.TestTableOperations("y", tableDir, secondFileIO); | ||
fileIOTracker.track(secondOps); | ||
assertThat(fileIOTracker.tracker().estimatedSize()).isEqualTo(2); | ||
|
||
fileIOTracker.close(); | ||
Awaitility.await("FileIO gets closed") | ||
.atMost(5, TimeUnit.SECONDS) | ||
.untilAsserted( | ||
() -> { | ||
assertThat(fileIOTracker.tracker().estimatedSize()).isEqualTo(0); | ||
Mockito.verify(firstFileIO, times(1)).close(); | ||
Mockito.verify(secondFileIO, times(1)).close(); | ||
}); | ||
} | ||
} |
Oops, something went wrong.