DeforaNetworks/corteza
3
0
Fork 0
Code Activity

Refetch data based on prefilter value dependency changes

Browse Source
This commit is contained in:
Kelani Tolulope
2024-03-18 12:40:12 +01:00
parent dd98df564c
commit c38ff2aecf
12 changed files with 195 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/web/compose/src/components/ModuleFields/Editor/Record.vue
+25 -2
View File
@@ -166,7 +166,7 @@ import base from './base'
import { debounce } from 'lodash'
import { compose, NoID } from '@cortezaproject/corteza-js'
import { mapActions, mapGetters } from 'vuex'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import Pagination from '../Common/Pagination.vue'
export default {
@@ -282,6 +282,11 @@ export default {
beforeDestroy () {
this.setDefaultValues()
this.destroyEvents()
},
mounted () {
this.createEvents()
},
methods: {
@@ -292,6 +297,20 @@ export default {
updateRecords: 'record/updateRecords',
}),
createEvents () {
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { prefilter } = this.field.options
if (isFieldInFilter(fieldName, prefilter)) {
const namespaceID = this.namespace.namespaceID
const moduleID = this.field.options.moduleID
this.fetchPrefiltered({ namespaceID, moduleID })
}
},
getRecord (index = undefined) {
const recordID = index !== undefined ? this.value[index] : this.value
return (this.convert({ recordID }) || {}).value
@@ -369,7 +388,7 @@ export default {
}
},
fetchPrefiltered (q) {
fetchPrefiltered (q = this.filter) {
this.processing = true
// Support prefilters
@@ -523,6 +542,10 @@ export default {
return label
},
destroyEvents () {
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
setDefaultValues () {
this.processing = false
this.query = ''
client/web/compose/src/components/PageBlocks/CalendarBase.vue
+16 -2
View File
@@ -112,7 +112,7 @@ import listPlugin from '@fullcalendar/list'
import { compose, NoID } from '@cortezaproject/corteza-js'
import { BootstrapTheme } from '@fullcalendar/bootstrap'
import { createPlugin } from '@fullcalendar/core'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
/**
* FullCalendar Corteza theme definition.
@@ -235,7 +235,7 @@ export default {
},
mounted () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -249,6 +249,19 @@ export default {
findModuleByID: 'module/findByID',
}),
createEvents () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { feeds } = this.options
if (feeds.some(({ options }) => isFieldInFilter(fieldName, options.prefilter))) {
this.refresh()
}
},
updateSize () {
this.$nextTick(() => {
this.api().updateSize()
@@ -423,6 +436,7 @@ export default {
destroyEvents () {
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/ChartBase.vue
+17 -5
View File
@@ -19,7 +19,7 @@ import { mapActions } from 'vuex'
import base from './base'
import ChartComponent from '../Chart'
import { NoID, compose } from '@cortezaproject/corteza-js'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
export default {
i18nOptions: {
@@ -54,10 +54,7 @@ export default {
mounted () {
this.fetchChart()
this.refreshBlock(this.refresh)
this.$root.$on('drill-down-chart', this.drillDown)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -70,6 +67,20 @@ export default {
findChartByID: 'chart/findByID',
}),
createEvents () {
this.$root.$on('drill-down-chart', this.drillDown)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { filter } = this.filter
if (isFieldInFilter(fieldName, filter)) {
this.refresh()
}
},
refreshOnRelatedRecordsUpdate ({ moduleID, notPageID }) {
if (this.filter.moduleID === moduleID && this.page.pageID !== notPageID) {
this.refresh()
@@ -198,6 +209,7 @@ export default {
destroyEvents () {
this.$root.$off('drill-down-chart', this.drillDown)
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/CommentBase.vue
+16 -2
View File
@@ -102,7 +102,7 @@ import base from './base'
import FieldViewer from 'corteza-webapp-compose/src/components/ModuleFields/Viewer'
import users from 'corteza-webapp-compose/src/mixins/users'
import { compose, NoID, fmt } from '@cortezaproject/corteza-js'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
export default {
i18nOptions: {
@@ -239,7 +239,7 @@ export default {
},
mounted () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -249,6 +249,19 @@ export default {
},
methods: {
createEvents () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { filter } = this.options
if (isFieldInFilter(fieldName, filter)) {
this.refresh()
}
},
getFormattedDate (date) {
return fmt.fullDateTime(date)
},
@@ -401,6 +414,7 @@ export default {
destroyEvents () {
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/GeometryBase.vue
+16 -2
View File
@@ -41,7 +41,7 @@ import axios from 'axios'
import { compose, NoID } from '@cortezaproject/corteza-js'
import { components } from '@cortezaproject/corteza-vue'
import { mapGetters, mapActions } from 'vuex'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { isNumber } from 'lodash'
import base from './base'
@@ -126,7 +126,7 @@ export default {
},
mounted () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -140,6 +140,19 @@ export default {
findModuleByID: 'module/findByID',
}),
createEvents () {
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { feeds } = this.options
if (feeds.some(({ options }) => isFieldInFilter(fieldName, options.prefilter))) {
this.refresh()
}
},
refreshOnRelatedRecordsUpdate ({ moduleID, notPageID }) {
this.options.feeds.forEach((feed) => {
if (feed.options.moduleID === moduleID && this.page.pageID !== notPageID) {
@@ -275,6 +288,7 @@ export default {
destroyEvents () {
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/IFrameBase.vue
+22 -1
View File
@@ -15,7 +15,7 @@
<script>
import base from './base'
import { NoID } from '@cortezaproject/corteza-js'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
export default {
extends: base,
@@ -46,12 +46,33 @@ export default {
mounted () {
this.refreshBlock(this.refresh)
this.createEvents()
},
beforeDestroy () {
this.destroyEvents()
},
methods: {
refresh () {
this.$refs.iframe.src = this.src
},
createEvents () {
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { src } = this.options
if (isFieldInFilter(fieldName, src)) {
this.refresh()
}
},
destroyEvents () {
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
</script>
client/web/compose/src/components/PageBlocks/MetricBase.vue
+19 -6
View File
@@ -41,7 +41,7 @@ import moment from 'moment'
import { debounce } from 'lodash'
import MetricItem from './Metric/Item'
import { NoID, compose } from '@cortezaproject/corteza-js'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
export default {
i18nOptions: {
@@ -89,11 +89,7 @@ export default {
},
mounted () {
this.$root.$on('metric.update', this.refresh)
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('drill-down-chart', this.drillDown)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -107,6 +103,22 @@ export default {
},
methods: {
createEvents () {
this.$root.$on('metric.update', this.refresh)
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('drill-down-chart', this.drillDown)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { metrics } = this.options
if (metrics.some(({ filter }) => isFieldInFilter(fieldName, filter))) {
this.refresh()
}
},
/**
* Performs some post processing on the provided data
*/
@@ -268,6 +280,7 @@ export default {
this.$root.$off(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$off('drill-down-chart', this.drillDown)
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/ProgressBase.vue
+17 -3
View File
@@ -37,7 +37,7 @@
import base from './base'
import { NoID } from '@cortezaproject/corteza-js'
import { components } from '@cortezaproject/corteza-vue'
import { evaluatePrefilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
const { CProgress } = components
export default {
@@ -77,8 +77,7 @@ export default {
},
mounted () {
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -87,6 +86,20 @@ export default {
},
methods: {
createEvents () {
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { value } = this.options
if (isFieldInFilter(fieldName, value.filter)) {
this.refresh()
}
},
/**
* Pulls fresh data from the API
*/
@@ -152,6 +165,7 @@ export default {
destroyEvents () {
this.$root.$off(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/components/PageBlocks/RecordEditor.vue
+5 -2
View File
@@ -26,7 +26,7 @@
v-bind="{ ...$props, errors: fieldErrors(field.name) }"
:horizontal="horizontal"
:field="field"
@change="onFieldChange()"
@change="onFieldChange(field)"
/>
<b-form-group
@@ -214,8 +214,11 @@ export default {
return !expressions.value
},
onFieldChange: debounce(function () {
onFieldChange: debounce(function (field) {
this.evaluateExpressions()
this.$root.$emit('record-field-change', {
fieldName: field.name,
})
}, 500),
},
}
client/web/compose/src/components/PageBlocks/RecordListBase.vue
+12 -1
View File
@@ -745,7 +745,7 @@ import AutomationButtons from './Shared/AutomationButtons'
import { compose, validator, NoID } from '@cortezaproject/corteza-js'
import users from 'corteza-webapp-compose/src/mixins/users'
import records from 'corteza-webapp-compose/src/mixins/records'
import { evaluatePrefilter, queryToFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, queryToFilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { getItem, setItem, removeItem } from 'corteza-webapp-compose/src/lib/local-storage'
import { components, url } from '@cortezaproject/corteza-vue'
import draggable from 'vuedraggable'
@@ -1105,6 +1105,16 @@ export default {
this.$root.$on(`refetch-non-record-blocks:${pageID}`, this.refreshAndResetPagination)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { prefilter } = this.options
if (isFieldInFilter(fieldName, prefilter)) {
this.prepRecordList()
this.refresh()
}
},
refreshOnRelatedRecordsUpdate ({ moduleID, notPageID }) {
@@ -1970,6 +1980,7 @@ export default {
this.$root.$off(`drill-down-recordList:${this.uniqueID}`, this.setDrillDownFilter)
this.$root.$off(`refetch-non-record-blocks:${pageID}`, this.refreshAndResetPagination)
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
handleAddRecord () {
client/web/compose/src/components/PageBlocks/RecordOrganizerBase.vue
+17 -3
View File
@@ -115,7 +115,7 @@ import draggable from 'vuedraggable'
import FieldViewer from 'corteza-webapp-compose/src/components/ModuleFields/Viewer'
import users from 'corteza-webapp-compose/src/mixins/users'
import records from 'corteza-webapp-compose/src/mixins/records'
import { evaluatePrefilter, getFieldFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { evaluatePrefilter, getFieldFilter, isFieldInFilter } from 'corteza-webapp-compose/src/lib/record-filter'
import { compose, NoID } from '@cortezaproject/corteza-js'
export default {
@@ -250,8 +250,7 @@ export default {
},
mounted () {
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.createEvents()
},
beforeDestroy () {
@@ -261,6 +260,20 @@ export default {
},
methods: {
createEvents () {
this.$root.$on(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$on('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$on('record-field-change', this.refetchOnPrefilterValueChange)
},
refetchOnPrefilterValueChange ({ fieldName }) {
const { filter } = this.options
if (isFieldInFilter(fieldName, filter)) {
this.refresh()
}
},
// Allow move if repositioned or if record isn't in target record organizer
checkMove ({ draggedContext = {}, relatedContext = {} }) {
const { moduleID, recordID } = draggedContext.element || {}
@@ -527,6 +540,7 @@ export default {
destroyEvents () {
this.$root.$off(`refetch-non-record-blocks:${this.page.pageID}`, this.refresh)
this.$root.$off('module-records-updated', this.refreshOnRelatedRecordsUpdate)
this.$root.$off('record-field-change', this.refetchOnPrefilterValueChange)
},
},
}
client/web/compose/src/lib/record-filter.js
+13
View File
@@ -208,3 +208,16 @@ function trimChar (text = '', char = '') {
}
return text
}
// Helper function that checks if field name is included in a filter
export function isFieldInFilter (fieldName, filter = '') {
if (!fieldName) return
const filterCases = [
'${' + fieldName + '}',
'${record.' + fieldName + '}',
'${record.values.' + fieldName + '}',
]
return filterCases.some(filterCase => filter.includes(filterCase))
}