feat: allow using contact custom attributes in automation rules

abhinavxd · abhinavxd · commit 2fc642c34eed · 2025-04-15T02:23:47.000+05:30
diff --git a/cmd/custom_attributes.go b/cmd/custom_attributes.go
@@ -1,6 +1,7 @@
 package main
 
 import (
+	"slices"
 	"strconv"
 
 	cmodels "github.com/abhinavxd/libredesk/internal/custom_attribute/models"
@@ -9,6 +10,22 @@ import (
 	"github.com/zerodha/fastglue"
 )
 
+var (
+	// disallowedKeys contains keys that are not allowed for custom attributes as they're the default fields.
+	disallowedKeys = []string{
+		"contact_email",
+		"content",
+		"subject",
+		"status",
+		"priority",
+		"assigned_team",
+		"assigned_user",
+		"hours_since_created",
+		"hours_since_resolved",
+		"inbox",
+	}
+)
+
 // handleGetCustomAttribute retrieves a custom attribute by its ID.
 func handleGetCustomAttribute(r *fastglue.Request) error {
 	var (
@@ -76,7 +93,6 @@ func handleUpdateCustomAttribute(r *fastglue.Request) error {
 	if err = app.customAttribute.Update(id, attribute); err != nil {
 		return sendErrorEnvelope(r, err)
 	}
-
 	return r.SendEnvelope(true)
 }
 
@@ -89,11 +105,9 @@ func handleDeleteCustomAttribute(r *fastglue.Request) error {
 	if err != nil || id <= 0 {
 		return r.SendErrorEnvelope(fasthttp.StatusBadRequest, app.i18n.Ts("globals.messages.invalid", "name", "`id`"), nil, envelope.InputError)
 	}
-
 	if err = app.customAttribute.Delete(id); err != nil {
 		return sendErrorEnvelope(r, err)
 	}
-
 	return r.SendEnvelope(true)
 }
 
@@ -114,5 +128,8 @@ func validateCustomAttribute(app *App, attribute cmodels.CustomAttribute) error
 	if attribute.Key == "" {
 		return envelope.NewError(envelope.InputError, app.i18n.Ts("globals.messages.empty", "name", "`key`"), nil)
 	}
+	if slices.Contains(disallowedKeys, attribute.Key) {
+		return envelope.NewError(envelope.InputError, app.i18n.T("admin.customAttributes.keyNotAllowed"), nil)
+	}
 	return nil
 }
diff --git a/frontend/src/composables/useConversationFilters.js b/frontend/src/composables/useConversationFilters.js
@@ -4,6 +4,7 @@ import { useInboxStore } from '@/stores/inbox'
 import { useUsersStore } from '@/stores/users'
 import { useTeamStore } from '@/stores/team'
 import { useSlaStore } from '@/stores/sla'
+import { useCustomAttributeStore } from '@/stores/customAttributes'
 import { FIELD_TYPE, FIELD_OPERATORS } from '@/constants/filterConfig'
 
 export function useConversationFilters () {
@@ -12,6 +13,25 @@ export function useConversationFilters () {
     const uStore = useUsersStore()
     const tStore = useTeamStore()
     const slaStore = useSlaStore()
+    const customAttributeStore = useCustomAttributeStore()
+
+    const customAttributeDataTypeToFieldType = {
+        'text': FIELD_TYPE.TEXT,
+        'number': FIELD_TYPE.NUMBER,
+        'checkbox': FIELD_TYPE.BOOLEAN,
+        'date': FIELD_TYPE.DATE,
+        'link': FIELD_TYPE.TEXT,
+        'list': FIELD_TYPE.SELECT,
+    }
+
+    const customAttributeDataTypeToFieldOperators = {
+        'text': FIELD_OPERATORS.TEXT,
+        'number': FIELD_OPERATORS.NUMBER,
+        'checkbox': FIELD_OPERATORS.BOOLEAN,
+        'date': FIELD_OPERATORS.DATE,
+        'link': FIELD_OPERATORS.TEXT,
+        'list': FIELD_OPERATORS.SELECT,
+    }
 
     const conversationsListFilters = computed(() => ({
         status_id: {
@@ -46,6 +66,23 @@ export function useConversationFilters () {
         }
     }))
 
+    const contactCustomAttributes = computed(() => {
+        return customAttributeStore.contactAttributeOptions
+            .filter(attribute => attribute.applies_to === 'contact')
+            .reduce((acc, attribute) => {
+                acc[attribute.key] = {
+                    label: attribute.label,
+                    type: customAttributeDataTypeToFieldType[attribute.data_type] || FIELD_TYPE.TEXT,
+                    operators: customAttributeDataTypeToFieldOperators[attribute.data_type] || FIELD_OPERATORS.TEXT,
+                    options: attribute.values.map(value => ({
+                        label: value,
+                        value: value
+                    })) || [],
+                }
+                return acc
+            }, {})
+    })
+
     const newConversationFilters = computed(() => ({
         contact_email: {
             label: 'Email',
@@ -223,6 +260,7 @@ export function useConversationFilters () {
         conversationFilters,
         newConversationFilters,
         conversationActions,
-        macroActions
+        macroActions,
+        contactCustomAttributes,
     }
 }
diff --git a/frontend/src/constants/filterConfig.js b/frontend/src/constants/filterConfig.js
@@ -3,7 +3,9 @@ export const FIELD_TYPE = {
     TAG: 'tag',
     TEXT: 'text',
     NUMBER: 'number',
-    RICHTEXT: 'richtext'
+    RICHTEXT: 'richtext',
+    BOOLEAN: 'boolean',
+    DATE: 'date',
 }
 
 export const OPERATOR = {
@@ -19,6 +21,7 @@ export const OPERATOR = {
 
 export const FIELD_OPERATORS = {
     SELECT: [OPERATOR.EQUALS, OPERATOR.NOT_EQUALS, OPERATOR.SET, OPERATOR.NOT_SET],
+    BOOLEAN: [OPERATOR.EQUALS, OPERATOR.NOT_EQUALS],
     TEXT: [
         OPERATOR.EQUALS,
         OPERATOR.NOT_EQUALS,
@@ -27,5 +30,13 @@ export const FIELD_OPERATORS = {
         OPERATOR.CONTAINS,
         OPERATOR.NOT_CONTAINS
     ],
-    NUMBER: [OPERATOR.GREATER_THAN, OPERATOR.LESS_THAN]
+    DATE: [
+        OPERATOR.EQUALS,
+        OPERATOR.NOT_EQUALS,
+        OPERATOR.SET,
+        OPERATOR.NOT_SET,
+        OPERATOR.GREATER_THAN,
+        OPERATOR.LESS_THAN
+    ],
+    NUMBER: [OPERATOR.EQUALS, OPERATOR.NOT_EQUALS],
 }
diff --git a/frontend/src/features/admin/automation/RuleBox.vue b/frontend/src/features/admin/automation/RuleBox.vue
@@ -41,10 +41,20 @@
               </SelectTrigger>
               <SelectContent>
                 <SelectGroup>
+                  <!-- Conversation fields -->
                   <SelectLabel>{{ $t('globals.terms.conversation') }}</SelectLabel>
                   <SelectItem v-for="(field, key) in currentFilters" :key="key" :value="key">
                     {{ field.label }}
                   </SelectItem>
+                  <!-- Contact custom attributes -->
+                  <SelectLabel>{{ $t('globals.terms.contact') }}</SelectLabel>
+                  <SelectItem
+                    v-for="(field, key) in contactCustomAttributes"
+                    :key="key"
+                    :value="key"
+                  >
+                    {{ field.label }}
+                  </SelectItem>
                 </SelectGroup>
               </SelectContent>
             </Select>
@@ -60,7 +70,7 @@
               <SelectContent>
                 <SelectGroup>
                   <SelectItem
-                    v-for="(op, key) in getFieldOperators(rule.field)"
+                    v-for="(op, key) in getFieldOperators(rule.field, rule.field_type)"
                     :key="key"
                     :value="op"
                   >
@@ -94,7 +104,7 @@
               <div v-if="inputType(index) === 'select'">
                 <ComboBox
                   v-model="rule.value"
-                  :items="getFieldOptions(rule.field)"
+                  :items="getFieldOptions(rule.field, rule.field_type)"
                   @select="handleValueChange($event, index)"
                 >
                   <template #item="{ item }">
@@ -128,7 +138,7 @@
                       <div v-if="selected" class="flex items-center gap-2">
                         <Avatar class="w-7 h-7">
                           <AvatarImage
-                            :src="selected.avatar_url ?? ''"
+                            :src="selected.avatar_url || ''"
                             :alt="selected.label.slice(0, 2)"
                           />
                           <AvatarFallback>
@@ -167,8 +177,39 @@
                   {{ $t('globals.messages.pressEnterToSelectAValue') }}
                 </p>
               </div>
+
+              <!-- Date input -->
+              <Input
+                type="date"
+                :placeholder="t('form.field.setValue')"
+                v-if="inputType(index) === 'date'"
+                v-model="rule.value"
+                @update:modelValue="(value) => handleValueChange(value, index)"
+              />
+
+              <!-- Boolean / Checkbox input -->
+              <Select
+                v-model="rule.value"
+                @update:modelValue="(value) => handleValueChange(value, index)"
+                v-if="inputType(index) === 'boolean'"
+              >
+                <SelectTrigger>
+                  <SelectValue :placeholder="t('form.field.selectValue')" />
+                </SelectTrigger>
+                <SelectContent>
+                  <SelectGroup>
+                    <SelectItem value="true">True</SelectItem>
+                    <SelectItem value="false">False</SelectItem>
+                  </SelectGroup>
+                </SelectContent>
+              </Select>
             </div>
 
+            <!-- Placeholder for spacing -->
+            <div v-else class="flex-1">
+            </div>
+
+
             <!-- Remove condition -->
             <div class="cursor-pointer mt-2" @click.prevent="removeCondition(index)">
               <X size="16" />
@@ -242,7 +283,12 @@ const props = defineProps({
   }
 })
 
-const { conversationFilters, newConversationFilters } = useConversationFilters()
+const fieldTypeConstants = {
+  conversation: 'conversation',
+  contact_custom_attribute: 'contact_custom_attribute'
+}
+const { conversationFilters, newConversationFilters, contactCustomAttributes } =
+  useConversationFilters()
 const { ruleGroup } = toRefs(props)
 const emit = defineEmits(['update-group', 'add-condition', 'remove-condition'])
 const { t } = useI18n()
@@ -272,9 +318,16 @@ const handleGroupOperator = (value) => {
 }
 
 const handleFieldChange = (value, ruleIndex) => {
+  // Set the field type based on the selected field value.
+  let fieldType = fieldTypeConstants.conversation
+  if (contactCustomAttributes.value[value]) {
+    fieldType = fieldTypeConstants.contact_custom_attribute
+  }
+
   ruleGroup.value.rules[ruleIndex].operator = ''
   ruleGroup.value.rules[ruleIndex].value = ''
   ruleGroup.value.rules[ruleIndex].field = value
+  ruleGroup.value.rules[ruleIndex].field_type = fieldType
   emitUpdate()
 }
 
@@ -326,19 +379,39 @@ const emitUpdate = () => {
   emit('update-group', ruleGroup, props.groupIndex)
 }
 
-const getFieldOperators = (field) => {
-  return currentFilters.value[field]?.operators || []
+const getFieldOperators = (field, fieldType) => {
+  if (fieldType === fieldTypeConstants.contact_custom_attribute) {
+    return contactCustomAttributes.value[field]?.operators || []
+  }
+  if (fieldType === fieldTypeConstants.conversation) {
+    return currentFilters.value[field]?.operators || []
+  }
+  return []
 }
 
-const getFieldOptions = (field) => {
-  return currentFilters.value[field]?.options || []
+const getFieldOptions = (field, fieldType) => {
+  if (fieldType === fieldTypeConstants.contact_custom_attribute) {
+    return contactCustomAttributes.value[field]?.options || []
+  }
+  if (fieldType === fieldTypeConstants.conversation) {
+    return currentFilters.value[field]?.options || []
+  }
+  return []
 }
 
 const inputType = (index) => {
   const field = ruleGroup.value.rules[index]?.field
+  const fieldType = ruleGroup.value.rules[index]?.field_type
   const operator = ruleGroup.value.rules[index]?.operator
   if (['contains', 'not contains'].includes(operator)) return 'tag'
-  if (field) return currentFilters.value[field].type
+  if (field && fieldType) {
+    if (fieldType === fieldTypeConstants.contact_custom_attribute) {
+      return contactCustomAttributes.value[field]?.type || ''
+    }
+    if (fieldType === fieldTypeConstants.conversation) {
+      return currentFilters.value[field]?.type || ''
+    }
+  }
   return ''
 }
 
diff --git a/frontend/src/features/admin/custom-attributes/CustomAttributesForm.vue b/frontend/src/features/admin/custom-attributes/CustomAttributesForm.vue
@@ -66,7 +66,7 @@
       <FormItem>
         <FormLabel>{{ $t('form.field.type') }}</FormLabel>
         <FormControl>
-          <Select v-bind="componentField">
+          <Select v-bind="componentField" :disabled="form.values.id && form.values.id > 0">
             <SelectTrigger>
               <SelectValue />
             </SelectTrigger>
diff --git a/frontend/src/features/admin/custom-attributes/dataTableColumns.js b/frontend/src/features/admin/custom-attributes/dataTableColumns.js
@@ -21,6 +21,15 @@ export const createColumns = (t) => [
             return h('div', { class: 'text-center font-medium' }, row.getValue('key'))
         }
     },
+    {
+        accessorKey: 'data_type',
+        header: function () {
+            return h('div', { class: 'text-center' }, t('form.field.type'))
+        },
+        cell: function ({ row }) {
+            return h('div', { class: 'text-center font-medium' }, row.getValue('data_type'))
+        }
+    },
     {
         accessorKey: 'applies_to',
         header: function () {
diff --git a/frontend/src/features/contact/ContactNotes.vue b/frontend/src/features/contact/ContactNotes.vue
@@ -55,7 +55,7 @@
       <Card
         v-for="note in notes"
         :key="note.id"
-        class="overflow-hidden border-gray-2 00 hover:border-gray-300 transition-all duration-200 box hover:shadow"
+        class="overflow-hidden border-gray-2 hover:border-gray-300 transition-all duration-200 box hover:shadow"
       >
         <!-- Header -->
         <CardHeader class="bg-gray-50/50 border-b p-2">
diff --git a/i18n/en.json b/i18n/en.json
@@ -613,5 +613,6 @@
   "contact.notes.help": "   Add note for this contact to keep track of important information and conversations.",
   "admin.customAttributes.deleteConfirmation": "This action cannot be undone. This will permanently delete this custom attribute.",
   "admin.customAttributes.regex.description": "Regex to validate the value of this custom attribute. Leave empty to skip validation.",
-  "admin.customAttributes.regexHint.description": "Regex pattern hint."
+  "admin.customAttributes.regexHint.description": "Regex pattern hint.",
+  "admin.customAttributes.keyNotAllowed": "The provided key is not allowed as it conflicts with default attributes. Please use a different key."
 }
diff --git a/internal/automation/automation.go b/internal/automation/automation.go
@@ -25,7 +25,7 @@ import (
 var (
 	//go:embed queries.sql
 	efs embed.FS
-	// MaxQueueSize defines the maximum size of the task queues.
+	// MaxQueueSize is the maximum size of the task queue.
 	MaxQueueSize = 5000
 )
 
diff --git a/internal/automation/evaluator.go b/internal/automation/evaluator.go
diff --git a/internal/automation/models/models.go b/internal/automation/models/models.go
diff --git a/internal/custom_attribute/custom_attribute.go b/internal/custom_attribute/custom_attribute.go
diff --git a/internal/custom_attribute/queries.sql b/internal/custom_attribute/queries.sql

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@`
`55`	`55`	`<Card`
`56`	`56`	`v-for="note in notes"`
`57`	`57`	`:key="note.id"`
`58`		`- class="overflow-hidden border-gray-2 00 hover:border-gray-300 transition-all duration-200 box hover:shadow"`
	`58`	`+ class="overflow-hidden border-gray-2 hover:border-gray-300 transition-all duration-200 box hover:shadow"`
`59`	`59`	`>`
`60`	`60`	`<!-- Header -->`
`61`	`61`	`<CardHeader class="bg-gray-50/50 border-b p-2">`
Original file line number	Diff line number	Diff line change
`@@ -613,5 +613,6 @@`
`613`	`613`	`"contact.notes.help": " Add note for this contact to keep track of important information and conversations.",`
`614`	`614`	`"admin.customAttributes.deleteConfirmation": "This action cannot be undone. This will permanently delete this custom attribute.",`
`615`	`615`	`"admin.customAttributes.regex.description": "Regex to validate the value of this custom attribute. Leave empty to skip validation.",`
`616`		`- "admin.customAttributes.regexHint.description": "Regex pattern hint."`
	`616`	`+ "admin.customAttributes.regexHint.description": "Regex pattern hint.",`
	`617`	`+ "admin.customAttributes.keyNotAllowed": "The provided key is not allowed as it conflicts with default attributes. Please use a different key."`
`617`	`618`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ import (`
`25`	`25`	`var (`
`26`	`26`	`//go:embed queries.sql`
`27`	`27`	`efs embed.FS`
`28`		`- // MaxQueueSize defines the maximum size of the task queues.`
	`28`	`+ // MaxQueueSize is the maximum size of the task queue.`
`29`	`29`	`MaxQueueSize = 5000`
`30`	`30`	`)`
`31`	`31`