Skip to content

Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia

feat: group history by date and time

liyasthomasa0f7201faee4
diff --git a/packages/hoppscotch-app/assets/scss/styles.scss b/packages/hoppscotch-app/assets/scss/styles.scss
index 439da74f6..54a433491 100644
--- a/packages/hoppscotch-app/assets/scss/styles.scss
+++ b/packages/hoppscotch-app/assets/scss/styles.scss
@@ -102,6 +102,7 @@ body {
.material-icons {
@apply flex-shrink-0;
+ @apply overflow-hidden;
font-size: var(--line-height-body) !important;
width: var(--line-height-body);
@@ -109,6 +110,7 @@ body {
.svg-icons {
@apply flex-shrink-0;
+ @apply overflow-hidden;
height: var(--line-height-body);
width: var(--line-height-body);
@@ -457,6 +459,10 @@ pre.ace_editor {
@apply px-1;
}
+.capitalize-first::first-letter {
+ @apply capitalize;
+}
+
@media (max-width: 767px) {
main {
margin-bottom: env(safe-area-inset-bottom);
diff --git a/packages/hoppscotch-app/components/app/Announcement.vue b/packages/hoppscotch-app/components/app/Announcement.vue
index cdbdbd45c..fab647c15 100644
--- a/packages/hoppscotch-app/components/app/Announcement.vue
+++ b/packages/hoppscotch-app/components/app/Announcement.vue
@@ -1,7 +1,7 @@
<template>
<div class="bg-error flex justify-between">
<span
- class="flex py-2 px-4 transition justify-center group relative items-center"
+ class="flex py-2 px-4 transition justify-center text-tiny group relative items-center"
>
<i class="mr-2 material-icons">info_outline</i>
<span class="text-secondaryDark">
diff --git a/packages/hoppscotch-app/components/history/graphql/Card.vue b/packages/hoppscotch-app/components/history/graphql/Card.vue
index b7b358475..64e590a51 100644
--- a/packages/hoppscotch-app/components/history/graphql/Card.vue
+++ b/packages/hoppscotch-app/components/history/graphql/Card.vue
@@ -9,6 +9,12 @@
<span class="truncate">
{{ entry.request.url }}
</span>
+ <tippy
+ v-if="entry.updatedOn"
+ theme="tooltip"
+ :delay="[500, 20]"
+ :content="`${new Date(entry.updatedOn).toLocaleString()}`"
+ />
</span>
<ButtonSecondary
v-tippy="{ theme: 'tooltip' }"
@@ -49,53 +55,39 @@
</div>
</template>
-<script lang="ts">
-import {
- computed,
- defineComponent,
- PropType,
- ref,
-} from "@nuxtjs/composition-api"
+<script setup lang="ts">
+import { computed, ref } from "@nuxtjs/composition-api"
import { makeGQLRequest } from "@hoppscotch/data"
import { setGQLSession } from "~/newstore/GQLSession"
import { GQLHistoryEntry } from "~/newstore/history"
-export default defineComponent({
- props: {
- entry: { type: Object as PropType<GQLHistoryEntry>, default: () => {} },
- showMore: Boolean,
- },
- setup(props) {
- const expand = ref(false)
+const props = defineProps<{
+ entry: GQLHistoryEntry
+ showMore: Boolean
+}>()
- const query = computed(() =>
- expand.value
- ? (props.entry.request.query.split("\n") as string[])
- : (props.entry.request.query
- .split("\n")
- .slice(0, 2)
- .concat(["..."]) as string[])
- )
+const expand = ref(false)
- const useEntry = () => {
- setGQLSession({
- request: makeGQLRequest({
- name: props.entry.request.name,
- url: props.entry.request.url,
- headers: props.entry.request.headers,
- query: props.entry.request.query,
- variables: props.entry.request.variables,
- }),
- schema: "",
- response: props.entry.response,
- })
- }
+const query = computed(() =>
+ expand.value
+ ? (props.entry.request.query.split("\n") as string[])
+ : (props.entry.request.query
+ .split("\n")
+ .slice(0, 2)
+ .concat(["..."]) as string[])
+)
- return {
- expand,
- query,
- useEntry,
- }
- },
-})
+const useEntry = () => {
+ setGQLSession({
+ request: makeGQLRequest({
+ name: props.entry.request.name,
+ url: props.entry.request.url,
+ headers: props.entry.request.headers,
+ query: props.entry.request.query,
+ variables: props.entry.request.variables,
+ }),
+ schema: "",
+ response: props.entry.response,
+ })
+}
</script>
diff --git a/packages/hoppscotch-app/components/history/index.vue b/packages/hoppscotch-app/components/history/index.vue
index a7f12ea2c..5d80e03cf 100644
--- a/packages/hoppscotch-app/components/history/index.vue
+++ b/packages/hoppscotch-app/components/history/index.vue
@@ -6,14 +6,14 @@
type="search"
autocomplete="off"
class="bg-transparent flex w-full p-4 py-2"
- :placeholder="`${$t('action.search')}`"
+ :placeholder="`${t('action.search')}`"
/>
<div class="flex">
<ButtonSecondary
v-tippy="{ theme: 'tooltip' }"
to="https://docs.hoppscotch.io/features/history"
blank
- :title="$t('app.wiki')"
+ :title="t('app.wiki')"
svg="help-circle"
/>
<ButtonSecondary
@@ -21,30 +21,39 @@
data-testid="clear_history"
:disabled="history.length === 0"
svg="trash-2"
- :title="$t('action.clear_all')"
+ :title="t('action.clear_all')"
@click.native="confirmRemove = true"
/>
</div>
</div>
<div class="flex flex-col">
- <div v-for="(entry, index) in filteredHistory" :key="`entry-${index}`">
- <HistoryRestCard
- v-if="page == 'rest'"
- :id="index"
- :entry="entry"
- :show-more="showMore"
- @toggle-star="toggleStar(entry)"
- @delete-entry="deleteHistory(entry)"
- @use-entry="useHistory(entry)"
- />
- <HistoryGraphqlCard
- v-if="page == 'graphql'"
- :entry="entry"
- :show-more="showMore"
- @toggle-star="toggleStar(entry)"
- @delete-entry="deleteHistory(entry)"
- @use-entry="useHistory(entry)"
- />
+ <div
+ v-for="(filteredHistoryGroup, filteredHistoryGroupIndex) in groupByDate(
+ filteredHistory,
+ 'updatedOn'
+ )"
+ :key="`filteredHistoryGroup-${filteredHistoryGroupIndex}`"
+ class="flex flex-col"
+ >
+ <span
+ class="ml-4 capitalize-first px-3 align-start my-2 py-1 text-secondaryLight bg-primaryLight truncate rounded-l-full flex-inline text-tiny"
+ >
+ {{ filteredHistoryGroupIndex }}
+ </span>
+ <div
+ v-for="(entry, index) in filteredHistoryGroup"
+ :key="`entry-${index}`"
+ >
+ <component
+ :is="page == 'rest' ? 'HistoryRestCard' : 'HistoryGraphqlCard'"
+ :id="index"
+ :entry="entry"
+ :show-more="showMore"
+ @toggle-star="toggleStar(entry)"
+ @delete-entry="deleteHistory(entry)"
+ @use-entry="useHistory(entry)"
+ />
+ </div>
</div>
</div>
<div
@@ -53,7 +62,7 @@
>
<i class="opacity-75 pb-2 material-icons">manage_search</i>
<span class="my-2 text-center">
- {{ $t("state.nothing_found") }} "{{ filterText }}"
+ {{ t("state.nothing_found") }} "{{ filterText }}"
</span>
</div>
<div
@@ -64,24 +73,29 @@
:src="`/images/states/${$colorMode.value}/history.svg`"
loading="lazy"
class="flex-col object-contain object-center h-16 my-4 w-16 inline-flex"
- :alt="`${$t('empty.history')}`"
+ :alt="`${t('empty.history')}`"
/>
<span class="text-center mb-4">
- {{ $t("empty.history") }}
+ {{ t("empty.history") }}
</span>
</div>
<SmartConfirmModal
:show="confirmRemove"
- :title="`${$t('confirm.remove_history')}`"
+ :title="`${t('confirm.remove_history')}`"
@hide-modal="confirmRemove = false"
@resolve="clearHistory"
/>
</div>
</template>
-<script lang="ts">
-import { defineComponent, PropType } from "@nuxtjs/composition-api"
-import { useReadonlyStream } from "~/helpers/utils/composables"
+<script setup lang="ts">
+import { computed, ref } from "@nuxtjs/composition-api"
+import * as timeago from "timeago.js"
+import {
+ useI18n,
+ useReadonlyStream,
+ useToast,
+} from "~/helpers/utils/composables"
import {
restHistory$,
graphqlHistory$,
@@ -96,64 +110,65 @@ import {
} from "~/newstore/history"
import { setRESTRequest } from "~/newstore/RESTSession"
-export default defineComponent({
- props: {
- page: { type: String as PropType<"rest" | "graphql">, default: null },
- },
- setup(props) {
- return {
- history: useReadonlyStream<RESTHistoryEntry[] | GQLHistoryEntry[]>(
- props.page === "rest" ? restHistory$ : graphqlHistory$,
- []
- ),
- }
- },
- data() {
- return {
- filterText: "",
- showMore: false,
- confirmRemove: false,
- }
- },
- computed: {
- filteredHistory(): any[] {
- const filteringHistory = this.history as Array<
- RESTHistoryEntry | GQLHistoryEntry
- >
+const props = defineProps<{
+ page: "rest" | "graphql"
+}>()
+
+const filterText = ref("")
+const showMore = ref(false)
+const confirmRemove = ref(false)
+const toast = useToast()
+const t = useI18n()
- return filteringHistory.filter(
- (entry: RESTHistoryEntry | GQLHistoryEntry) => {
- const filterText = this.filterText.toLowerCase()
- return Object.keys(entry).some((key) => {
- let value = entry[key as keyof typeof entry]
- if (value) {
- value = `${value}`
- return value.toLowerCase().includes(filterText)
- }
- return false
- })
+const groupByDate = (array: any[], key: string) => {
+ return array.reduce((rv: any, x: any) => {
+ ;(rv[timeago.format(x[key])] = rv[timeago.format(x[key])] || []).push(x)
+ return rv
+ }, {})
+}
+
+const history = useReadonlyStream<RESTHistoryEntry[] | GQLHistoryEntry[]>(
+ props.page === "rest" ? restHistory$ : graphqlHistory$,
+ []
+)
+
+const filteredHistory = computed(() => {
+ const filteringHistory = history as any as Array<
+ RESTHistoryEntry | GQLHistoryEntry
+ >
+
+ return filteringHistory.value.filter(
+ (entry: RESTHistoryEntry | GQLHistoryEntry) => {
+ return Object.keys(entry).some((key) => {
+ let value = entry[key as keyof typeof entry]
+ if (value) {
+ value = `${value}`
+ return value.toLowerCase().includes(filterText.value.toLowerCase())
}
- )
- },
- },
- methods: {
- clearHistory() {
- if (this.page === "rest") clearRESTHistory()
- else clearGraphqlHistory()
- this.$toast.success(`${this.$t("state.history_deleted")}`)
- },
- useHistory(entry: any) {
- if (this.page === "rest") setRESTRequest(entry.request)
- },
- deleteHistory(entry: any) {
- if (this.page === "rest") deleteRESTHistoryEntry(entry)
- else deleteGraphqlHistoryEntry(entry)
- this.$toast.success(`${this.$t("state.deleted")}`)
- },
- toggleStar(entry: any) {
- if (this.page === "rest") toggleRESTHistoryEntryStar(entry)
- else toggleGraphqlHistoryEntryStar(entry)
- },
- },
+ return false
+ })
+ }
+ )
})
+
+const clearHistory = () => {
+ if (props.page === "rest") clearRESTHistory()
+ else clearGraphqlHistory()
+ toast.success(`${t("state.history_deleted")}`)
+}
+
+const useHistory = (entry: any) => {
+ if (props.page === "rest") setRESTRequest(entry.request)
+}
+
+const deleteHistory = (entry: any) => {
+ if (props.page === "rest") deleteRESTHistoryEntry(entry)
+ else deleteGraphqlHistoryEntry(entry)
+ toast.success(`${t("state.deleted")}`)
+}
+
+const toggleStar = (entry: any) => {
+ if (props.page === "rest") toggleRESTHistoryEntryStar(entry)
+ else toggleGraphqlHistoryEntryStar(entry)
+}
</script>
diff --git a/packages/hoppscotch-app/components/history/rest/Card.vue b/packages/hoppscotch-app/components/history/rest/Card.vue
index 3ecd2801c..4cdb6df67 100644
--- a/packages/hoppscotch-app/components/history/rest/Card.vue
+++ b/packages/hoppscotch-app/components/history/rest/Card.vue
@@ -1,6 +1,7 @@
<template>
<div class="flex items-stretch group">
<span
+ v-tippy="{ theme: 'tooltip', delay: [500, 20] }"
class="cursor-pointer flex px-2 w-16 items-center justify-center truncate"
:class="entryStatus.className"
data-testid="restore_history_entry"
@@ -12,12 +13,17 @@
<span
class="cursor-pointer flex flex-1 min-w-0 py-2 pr-2 transition group-hover:text-secondaryDark"
data-testid="restore_history_entry"
- :title="`${duration}`"
@click="$emit('use-entry')"
>
<span class="truncate">
{{ entry.request.endpoint }}
</span>
+ <tippy
+ v-if="entry.updatedOn"
+ theme="tooltip"
+ :delay="[500, 20]"
+ :content="`${new Date(entry.updatedOn).toLocaleString()}`"
+ />
</span>
<ButtonSecondary
v-tippy="{ theme: 'tooltip' }"
@@ -40,46 +46,36 @@
</div>
</template>
-<script lang="ts">
-import { computed, defineComponent, PropType } from "@nuxtjs/composition-api"
+<script setup lang="ts">
+import { computed } from "@nuxtjs/composition-api"
import findStatusGroup from "~/helpers/findStatusGroup"
import { useI18n } from "~/helpers/utils/composables"
import { RESTHistoryEntry } from "~/newstore/history"
-export default defineComponent({
- props: {
- entry: { type: Object as PropType<RESTHistoryEntry>, default: () => {} },
- showMore: Boolean,
- },
- setup(props) {
- const t = useI18n()
+const props = defineProps<{
+ entry: RESTHistoryEntry
+ showMore: Boolean
+}>()
- const duration = computed(() => {
- if (props.entry.responseMeta.duration) {
- const responseDuration = props.entry.responseMeta.duration
- if (!responseDuration) return ""
+const t = useI18n()
- return responseDuration > 0
- ? `${t("request.duration")}: ${responseDuration}ms`
- : t("error.no_duration")
- } else return t("error.no_duration")
- })
+const duration = computed(() => {
+ if (props.entry.responseMeta.duration) {
+ const responseDuration = props.entry.responseMeta.duration
+ if (!responseDuration) return ""
- const entryStatus = computed(() => {
- const foundStatusGroup = findStatusGroup(
- props.entry.responseMeta.statusCode
- )
- return (
- foundStatusGroup || {
- className: "",
- }
- )
- })
+ return responseDuration > 0
+ ? `${t("request.duration")}: ${responseDuration}ms`
+ : t("error.no_duration")
+ } else return t("error.no_duration")
+})
- return {
- duration,
- entryStatus,
+const entryStatus = computed(() => {
+ const foundStatusGroup = findStatusGroup(props.entry.responseMeta.statusCode)
+ return (
+ foundStatusGroup || {
+ className: "",
}
- },
+ )
})
</script>
diff --git a/packages/hoppscotch-app/helpers/fb/history.ts b/packages/hoppscotch-app/helpers/fb/history.ts
index 201d30d8f..198b4daad 100644
--- a/packages/hoppscotch-app/helpers/fb/history.ts
+++ b/packages/hoppscotch-app/helpers/fb/history.ts
@@ -206,6 +206,7 @@ export function initHistory() {
historyRef.forEach((doc) => {
const entry = doc.data()
entry.id = doc.id
+ entry.updatedOn = doc.data().updatedOn.toDate()
history.push(translateToNewRESTHistory(entry))
})
@@ -227,6 +228,7 @@ export function initHistory() {
historyRef.forEach((doc) => {
const entry = doc.data()
entry.id = doc.id
+ entry.updatedOn = doc.data().updatedOn.toDate()
history.push(translateToNewGQLHistory(entry))
})
diff --git a/packages/hoppscotch-app/newstore/history.ts b/packages/hoppscotch-app/newstore/history.ts
index 340823f28..963829850 100644
--- a/packages/hoppscotch-app/newstore/history.ts
+++ b/packages/hoppscotch-app/newstore/history.ts
@@ -22,6 +22,8 @@ export type RESTHistoryEntry = {
star: boolean
id?: string // For when Firebase Firestore is set
+
+ updatedOn?: Date
}
export type GQLHistoryEntry = {
@@ -33,6 +35,8 @@ export type GQLHistoryEntry = {
star: boolean
id?: string // For when Firestore ID is set
+
+ updatedOn?: Date
}
export function makeRESTHistoryEntry(
@@ -50,6 +54,7 @@ export function makeGQLHistoryEntry(
return {
v: 1,
...x,
+ updatedOn: new Date(),
}
}
@@ -61,7 +66,7 @@ export function translateToNewRESTHistory(x: any): RESTHistoryEntry {
const star = x.star ?? false
const duration = x.duration ?? null
const statusCode = x.status ?? null
-
+ const updatedOn = x.updatedOn ?? null
const obj: RESTHistoryEntry = makeRESTHistoryEntry({
request,
star,
@@ -69,6 +74,7 @@ export function translateToNewRESTHistory(x: any): RESTHistoryEntry {
duration,
statusCode,
},
+ updatedOn,
})
if (x.id) obj.id = x.id
@@ -83,11 +89,13 @@ export function translateToNewGQLHistory(x: any): GQLHistoryEntry {
const request = translateToGQLRequest(x)
const star = x.star ?? false
const response = x.response ?? ""
+ const updatedOn = x.updatedOn ?? ""
const obj: GQLHistoryEntry = makeGQLHistoryEntry({
request,
star,
response,
+ updatedOn,
})
if (x.id) obj.id = x.id
@@ -313,6 +321,7 @@ completedRESTResponse$.subscribe((res) => {
statusCode: res.statusCode,
},
star: false,
+ updatedOn: new Date(),
})
)
}
diff --git a/packages/hoppscotch-app/package.json b/packages/hoppscotch-app/package.json
index f94e4ccef..d96fbd31d 100644
--- a/packages/hoppscotch-app/package.json
+++ b/packages/hoppscotch-app/package.json
@@ -96,6 +96,7 @@
"splitpanes": "^2.3.8",
"subscriptions-transport-ws": "^0.11.0",
"tern": "^0.24.3",
+ "timeago.js": "^4.0.2",
"uuid": "8.3.2",
"vue-apollo": "^3.1.0",
"vue-functional-data-merge": "^3.1.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index d298e57a9..1ed476331 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -156,6 +156,7 @@ importers:
stylelint-config-standard-scss: ^3.0.0
subscriptions-transport-ws: ^0.11.0
tern: ^0.24.3
+ timeago.js: ^4.0.2
ts-jest: ^27.1.2
typescript: ^4.5.4
uuid: 8.3.2
@@ -233,6 +234,7 @@ importers:
splitpanes: 2.3.8
subscriptions-transport-ws: [email protected]
tern: 0.24.3
+ timeago.js: 4.0.2
uuid: 8.3.2
vue-apollo: [email protected]
vue-functional-data-merge: 3.1.0
@@ -16684,6 +16686,10 @@ packages:
webpack: 4.46.0
dev: false
+ /timeago.js/4.0.2:
+ resolution: {integrity: sha512-a7wPxPdVlQL7lqvitHGGRsofhdwtkoSXPGATFuSOA2i1ZNQEPLrGnj68vOp2sOJTCFAQVXPeNMX/GctBaO9L2w==}
+ dev: false
+
/timers-browserify/2.0.12:
resolution: {integrity: sha512-9phl76Cqm6FhSX9Xe1ZUAMLtm1BLkKj2Qd5ApyWkXzsMRaA7dgr81kf4wJmQf/hAvg8EEyJxDo3du/0KlhPiKQ==}
engines: {node: '>=0.6.0'}