feat: scaffold the feature

WarningImHack3r · WarningImHack3r · commit 6e3b93194147 · 2025-05-09T00:52:36.000+02:00
diff --git a/src/lib/server/github-cache.ts b/src/lib/server/github-cache.ts
@@ -17,19 +17,28 @@ export type GitHubRelease = Awaited<
 	ReturnType<InstanceType<typeof Octokit>["rest"]["repos"]["listReleases"]>
 >["data"][number];
 
-type KeyType = "releases" | "descriptions" | "issue" | "pr";
+export type Member = Awaited<
+	ReturnType<InstanceType<typeof Octokit>["rest"]["orgs"]["listMembers"]>
+>["data"][number];
+
+type OwnerKeyType = "members";
+
+type RepoKeyType = "releases" | "descriptions" | "issue" | "issues" | "pr" | "prs";
 
 export type ItemDetails = {
 	comments: Awaited<ReturnType<Issues["listComments"]>>["data"];
 };
 
+export type Issue = Awaited<ReturnType<Issues["get"]>>["data"];
 export type IssueDetails = ItemDetails & {
-	info: Awaited<ReturnType<Issues["get"]>>["data"];
+	info: Issue;
 	linkedPrs: LinkedItem[];
 };
 
+export type PullRequest = Awaited<ReturnType<Pulls["get"]>>["data"];
+export type ListedPullRequest = Awaited<ReturnType<Pulls["list"]>>["data"][number];
 export type PullRequestDetails = ItemDetails & {
-	info: Awaited<ReturnType<Pulls["get"]>>["data"];
+	info: PullRequest;
 	commits: Awaited<ReturnType<Pulls["listCommits"]>>["data"];
 	files: Awaited<ReturnType<Pulls["listFiles"]>>["data"];
 	linkedIssues: LinkedItem[];
@@ -70,6 +79,10 @@ const FULL_DETAILS_TTL = 60 * 60 * 2; // 2 hours
  * The TTL of the cached descriptions, in seconds.
  */
 const DESCRIPTIONS_TTL = 60 * 60 * 24 * 10; // 10 days
+/**
+ * The TTL of organization members, in seconds.
+ */
+const MEMBERS_TTL = 60 * 60 * 24 * 2; // 2 days
 
 /**
  * A fetch layer to reach the GitHub API
@@ -98,6 +111,22 @@ export class GitHubCache {
 		});
 	}
 
+	/**
+	 * Generates a Redis key from the passed info.
+	 *
+	 * @param owner the GitHub repository owner
+	 * @param type the kind of cache to use
+	 * @param args the optional additional values to append
+	 * at the end of the key; every element will be interpolated
+	 * in a string
+	 * @returns the pure computed key
+	 * @private
+	 */
+	#getOwnerKey(owner: string, type: OwnerKeyType, ...args: unknown[]) {
+		const strArgs = args.map(a => `:${a}`);
+		return `owner:${owner}:${type}${strArgs}`;
+	}
+
 	/**
 	 * Generates a Redis key from the passed info.
 	 *
@@ -110,7 +139,7 @@ export class GitHubCache {
 	 * @returns the pure computed key
 	 * @private
 	 */
-	#getRepoKey(owner: string, repo: string, type: KeyType, ...args: unknown[]) {
+	#getRepoKey(owner: string, repo: string, type: RepoKeyType, ...args: unknown[]) {
 		const strArgs = args.map(a => `:${a}`);
 		return `repo:${owner}/${repo}:${type}${strArgs}`;
 	}
