Skynet/misc_pterodactyl-panel
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Better user search filtering

Browse source
This commit is contained in:
Dane Everitt 2022-03-12 17:06:14 -05:00
parent 6cc029cad6
commit f51b730f51
No known key found for this signature in database
GPG key ID: EEA66103B3D71F53
5 changed files with 91 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
app/Http/Controllers/Api/Application/Users/UserController.php
View file

@ -2,6 +2,7 @@
namespace Pterodactyl\Http\Controllers\Api\Application\Users;
use Illuminate\Support\Arr;
use Pterodactyl\Models\User;
use Illuminate\Http\Response;
use Illuminate\Http\JsonResponse;
@ -49,20 +50,21 @@ class UserController extends ApplicationApiController
$users = QueryBuilder::for(User::query())
->allowedFilters([
'id',
'uuid',
AllowedFilter::exact('id'),
AllowedFilter::exact('uuid'),
AllowedFilter::exact('external_id'),
'username',
'email',
'external_id',
AllowedFilter::callback('*', function (Builder $builder) use ($request) {
$value = trim($request->input('filters.*'), '%');
return $builder->where(function (Builder $builder) use ($value) {
$builder->where('uuid', 'LIKE', $value . '%')
->orWhere('username', 'LIKE', $value . '%')
->orWhere('email', 'LIKE', $value . '%')
->orWhere('external_id', 'LIKE', $value . '%');
AllowedFilter::callback('*', function (Builder $builder, $value) {
foreach (Arr::wrap($value) as $datum) {
$datum = '%' . $datum . '%';
$builder->where(function (Builder $builder) use ($datum) {
$builder->where('uuid', 'LIKE', $datum)
->orWhere('username', 'LIKE', $datum)
->orWhere('email', 'LIKE', $datum)
->orWhere('external_id', 'LIKE', $datum);
});
}
}),
])
->allowedSorts(['id', 'uuid', 'username', 'email', 'admin_role_id'])

5
resources/scripts/components/admin/users/UsersContainer.tsx
View file

@ -16,7 +16,10 @@ const filters = [ 'id', 'uuid', 'external_id', 'username', 'email' ] as const;
const UsersContainer = () => {
const [ search, setSearch ] = useDebouncedState('', 500);
const [ selected, setSelected ] = useState<UUID[]>([]);
const { data: users } = useGetUsers(extractSearchFilters(search, filters));
const { data: users } = useGetUsers(extractSearchFilters(search, filters, {
splitUnmatched: true,
returnUnmatched: true,
}));
useEffect(() => {
document.title = 'Admin | Users';

53
resources/scripts/helpers/extractSearchFilters.spec.ts
View file

@ -3,18 +3,17 @@ import extractSearchFilters from '@/helpers/extractSearchFilters';
type TestCase = [ string, 0 | Record<string, string[]> ];
describe('@/helpers/extractSearchFilters.ts', function () {
const _DEFAULT = 0x00;
const cases: TestCase[] = [
[ '', {} ],
[ 'hello world', _DEFAULT ],
[ 'hello world', {} ],
[ 'bar:xyz foo:abc', { bar: [ 'xyz' ], foo: [ 'abc' ] } ],
[ 'hello foo:abc', { foo: [ 'abc' ] } ],
[ 'hello foo:abc world another bar:xyz hodor', { foo: [ 'abc' ], bar: [ 'xyz' ] } ],
[ 'foo:1 foo:2 foo: 3 foo:4', { foo: [ '1', '2', '4' ] } ],
[ ' foo:123 foo:bar:123 foo: foo:string', { foo: [ '123', 'bar:123', 'string' ] } ],
[ 'foo:1 bar:2 baz:3', { foo: [ '1' ], bar: [ '2' ] } ],
[ 'hello "world this" is quoted', _DEFAULT ],
[ 'hello "world foo:123 is" quoted', _DEFAULT ],
[ 'hello "world this" is quoted', {} ],
[ 'hello "world foo:123 is" quoted', {} ],
[ 'hello foo:"this is quoted" bar:"this \\"is deeply\\" quoted" world foo:another', {
foo: [ 'this is quoted', 'another' ],
bar: [ 'this "is deeply" quoted' ],
@ -23,23 +22,59 @@ describe('@/helpers/extractSearchFilters.ts', function () {
it.each(cases)('should return expected filters: [%s]', function (input, output) {
expect(extractSearchFilters(input, [ 'foo', 'bar' ])).toStrictEqual({
filters: output === _DEFAULT ? {
'*': [ input ],
} : output,
filters: output,
});
});
it('should allow modification of the default parameter', function () {
expect(extractSearchFilters('hello world', [ 'foo' ], 'default_param')).toStrictEqual({
expect(extractSearchFilters('hello world', [ 'foo' ], { defaultFilter: 'default_param', returnUnmatched: true })).toStrictEqual({
filters: {
default_param: [ 'hello world' ],
},
});
expect(extractSearchFilters('foo:123 bar', [ 'foo' ], 'default_param')).toStrictEqual({
expect(extractSearchFilters('foo:123 bar', [ 'foo' ], { defaultFilter: 'default_param' })).toStrictEqual({
filters: {
foo: [ '123' ],
},
});
});
it.each([
[ '', {} ],
[ 'hello world', { '*': [ 'hello world' ] } ],
[ 'hello world foo:123 bar:456', { foo: [ '123' ], bar: [ '456' ], '*': [ 'hello world' ] } ],
[ 'hello world foo:123 another string', { foo: [ '123' ], '*': [ 'hello world another string' ] } ],
])('should return unmatched parameters: %s', function (input, output) {
expect(extractSearchFilters(input, [ 'foo', 'bar' ], { returnUnmatched: true })).toStrictEqual({
filters: output,
});
});
it.each([
[ '', {} ],
[ 'hello world', { '*': [ 'hello', 'world' ] } ],
[ 'hello world foo:123 bar:456', { foo: [ '123' ], bar: [ '456' ], '*': [ 'hello', 'world' ] } ],
[ 'hello world foo:123 another string', { foo: [ '123' ], '*': [ 'hello', 'world', 'another', 'string' ] } ],
])('should split unmatched parameters: %s', function (input, output) {
expect(extractSearchFilters(input, [ 'foo', 'bar' ], {
returnUnmatched: true,
splitUnmatched: true,
})).toStrictEqual({
filters: output,
});
});
it.each([ true, false ])('should return the unsplit value (splitting: %s)', function (split) {
const extracted = extractSearchFilters('hello foo:123 bar:123 world', [ 'foo' ], {
returnUnmatched: true,
splitUnmatched: split,
});
expect(extracted).toStrictEqual({
filters: {
foo: [ '123' ],
'*': split ? [ 'hello', 'bar:123', 'world' ] : [ 'hello bar:123 world' ],
},
});
});
});

47
resources/scripts/helpers/extractSearchFilters.ts
View file

@ -1,40 +1,49 @@
import { QueryBuilderParams } from '@/api/http';
import splitStringWhitespace from '@/helpers/splitStringWhitespace';
const extractSearchFilters = <T extends string, D extends string = string> (
interface Options<D extends string = string> {
defaultFilter?: D;
splitUnmatched?: boolean;
returnUnmatched?: boolean;
}
const extractSearchFilters = <T extends string, D extends string = '*'> (
str: string,
params: Readonly<T[]>,
defaultFilter: D = '*' as D,
): QueryBuilderParams<T> | QueryBuilderParams<D> => {
const filters: Map<T, string[]> = new Map();
options?: Options<D>,
): QueryBuilderParams<T> | QueryBuilderParams<D> | QueryBuilderParams<T & D> => {
const opts: Required<Options<D>> = {
defaultFilter: options?.defaultFilter || '*' as D,
splitUnmatched: options?.splitUnmatched || false,
returnUnmatched: options?.returnUnmatched || false,
};
if (str.trim().length === 0) {
return { filters: {} };
}
const filters: Map<T, string[]> = new Map();
const unmatched: string[] = [];
for (const segment of splitStringWhitespace(str)) {
const parts = segment.split(':');
const filter = parts[0] as T;
const value = parts.slice(1).join(':');
// @ts-ignore
if (!filter || !value || !params.includes(filter)) {
continue;
if (!filter || (parts.length > 1 && filter && !value)) {
// do nothing
} else if (!params.includes(filter)) {
unmatched.push(segment);
} else {
filters.set(filter, [ ...(filters.get(filter) || []), value ]);
}
}
filters.set(filter, [ ...(filters.get(filter) || []), value ]);
if (opts.returnUnmatched && str.trim().length > 0) {
filters.set(opts.defaultFilter as any, opts.splitUnmatched ? unmatched : [ unmatched.join(' ') ]);
}
if (filters.size === 0) {
return {
filters: {
[defaultFilter]: [ str ] as Readonly<string[]>,
} as unknown as QueryBuilderParams<D>['filters'],
};
return { filters: {} };
}
return {
filters: Object.fromEntries(filters) as unknown as QueryBuilderParams<T>['filters'],
};
// @ts-expect-error
return { filters: Object.fromEntries(filters) };
};
export default extractSearchFilters;

2
webpack.config.js
View file

@ -26,7 +26,7 @@ module.exports = {
rules: [
{
test: /\.tsx?$/,
exclude: /node_modules/,
exclude: /node_modules|\.spec\.tsx?$/,
loader: 'babel-loader',
},
{