Skip to content

feat: Filter recipes #2354

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
merged 10 commits into from
Jan 16, 2025
Merged

feat: Filter recipes #2354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
199ad45
feat: add languages/frameworks to recipes catalog
feloy Jan 9, 2025
516bfca
fix: backend
feloy Jan 9, 2025
40a05c9
feat: add filters in the frontend
feloy Jan 10, 2025
aed0844
test: adapt unit tests
feloy Jan 10, 2025
3c829ac
test: add unit tests
feloy Jan 10, 2025
5dbeedc
fix: dropdown text color
feloy Jan 10, 2025
89a69be
feat: add counts to filters
feloy Jan 15, 2025
573827d
feat: replace "no filter" with "all"
feloy Jan 15, 2025
907727c
fix: frontend tests
feloy Jan 15, 2025
c5fe080
fix: backend tests
feloy Jan 15, 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
36 changes: 27 additions & 9 deletions packages/backend/src/assets/ai.json
View file
Open in desktop

Large diffs are not rendered by default.

160 changes: 130 additions & 30 deletions packages/backend/src/managers/catalogManager.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,19 +336,37 @@ test('filter recipes by language', async () => {
});
expect(result1.result.map(r => r.id)).toEqual(['recipe1']);
expect(result1.choices).toEqual({
languages: ['lang1', 'lang10', 'lang11', 'lang2', 'lang3'],
frameworks: ['fw1', 'fw10'],
tools: ['tool1'],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 2 },
{ name: 'lang11', count: 1 },
{ name: 'lang2', count: 1 },
{ name: 'lang3', count: 1 },
],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 1 },
],
tools: [{ name: 'tool1', count: 1 }],
});

const result2 = catalogManager.filterRecipes({
languages: ['lang2'],
});
expect(result2.result.map(r => r.id)).toEqual(['recipe2']);
expect(result2.choices).toEqual({
languages: ['lang1', 'lang10', 'lang11', 'lang2', 'lang3'],
frameworks: ['fw10', 'fw2'],
tools: ['tool2'],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 2 },
{ name: 'lang11', count: 1 },
{ name: 'lang2', count: 1 },
{ name: 'lang3', count: 1 },
],
frameworks: [
{ name: 'fw10', count: 1 },
{ name: 'fw2', count: 1 },
],
tools: [{ name: 'tool2', count: 1 }],
});
});

Expand All @@ -364,29 +382,61 @@ test('filter recipes by tool', async () => {
});
expect(result1.result.map(r => r.id)).toEqual(['recipe1']);
expect(result1.choices).toEqual({
frameworks: ['fw1', 'fw10'],
languages: ['lang1', 'lang10'],
tools: ['tool1', 'tool2', 'tool3'],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 1 },
],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 1 },
],
tools: [
{ name: 'tool1', count: 1 },
{ name: 'tool2', count: 1 },
{ name: 'tool3', count: 1 },
],
});

const result2 = catalogManager.filterRecipes({
tools: ['tool2'],
});
expect(result2.result.map(r => r.id)).toEqual(['recipe2']);
expect(result2.choices).toEqual({
frameworks: ['fw10', 'fw2'],
languages: ['lang10', 'lang2'],
tools: ['tool1', 'tool2', 'tool3'],
frameworks: [
{ name: 'fw10', count: 1 },
{ name: 'fw2', count: 1 },
],
languages: [
{ name: 'lang10', count: 1 },
{ name: 'lang2', count: 1 },
],
tools: [
{ name: 'tool1', count: 1 },
{ name: 'tool2', count: 1 },
{ name: 'tool3', count: 1 },
],
});

const result3 = catalogManager.filterRecipes({
tools: ['tool1', 'tool2'],
});
expect(result3.result.map(r => r.id)).toEqual(['recipe1', 'recipe2']);
expect(result3.choices).toEqual({
frameworks: ['fw1', 'fw10', 'fw2'],
languages: ['lang1', 'lang10', 'lang2'],
tools: ['tool1', 'tool2', 'tool3'],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 2 },
{ name: 'fw2', count: 1 },
],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 2 },
{ name: 'lang2', count: 1 },
],
tools: [
{ name: 'tool1', count: 1 },
{ name: 'tool2', count: 1 },
{ name: 'tool3', count: 1 },
],
});
});

