Skip to content

Commit de57a41

Browse files
arshsmith1Google Java Core Libraries
authored andcommitted
Check the predicate on setEntry calls from filterEntries(...).entrySet().toArray(...).
`FilteredEntryMap.EntrySet` wrapped only the entries returned by `iterator()`, so the entries returned by `toArray()` were the backing map's own entries, and their `setValue` bypassed the filter. The fix is to override `toArray`. But instead of using `standardToArray` like `AbstractBiMap.EntrySet` and `UnmodifiableEntries` do, we use `newArrayList(iterator()).toArray(...)` like `FilteredMapValues` and `FilteredEntryMap.KeySet` do so that we avoid evaluating the predicate against all elements twice (once in `size()` and once in `iterator()`). - Fixes #8758 - Support for #1575 RELNOTES=n/a PiperOrigin-RevId: 1003049749
1 parent 669a232 commit de57a41

4 files changed

Lines changed: 136 additions & 0 deletions

File tree

‎android/guava-tests/test/com/google/common/collect/AbstractFilteredMapTest.java‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import com.google.common.base.Predicate;
2727
import java.util.Map;
2828
import java.util.Map.Entry;
29+
import java.util.concurrent.atomic.AtomicInteger;
2930
import junit.framework.TestCase;
3031
import org.jspecify.annotations.NullMarked;
3132
import org.jspecify.annotations.Nullable;
@@ -122,6 +123,59 @@ public void testFilteredValuesIllegalSetValue() {
122123
assertEquals(ImmutableMap.of("a", 2, "b", 4), filtered);
123124
}
124125

126+
@SuppressWarnings("unchecked") // casting the elements of toArray() back to entries
127+
public void testFilteredValuesIllegalSetValueViaToArray() {
128+
Map<String, Integer> unfiltered = createUnfiltered();
129+
Map<String, Integer> filtered = filterValues(unfiltered, EVEN);
130+
filtered.put("a", 2);
131+
filtered.put("b", 4);
132+
133+
Entry<?, Integer> entry = (Entry<?, Integer>) filtered.entrySet().toArray()[0];
134+
assertThrows(IllegalArgumentException.class, () -> entry.setValue(5));
135+
Entry<?, Integer> typedEntry =
136+
(Entry<?, Integer>) filtered.entrySet().toArray(new Entry<?, ?>[0])[0];
137+
assertThrows(IllegalArgumentException.class, () -> typedEntry.setValue(5));
138+
139+
assertEquals(ImmutableMap.of("a", 2, "b", 4), unfiltered);
140+
}
141+
142+
public void testFilteredValuesToArrayEvaluatesPredicateOnce() {
143+
Map<String, Integer> unfiltered = createUnfiltered();
144+
unfiltered.put("a", 1);
145+
unfiltered.put("b", 2);
146+
AtomicInteger evaluations = new AtomicInteger();
147+
Map<String, Integer> filtered =
148+
filterValues(
149+
unfiltered,
150+
v -> {
151+
evaluations.incrementAndGet();
152+
return EVEN.apply(v);
153+
});
154+
155+
assertEquals(1, filtered.entrySet().toArray().length);
156+
assertEquals(2, evaluations.get());
157+
158+
evaluations.set(0);
159+
assertEquals(1, filtered.entrySet().toArray(new Entry<?, ?>[0]).length);
160+
assertEquals(2, evaluations.get());
161+
162+
evaluations.set(0);
163+
assertEquals(1, filtered.keySet().toArray().length);
164+
assertEquals(2, evaluations.get());
165+
166+
evaluations.set(0);
167+
assertEquals(1, filtered.keySet().toArray(new String[0]).length);
168+
assertEquals(2, evaluations.get());
169+
170+
evaluations.set(0);
171+
assertEquals(1, filtered.values().toArray().length);
172+
assertEquals(2, evaluations.get());
173+
174+
evaluations.set(0);
175+
assertEquals(1, filtered.values().toArray(new Integer[0]).length);
176+
assertEquals(2, evaluations.get());
177+
}
178+
125179
public void testFilteredValuesClear() {
126180
Map<String, Integer> unfiltered = createUnfiltered();
127181
unfiltered.put("one", 1);

‎android/guava/src/com/google/common/collect/Maps.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2914,6 +2914,20 @@ public V setValue(@ParametricNullness V newValue) {
29142914
}
29152915
};
29162916
}
2917+
2918+
// See java.util.Collections.CheckedEntrySet for details on attacks.
2919+
2920+
@Override
2921+
public @Nullable Object[] toArray() {
2922+
// creating an ArrayList so filtering happens once
2923+
return newArrayList(iterator()).toArray();
2924+
}
2925+
2926+
@Override
2927+
@SuppressWarnings("nullness") // b/192354773 in our checker affects toArray declarations
2928+
public <T extends @Nullable Object> T[] toArray(T[] array) {
2929+
return newArrayList(iterator()).toArray(array);
2930+
}
29172931
}
29182932

