refactor: address adversarial widget architecture review
This commit is contained in:
1 parent
0ca62f1232
commit
9bf266935b
42 files changed
+460
-578
No files matched your search
@@ -20,7 +20,6 @@
|
||||
"./custom-api/custom-jsx-display": "./src/custom-api/custom-jsx-display.tsx",
|
||||
"./custom-api/extract-display-data": "./src/custom-api/extract-display-data.ts",
|
||||
"./assistant/context": "./src/assistant/context.tsx",
|
||||
"./catalog": "./src/catalog.ts",
|
||||
"./definition": "./src/definition.ts",
|
||||
"./errors": "./src/errors/component.tsx",
|
||||
"./manifest": "./src/manifest.ts",
|
||||
|
||||
@@ -7,8 +7,11 @@ import { createTrpcQueryKey } from "../trpc-query-key";
|
||||
|
||||
const logger = createLogger({ module: "appWidgetPrefetch" });
|
||||
|
||||
const prefetchAllAsync: Prefetch<"app"> = async (queryClient, items) => {
|
||||
const appIds = items.map((item) => item.options.appId);
|
||||
const prefetchAllAsync: Prefetch = async (queryClient, items) => {
|
||||
const appIds: string[] = [];
|
||||
for (const item of items) {
|
||||
if (typeof item.options.appId === "string") appIds.push(item.options.appId);
|
||||
}
|
||||
const distinctAppIds = [...new Set(appIds)];
|
||||
|
||||
const dbApps = await db.query.apps.findMany({
|
||||
|
||||
@@ -8,8 +8,13 @@ import { getDirectBookmarkUrl } from "./bookmark-item";
|
||||
|
||||
const logger = createLogger({ module: "bookmarksWidgetPrefetch" });
|
||||
|
||||
const prefetchAllAsync: Prefetch<"bookmarks"> = async (queryClient, items) => {
|
||||
const appIds = items.flatMap((item) => item.options.items.filter((value) => !getDirectBookmarkUrl(value)));
|
||||
const getAppIds = (options: Record<string, unknown>) => {
|
||||
if (!Array.isArray(options.items)) return [];
|
||||
return options.items.filter((value): value is string => typeof value === "string" && !getDirectBookmarkUrl(value));
|
||||
};
|
||||
|
||||
const prefetchAllAsync: Prefetch = async (queryClient, items) => {
|
||||
const appIds = items.flatMap((item) => getAppIds(item.options));
|
||||
const distinctAppIds = [...new Set(appIds)];
|
||||
|
||||
const dbApps = await db.query.apps.findMany({
|
||||
@@ -17,7 +22,7 @@ const prefetchAllAsync: Prefetch<"bookmarks"> = async (queryClient, items) => {
|
||||
});
|
||||
|
||||
for (const item of items) {
|
||||
const itemAppIds = item.options.items.filter((value) => !getDirectBookmarkUrl(value));
|
||||
const itemAppIds = getAppIds(item.options);
|
||||
if (itemAppIds.length === 0) {
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
export { widgetCatalogIcons } from "@homarr/ui/widget-icons";
|
||||
@@ -83,11 +83,11 @@ const createWithDynamicImport =
|
||||
componentLoader,
|
||||
});
|
||||
|
||||
export type PrefetchLoader<TKind extends WidgetKind> = () => Promise<{ default: Prefetch<TKind> }>;
|
||||
export type Prefetch<TKind extends WidgetKind> = (
|
||||
export type PrefetchLoader = () => Promise<{ default: Prefetch }>;
|
||||
export type Prefetch = (
|
||||
queryClient: QueryClient,
|
||||
items: {
|
||||
options: inferOptionsFromCreator<WidgetOptionsRecordOf<TKind>>;
|
||||
options: Record<string, unknown>;
|
||||
integrationIds: string[];
|
||||
}[],
|
||||
) => Promise<void>;
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import { healthMonitoringClusterIntegrationKinds, healthMonitoringSystemIntegrationKinds } from "@homarr/definitions";
|
||||
import type { IntegrationKind } from "@homarr/definitions";
|
||||
|
||||
interface HealthMonitoringIntegration {
|
||||
@@ -5,8 +6,11 @@ interface HealthMonitoringIntegration {
|
||||
kind: IntegrationKind;
|
||||
}
|
||||
|
||||
const systemIntegrationKinds = new Set<IntegrationKind>(healthMonitoringSystemIntegrationKinds);
|
||||
const clusterIntegrationKinds = new Set<IntegrationKind>(healthMonitoringClusterIntegrationKinds);
|
||||
|
||||
export const partitionHealthMonitoringIntegrations = (integrations: HealthMonitoringIntegration[]) => ({
|
||||
clusterIntegrationIds: integrations.filter(({ kind }) => kind === "proxmox" || kind === "mock").map(({ id }) => id),
|
||||
clusterIntegrationIds: integrations.filter(({ kind }) => clusterIntegrationKinds.has(kind)).map(({ id }) => id),
|
||||
// Mock implements both contracts and remains visible in both views.
|
||||
systemIntegrationIds: integrations.filter(({ kind }) => kind !== "proxmox").map(({ id }) => id),
|
||||
systemIntegrationIds: integrations.filter(({ kind }) => systemIntegrationKinds.has(kind)).map(({ id }) => id),
|
||||
});
|
||||
@@ -14,7 +14,7 @@ import {
|
||||
widgetKinds,
|
||||
} from "./manifest";
|
||||
import { widgetQueryRefetchIntervals } from "./refetch-intervals";
|
||||
import { widgetCatalogIcons } from "./catalog";
|
||||
import { widgetCatalogIcons } from "@homarr/ui/widget-icons";
|
||||
import { getWidgetQueryKeys } from "./definition";
|
||||
|
||||
const serializePollingPolicy = ({
|
||||
|
||||
@@ -154,12 +154,10 @@ export const reduceWidgetOptionsWithDefinition = (
|
||||
settings: Pick<SettingsContextProps, "enableStatusByDefault" | "forceDisableStatus">,
|
||||
currentValue: Record<string, unknown> = {},
|
||||
) => {
|
||||
const options = definition.createOptions(settings) as Record<string, WidgetOptionDefinition>;
|
||||
return objectEntries(options).reduce(
|
||||
(prev, [key, value]) => ({
|
||||
...prev,
|
||||
[key]: currentValue[key] ?? value.defaultValue,
|
||||
}),
|
||||
{} as Record<string, unknown>,
|
||||
);
|
||||
const options: Record<string, WidgetOptionDefinition> = definition.createOptions(settings);
|
||||
const result: Record<string, unknown> = {};
|
||||
for (const [key, value] of objectEntries(options)) {
|
||||
result[key] = currentValue[key] ?? value.defaultValue;
|
||||
}
|
||||
return result;
|
||||
};
|
||||
@@ -5,12 +5,10 @@ import type { WidgetKind } from "@homarr/definitions";
|
||||
import { createSettings } from "@homarr/settings/creator";
|
||||
|
||||
import { loadWidgetDefinition, reduceWidgetOptionsWithDefinition } from "./manifest";
|
||||
import type { PrefetchLoader, WidgetOptionsRecordOf } from "./definition";
|
||||
import type { inferOptionsFromCreator } from "./options";
|
||||
import type { PrefetchLoader } from "./definition";
|
||||
|
||||
const definePrefetchLoaders = <TLoaders extends Partial<{ [TKind in WidgetKind]: PrefetchLoader<TKind> }>>(
|
||||
loaders: TLoaders,
|
||||
) => loaders;
|
||||
const definePrefetchLoaders = <TLoaders extends Partial<Record<WidgetKind, PrefetchLoader>>>(loaders: TLoaders) =>
|
||||
loaders;
|
||||
|
||||
// Keep these imports explicit so Next.js can trace each optional prefetch
|
||||
// module without loading its database-specific implementation eagerly.
|
||||
@@ -24,11 +22,11 @@ type PrefetchWidgetKind = keyof typeof prefetchLoaders;
|
||||
const hasPrefetchLoader = (kind: WidgetKind): kind is PrefetchWidgetKind =>
|
||||
Object.prototype.hasOwnProperty.call(prefetchLoaders, kind);
|
||||
|
||||
export const prefetchForKindAsync = async <TKind extends WidgetKind>(
|
||||
kind: TKind,
|
||||
export const prefetchForKindAsync = async (
|
||||
kind: WidgetKind,
|
||||
queryClient: QueryClient,
|
||||
items: {
|
||||
options: inferOptionsFromCreator<WidgetOptionsRecordOf<TKind>>;
|
||||
options: Record<string, unknown>;
|
||||
integrationIds: string[];
|
||||
}[],
|
||||
) => {
|
||||
@@ -51,5 +49,5 @@ export const prefetchForKindAsync = async <TKind extends WidgetKind>(
|
||||
),
|
||||
}));
|
||||
|
||||
await callback(queryClient, itemsWithDefaultOptions as never[]);
|
||||
await callback(queryClient, itemsWithDefaultOptions);
|
||||
};
|
||||
Reference in new issue
Block a user