Skip to content

Fix search filtering #5599

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.

Sign up for GitHub

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

Merged
mstange merged 4 commits into from
Sep 5, 2025
Merged

Fix search filtering #5599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
871fda3
Add a test for call tree search filtering.
mstange Sep 4, 2025
999dedd
Make bit set functions check for out-of-bounds indexes.
mstange Sep 4, 2025
9be394d
Pass the right length when creating the stackMatchesSearch bit set.
mstange Sep 4, 2025
3f01b04
Merge branch 'main' into fix-search-filter
mstange Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/profile-logic/profile-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1538,7 +1538,7 @@ export function filterThreadToSearchString(
}
}

const stackMatchesSearch = makeBitSet(funcTable.length);
const stackMatchesSearch = makeBitSet(stackTable.length);
for (let stackIndex = 0; stackIndex < stackTable.length; stackIndex++) {
const prefix = stackTable.prefix[stackIndex];
if (prefix !== null && checkBit(stackMatchesSearch, prefix)) {
Expand Down
170 changes: 170 additions & 0 deletions src/test/store/profile-view.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { withAnalyticsMock } from '../fixtures/mocks/analytics';
import { getProfileWithNiceTracks } from '../fixtures/profiles/tracks';
import { blankStore, storeWithProfile } from '../fixtures/stores';
import { assertSetContainsOnly } from '../fixtures/custom-assertions';
import { formatTree } from '../fixtures/utils';

import * as App from '../../actions/app';
import * as ProfileView from '../../actions/profile-view';
Expand Down Expand Up @@ -750,6 +751,175 @@ describe('actions/ProfileView', function () {
});
});
});

function setup() {
// Create a profile which has more than 32 stacks, so that, if any parts of the implementation
// use a BitSet to keep track of something that's per-stack (such as whether a stack matches
// the search filter), the BitSet needs at least two 32-bit slots.
const { profile } = getProfileFromTextSamples(`
A[lib:K][file:S] A[lib:K][file:S] A[lib:K][file:S] D[lib:nNn][file:uV] C[lib:m][file:t]
B[lib:L][file:t] B[lib:L][file:t] E[lib:O][file:Pq]
A[lib:K][file:S] C[lib:m][file:t]
B[lib:L][file:t] D[lib:n][file:uV]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
B[lib:L][file:t]
`);

const { dispatch, getState } = storeWithProfile(profile);
return { dispatch, getState, profile };
}

it('starts as an unfiltered call tree', function () {
const { getState } = setup();
const originalCallTree = selectedThreadSelectors.getCallTree(getState());
expect(formatTree(originalCallTree)).toEqual([
'- A (total: 3, self: —)',
' - B (total: 2, self: —)',
' - A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: —)',
' - B (total: 1, self: 1)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
' - E (total: 1, self: 1)',
'- D (total: 1, self: 1)',
'- C (total: 1, self: 1)',
]);
});

it('filters out all samples if there is no match', function () {
const { dispatch, getState } = setup();
dispatch(ProfileView.changeCallTreeSearchString('F'));
const callTree = selectedThreadSelectors.getCallTree(getState());
expect(formatTree(callTree)).toEqual([]);
});

it('filters based on function names', function () {
const { dispatch, getState } = setup();
dispatch(ProfileView.changeCallTreeSearchString('c'));
const callTree = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function C
expect(formatTree(callTree)).toEqual([
'- A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
'- C (total: 1, self: 1)',
]);

// Also test with uppercase 'C'
dispatch(ProfileView.changeCallTreeSearchString('C'));
const callTree2 = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function C
expect(formatTree(callTree2)).toEqual([
'- A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
'- C (total: 1, self: 1)',
]);
});

it('filters based on filenames', function () {
const { dispatch, getState } = setup();
dispatch(ProfileView.changeCallTreeSearchString('u'));
const callTree_u = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function D, which has filename uV
expect(formatTree(callTree_u)).toEqual([
'- A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
'- D (total: 1, self: 1)',
]);
dispatch(ProfileView.changeCallTreeSearchString('pQ'));
const callTree_pQ = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function E, which has filename Pq
expect(formatTree(callTree_pQ)).toEqual([
'- A (total: 1, self: —)',
' - E (total: 1, self: 1)',
]);
});

it('filters based on library names', function () {
const { dispatch, getState } = setup();
dispatch(ProfileView.changeCallTreeSearchString('M'));
const callTree_M = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function C, which has lib name m
expect(formatTree(callTree_M)).toEqual([
'- A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
'- C (total: 1, self: 1)',
]);
dispatch(ProfileView.changeCallTreeSearchString('NN'));
const callTree_NN = selectedThreadSelectors.getCallTree(getState());
// Keep all stacks which include function D, which has filename nNn
expect(formatTree(callTree_NN)).toEqual([
'- A (total: 1, self: —)',
' - B (total: 1, self: —)',
' - C (total: 1, self: —)',
' - D (total: 1, self: 1)',
'- D (total: 1, self: 1)',
]);
});
});

/**
Expand Down
18 changes: 18 additions & 0 deletions src/utils/bitset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,35 @@ export function makeBitSet(length: number): BitSet {
export function setBit(bitSet: BitSet, bitIndex: number) {
const q = bitIndex >> 5;
const r = bitIndex & 0b11111;
if (q >= bitSet.length) {
throw new BitSetOutOfBoundsError(bitIndex);
}
bitSet[q] |= 1 << r;
}

export function clearBit(bitSet: BitSet, bitIndex: number) {
const q = bitIndex >> 5;
const r = bitIndex & 0b11111;
if (q >= bitSet.length) {
throw new BitSetOutOfBoundsError(bitIndex);
}
bitSet[q] &= ~(1 << r);
}

export function checkBit(bitSet: BitSet, bitIndex: number): boolean {
const q = bitIndex >> 5;
const r = bitIndex & 0b11111;
if (q >= bitSet.length) {
throw new BitSetOutOfBoundsError(bitIndex);
}
return (bitSet[q] & (1 << r)) !== 0;
}

export class BitSetOutOfBoundsError extends Error {
override name = 'BitSetOutOfBoundsError';
bitIndex: number;
constructor(bitIndex: number) {
super(`Bit index ${bitIndex} is out of bounds`);
this.bitIndex = bitIndex;
}
}