Skip to content
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.

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

feat: add releases widget #2497

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from
Draft
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
2 changes: 2 additions & 0 deletions packages/api/src/router/widgets/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { mediaTranscodingRouter } from "./media-transcoding";
import { minecraftRouter } from "./minecraft";
import { notebookRouter } from "./notebook";
import { optionsRouter } from "./options";
import { releasesRouter } from "./releases";
import { rssFeedRouter } from "./rssFeed";
import { smartHomeRouter } from "./smart-home";
import { weatherRouter } from "./weather";
Expand All @@ -31,4 +32,5 @@ export const widgetRouter = createTRPCRouter({
mediaTranscoding: mediaTranscodingRouter,
minecraft: minecraftRouter,
options: optionsRouter,
releases: releasesRouter,
});
36 changes: 36 additions & 0 deletions packages/api/src/router/widgets/releases.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import { z } from "zod";

import { releasesRequestHandler } from "@homarr/request-handler/releases";

import { createTRPCRouter, publicProcedure } from "../../trpc";

export const releasesRouter = createTRPCRouter({
getLatest: publicProcedure
.input(
z.object({
releases: z.array(
z.object({
providerName: z.string(),
identifier: z.string(),
versionRegex: z.string().optional(),
}),
),
}),
)
.query(async ({ input }) => {
const result = await Promise.all(
input.releases.map(async (release) => {
const innerHandler = releasesRequestHandler.handler({
providerName: release.providerName,
identifier: release.identifier,
versionRegex: release.versionRegex,
});
return await innerHandler.getCachedOrUpdatedDataAsync({
forceUpdate: false,
});
}),
);

return result;
}),
});
2 changes: 1 addition & 1 deletion packages/api/src/router/widgets/rssFeed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { rssFeedsRequestHandler } from "@homarr/request-handler/rss-feeds";

import { createTRPCRouter, publicProcedure } from "../../trpc";