@@ -130,7 +159,7 @@ export class GitHubCache {
 		owner: string,
 		repo: string,
 		id: number,
-		type: ExtractStrict<KeyType, "issue" | "pr"> | undefined = undefined
+		type: ExtractStrict<RepoKeyType, "issue" | "pr"> | undefined = undefined
 	) {
 		// Known type we assume the existence of
 		switch (type) {
@@ -575,6 +604,115 @@ export class GitHubCache {
 		return Object.fromEntries(descriptions);
 	}
 
+	/**
+	 * Get the list of members for a given organization.
+	 *
+	 * @param owner the GitHub organization name
+	 * @returns a list of members, or `undefined` if not existing
+	 */
+	async getOrganizationMembers(owner: string): Promise<Member[] | undefined> {
+		const cacheKey = this.#getOwnerKey(owner, "members");
+
+		const cachedMembers = await this.#redis.json.get<Member[]>(cacheKey);
+		if (cachedMembers) {
+			console.log(`Cache hit for members of ${owner}`);
+			return cachedMembers.length ? cachedMembers : undefined; // technically we can have a real empty list, but we ignore this case here
+		}
+
+		console.log(`Cache miss for members of ${owner}, fetching from GitHub API`);
+
+		try {
+			const { data: members } = await this.#octokit.rest.orgs.listPublicMembers({
+				org: owner,
+				per_page
+			});
+
+			await this.#redis.json.set(cacheKey, "$", members);
+			await this.#redis.expire(cacheKey, MEMBERS_TTL);
+
+			return members;
+		} catch {
+			await this.#redis.json.set(cacheKey, "$", []);
+			await this.#redis.expire(cacheKey, MEMBERS_TTL);
+
+			return undefined;
+		}
+	}
+
+	/**
+	 * Get all the issues for a given GitHub repository.
+	 *
+	 * @param owner the GitHub repository owner
+	 * @param repo the GitHub repository name
+	 * @returns a list of issues, or `undefined` if not existing
+	 */
+	async getAllIssues(owner: string, repo: string): Promise<Issue[] | undefined> {
+		const cacheKey = this.#getRepoKey(owner, repo, "issues");
+
+		const cachedIssues = await this.#redis.json.get<Issue[]>(cacheKey);
+		if (cachedIssues) {
+			console.log(`Cache hit for issues for ${owner}`);
+			return cachedIssues.length ? cachedIssues : undefined;
+		}
+
+		console.log(`Cache miss for issues for ${owner}`);
+
+		try {
+			const { data: issues } = await this.#octokit.rest.issues.listForRepo({
+				owner,
+				repo,
+				per_page
+			});
+
+			await this.#redis.json.set(cacheKey, "$", issues);
+			await this.#redis.expire(cacheKey, FULL_DETAILS_TTL);
+
+			return issues;
+		} catch {
+			await this.#redis.json.set(cacheKey, "$", []);
+			await this.#redis.expire(cacheKey, FULL_DETAILS_TTL);
+
+			return undefined;
+		}
+	}
+
+	/**
+	 * Get all the pull requests for a given GitHub repository.
+	 *
+	 * @param owner the GitHub repository owner
+	 * @param repo the GitHub repository name
+	 * @returns a list of pull requests, or `undefined` if not existing
+	 */
+	async getAllPRs(owner: string, repo: string): Promise<ListedPullRequest[] | undefined> {
+		const cacheKey = this.#getRepoKey(owner, repo, "prs");
+
+		const cachedPrs = await this.#redis.json.get<ListedPullRequest[]>(cacheKey);
+		if (cachedPrs) {
+			console.log(`Cache hit for PRs for ${owner}`);
+			return cachedPrs.length ? cachedPrs : undefined;
+		}
+
+		console.log(`Cache miss for PRs for PRs for ${owner}`);
+
+		try {
+			const { data: prs } = await this.#octokit.rest.pulls.list({
+				owner,
+				repo,
+				per_page
+			});
+
+			await this.#redis.json.set(cacheKey, "$", prs);
+			await this.#redis.expire(cacheKey, FULL_DETAILS_TTL);
+
+			return prs;
+		} catch {
+			await this.#redis.json.set(cacheKey, "$", []);
+			await this.#redis.expire(cacheKey, FULL_DETAILS_TTL);
+
+			return undefined;
+		}
+	}
+
 	/**
 	 * Checks if releases are present in the cache for the
 	 * given GitHub info
@@ -586,7 +724,7 @@ export class GitHubCache {
 	 * @param type the kind of cache to target
 	 * @returns whether the repository is cached or not
 	 */
