Repository navigation
REQ: keep the sketch consistent when an update fails #808
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
leerho
wants to merge
2
commits into
main
Choose a base branch
from
req-update-failure-safety
base: main
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.
+171
−32
Open
Changes from all commits
Commits
Show all changes
2 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
Some comments aren't visible on the classic Files Changed page.
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
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
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
116 changes: 116 additions & 0 deletions
116
src/test/java/org/apache/datasketches/req/ReqUpdateFailureTest.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,116 @@ | ||
| /* | ||
| * 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.datasketches.req; | ||
|
|
||
| import static org.testng.Assert.assertEquals; | ||
| import static org.testng.Assert.fail; | ||
|
|
||
| import java.lang.foreign.MemorySegment; | ||
| import java.lang.reflect.Proxy; | ||
| import java.util.Random; | ||
|
|
||
| import org.apache.datasketches.common.SketchesArgumentException; | ||
| import org.apache.datasketches.quantilescommon.QuantilesFloatsSketchIterator; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| /** | ||
| * Checks that a ReqSketch stays consistent when an error interrupts an update. | ||
| */ | ||
| public class ReqUpdateFailureTest { | ||
| private static final int K = 12; | ||
|
|
||
| private static float value(final int i) { return (i * 7919) % 100_003; } | ||
|
|
||
| /** | ||
| * A compaction allocates the space in the next level before it changes anything. Here the merge into the | ||
| * next level fails instead, because that buffer is not sorted. Both compactors must be left as they were. | ||
| */ | ||
| @Test | ||
| public void compactorUnchangedWhenPromotionFails() { | ||
| for (final boolean hra : new boolean[] {true, false}) { | ||
| final ReqCompactor c = new ReqCompactor((byte) 0, hra, K, null); | ||
| final FloatBuffer buf = c.getBuffer(); | ||
| for (int i = 0; i < c.getNomCapacity(); i++) { buf.append(value(i)); } | ||
| buf.sort(); | ||
| final FloatBuffer next = new FloatBuffer(4, 4, hra); | ||
| next.append(2f); | ||
| next.append(1f); //not sorted | ||
| final byte[] before = c.toByteArray(); | ||
| final int nextCount = next.getCount(); | ||
| final boolean coin = c.getCoin(); | ||
| try { | ||
| c.compact(new ReqSketch.CompactorReturn(), new Random(1), next); | ||
| fail(); | ||
| } catch (final SketchesArgumentException e) { | ||
| //expected | ||
| } | ||
| assertEquals(c.toByteArray(), before); | ||
| assertEquals(c.getCoin(), coin); | ||
| assertEquals(next.getCount(), nextCount); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * An error during compression leaves the item that started it in the sketch, with counts, bounds and | ||
| * min and max that agree with the compactors, and the sketch keeps working. | ||
| */ | ||
| @Test | ||
| public void sketchConsistentWhenCompressionFails() { | ||
| for (final boolean hra : new boolean[] {true, false}) { | ||
| final int[] calls = {0}; | ||
| final ReqDebug failOnThirdLevel = (ReqDebug) Proxy.newProxyInstance(ReqDebug.class.getClassLoader(), | ||
| new Class<?>[] {ReqDebug.class}, (proxy, method, args) -> { | ||
| if (method.getName().equals("emitNewCompactor") && (++calls[0] == 3)) { | ||
| throw new IllegalStateException("simulated failure"); | ||
| } | ||
| return null; | ||
| }); | ||
| final ReqSketch sk = ReqSketch.builder().setK(K).setHighRankAccuracy(hra).setReqDebug(failOnThirdLevel).build(); | ||
| int n = 0; | ||
| boolean failed = false; | ||
| while (!failed) { | ||
| final float item = -n; | ||
| try { | ||
| sk.update(item); | ||
| } catch (final IllegalStateException e) { | ||
| failed = true; | ||
| } | ||
| n++; | ||
| assertEquals(sk.getN(), n); | ||
| assertEquals(sk.getMinItem(), item); //each item is the new min | ||
| checkConsistent(sk); | ||
| } | ||
| for (int i = 0; i < 10_000; i++) { sk.update(value(i)); } | ||
| checkConsistent(sk); | ||
| final ReqSketch copy = ReqSketch.heapify(MemorySegment.ofArray(sk.toByteArray())); | ||
| assertEquals(copy.toByteArray(), sk.toByteArray()); | ||
| } | ||
| } | ||
|
|
||
| private static void checkConsistent(final ReqSketch sk) { | ||
| assertEquals(sk.getNumRetained(), sk.computeTotalRetainedItems()); | ||
| assertEquals(sk.getMaxNomSize(), sk.computeMaxNomSize()); | ||
| final QuantilesFloatsSketchIterator it = sk.iterator(); | ||
| long weight = 0; | ||
| while (it.next()) { weight += it.getWeight(); } | ||
| assertEquals(weight, sk.getN()); | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.