mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-12-24 20:24:05 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

refactor(editor): Track advanced filter custom data usage (#6084)

Browse source
This commit is contained in:
Csaba Tuncsik 2023-04-25 17:47:21 +02:00 committed by GitHub
parent ca4e0df90b
commit f9b11c73b9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
packages/editor-ui/src/components/ExecutionFilter.vue
View file

@ -1,5 +1,5 @@
<script lang="ts" setup>
import { computed, reactive, onBeforeMount } from 'vue';
import { computed, reactive, onBeforeMount, ref } from 'vue';
import debounce from 'lodash/debounce';
import type { PopoverPlacement } from 'element-ui/types/popover';
import type {
@ -14,6 +14,7 @@ import { EnterpriseEditionFeature } from '@/constants';
import { useSettingsStore } from '@/stores/settings';
import { useUsageStore } from '@/stores/usage';
import { useUIStore } from '@/stores/ui';
import { useTelemetry } from '@/composables';
export type ExecutionFilterProps = {
workflows?: IWorkflowShortResponse[];
@ -25,6 +26,9 @@ const DATE_TIME_MASK = 'yyyy-MM-dd HH:mm';
const settingsStore = useSettingsStore();
const usageStore = useUsageStore();
const uiStore = useUIStore();
const telemetry = useTelemetry();
const props = withDefaults(defineProps<ExecutionFilterProps>(), {
popoverPlacement: 'bottom',
});
@ -33,6 +37,7 @@ const emit = defineEmits<{
}>();
const debouncedEmit = debounce(emit, 500);
const isCustomDataFilterTracked = ref(false);
const isAdvancedExecutionFilterEnabled = computed(() =>
settingsStore.isEnterpriseFeatureEnabled(EnterpriseEditionFeature.AdvancedExecutionFilters),
);
@ -109,6 +114,12 @@ const onFilterMetaChange = (index: number, prop: keyof ExecutionFilterMetadata,
};
}
filter.metadata[index][prop] = value;
if (!isCustomDataFilterTracked.value) {
telemetry.track('User filtered executions with custom data');
isCustomDataFilterTracked.value = true;
}
debouncedEmit('filterChanged', filter);
};
@ -129,6 +140,7 @@ const goToUpgrade = () => {
};
onBeforeMount(() => {
isCustomDataFilterTracked.value = false;
emit('filterChanged', filter);
});
</script>

26
packages/editor-ui/src/components/__tests__/ExecutionFilter.test.ts
View file

@ -10,6 +10,18 @@ import ExecutionFilter from '@/components/ExecutionFilter.vue';
import { STORES } from '@/constants';
import { i18nInstance } from '@/plugins/i18n';
import type { IWorkflowShortResponse, ExecutionFilterType } from '@/Interface';
import { useTelemetry } from '@/composables';
vi.mock('@/composables', () => {
const track = vi.fn();
return {
useTelemetry: () => ({
track,
}),
};
});
let telemetry: ReturnType<typeof useTelemetry>;
Vue.use(PiniaVuePlugin);
@ -58,6 +70,10 @@ const renderOptions: RenderOptions<ExecutionFilter> = {
};
describe('ExecutionFilter', () => {
beforeEach(() => {
telemetry = useTelemetry();
});
test.each([
['development', 'default', false, workflowsData],
['development', 'default', true, workflowsData],
@ -120,4 +136,14 @@ describe('ExecutionFilter', () => {
expect(queryByTestId('executions-filter-reset-button')).not.toBeInTheDocument();
expect(queryByTestId('execution-filter-badge')).not.toBeInTheDocument();
});
test('telemetry sent only once after component is mounted', async () => {
const { getByTestId } = render(ExecutionFilter, renderOptions);
const customDataKeyInput = getByTestId('execution-filter-saved-data-key-input');
await userEvent.type(customDataKeyInput, 'test');
await userEvent.type(customDataKeyInput, 'key');
expect(telemetry.track).toHaveBeenCalledTimes(1);
});
});