aboutsummaryrefslogtreecommitdiffstats
path: root/apps/web/components/shared/sidebar/SidebarVersion.tsx
blob: fc2ec5a3a9dea17f1a928b64ee44a349b11b88ab (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
"use client";

import { useCallback, useEffect, useMemo, useState } from "react";
import Link from "next/link";
import { Button } from "@/components/ui/button";
import {
  Dialog,
  DialogContent,
  DialogDescription,
  DialogHeader,
  DialogTitle,
} from "@/components/ui/dialog";
import { MarkdownReadonly } from "@/components/ui/markdown/markdown-readonly";
import { useClientConfig } from "@/lib/clientConfig";
import { useTranslation } from "@/lib/i18n/client";
import { useQuery } from "@tanstack/react-query";
import { AlertCircle, Loader2 } from "lucide-react";
import { z } from "zod";

const GITHUB_OWNER_REPO = "karakeep-app/karakeep";
const GITHUB_REPO_URL = `https://github.com/${GITHUB_OWNER_REPO}`;
const GITHUB_RELEASE_URL = `${GITHUB_REPO_URL}/releases/tag/`;
const RELEASE_API_URL = `https://api.github.com/repos/${GITHUB_OWNER_REPO}/releases/tags/`;
const LOCAL_STORAGE_KEY = "karakeep:whats-new:last-seen-version";
const RELEASE_NOTES_STALE_TIME = 1000 * 60 * 10; // 10 minutes

const zGitHubReleaseSchema = z.object({
  body: z.string().optional(),
  tag_name: z.string(),
  name: z.string(),
});

function isStableRelease(version?: string) {
  if (!version) {
    return false;
  }
  const normalized = version.toLowerCase();
  if (
    normalized.includes("nightly") ||
    normalized.includes("beta") ||
    normalized.includes("0.0.1")
  ) {
    return false;
  }
  return true;
}

interface SidebarVersionProps {
  serverVersion?: string;
}

export default function SidebarVersion({ serverVersion }: SidebarVersionProps) {
  const { disableNewReleaseCheck } = useClientConfig();
  const { t } = useTranslation();

  const stableRelease = isStableRelease(serverVersion);
  const displayVersion = serverVersion ?? "unknown";
  const versionLabel = `Karakeep v${displayVersion}`;
  const releasePageUrl = useMemo(() => {
    if (!serverVersion || !isStableRelease(serverVersion)) {
      return GITHUB_REPO_URL;
    }
    return `${GITHUB_RELEASE_URL}v${serverVersion}`;
  }, [serverVersion]);

  const [open, setOpen] = useState(false);
  const [shouldNotify, setShouldNotify] = useState(false);

  const releaseNotesQuery = useQuery<string>({
    queryKey: ["sidebar-release-notes", serverVersion],
    queryFn: async ({ signal }) => {
      if (!serverVersion) {
        return "";
      }

      const response = await fetch(`${RELEASE_API_URL}v${serverVersion}`, {
        signal,
      });

      if (!response.ok) {
        throw new Error("Failed to load release notes");
      }

      const json = await response.json();
      const data = zGitHubReleaseSchema.parse(json);
      return data.body ?? "";
    },
    enabled:
      open &&
      stableRelease &&
      !disableNewReleaseCheck &&
      Boolean(serverVersion),
    staleTime: RELEASE_NOTES_STALE_TIME,
    retry: 1,
    refetchOnWindowFocus: false,
  });

  const isLoadingReleaseNotes =
    releaseNotesQuery.isLoading && !releaseNotesQuery.data;

  const releaseNotesErrorMessage = useMemo(() => {
    const queryError = releaseNotesQuery.error;
    if (!queryError) {
      return null;
    }

    const errorName =
      queryError instanceof Error
        ? queryError.name
        : typeof (queryError as { name?: unknown })?.name === "string"
          ? String((queryError as { name?: unknown }).name)
          : undefined;

    if (
      errorName === "AbortError" ||
      errorName === "CanceledError" ||
      errorName === "CancelledError"
    ) {
      return null;
    }

    return t("version.unable_to_load_release_notes");
  }, [releaseNotesQuery.error, t]);

  useEffect(() => {
    if (!stableRelease || !serverVersion || disableNewReleaseCheck) {
      setShouldNotify(false);
      return;
    }

    try {
      const seenVersion = window.localStorage.getItem(LOCAL_STORAGE_KEY);
      setShouldNotify(seenVersion !== serverVersion);
    } catch (error) {
      console.warn("Failed to read localStorage:", error);
      setShouldNotify(true);
    }
  }, [serverVersion, stableRelease, disableNewReleaseCheck]);

  const markReleaseAsSeen = useCallback(() => {
    if (!serverVersion) return;
    try {
      window.localStorage.setItem(LOCAL_STORAGE_KEY, serverVersion);
    } catch (error) {
      console.warn("Failed to write to localStorage:", error);
      // Ignore failures, we still clear the notification for the session
    }
    setShouldNotify(false);
  }, [serverVersion]);

  const handleOpenChange = useCallback(
    (nextOpen: boolean) => {
      setOpen((prev) => {
        if (prev && !nextOpen) {
          markReleaseAsSeen();
        }
        return nextOpen;
      });
    },
    [markReleaseAsSeen],
  );

  if (!stableRelease || disableNewReleaseCheck) {
    return (
      <Link
        href={releasePageUrl}
        target="_blank"
        rel="noopener noreferrer"
        className="mt-auto flex items-center border-t pt-2 text-sm text-gray-400 hover:underline"
      >
        {versionLabel}
      </Link>
    );
  }

  return (
    <>
      <div className="mt-auto border-t pt-2">
        <button
          type="button"
          onClick={() => setOpen(true)}
          aria-label={
            shouldNotify ? t("version.new_release_available") : undefined
          }
          className="flex w-full items-center justify-between text-left text-sm text-gray-400 transition hover:text-foreground hover:underline focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring focus-visible:ring-offset-2"
        >
          <span aria-hidden={shouldNotify}>{versionLabel}</span>
          {shouldNotify && (
            <span className="inline-flex items-center gap-2 rounded-full bg-primary/10 px-2 py-1 text-xs font-semibold text-primary">
              <span className="sr-only">
                {t("version.new_release_available")}
              </span>
              <span className="relative flex size-2" aria-hidden="true">
                <span className="absolute inline-flex size-full animate-ping rounded-full bg-primary opacity-75" />
                <span className="relative inline-flex size-2 rounded-full bg-primary" />
              </span>
            </span>
          )}
        </button>
      </div>
      <Dialog open={open} onOpenChange={handleOpenChange}>
        <DialogContent className="max-w-3xl">
          <DialogHeader>
            <DialogTitle>
              {t("version.whats_new_title", { version: displayVersion })}
            </DialogTitle>
            <DialogDescription>
              {t("version.release_notes_description")}
            </DialogDescription>
          </DialogHeader>
          <div className="max-h-[60vh] overflow-y-auto pr-2">
            {isLoadingReleaseNotes ? (
              <div className="flex items-center justify-center gap-2 py-10 text-muted-foreground">
                <Loader2 className="size-5 animate-spin" aria-hidden="true" />
                <span>{t("version.loading_release_notes")}</span>
              </div>
            ) : releaseNotesErrorMessage ? (
              <div className="flex items-center gap-2 rounded-md border border-destructive/40 bg-destructive/10 p-3 text-sm text-destructive">
                <AlertCircle className="size-4" aria-hidden="true" />
                <span>{releaseNotesErrorMessage}</span>
              </div>
            ) : releaseNotesQuery.data !== undefined ? (
              releaseNotesQuery.data.trim() ? (
                <MarkdownReadonly className="prose-sm">
                  {releaseNotesQuery.data}
                </MarkdownReadonly>
              ) : (
                <p className="text-sm text-muted-foreground">
                  {t("version.no_release_notes")}
                </p>
              )
            ) : null}
          </div>
          <div className="flex flex-col gap-2 text-sm text-muted-foreground sm:flex-row sm:items-center sm:justify-between">
            <span>{t("version.release_notes_synced")}</span>
            <Button asChild variant="link" size="sm" className="px-0">
              <Link
                href={releasePageUrl}
                target="_blank"
                rel="noopener noreferrer"
              >
                {t("version.view_on_github")}
              </Link>
            </Button>
          </div>
        </DialogContent>
      </Dialog>
    </>
  );
}