Expand All @@ -402,29 +452,65 @@ test('filter recipes by framework', async () => {
});
expect(result1.result.map(r => r.id)).toEqual(['recipe1']);
expect(result1.choices).toEqual({
languages: ['lang1', 'lang10'],
frameworks: ['fw1', 'fw10', 'fw11', 'fw2'],
tools: ['tool1'],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 1 },
],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 3 },
{ name: 'fw11', count: 1 },
{ name: 'fw2', count: 2 },
],
tools: [{ name: 'tool1', count: 1 }],
});

const result2 = catalogManager.filterRecipes({
frameworks: ['fw2'],
});
expect(result2.result.map(r => r.id)).toEqual(['recipe2', 'recipe3']);
expect(result2.choices).toEqual({
languages: ['lang10', 'lang11', 'lang2', 'lang3'],
frameworks: ['fw1', 'fw10', 'fw11', 'fw2'],
tools: ['tool2', 'tool3'],
languages: [
{ name: 'lang10', count: 1 },
{ name: 'lang11', count: 1 },
{ name: 'lang2', count: 1 },
{ name: 'lang3', count: 1 },
],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 3 },
{ name: 'fw11', count: 1 },
{ name: 'fw2', count: 2 },
],
tools: [
{ name: 'tool2', count: 1 },
{ name: 'tool3', count: 1 },
],
});

const result3 = catalogManager.filterRecipes({
frameworks: ['fw1', 'fw2'],
});
expect(result3.result.map(r => r.id)).toEqual(['recipe1', 'recipe2', 'recipe3']);
expect(result3.choices).toEqual({
languages: ['lang1', 'lang10', 'lang11', 'lang2', 'lang3'],
frameworks: ['fw1', 'fw10', 'fw11', 'fw2'],
tools: ['tool1', 'tool2', 'tool3'],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 2 },
{ name: 'lang11', count: 1 },
{ name: 'lang2', count: 1 },
{ name: 'lang3', count: 1 },
],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 3 },
{ name: 'fw11', count: 1 },
{ name: 'fw2', count: 2 },
],
tools: [
{ name: 'tool1', count: 1 },
{ name: 'tool2', count: 1 },
{ name: 'tool3', count: 1 },
],
});
});

Expand All @@ -441,9 +527,17 @@ test('filter recipes by language and framework', async () => {
});
expect(result1.result.map(r => r.id)).toEqual(['recipe2']);
expect(result1.choices).toEqual({
languages: ['lang10', 'lang11', 'lang2', 'lang3'],
frameworks: ['fw10', 'fw2'],
tools: ['tool2'],
languages: [
{ name: 'lang10', count: 1 },
{ name: 'lang11', count: 1 },
{ name: 'lang2', count: 1 },
{ name: 'lang3', count: 1 },
],
frameworks: [
{ name: 'fw10', count: 1 },
{ name: 'fw2', count: 1 },
],
tools: [{ name: 'tool2', count: 1 }],
});
});

Expand All @@ -461,8 +555,14 @@ test('filter recipes by language, tool and framework', async () => {
});
expect(result1.result.map(r => r.id)).toEqual(['recipe1']);
expect(result1.choices).toEqual({
languages: ['lang1', 'lang10'],
frameworks: ['fw1', 'fw10'],
tools: ['tool1'],
languages: [
{ name: 'lang1', count: 1 },
{ name: 'lang10', count: 1 },
],
frameworks: [
{ name: 'fw1', count: 1 },
{ name: 'fw10', count: 1 },
],
tools: [{ name: 'tool1', count: 1 }],
});
});
37 changes: 21 additions & 16 deletions packages/backend/src/managers/catalogManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,10 @@ import { Publisher } from '../utils/Publisher';
import type { LocalModelImportInfo } from '@shared/src/models/ILocalModelInfo';
import { InferenceType } from '@shared/src/models/IInference';
import { CatalogFormat, hasCatalogWrongFormat, merge, sanitize } from '../utils/catalogUtils';
import type { FilterRecipesResult, RecipeChoices, RecipeFilters } from '@shared/src/models/FilterRecipesResult';

