From 2378a1f115e60e3a862a080790b649b495881f64 Mon Sep 17 00:00:00 2001
From: Amir Raminfar <findamir@gmail.com>
Date: Wed, 22 Jan 2025 09:58:06 -0800
Subject: [PATCH] chore: adds survey as link (#3571)

---
 assets/auto-imports.d.ts            |   4 +-
 assets/components.d.ts              |   2 +-
 assets/components/Announcements.vue | 115 ++++++++++++++++++++++++++++
 assets/components/Links.vue         |  18 +----
 assets/components/Releases.vue      |  74 ------------------
 assets/pages/settings.vue           |   6 +-
 assets/stores/announcements.ts      |  51 ++++++++++++
 assets/stores/releases.ts           |  29 -------
 8 files changed, 173 insertions(+), 126 deletions(-)
 create mode 100644 assets/components/Announcements.vue
 delete mode 100644 assets/components/Releases.vue
 create mode 100644 assets/stores/announcements.ts
 delete mode 100644 assets/stores/releases.ts

diff --git a/assets/auto-imports.d.ts b/assets/auto-imports.d.ts
index 772d304d..7c5ebc28 100644
--- a/assets/auto-imports.d.ts
+++ b/assets/auto-imports.d.ts
@@ -162,6 +162,7 @@ declare global {
   const until: typeof import('@vueuse/core')['until']
   const useActiveElement: typeof import('@vueuse/core')['useActiveElement']
   const useAnimate: typeof import('@vueuse/core')['useAnimate']
+  const useAnnouncements: typeof import('./stores/announcements')['useAnnouncements']
   const useArrayDifference: typeof import('@vueuse/core')['useArrayDifference']
   const useArrayEvery: typeof import('@vueuse/core')['useArrayEvery']
   const useArrayFilter: typeof import('@vueuse/core')['useArrayFilter']
@@ -287,7 +288,6 @@ declare global {
   const useProfileStorage: typeof import('./composable/profileStorage')['useProfileStorage']
   const useRafFn: typeof import('@vueuse/core')['useRafFn']
   const useRefHistory: typeof import('@vueuse/core')['useRefHistory']
-  const useReleases: typeof import('./stores/releases')['useReleases']
   const useResizeObserver: typeof import('@vueuse/core')['useResizeObserver']
   const useRoute: typeof import('vue-router')['useRoute']
   const useRouter: typeof import('vue-router')['useRouter']
@@ -551,6 +551,7 @@ declare module 'vue' {
     readonly until: UnwrapRef<typeof import('@vueuse/core')['until']>
     readonly useActiveElement: UnwrapRef<typeof import('@vueuse/core')['useActiveElement']>
     readonly useAnimate: UnwrapRef<typeof import('@vueuse/core')['useAnimate']>
+    readonly useAnnouncements: UnwrapRef<typeof import('./stores/announcements')['useAnnouncements']>
     readonly useArrayDifference: UnwrapRef<typeof import('@vueuse/core')['useArrayDifference']>
     readonly useArrayEvery: UnwrapRef<typeof import('@vueuse/core')['useArrayEvery']>
     readonly useArrayFilter: UnwrapRef<typeof import('@vueuse/core')['useArrayFilter']>
@@ -676,7 +677,6 @@ declare module 'vue' {
     readonly useProfileStorage: UnwrapRef<typeof import('./composable/profileStorage')['useProfileStorage']>
     readonly useRafFn: UnwrapRef<typeof import('@vueuse/core')['useRafFn']>
     readonly useRefHistory: UnwrapRef<typeof import('@vueuse/core')['useRefHistory']>
-    readonly useReleases: UnwrapRef<typeof import('./stores/releases')['useReleases']>
     readonly useResizeObserver: UnwrapRef<typeof import('@vueuse/core')['useResizeObserver']>
     readonly useRoute: UnwrapRef<typeof import('vue-router')['useRoute']>
     readonly useRouter: UnwrapRef<typeof import('vue-router')['useRouter']>
diff --git a/assets/components.d.ts b/assets/components.d.ts
index 9e331803..a014765c 100644
--- a/assets/components.d.ts
+++ b/assets/components.d.ts
@@ -7,6 +7,7 @@ export {}
 /* prettier-ignore */
 declare module 'vue' {
   export interface GlobalComponents {
+    Announcements: typeof import('./components/Announcements.vue')['default']
     'Carbon:caretDown': typeof import('~icons/carbon/caret-down')['default']
     'Carbon:circleSolid': typeof import('~icons/carbon/circle-solid')['default']
     'Carbon:copyFile': typeof import('~icons/carbon/copy-file')['default']
@@ -99,7 +100,6 @@ declare module 'vue' {
     'Ph:stackSimple': typeof import('~icons/ph/stack-simple')['default']
     Popup: typeof import('./components/Popup.vue')['default']
     RandomColorTag: typeof import('./components/LogViewer/RandomColorTag.vue')['default']
-    Releases: typeof import('./components/Releases.vue')['default']
     RouterLink: typeof import('vue-router')['RouterLink']
     RouterView: typeof import('vue-router')['RouterView']
     ScrollableView: typeof import('./components/ScrollableView.vue')['default']
diff --git a/assets/components/Announcements.vue b/assets/components/Announcements.vue
new file mode 100644
index 00000000..70cee2dc
--- /dev/null
+++ b/assets/components/Announcements.vue
@@ -0,0 +1,115 @@
+<template>
+  <Dropdown class="dropdown-end" @closed="releaseSeen = mostRecent?.tag ?? config.version">
+    <template #trigger>
+      <mdi:announcement class="size-6 -rotate-12" />
+      <template v-if="announcements.length > 0 && releaseSeen != mostRecent?.tag">
+        <span class="bg-red absolute top-0 right-px size-2 animate-ping rounded-full opacity-75"></span>
+        <span class="bg-red absolute top-0 right-px size-2 rounded-full"></span>
+      </template>
+    </template>
+    <template #content>
+      <div class="w-72">
+        <ul class="space-y-4 p-2">
+          <li v-for="release in announcements" v-if="announcements.length > 0">
+            <template v-if="release.announcement">
+              <div class="flex items-baseline gap-1">
+                <carbon:information class="text-info self-center" />
+                <a
+                  :href="release.htmlUrl"
+                  class="link-primary text-lg font-bold"
+                  target="_blank"
+                  rel="noreferrer noopener"
+                >
+                  {{ release.name }}
+                </a>
+                <span class="ml-1 text-xs"><distance-time :date="release.createdAt" /></span>
+              </div>
+              <div class="text-base-content/80 text-sm">
+                {{ release.body }}
+              </div>
+            </template>
+            <template v-else>
+              <div class="flex items-baseline gap-1">
+                <carbon:warning class="stroke-orange self-center" v-if="release.breaking > 0" />
+                <a
+                  :href="release.htmlUrl"
+                  class="link-primary text-lg font-bold"
+                  target="_blank"
+                  rel="noreferrer noopener"
+                >
+                  {{ release.name }}
+                </a>
+                <span class="ml-1 text-xs"><distance-time :date="release.createdAt" /></span>
+                <Tag class="bg-red ml-auto px-1 py-1 text-xs" v-if="release.latest">
+                  {{ $t("releases.latest") }}
+                </Tag>
+              </div>
+              <div class="text-base-content/80 text-sm">
+                {{ summary(release) }}
+              </div>
+            </template>
+          </li>
+          <li v-else>
+            <div class="text-base-content/80 text-sm">
+              {{ $t("releases.no_releases") }}
+            </div>
+          </li>
+        </ul>
+      </div>
+    </template>
+  </Dropdown>
+</template>
+
+<script setup lang="ts">
+import { useAnnouncements } from "@/stores/announcements";
+
+const { announcements, mostRecent } = useAnnouncements();
+const { t } = useI18n();
+
+const releaseSeen = useProfileStorage("releaseSeen", config.version);
+
+function summary(release: { features: number; bugFixes: number; breaking: number }) {
+  if (release.features > 0 && release.bugFixes > 0 && release.breaking > 0) {
+    return t("releases.three_parts", {
+      first: t("releases.breaking", { count: release.breaking }),
+      second: t("releases.features", { count: release.features }),
+      third: t("releases.bugFixes", { count: release.bugFixes }),
+    });
+  }
+
+  if (release.features > 0 && release.bugFixes > 0) {
+    return t("releases.two_parts", {
+      first: t("releases.features", { count: release.features }),
+      second: t("releases.bugFixes", { count: release.bugFixes }),
+    });
+  }
+
+  if (release.features > 0 && release.breaking > 0) {
+    return t("releases.two_parts", {
+      first: t("releases.features", { count: release.features }),
+      second: t("releases.breaking", { count: release.breaking }),
+    });
+  }
+
+  if (release.bugFixes > 0 && release.breaking > 0) {
+    return t("releases.two_parts", {
+      first: t("releases.bugFixes", { count: release.bugFixes }),
+      second: t("releases.breaking", { count: release.breaking }),
+    });
+  }
+
+  if (release.features > 0) {
+    return t("releases.features", { count: release.features });
+  }
+
+  if (release.bugFixes > 0) {
+    return t("releases.bugFixes", { count: release.bugFixes });
+  }
+
+  if (release.breaking > 0) {
+    return t("releases.breaking", { count: release.breaking });
+  }
+}
+</script>
+
+<style scoped></style>
diff --git a/assets/components/Links.vue b/assets/components/Links.vue
index ec57020b..5825c7fa 100644
--- a/assets/components/Links.vue
+++ b/assets/components/Links.vue
@@ -1,20 +1,7 @@
 <template>
   <div class="flex items-center justify-end gap-4">
     <slot name="more-items"></slot>
-    <Dropdown class="dropdown-end" @closed="latestTag = latest?.tag ?? config.version">
-      <template #trigger>
-        <mdi:announcement class="size-6 -rotate-12" />
-        <span
-          class="bg-red absolute top-0 right-px size-2 rounded-full"
-          v-if="hasUpdate && latestTag != latest?.tag"
-        ></span>
-      </template>
-      <template #content>
-        <div class="w-72">
-          <Releases />
-        </div>
-      </template>
-    </Dropdown>
+    <Announcements />
 
     <router-link
       :to="{ name: '/settings' }"
@@ -58,7 +45,4 @@ async function logout() {
 
   location.reload();
 }
-
-const { hasUpdate, latest } = useReleases();
-const latestTag = useProfileStorage("releaseSeen", config.version);
 </script>
diff --git a/assets/components/Releases.vue b/assets/components/Releases.vue
deleted file mode 100644
index c22502c1..00000000
--- a/assets/components/Releases.vue
+++ /dev/null
@@ -1,74 +0,0 @@
-<template>
-  <ul class="space-y-4 p-2">
-    <li v-for="release in releases" v-if="releases?.length">
-      <div class="flex items-baseline gap-1">
-        <carbon:warning class="stroke-orange self-center" v-if="release.breaking > 0" />
-        <a :href="release.htmlUrl" class="link-primary text-lg font-bold" target="_blank" rel="noreferrer noopener">
-          {{ release.name }}
-        </a>
-        <span class="ml-1 text-xs"><distance-time :date="new Date(release.createdAt)" /></span>
-        <Tag class="bg-red ml-auto px-1 py-1 text-xs" v-if="release.tag === latest?.tag">
-          {{ $t("releases.latest") }}
-        </Tag>
-      </div>
-      <div class="text-base-content/80 text-sm">
-        {{ summary(release) }}
-      </div>
-    </li>
-    <li v-else>
-      <div class="text-base-content/80 text-sm">
-        {{ $t("releases.no_releases") }}
-      </div>
-    </li>
-  </ul>
-</template>
-
-<script setup lang="ts">
-const { releases, latest } = useReleases();
-const { t } = useI18n();
-
-function summary(release: { features: number; bugFixes: number; breaking: number }) {
-  if (release.features > 0 && release.bugFixes > 0 && release.breaking > 0) {
-    return t("releases.three_parts", {
-      first: t("releases.breaking", { count: release.breaking }),
-      second: t("releases.features", { count: release.features }),
-      third: t("releases.bugFixes", { count: release.bugFixes }),
-    });
-  }
-
-  if (release.features > 0 && release.bugFixes > 0) {
-    return t("releases.two_parts", {
-      first: t("releases.features", { count: release.features }),
-      second: t("releases.bugFixes", { count: release.bugFixes }),
-    });
-  }
-
-  if (release.features > 0 && release.breaking > 0) {
-    return t("releases.two_parts", {
-      first: t("releases.features", { count: release.features }),
-      second: t("releases.breaking", { count: release.breaking }),
-    });
-  }
-
-  if (release.bugFixes > 0 && release.breaking > 0) {
-    return t("releases.two_parts", {
-      first: t("releases.bugFixes", { count: release.bugFixes }),
-      second: t("releases.breaking", { count: release.breaking }),
-    });
-  }
-
-  if (release.features > 0) {
-    return t("releases.features", { count: release.features });
-  }
-
-  if (release.bugFixes > 0) {
-    return t("releases.bugFixes", { count: release.bugFixes });
-  }
-
-  if (release.breaking > 0) {
-    return t("releases.breaking", { count: release.breaking });
-  }
-}
-</script>
-
-<style scoped></style>
diff --git a/assets/pages/settings.vue b/assets/pages/settings.vue
index f576c3db..9df0d456 100644
--- a/assets/pages/settings.vue
+++ b/assets/pages/settings.vue
@@ -8,8 +8,8 @@
       <div>
         <span v-html="$t('settings.using-version', { version: config.version })"></span>
         <div
-          v-if="hasUpdate"
-          v-html="$t('settings.update-available', { nextVersion: latest?.name, href: latest?.htmlUrl })"
+          v-if="hasRelease"
+          v-html="$t('settings.update-available', { nextVersion: latestRelease?.name, href: latestRelease?.htmlUrl })"
         ></div>
       </div>
     </section>
@@ -154,7 +154,7 @@ import { availableLocales, i18n } from "@/modules/i18n";
 const { t } = useI18n();
 
 setTitle(t("title.settings"));
-const { latest, hasUpdate } = useReleases();
+const { latestRelease, hasRelease } = useAnnouncements();
 
 const now = new Date();
 const hoursAgo = (hours: number) => {
diff --git a/assets/stores/announcements.ts b/assets/stores/announcements.ts
new file mode 100644
index 00000000..d7a39ad0
--- /dev/null
+++ b/assets/stores/announcements.ts
@@ -0,0 +1,51 @@
+type Announcement = {
+  name: string;
+  announcement: boolean;
+  createdAt: Date;
+  body: string;
+  tag: string;
+  htmlUrl: string;
+  latest: boolean;
+  mentionsCount: number;
+  features: number;
+  bugFixes: number;
+  breaking: number;
+};
+
+const { data: releases } = useFetch(withBase("/api/releases")).get().json<Announcement[]>();
+
+const otherAnnouncements = [
+  {
+    body: "I'd love to hear about your experience in this short survey to shape the future of Dozzle!",
+    createdAt: new Date("2025-01-22T18:00:00Z"),
+    htmlUrl: "https://tally.so/r/wLv4g2?ref=notification",
+    name: "Take survey!",
+    announcement: true,
+    tag: "survey-2025-01",
+    latest: true,
+    mentionsCount: 0,
+    features: 0,
+    bugFixes: 0,
+    breaking: 0,
+  },
+] as Announcement[];
+
+const announcements = computed(() => {
+  const newReleases =
+    releases.value?.map((release) => ({ ...release, createdAt: new Date(release.createdAt), announcement: false })) ??
+    [];
+  return [...newReleases, ...otherAnnouncements].sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime());
+});
+
+const mostRecent = computed(() => announcements.value?.[0]);
+const latestRelease = computed(() => announcements.value?.find((release) => release.latest && !release.announcement));
+const hasRelease = computed(() => latestRelease.value !== undefined);
+
+export function useAnnouncements() {
+  return {
+    mostRecent,
+    announcements,
+    latestRelease,
+    hasRelease,
+  };
+}
diff --git a/assets/stores/releases.ts b/assets/stores/releases.ts
deleted file mode 100644
index 0567427b..00000000
--- a/assets/stores/releases.ts
+++ /dev/null
@@ -1,29 +0,0 @@
-const { data: releases } = useFetch(withBase("/api/releases")).get().json<
-  {
-    name: string;
-    mentionsCount: number;
-    createdAt: string;
-    body: string;
-    tag: string;
-    htmlUrl: string;
-    latest: boolean;
-    features: number;
-    bugFixes: number;
-    breaking: number;
-  }[]
->();
-
-const hasUpdate = computed(() => {
-  if (!releases.value?.length) return false;
-  return releases.value[0].tag !== config.version;
-});
-
-const latest = computed(() => releases.value?.find((release) => release.latest));
-
-export function useReleases() {
-  return {
-    hasUpdate,
-    latest,
-    releases,
-  };
-}