29192933
@Override

‎guava-tests/test/com/google/common/collect/AbstractFilteredMapTest.java‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import com.google.common.base.Predicate;
2727
import java.util.Map;
2828
import java.util.Map.Entry;
29+
import java.util.concurrent.atomic.AtomicInteger;
2930
import junit.framework.TestCase;
3031
import org.jspecify.annotations.NullMarked;
3132
import org.jspecify.annotations.Nullable;
@@ -122,6 +123,59 @@ public void testFilteredValuesIllegalSetValue() {
122123
assertEquals(ImmutableMap.of("a", 2, "b", 4), filtered);
123124
}
124125

126+
@SuppressWarnings("unchecked") // casting the elements of toArray() back to entries
127+
public void testFilteredValuesIllegalSetValueViaToArray() {
128+
Map<String, Integer> unfiltered = createUnfiltered();
129+
Map<String, Integer> filtered = filterValues(unfiltered, EVEN);
130+
filtered.put("a", 2);
131+
filtered.put("b", 4);
132+
133+
Entry<?, Integer> entry = (Entry<?, Integer>) filtered.entrySet().toArray()[0];
134+
assertThrows(IllegalArgumentException.class, () -> entry.setValue(5));
135+
Entry<?, Integer> typedEntry =
136+
(Entry<?, Integer>) filtered.entrySet().toArray(new Entry<?, ?>[0])[0];
137+
assertThrows(IllegalArgumentException.class, () -> typedEntry.setValue(5));
138+
139+
assertEquals(ImmutableMap.of("a", 2, "b", 4), unfiltered);
140+
}
141+
142+
public void testFilteredValuesToArrayEvaluatesPredicateOnce() {
143+
Map<String, Integer> unfiltered = createUnfiltered();
144+
unfiltered.put("a", 1);
145+
unfiltered.put("b", 2);
146+
AtomicInteger evaluations = new AtomicInteger();
147+
Map<String, Integer> filtered =
148+
filterValues(
149+
unfiltered,
150+
v -> {
151+
evaluations.incrementAndGet();
152+
return EVEN.apply(v);
153+
});
154+
155+
assertEquals(1, filtered.entrySet().toArray().length);
156+
assertEquals(2, evaluations.get());
157+
158+
evaluations.set(0);
159+
assertEquals(1, filtered.entrySet().toArray(new Entry<?, ?>[0]).length);
160+
assertEquals(2, evaluations.get());
161+
162+
evaluations.set(0);
163+
assertEquals(1, filtered.keySet().toArray().length);
164+
assertEquals(2, evaluations.get());
165+
166+
evaluations.set(0);
167+
assertEquals(1, filtered.keySet().toArray(new String[0]).length);
168+
assertEquals(2, evaluations.get());
169+
170+
evaluations.set(0);
171+
assertEquals(1, filtered.values().toArray().length);
172+
assertEquals(2, evaluations.get());
173+
174+
evaluations.set(0);
175+
assertEquals(1, filtered.values().toArray(new Integer[0]).length);
176+
assertEquals(2, evaluations.get());
177+
}
178+
125179
public void testFilteredValuesClear() {
126180
Map<String, Integer> unfiltered = createUnfiltered();
127181
unfiltered.put("one", 1);

‎guava/src/com/google/common/collect/Maps.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3025,6 +3025,20 @@ public V setValue(@ParametricNullness V newValue) {
30253025
}
30263026
};
30273027
}
3028+
3029+
// See java.util.Collections.CheckedEntrySet for details on attacks.
3030+
3031+
@Override
3032+
public @Nullable Object[] toArray() {
3033+
// creating an ArrayList so filtering happens once
3034+
return newArrayList(iterator()).toArray();
3035+
}
3036+
3037+
@Override
3038+
@SuppressWarnings("nullness") // b/192354773 in our checker affects toArray declarations
3039+
public <T extends @Nullable Object> T[] toArray(T[] array) {
3040+
return newArrayList(iterator()).toArray(array);
3041+
}
30283042
}
30293043

30303044
@Override

0 commit comments

Comments
 (0)
⌂ 换网址