-	async exists(owner: string, repo: string, type: KeyType) {
+	async exists(owner: string, repo: string, type: RepoKeyType) {
 		const cacheKey = this.#getRepoKey(owner, repo, type);
 		const result = await this.#redis.exists(cacheKey);
 		return result === 1;
@@ -601,7 +739,7 @@ export class GitHubCache {
 	 * from the cache
 	 * @param type the kind of cache to target
 	 */
-	async deleteEntry(owner: string, repo: string, type: KeyType) {
+	async deleteEntry(owner: string, repo: string, type: RepoKeyType) {
 		const cacheKey = this.#getRepoKey(owner, repo, type);
 		await this.#redis.del(cacheKey);
 	}
diff --git a/src/routes/+layout.svelte b/src/routes/+layout.svelte
@@ -147,7 +147,7 @@
 			<!-- Navigation -->
 			{#if !page.route.id?.startsWith("/blog")}
 				<ul class="ml-6 hidden sm:flex">
-					{#each [{ link: "/packages", title: "Packages" }, { link: "/blog", title: "Blog" }] as { link, title } (link)}
+					{#each [{ link: "/packages", title: "Packages" }, { link: "/tracker", title: "Tracker" }, { link: "/blog", title: "Blog" }] as { link, title } (link)}
 						{@const disabled = page.url.pathname.startsWith(link)}
 						<li>
 							<Button
diff --git a/src/routes/tracker/+page.server.ts b/src/routes/tracker/+page.server.ts
@@ -0,0 +1,9 @@
+import { redirect } from "@sveltejs/kit";
+import { uniqueRepos } from "$lib/repositories";
+
+export function load({ url }) {
+	// Load the first repo of our list
+	const firstRepo = uniqueRepos[0];
+	if (!firstRepo) redirect(307, "/");
+	redirect(307, `${url.pathname}/${firstRepo.owner}/${firstRepo.name}`);
+}
diff --git a/src/routes/tracker/[org]/+page.server.ts b/src/routes/tracker/[org]/+page.server.ts
@@ -0,0 +1,11 @@
+import { redirect } from "@sveltejs/kit";
+import { uniqueRepos } from "$lib/repositories";
+
+export function load({ params }) {
+	// Load the first repo that has the org
+	const matchingRepo = uniqueRepos.find(
+		({ owner }) => owner.localeCompare(params.org, undefined, { sensitivity: "base" }) === 0
+	);
+	if (!matchingRepo) redirect(307, "/");
+	redirect(307, `/tracker/${matchingRepo.owner}/${matchingRepo.name}`);
+}
diff --git a/src/routes/tracker/[org]/[repo]/+page.server.ts b/src/routes/tracker/[org]/[repo]/+page.server.ts
@@ -0,0 +1,51 @@
+import { error } from "@sveltejs/kit";
+import { gitHubCache } from "$lib/server/github-cache";
+
+// source: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
+const closingKeywords = [
+	"close",
+	"closes",
+	"closed",
+	"fix",
+	"fixes",
+	"fixed",
+	"resolve",
+	"resolves",
+	"resolved"
+];
+
+export async function load({ params }) {
+	const members = await gitHubCache.getOrganizationMembers(params.org);
+	if (!members) error(404, `Organization ${params.org} not found or empty`);
+
+	const membersNames = members.map(({ login }) => login);
+
+	const [unfilteredPRs, unfilteredIssues] = await Promise.all([
+		gitHubCache.getAllPRs(params.org, params.repo),
+		gitHubCache.getAllIssues(params.org, params.repo)
+	]);
+	return {
+		prs: unfilteredPRs
+			?.filter(({ user, body }) => {
+				if (!membersNames.includes(user?.login ?? "")) return false;
+				if (!body) return true;
+				const lowerBody = body.toLowerCase();
+				for (const keyword of closingKeywords) {
+					if (
+						lowerBody.includes(`${keyword} #`) ||
+						lowerBody.includes(`${keyword} https://github.com`) ||
+						new RegExp(`${keyword} [A-z0-9]+/[A-z0-9]+#[0-9]+`).test(lowerBody)
+					) {
+						return false;
+					}
+				}
+				return true;
+			})
+			.toSorted((a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime())
+			.slice(0, 10),
+		issues: unfilteredIssues
+			?.filter(({ user }) => membersNames.includes(user?.login ?? ""))
+			.toSorted((a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime())
+			.slice(0, 10)
+	};
+}
diff --git a/src/routes/tracker/[org]/[repo]/+page.svelte b/src/routes/tracker/[org]/[repo]/+page.svelte
@@ -0,0 +1,91 @@
+<script lang="ts">
+	import { Transparent } from "svelte-exmarkdown";
+	import { Separator } from "$lib/components/ui/separator";
+	import MarkdownRenderer from "$lib/components/MarkdownRenderer.svelte";
+
+	let { data } = $props();
+
+	type Item = NonNullable<typeof data.issues>[number] | NonNullable<typeof data.prs>[number];
+
+	function isNew(date: Date) {
+		return date.getTime() >= new Date().getTime() - 1000 * 60 * 60 * 24 * 30;
+	}
+
+	function daysAgo(date: Date) {
+		const days = Math.floor((new Date().getTime() - date.getTime()) / 1000 / 60 / 60 / 24);
+		return new Intl.RelativeTimeFormat("en", { numeric: "auto" }).format(-days, "day");
+	}
+</script>
+
+<!-- snippets don't support generics: https://github.com/sveltejs/svelte/issues/15883 -->
+<!-- eslint-disable-next-line @typescript-eslint/no-explicit-any -->
+{#snippet list(title: string, items: Item[], itemToLink: (item: any) => string)}
+	<!-- {#snippet list<T extends Item>(title: string, items: T[], itemToLink: (item: T) => string)} -->
+	<div>
+		<h2 class="mt-12 mb-2 text-2xl font-semibold tracking-tight">{title}</h2>
+		{#each items as item, i (item.id)}
+			{#if i > 0}
+				<Separator class="my-1" />
+			{/if}
+			{@render listItem(item, itemToLink(item))}
+		{/each}
+	</div>
+{/snippet}
+
+{#snippet listItem(item: Item, link: string)}
+	{@const date = new Date(item.created_at)}
+	<a
+		href={link}
+		class="flex flex-col rounded-xl px-4 py-3 transition-colors hover:bg-neutral-100 dark:hover:bg-neutral-800"
+	>
+		<div class="flex justify-between">
+			<span>
+				<MarkdownRenderer markdown={item.title} inline class="text-foreground" />
+				<span class="text-muted-foreground">#{item.number}</span>
+			</span>
+			<span>
+				{#if isNew(date)}
+					{daysAgo(date)} •
+				{/if}
+				{new Intl.DateTimeFormat("en", {
+					dateStyle: "medium"
+				}).format(date)}
+			</span>
+		</div>
+		<MarkdownRenderer
+			markdown={item.body || "_No description_"}
+			inline
+			parseRawHtml
+			class="line-clamp-2 max-w-full text-base text-muted-foreground"
+			additionalPlugins={[
+				{
+					renderer: {
+						h1: "h4",
+						h2: "h4",
+						h3: "h4",
+						pre: Transparent,
+						a: Transparent,
+						ul: Transparent
+					}
+				}
+			]}
+		/>
+	</a>
+{/snippet}
+
+{#if data.prs}
+	{@render list(
+		"Pull requests",
+		data.prs,
+		pr => `/pull/${pr.base.repo.owner.login}/${pr.base.repo.name}/${pr.number}`
+	)}
+{/if}
+
+{#if data.issues}
+	{@render list("Issues", data.issues, issue => {
+		const ownerSlashRepo = issue.html_url
+			.replace("https://github.com/", "")
+			.replace(/\/[A-z]+\/\d+$/, "");
+		return `/issues/${ownerSlashRepo}/${issue.number}`;
+	})}
+{/if}
diff --git a/src/routes/tracker/[org]/[repo]/+page.ts b/src/routes/tracker/[org]/[repo]/+page.ts
