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.

Sign up for GitHub

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(editor): Insights summary #13424

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+187 −1
Draft

feat(editor): Insights summary #13424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions packages/editor-ui/src/components/Projects/ProjectHeader.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ const onSelect = (action: string) => {
</N8nTooltip>
</div>
</div>
<slot></slot>
<div :class="$style.actions">
<ProjectTabs :show-settings="showSettings" />
</div>
Expand Down
110 changes: 110 additions & 0 deletions packages/editor-ui/src/features/insights/InsightsSummary.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<script setup lang="ts">
import { N8nHeading } from 'n8n-design-system';

type Summary = {
id: string;
title: string;
count: number;
sign?: string;
deviation: number;
evaluation?: 'positive' | 'negative';
};
defineProps<{
summaries: Summary[];
}>();

const getSign = (count: number) => (count > 0 ? '+' : undefined);
</script>

<template>
<div :class="$style.insights">
<N8nHeading bold tag="h3" size="medium" class="mb-xs"
>Insights from the last 30 days</N8nHeading
>
<ul>
<li v-for="{ id, title, count, sign, deviation, evaluation } in summaries" :key="id">
<p>
<strong>{{ title }}</strong>
<em
>{{ count }} <i>{{ sign }}</i></em
>
<small>
<N8nIcon
:class="$style.icon"
:icon="evaluation === 'positive' ? 'caret-up' : 'caret-down'"
color="text-light"
/>
{{ getSign(deviation) }} {{ deviation }} {{ sign }}
</small>
</p>
</li>
</ul>
</div>
</template>

<style lang="scss" module>
.insights {
padding: var(--spacing-xs) 0 var(--spacing-2xl);

ul {
display: flex;
height: 132px;
justify-content: space-between;
align-items: center;
padding: 0 var(--spacing-xl);
border: var(--border-width-base) var(--border-style-base) var(--color-foreground-base);
border-radius: 6px;
list-style: none;
background-color: var(--color-background-xlight);

p {
display: grid;

strong {
color: var(--color-text-dark);
font-size: 14px;
font-weight: 400;
white-space: nowrap;
margin-bottom: var(--spacing-2xs);
}

em {
display: flex;
align-items: baseline;
justify-content: flex-start;
color: var(--color-text-dark);
font-size: 32px;
line-height: 100%;
font-weight: 600;
font-style: normal;
gap: var(--spacing-5xs);

i {
color: var(--color-text-light);
font-size: 22px;
font-style: normal;
}
}

small {
position: relative;
display: flex;
align-items: center;
padding: 0 0 0 18px;
color: var(--color-text-light);
font-size: 14px;
font-weight: 400;
white-space: nowrap;
}
}
}
}

.icon {
position: absolute;
font-size: 32px;
left: 0;
top: 50%;
transform: translateY(-50%);
}
</style>
61 changes: 61 additions & 0 deletions packages/editor-ui/src/features/insights/insights.store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { defineStore } from 'pinia';

export type Summary = {
id: string;
title: string;
count: number;
sign?: string;
deviation: number;
evaluation?: 'positive' | 'negative';
};

export const useInsightsStore = defineStore('insights', () => {
const fetchSummary = async (): Promise<Summary[]> => {
return [
{
id: 'executions',
title: 'Executions',
count: 525,
deviation: 85,
sign: undefined,
evaluation: 'positive' as const,
},
{
id: 'failed',
title: 'Failed executions',
count: 14,
deviation: 3,
sign: undefined,
evaluation: 'negative' as const,
},
{
id: 'failureRate',
title: 'Failure rate',
count: 1.9,
deviation: -5,
sign: '%',
evaluation: 'negative' as const,
},
{
id: 'runTime',
title: 'Avg. run time',
count: 2.5,
deviation: -5,
sign: 's',
evaluation: 'positive' as const,
},
{
id: 'timeSaved',
title: 'Time saved',
count: 54,
deviation: -5,
sign: 'h',
evaluation: 'negative' as const,
},
];
};

return {
fetchSummary,
};
});
4 changes: 4 additions & 0 deletions packages/editor-ui/src/plugins/icons/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import {
faBrain,
faCalculator,
faCalendar,
faCaretDown,
faCaretUp,
faChartBar,
faCheck,
faCheckCircle,
Expand Down Expand Up @@ -198,6 +200,8 @@ export const FontAwesomePlugin: Plugin = {
addIcon(faBrain);
addIcon(faCalculator);
addIcon(faCalendar);
addIcon(faCaretDown);
addIcon(faCaretUp);
addIcon(faChartBar);
addIcon(faCheck);
addIcon(faCheckCircle);
Expand Down
12 changes: 11 additions & 1 deletion packages/editor-ui/src/views/WorkflowsView.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ import ProjectHeader from '@/components/Projects/ProjectHeader.vue';
import { getEasyAiWorkflowJson } from '@/utils/easyAiWorkflowUtils';
import { useDebounce } from '@/composables/useDebounce';
import { createEventBus } from 'n8n-design-system/utils';
import { useInsightsStore } from '@/features/insights/insights.store';
import InsightsSummary from '@/features/insights/InsightsSummary.vue';
import { useAsyncState } from '@vueuse/core';

interface Filters extends BaseFilters {
status: string | boolean;
Expand Down Expand Up @@ -76,6 +79,11 @@ const tagsStore = useTagsStore();
const documentTitle = useDocumentTitle();
const { callDebounced } = useDebounce();

const insightsStore = useInsightsStore();
const { state: summaries } = useAsyncState(insightsStore.fetchSummary, [], {
immediate: true,
});

const loading = ref(false);
const filters = ref<Filters>({
search: '',
Expand Down Expand Up @@ -446,7 +454,9 @@ const onWorkflowActiveToggle = (data: { id: string; active: boolean }) => {
@sort="onSortUpdated"
>
<template #header>
<ProjectHeader />
<ProjectHeader>
<InsightsSummary class="summary" :summaries="summaries"> </InsightsSummary>
</ProjectHeader>
</template>
<template #callout>
<N8nCallout
Expand Down