-
Notifications
You must be signed in to change notification settings - Fork 1.5k
fix(minion): fail single-segment task when segment upload fails #18813
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tarun11Mavani
wants to merge
3
commits into
apache:master
Choose a base branch
from
tarun11Mavani:fix-minion-single-segment-upload-failure
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+267
−11
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
245 changes: 245 additions & 0 deletions
245
...st/java/org/apache/pinot/plugin/minion/tasks/BaseSingleSegmentConversionExecutorTest.java
This file contains hidden or 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,245 @@ | ||
| /** | ||
| * 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.pinot.plugin.minion.tasks; | ||
|
|
||
| import java.io.File; | ||
| import java.net.URI; | ||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.apache.commons.io.FileUtils; | ||
| import org.apache.pinot.common.metadata.segment.SegmentZKMetadataCustomMapModifier; | ||
| import org.apache.pinot.common.metrics.MinionMetrics; | ||
| import org.apache.pinot.core.common.MinionConstants; | ||
| import org.apache.pinot.core.minion.PinotTaskConfig; | ||
| import org.apache.pinot.minion.MinionContext; | ||
| import org.apache.pinot.minion.event.MinionEventObservers; | ||
| import org.apache.pinot.segment.local.segment.creator.impl.SegmentIndexCreationDriverImpl; | ||
| import org.apache.pinot.segment.local.segment.readers.GenericRowRecordReader; | ||
| import org.apache.pinot.segment.local.utils.SegmentPushUtils; | ||
| import org.apache.pinot.segment.spi.creator.SegmentGeneratorConfig; | ||
| import org.apache.pinot.spi.config.instance.InstanceType; | ||
| import org.apache.pinot.spi.config.table.TableConfig; | ||
| import org.apache.pinot.spi.config.table.TableType; | ||
| import org.apache.pinot.spi.data.FieldSpec; | ||
| import org.apache.pinot.spi.data.Schema; | ||
| import org.apache.pinot.spi.data.readers.GenericRow; | ||
| import org.apache.pinot.spi.filesystem.PinotFS; | ||
| import org.apache.pinot.spi.ingestion.batch.BatchConfigProperties; | ||
| import org.apache.pinot.spi.utils.builder.TableConfigBuilder; | ||
| import org.apache.pinot.spi.utils.builder.TableNameBuilder; | ||
| import org.mockito.MockedStatic; | ||
| import org.mockito.Mockito; | ||
| import org.testng.Assert; | ||
| import org.testng.annotations.AfterClass; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.Test; | ||
|
|
||
|
|
||
| /** | ||
| * Tests the {@link BaseSingleSegmentConversionExecutor#executeTask} upload-failure handling: a segment-upload failure | ||
| * must propagate so the task is marked failed (and retried) rather than being silently reported as successful. | ||
| */ | ||
| public class BaseSingleSegmentConversionExecutorTest { | ||
| private static final File TEMP_DIR = | ||
| new File(FileUtils.getTempDirectory(), "BaseSingleSegmentConversionExecutorTest"); | ||
| private static final File SEGMENT_DIR = new File(TEMP_DIR, "segment"); | ||
| private static final File DATA_DIR = new File(TEMP_DIR, "minionData"); | ||
|
|
||
| private static final int NUM_ROWS = 5; | ||
| private static final String RAW_TABLE_NAME = "testTable"; | ||
| private static final String TABLE_NAME_WITH_TYPE = TableNameBuilder.OFFLINE.tableNameWithType(RAW_TABLE_NAME); | ||
| private static final String SEGMENT_NAME = "testSegment"; | ||
| private static final String TASK_TYPE = "TestSingleSegmentConversionTask"; | ||
| private static final String TASK_ID = "Task_" + TASK_TYPE + "_0"; | ||
| private static final long SEGMENT_CRC = 100L; | ||
| private static final String D1 = "d1"; | ||
|
|
||
| private File _segmentIndexDir; | ||
|
|
||
| @BeforeClass | ||
| public void setUp() | ||
| throws Exception { | ||
| FileUtils.deleteDirectory(TEMP_DIR); | ||
| MinionMetrics.register(Mockito.mock(MinionMetrics.class)); | ||
|
|
||
| TableConfig tableConfig = new TableConfigBuilder(TableType.OFFLINE).setTableName(RAW_TABLE_NAME).build(); | ||
| Schema schema = new Schema.SchemaBuilder().addSingleValueDimension(D1, FieldSpec.DataType.INT).build(); | ||
| List<GenericRow> rows = new ArrayList<>(NUM_ROWS); | ||
| for (int i = 0; i < NUM_ROWS; i++) { | ||
| GenericRow row = new GenericRow(); | ||
| row.putValue(D1, i); | ||
| rows.add(row); | ||
| } | ||
|
|
||
| SegmentGeneratorConfig config = new SegmentGeneratorConfig(tableConfig, schema); | ||
| config.setInstanceType(InstanceType.MINION); | ||
| config.setOutDir(SEGMENT_DIR.getPath()); | ||
| config.setSegmentName(SEGMENT_NAME); | ||
| SegmentIndexCreationDriverImpl driver = new SegmentIndexCreationDriverImpl(); | ||
| driver.init(config, new GenericRowRecordReader(rows)); | ||
| driver.build(); | ||
| _segmentIndexDir = new File(SEGMENT_DIR, SEGMENT_NAME); | ||
|
|
||
| Assert.assertTrue(DATA_DIR.mkdirs()); | ||
| MinionContext.getInstance().setDataDir(DATA_DIR); | ||
| // executeTask resolves the event observer from the registry by task id; register one so it is non-null. | ||
| MinionEventObservers.getInstance().addMinionEventObserver(TASK_ID, MinionTaskTestUtils.getMinionProgressObserver()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testExecuteTaskRethrowsWhenUploadFails() | ||
| throws Exception { | ||
| try (MockedStatic<SegmentConversionUtils> mocked = Mockito.mockStatic(SegmentConversionUtils.class)) { | ||
| mocked.when(() -> SegmentConversionUtils.uploadSegment(Mockito.any(), Mockito.any(), Mockito.any(), | ||
| Mockito.anyString(), Mockito.anyString(), Mockito.anyString(), Mockito.any(File.class))) | ||
| .thenThrow(new RuntimeException("simulated upload failure")); | ||
|
|
||
| TestSingleSegmentConversionExecutor executor = new TestSingleSegmentConversionExecutor(); | ||
| try { | ||
| executor.executeTask(createTaskConfig()); | ||
| Assert.fail("executeTask must rethrow when segment upload fails, not report success"); | ||
| } catch (RuntimeException e) { | ||
| Assert.assertEquals(e.getMessage(), "simulated upload failure"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testExecuteTaskSucceedsWhenUploadSucceeds() | ||
| throws Exception { | ||
| try (MockedStatic<SegmentConversionUtils> mocked = Mockito.mockStatic(SegmentConversionUtils.class)) { | ||
| // uploadSegment is a no-op by default for the mocked static, simulating a successful upload. | ||
| TestSingleSegmentConversionExecutor executor = new TestSingleSegmentConversionExecutor(); | ||
| SegmentConversionResult result = executor.executeTask(createTaskConfig()); | ||
| Assert.assertEquals(result.getSegmentName(), SEGMENT_NAME); | ||
| Assert.assertEquals(result.getTableNameWithType(), TABLE_NAME_WITH_TYPE); | ||
| mocked.verify(() -> SegmentConversionUtils.uploadSegment(Mockito.any(), Mockito.any(), Mockito.any(), | ||
| Mockito.anyString(), Mockito.anyString(), Mockito.anyString(), Mockito.any(File.class))); | ||
| } | ||
| } | ||
|
|
||
| private PinotTaskConfig createTaskConfig() { | ||
| Map<String, String> configs = new HashMap<>(); | ||
| configs.put(MinionConstants.TABLE_NAME_KEY, TABLE_NAME_WITH_TYPE); | ||
| configs.put(MinionConstants.SEGMENT_NAME_KEY, SEGMENT_NAME); | ||
| configs.put(MinionConstants.DOWNLOAD_URL_KEY, "http://unused/download"); | ||
| configs.put(MinionConstants.UPLOAD_URL_KEY, "http://unused/upload"); | ||
| configs.put(MinionConstants.ORIGINAL_SEGMENT_CRC_KEY, Long.toString(SEGMENT_CRC)); | ||
| configs.put("TASK_ID", TASK_ID); | ||
| return new PinotTaskConfig(TASK_TYPE, configs); | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that when a METADATA-mode push fails after the converted tar was already staged to the output PinotFS, | ||
| * the staged tar is deleted before the exception propagates. Without this cleanup the rethrow would make the retry | ||
| * fail in moveSegmentToOutputPinotFS with "Output file already exists" (overwriteOutput defaults to false), so | ||
| * transient push failures would never self-heal. | ||
| */ | ||
| @Test | ||
| public void testExecuteTaskCleansUpStagedTarWhenMetadataPushFails() | ||
| throws Exception { | ||
| File outputDir = new File(TEMP_DIR, "output"); | ||
| FileUtils.forceMkdir(outputDir); | ||
| PinotFS mockOutputFS = Mockito.mock(PinotFS.class); | ||
| Mockito.when(mockOutputFS.exists(Mockito.any())).thenReturn(false); | ||
|
|
||
| try (MockedStatic<MinionTaskUtils> minionTaskUtils = | ||
| Mockito.mockStatic(MinionTaskUtils.class, Mockito.CALLS_REAL_METHODS); | ||
| MockedStatic<SegmentPushUtils> segmentPushUtils = | ||
| Mockito.mockStatic(SegmentPushUtils.class, Mockito.CALLS_REAL_METHODS)) { | ||
| minionTaskUtils.when(() -> MinionTaskUtils.getOutputPinotFS(Mockito.any(), Mockito.any())) | ||
| .thenReturn(mockOutputFS); | ||
| segmentPushUtils.when(() -> SegmentPushUtils.sendSegmentUriAndMetadata(Mockito.any(), Mockito.any(), | ||
| Mockito.any(), Mockito.anyList(), Mockito.anyList())) | ||
| .thenThrow(new RuntimeException("simulated metadata push failure")); | ||
|
|
||
| TestSingleSegmentConversionExecutor executor = new TestSingleSegmentConversionExecutor(); | ||
| try { | ||
| executor.executeTask(createMetadataPushTaskConfig(outputDir)); | ||
| Assert.fail("executeTask must rethrow when metadata push fails"); | ||
| } catch (RuntimeException e) { | ||
| Assert.assertEquals(e.getMessage(), "simulated metadata push failure"); | ||
| } | ||
| // The staged tar must be deleted so a retry can re-stage it and self-heal. | ||
| Mockito.verify(mockOutputFS).delete(Mockito.any(URI.class), Mockito.eq(true)); | ||
| } | ||
| } | ||
|
|
||
| private PinotTaskConfig createMetadataPushTaskConfig(File outputDir) { | ||
| Map<String, String> configs = new HashMap<>(); | ||
| configs.put(MinionConstants.TABLE_NAME_KEY, TABLE_NAME_WITH_TYPE); | ||
| configs.put(MinionConstants.SEGMENT_NAME_KEY, SEGMENT_NAME); | ||
| configs.put(MinionConstants.DOWNLOAD_URL_KEY, "http://unused/download"); | ||
| configs.put(MinionConstants.UPLOAD_URL_KEY, "http://unused/upload"); | ||
| configs.put(MinionConstants.ORIGINAL_SEGMENT_CRC_KEY, Long.toString(SEGMENT_CRC)); | ||
| configs.put("TASK_ID", TASK_ID); | ||
| configs.put(BatchConfigProperties.PUSH_MODE, BatchConfigProperties.SegmentPushType.METADATA.name()); | ||
| configs.put(BatchConfigProperties.OUTPUT_SEGMENT_DIR_URI, outputDir.toURI().toString()); | ||
| return new PinotTaskConfig(TASK_TYPE, configs); | ||
| } | ||
|
|
||
| @AfterClass | ||
| public void tearDown() | ||
| throws Exception { | ||
| // Restore the process-global state mutated in setUp so it does not leak into other test classes. | ||
| MinionEventObservers.getInstance().removeMinionEventObserver(TASK_ID); | ||
| MinionContext.getInstance().setDataDir(null); | ||
| FileUtils.deleteDirectory(TEMP_DIR); | ||
| } | ||
|
|
||
| /** | ||
| * Minimal concrete executor that stubs out the infrastructure-dependent hooks (download, CRC check, conversion, ZK | ||
| * metadata modifier) so {@code executeTask} runs to the upload step without a server, controller, or deep store. | ||
| */ | ||
| private class TestSingleSegmentConversionExecutor extends BaseSingleSegmentConversionExecutor { | ||
| @Override | ||
| protected File downloadSegmentToLocalAndUntar(String tableNameWithType, String segmentName, String deepstoreURL, | ||
| String taskType, File tempDataDir, String suffix) | ||
| throws Exception { | ||
| File indexDir = new File(tempDataDir, "inputSegment"); | ||
| FileUtils.copyDirectory(_segmentIndexDir, indexDir); | ||
| return indexDir; | ||
| } | ||
|
|
||
| @Override | ||
| protected long getSegmentCrc(String tableNameWithType, String segmentName) { | ||
| return SEGMENT_CRC; | ||
| } | ||
|
|
||
| @Override | ||
| protected SegmentConversionResult convert(PinotTaskConfig pinotTaskConfig, File indexDir, File workingDir) | ||
| throws Exception { | ||
| File convertedDir = new File(workingDir, SEGMENT_NAME); | ||
| FileUtils.copyDirectory(indexDir, convertedDir); | ||
| return new SegmentConversionResult.Builder().setFile(convertedDir) | ||
| .setTableNameWithType(pinotTaskConfig.getConfigs().get(MinionConstants.TABLE_NAME_KEY)) | ||
| .setSegmentName(SEGMENT_NAME).build(); | ||
| } | ||
|
|
||
| @Override | ||
| protected SegmentZKMetadataCustomMapModifier getSegmentZKMetadataCustomMapModifier(PinotTaskConfig pinotTaskConfig, | ||
| SegmentConversionResult segmentConversionResult) { | ||
| return new SegmentZKMetadataCustomMapModifier(SegmentZKMetadataCustomMapModifier.ModifyMode.UPDATE, | ||
| Collections.emptyMap()); | ||
| } | ||
| } | ||
| } |
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.
In METADATA push mode this rethrow turns controller-side push failures into task retries, but the retry comes back through
moveSegmentToOutputPinotFS()with the same<segment>.tar.gztarget.overwriteOutputis normally left false inMinionTaskUtils.getPushTaskConfig(), so if the first attempt already copied the tar before failing, the retry now dies onOutput file already existsbefore it can resend metadata. That makes transient metadata-push failures sticky instead of self-healing. Can we make the staged tar idempotent across retries or clean it up before rethrowing?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.
Good catch — fixed in 9863fcc.
uploadSegmentWithMetadatanow deletes the staged tar from the output PinotFS if the metadata send fails, before rethrowing, so a retry re-stages cleanly instead of hitting "Output file already exists".I went with cleanup-on-failure rather than forcing
overwriteOutput=true, so the existing guard against unrelated collisions in the output dir stays intact — we only remove the tar when it's our own stale partial from a failed attempt.Added
testExecuteTaskCleansUpStagedTarWhenMetadataPushFails, verified it fails without the cleanup.