export const USER_CATALOG = 'user-catalog.json';

export type CatalogFilterKey = 'languages' | 'tools' | 'frameworks';

export type RecipeFilters = {
[key in CatalogFilterKey]?: string[];
};

export interface FilterRecipesResult {
filters: RecipeFilters;
choices: RecipeFilters;
result: Recipe[];
}

export class CatalogManager extends Publisher<ApplicationCatalog> implements Disposable {
private readonly _onUpdate = new EventEmitter<ApplicationCatalog>();
readonly onUpdate: Event<ApplicationCatalog> = this._onUpdate.event;
Expand Down Expand Up @@ -312,7 +301,7 @@ export class CatalogManager extends Publisher<ApplicationCatalog> implements Dis
}
}
}
const choices: RecipeFilters = {};
const choices: RecipeChoices = {};
if ('languages' in filters) {
const subfilters = structuredClone(filters);
delete subfilters.languages;
Expand All @@ -322,15 +311,27 @@ export class CatalogManager extends Publisher<ApplicationCatalog> implements Dis
.flatMap(r => r.languages)
.filter(l => l !== undefined)
.filter((value, index, array) => array.indexOf(value) === index)
.sort((a, b) => a.localeCompare(b));
.sort((a, b) => a.localeCompare(b))
.map(l => ({
name: l,
count: result.filter(r => r.languages?.includes(l)).length,
}));
}

if ('tools' in filters) {
const subfilters = structuredClone(filters);
delete subfilters.tools;
choices.tools = this.filterRecipes(subfilters).choices.tools;
} else {
choices.tools = result.map(r => r.backend).filter(b => b !== undefined);
choices.tools = result
.map(r => r.backend)
.filter(b => b !== undefined)
.filter((value, index, array) => array.indexOf(value) === index)
.sort((a, b) => a.localeCompare(b))
.map(t => ({
name: t,
count: result.filter(r => r.backend === t).length,
}));
}

if ('frameworks' in filters) {
Expand All @@ -342,7 +343,11 @@ export class CatalogManager extends Publisher<ApplicationCatalog> implements Dis
.flatMap(r => r.frameworks)
.filter(f => f !== undefined)
.filter((value, index, array) => array.indexOf(value) === index)
.sort((a, b) => a.localeCompare(b));
.sort((a, b) => a.localeCompare(b))
.map(f => ({
name: f,
count: result.filter(r => r.frameworks?.includes(f)).length,
}));
}
return {
filters,
Expand Down
5 changes: 5 additions & 0 deletions packages/backend/src/studio-api-impl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ import type { PodmanConnection } from './managers/podmanConnection';
import type { RecipePullOptions } from '@shared/src/models/IRecipe';
import type { ContainerProviderConnection } from '@podman-desktop/api';
import type { NavigationRegistry } from './registries/NavigationRegistry';
import type { FilterRecipesResult, RecipeFilters } from '@shared/src/models/FilterRecipesResult';

interface PortQuickPickItem extends podmanDesktopApi.QuickPickItem {
port: number;
Expand Down Expand Up @@ -250,6 +251,10 @@ export class StudioApiImpl implements StudioAPI {
return this.catalogManager.getCatalog();
}

async filterRecipes(filters: RecipeFilters): Promise<FilterRecipesResult> {
return this.catalogManager.filterRecipes(filters);
}

async requestRemoveLocalModel(modelId: string): Promise<void> {
const modelInfo = this.modelsManager.getLocalModelInfo(modelId);

Expand Down
Loading