Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
228 changes: 228 additions & 0 deletions ui/src/components/favorite-button.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,228 @@
/*
* Copyright (C) 2026 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>)
*
* Licensed 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
*
* https://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.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/

import { useQuery } from '@tanstack/react-query';
import { Star } from 'lucide-react';
import { ComponentProps } from 'react';

import type { Organization, OrtRun, Product, Repository } from '@/api';
import {
getOrganizationOptions,
getProductOptions,
getRepositoryOptions,
} from '@/api/@tanstack/react-query.gen';
import { Button } from '@/components/ui/button';
import {
Tooltip,
TooltipContent,
TooltipTrigger,
} from '@/components/ui/tooltip';
import { cn } from '@/lib/utils';
import {
buildOrganizationFavorite,
buildProductFavorite,
buildRepositoryFavorite,
buildRunFavorite,
FavoriteItemInput,
useHomeFavoriteActions,
useIsHomeDataEnabled,
useIsHomeFavorite,
} from '@/providers/home-data';

type FavoriteButtonProps = Omit<
ComponentProps<typeof Button>,
'aria-label' | 'aria-pressed' | 'onClick' | 'type'
> & {
favorite: FavoriteItemInput;
};

type EntityFavoriteButtonProps = Omit<FavoriteButtonProps, 'favorite'>;

type FavoriteEntityId = number | string;

const toNumber = (id: FavoriteEntityId) =>
typeof id === 'number' ? id : Number.parseInt(id);

export const FavoriteButton = ({
favorite,
className,
disabled,
size = 'icon',
variant = 'outline',
...props
}: FavoriteButtonProps) => {
const isFavorite = useIsHomeFavorite(favorite.id);
const isEnabled = useIsHomeDataEnabled();
const { toggleFavorite } = useHomeFavoriteActions();
// Disable the button when favorites cannot be persisted (e.g. no user is
// known yet), so a click is never silently dropped.
const isDisabled = disabled || !isEnabled;
const label = isFavorite ? 'Remove from favorites' : 'Add to favorites';
const tooltip = isEnabled ? label : 'Sign in to manage favorites';

return (
<Tooltip>
<TooltipTrigger asChild>
<Button
aria-label={`${label}: ${favorite.name}`}
aria-pressed={isFavorite}
className={className}
disabled={isDisabled}
onClick={() => toggleFavorite(favorite)}
size={size}
type='button'
variant={variant}
{...props}
>
<Star
className={cn(
'h-4 w-4 text-white/50',
isFavorite && 'fill-white text-white'
)}
/>
</Button>
</TooltipTrigger>
<TooltipContent>{tooltip}</TooltipContent>
</Tooltip>
);
};

export const OrganizationFavoriteButton = ({
organization,
...props
}: EntityFavoriteButtonProps & { organization: Organization }) => (
<FavoriteButton
favorite={buildOrganizationFavorite(organization)}
{...props}
/>
);

export const ProductFavoriteButton = ({
organization,
organizationId,
product,
...props
}: EntityFavoriteButtonProps & {
organization?: Organization;
organizationId: FavoriteEntityId;
product: Product;
}) => {
const { data: loadedOrganization } = useQuery({
...getOrganizationOptions({
path: { organizationId: toNumber(organizationId) },
}),
enabled: organization === undefined,
});
const favoriteOrganization = organization ?? loadedOrganization;

return favoriteOrganization ? (
<FavoriteButton
favorite={buildProductFavorite(favoriteOrganization, product)}
{...props}
/>
) : null;
};

export const RepositoryFavoriteButton = ({
organization,
organizationId,
product,
productId,
repository,
...props
}: EntityFavoriteButtonProps & {
organization?: Organization;
organizationId: FavoriteEntityId;
product?: Product;
productId: FavoriteEntityId;
repository: Repository;
}) => {
const { data: loadedOrganization } = useQuery({
...getOrganizationOptions({
path: { organizationId: toNumber(organizationId) },
}),
enabled: organization === undefined,
});
const { data: loadedProduct } = useQuery({
...getProductOptions({ path: { productId: toNumber(productId) } }),
enabled: product === undefined,
});
const favoriteOrganization = organization ?? loadedOrganization;
const favoriteProduct = product ?? loadedProduct;

return favoriteOrganization && favoriteProduct ? (
<FavoriteButton
favorite={buildRepositoryFavorite(
favoriteOrganization,
favoriteProduct,
repository
)}
{...props}
/>
) : null;
};

export const RunFavoriteButton = ({
organization,
organizationId,
product,
productId,
repository,
repositoryId,
run,
...props
}: EntityFavoriteButtonProps & {
organization?: Organization;
organizationId: FavoriteEntityId;
product?: Product;
productId: FavoriteEntityId;
repository?: Repository;
repositoryId: FavoriteEntityId;
run: Pick<OrtRun, 'id' | 'index'>;
}) => {
const { data: loadedOrganization } = useQuery({
...getOrganizationOptions({
path: { organizationId: toNumber(organizationId) },
}),
enabled: organization === undefined,
});
const { data: loadedProduct } = useQuery({
...getProductOptions({ path: { productId: toNumber(productId) } }),
enabled: product === undefined,
});
const { data: loadedRepository } = useQuery({
...getRepositoryOptions({ path: { repositoryId: toNumber(repositoryId) } }),
enabled: repository === undefined,
});
const favoriteOrganization = organization ?? loadedOrganization;
const favoriteProduct = product ?? loadedProduct;
const favoriteRepository = repository ?? loadedRepository;

return favoriteOrganization && favoriteProduct && favoriteRepository ? (
<FavoriteButton
favorite={buildRunFavorite(
favoriteOrganization,
favoriteProduct,
favoriteRepository,
run
)}
{...props}
/>
) : null;
};
5 changes: 4 additions & 1 deletion ui/src/components/providers.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ import { TooltipProvider } from '@/components/ui/tooltip';
import { config } from '@/config';
import { TOKEN_FLOW_MARKER_KEY } from '@/helpers/token-flow';
import { queryClient } from '@/lib/query-client';
import { HomeDataProvider } from '@/providers/home-data';

const oidcConfig = config.oidcConfig;

Expand Down Expand Up @@ -55,7 +56,9 @@ export const Providers = ({ children }: { children: ReactNode }) => {
defaultColorTheme='default'
storageKeyColorTheme='vite-ui-theme-color'
>
<TooltipProvider>{children}</TooltipProvider>
<HomeDataProvider>
<TooltipProvider>{children}</TooltipProvider>
</HomeDataProvider>
</ThemeProvider>
</QueryClientProvider>
<Toaster
Expand Down
128 changes: 128 additions & 0 deletions ui/src/providers/home-data/favorite-builders.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
/*
* Copyright (C) 2026 The ORT Server Authors (See <https://github.com/eclipse-apoapsis/ort-server/blob/main/NOTICE>)
*
* Licensed 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
*
* https://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.
*
* SPDX-License-Identifier: Apache-2.0
* License-Filename: LICENSE
*/