export const rssFeedRouter = createTRPCRouter({
export const rssFeedRouter = createTRPCRouter({
getFeeds: publicProcedure
.input(
z.object({
Expand Down
1 change: 1 addition & 0 deletions packages/definitions/src/widget.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,6 @@ export const widgetKinds = [
"bookmarks",
"indexerManager",
"healthMonitoring",
"releases",
] as const;
export type WidgetKind = (typeof widgetKinds)[number];
5 changes: 3 additions & 2 deletions packages/forms-collection/src/icon-picker/icon-picker.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,10 @@ interface IconPickerProps {
error?: string | null;
onFocus?: FocusEventHandler;
onBlur?: FocusEventHandler;
withAsterisk?: boolean;
}

export const IconPicker = ({ value: propsValue, onChange, error, onFocus, onBlur }: IconPickerProps) => {
export const IconPicker = ({ value: propsValue, onChange, error, onFocus, onBlur, withAsterisk = true }: IconPickerProps) => {
const [value, setValue] = useUncontrolled({
value: propsValue,
onChange,
Expand Down Expand Up @@ -145,7 +146,7 @@ export const IconPicker = ({ value: propsValue, onChange, error, onFocus, onBlur
setSearch(value || "");
}}
rightSectionPointerEvents="none"
withAsterisk
withAsterisk={withAsterisk}
error={error}
label={tCommon("iconPicker.label")}
placeholder={tCommon("iconPicker.header", { countIcons: data?.countIcons ?? 0 })}
Expand Down
146 changes: 146 additions & 0 deletions packages/request-handler/src/releases.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
import dayjs from "dayjs";
import { z } from "zod";

import { fetchWithTimeout } from "@homarr/common";

import { Providers } from "../../widgets/src/releases/release-providers";
import { createCachedWidgetRequestHandler } from "./lib/cached-widget-request-handler";

const dockerResponseSchema = z
.object({
results: z.array(
z
.object({ name: z.string(), last_updated: z.string().transform((value) => new Date(value)) })
.transform((tag) => ({
identifier: "",
tag: tag.name,
lastUpdated: tag.last_updated,
})),
),
})
.transform((resp) => resp.results);

const githubResponseSchema = z.array(
z
.object({ tag_name: z.string(), published_at: z.string().transform((value) => new Date(value)) })
.transform((tag) => ({
identifier: "",
tag: tag.tag_name,
lastUpdated: tag.published_at,
})),
);

const gitlabResponseSchema = z.array(
z.object({ name: z.string(), released_at: z.string().transform((value) => new Date(value)) }).transform((tag) => ({
identifier: "",
tag: tag.name,
lastUpdated: tag.released_at,
})),
);

const npmResponseSchema = z
.object({
time: z.record(z.string().transform((value) => new Date(value))).transform((version) =>
Object.entries(version).map(([key, value]) => ({
identifier: "",
tag: key,
lastUpdated: value,
})),
),
})
.transform((resp) => resp.time);

const codebergResponseSchema = z.array(
z
.object({ tag_name: z.string(), published_at: z.string().transform((value) => new Date(value)) })
.transform((tag) => ({
identifier: "",
tag: tag.tag_name,
lastUpdated: tag.published_at,
})),
);

const _responseSchema = z.object({ identifier: z.string(), tag: z.string(), lastUpdated: z.date() });

function getDockerUrl(identifier: string): string {
if (identifier.indexOf("/") > 0) {
const [owner, name] = identifier.split("/");
if (!owner || !name) {
return "";
}
return `https://hub.docker.com/v2/namespaces/${encodeURIComponent(owner)}/repositories/${encodeURIComponent(name)}/tags?page_size=50`;
} else {
return `https://hub.docker.com/v2/repositories/library/${encodeURIComponent(identifier)}/tags?page_size=50`;
}
}

function getGithubUrl(identifier: string): string {
return `https://api.github.com/repos/${encodeURIComponent(identifier)}/releases`;
}

function getGitlabUrl(identifier: string): string {
return `https://gitlab.com/api/v4/projects/${encodeURIComponent(identifier)}/releases`;
}

function getNpmUrl(identifier: string): string {
return `https://registry.npmjs.org/${encodeURIComponent(identifier)}`;
}

function getCodebergUrl(identifier: string): string {
const [owner, name] = identifier.split("/");
if (!owner || !name) {
return "";
}
return `https://codeberg.org/api/v1/repos/${encodeURIComponent(owner)}/${encodeURIComponent(name)}/releases`;
}

export const releasesRequestHandler = createCachedWidgetRequestHandler({
queryKey: "releasesApiResult",
widgetKind: "releases",
async requestAsync(input: { providerName: string; identifier: string; versionRegex: string | undefined }) {
let url = "";
let responseSchema;
switch (input.providerName) {
case Providers.Docker.name:
url = getDockerUrl(input.identifier);
responseSchema = dockerResponseSchema;
break;
case Providers.Github.name:
url = getGithubUrl(input.identifier);
responseSchema = githubResponseSchema;
break;
case Providers.Gitlab.name:
url = getGitlabUrl(input.identifier);
responseSchema = gitlabResponseSchema;
break;
case Providers.Npm.name:
url = getNpmUrl(input.identifier);
responseSchema = npmResponseSchema;
break;
case Providers.Codeberg.name:
url = getCodebergUrl(input.identifier);
responseSchema = codebergResponseSchema;
break;
}

if (url === "" || responseSchema === undefined) return undefined;

const response = await fetchWithTimeout(url);
const result = responseSchema.safeParse(await response.json());

if (!result.success) return undefined;

const latest: ReleaseResponse = result.data
.filter((result) => (input.versionRegex ? new RegExp(input.versionRegex).test(result.tag) : false))
.reduce(
(latest, result) => {
return result.lastUpdated > latest.lastUpdated ? { ...result, identifier: input.identifier } : latest;
},
{ identifier: "", tag: "", lastUpdated: new Date(0) },
);
return latest;
},
cacheDuration: dayjs.duration(5, "minutes"),
});

export type ReleaseResponse = z.infer<typeof _responseSchema>;
41 changes: 41 additions & 0 deletions packages/translation/src/lang/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -1927,6 +1927,47 @@
"label": "Amount posts limit"
}
}
},
"releases": {
"name": "Releases",
"description": "Displays a list of the current version of the given repositories with the given version regex.",
"option": {
"releases": {
"label": "Releases"
},
"addRelease": {
"label": "Add release"
},
"provider": {
"label": "Provider"
},
"identifier": {
"label": "Identifier",
"placeholder": "Name or Owner/Name"
},
"versionRegex": {
"label": "Version Regex"
},
"sortBy": {
"label": "Sort By"
},
"showOnlyNewReleases": {
"label": "Show Only New Releases"
},
"edit": {
"label": "Edit"
}
},
"editForm": {
"title": "Edit Release",
"cancel": {
"label": "Cancel"
},
"confirm": {
"label": "Confirm"
}
},
"not-found": "Not Found"
}
},
"widgetPreview": {
Expand Down
2 changes: 2 additions & 0 deletions packages/widgets/src/_inputs/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { WidgetSliderInput } from "./widget-slider-input";
import { WidgetSortedItemListInput } from "./widget-sortable-item-list-input";
import { WidgetSwitchInput } from "./widget-switch-input";
import { WidgetTextInput } from "./widget-text-input";
import { WidgetMultiReleasesInput } from "./widget-multiReleases-input";

const mapping = {
text: WidgetTextInput,
Expand All @@ -21,6 +22,7 @@ const mapping = {
switch: WidgetSwitchInput,
app: WidgetAppInput,
sortableItemList: WidgetSortedItemListInput,
multiReleases: WidgetMultiReleasesInput
} satisfies Record<WidgetOptionType, unknown>;

export const getInputForType = <TType extends WidgetOptionType>(type: TType) => {
Expand Down
Loading