import type { Organization, OrtRun, Product, Repository } from '@/api';
import {
buildOrganizationFavoriteId,
buildProductFavoriteId,
buildRepositoryFavoriteId,
buildRunFavoriteId,
} from './favorites';
import { buildRecentRunId } from './recent-runs';
import type { FavoriteItemInput, RecentRunItemInput } from './types';

const getRepositoryName = (repository: Repository) =>
repository.name || repository.url;

export const buildOrganizationFavorite = (
organization: Organization
): FavoriteItemInput => ({
id: buildOrganizationFavoriteId(organization.id),
type: 'organization',
name: organization.name,
breadcrumbs: [organization.name],
to: '/organizations/$orgId',
params: { orgId: organization.id.toString() },
});

export const buildProductFavorite = (
organization: Organization,
product: Product
): FavoriteItemInput => ({
id: buildProductFavoriteId(organization.id, product.id),
type: 'product',
name: product.name,
breadcrumbs: [organization.name, product.name],
to: '/organizations/$orgId/products/$productId',
params: {
orgId: organization.id.toString(),
productId: product.id.toString(),
},
});

/** Build a repository favorite using the repository name, falling back to its URL. */
export const buildRepositoryFavorite = (
organization: Organization,
product: Product,
repository: Repository
): FavoriteItemInput => ({
id: buildRepositoryFavoriteId(organization.id, product.id, repository.id),
type: 'repository',
name: getRepositoryName(repository),
breadcrumbs: [organization.name, product.name, getRepositoryName(repository)],
to: '/organizations/$orgId/products/$productId/repositories/$repoId/runs',
params: {
orgId: organization.id.toString(),
productId: product.id.toString(),
repoId: repository.id.toString(),
},
});

export const buildRunFavorite = (
organization: Organization,
product: Product,
repository: Repository,
run: Pick<OrtRun, 'id' | 'index'>
): FavoriteItemInput => ({
id: buildRunFavoriteId(run.id),
type: 'run',
name: `Run ${run.index}`,
breadcrumbs: [
organization.name,
product.name,
getRepositoryName(repository),
`Run ${run.index}`,
],
to: '/organizations/$orgId/products/$productId/repositories/$repoId/runs/$runIndex',
params: {
orgId: organization.id.toString(),
productId: product.id.toString(),
repoId: repository.id.toString(),
runIndex: run.index.toString(),
},
});

/** Build a recent run snapshot from the current organization, product, repository, and run. */
export const buildRecentRun = (
organization: Organization,
product: Product,
repository: Repository,
run: OrtRun
): RecentRunItemInput => ({
id: buildRecentRunId(run.id),
runId: run.id,
runIndex: run.index,
organizationId: organization.id,
organizationName: organization.name,
productId: product.id,
productName: product.name,
repositoryId: repository.id,
repositoryName: getRepositoryName(repository),
revision: run.revision,
path: run.path ?? undefined,
status: run.status,
to: '/organizations/$orgId/products/$productId/repositories/$repoId/runs/$runIndex',
params: {
orgId: organization.id.toString(),
productId: product.id.toString(),
repoId: repository.id.toString(),
runIndex: run.index.toString(),
},
createdAt: run.createdAt,
});
Loading
Loading