feat: add ability to create string conditions (#45)

* String matching code

* Code review feedback

* Removing log

* Code review comments

Co-authored-by: Peter Hui <pehui@microsoft.com>

Author: phui01

packages/models/package.json

@@ -111,4 +111,4 @@
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }
   }
-}
+}

packages/models/src/Action.ts

@@ -23,12 +23,20 @@ export enum ConditionType {
   GREATER_THAN_OR_EQUAL = "GREATER_THAN_OR_EQUAL",
   LESS_THAN = "LESS_THAN",
   LESS_THAN_OR_EQUAL = "LESS_THAN_OR_EQUAL",
+  STRING_EQUAL = "STRING_EQUAL",
+}
+
+export enum ComparisonType {
+  NUMBER_OF_VALUES = "NUMBER_OF_VALUES",
+  NUMERIC_VALUE = "NUMERIC_VALUE",
+  STRING = "STRING",
 }
 
 export interface Condition {
   entityId: string
   valueId?: string
   value?: number
+  stringValue?: string
   condition: ConditionType
 }
 

packages/sdk/src/Utils.ts

@@ -227,7 +227,10 @@ export const isConditionTrue = (
     filledEntities: CLM.FilledEntity[],
     entities: CLM.EntityBase[]
 ): boolean => {
-    if (condition.valueId) {
+    if (condition.stringValue) {
+        return isStringConditionTrue(condition, filledEntities)
+    }
+    else if (condition.valueId) {
         return isEnumConditionTrue(condition, filledEntities)
     }
     else if (condition.value) {
@@ -239,6 +242,21 @@ export const isConditionTrue = (
     }
 }
 
+const isStringConditionTrue = (
+    condition: CLM.Condition,
+    filledEntities: CLM.FilledEntity[]
+): boolean => {
+    if (condition.stringValue && condition.condition === CLM.ConditionType.STRING_EQUAL) {
+        const filledEntity = filledEntities.find(e => e.entityId === condition.entityId)
+        const stringValue = filledEntity && filledEntity.values.length > 0 && filledEntity.values[0].userText
+        if (stringValue === condition.stringValue) {
+            return true
+        }
+    }
+
+    return false
+}
+
 const isEnumConditionTrue = (
     condition: CLM.Condition,
     filledEntities: CLM.FilledEntity[]

packages/ui/src/Utils/actionCondition.ts

@@ -18,6 +18,13 @@ export const conditionDisplay: Record<CLM.ConditionType, string> = {
     [CLM.ConditionType.GREATER_THAN_OR_EQUAL]: '>=',
     [CLM.ConditionType.LESS_THAN]: '<',
     [CLM.ConditionType.LESS_THAN_OR_EQUAL]: '<=',
+    [CLM.ConditionType.STRING_EQUAL]: 'Matches exactly'
+}
+
+export const comparisonTypeDisplay: Record<CLM.ComparisonType, string> = {
+    [CLM.ComparisonType.NUMBER_OF_VALUES]: 'Number of Items',
+    [CLM.ComparisonType.NUMERIC_VALUE]: 'Numeric Value',
+    [CLM.ComparisonType.STRING]: 'String',
 }
 
 export const getEnumConditionName = (entity: CLM.EntityBase, enumValue: CLM.EnumValue): string => {
@@ -28,6 +35,10 @@ export const getValueConditionName = (entity: CLM.EntityBase, condition: CLM.Con
     return `${entity.entityName} ${conditionDisplay[condition.condition]} ${condition.value}`
 }
 
+export const getStringConditionName = (entity: CLM.EntityBase, condition: CLM.Condition): string => {
+    return `${entity.entityName} ${conditionDisplay[condition.condition]} "${condition.stringValue}"`
+}
+
 export const convertConditionToConditionalTag = (condition: CLM.Condition, entities: CLM.EntityBase[]): IConditionalTag => {
     const entity = entities.find(e => e.entityId === condition.entityId)
     if (!entity) {
@@ -57,7 +68,9 @@ export const convertConditionToConditionalTag = (condition: CLM.Condition, entit
         }
     }
     else {
-        const name = getValueConditionName(entity, condition)
+        const name = condition.value
+            ? getValueConditionName(entity, condition)
+            : getStringConditionName(entity, condition)
         const key = CLM.hashText(name)
         conditionalTag = {
             key,
@@ -94,6 +107,22 @@ export const findNumberFromMemory = (memory: CLM.Memory, isMultivalue: boolean):
         : undefined
 }
 
+/**
+ * Given memory value,
+ * return the userText field of the given memory value, if it exists, or undefined otherwise.
+ */
+export const findStringFromMemory = (memory: CLM.Memory): string | undefined => {
+    return (memory?.entityValues?.[0]?.userText) ?? undefined
+}
+
+
+export const isStringConditionTrue = (condition: CLM.Condition, stringValue: string | undefined): boolean => {
+    if (condition.stringValue) {
+        return condition.condition == CLM.ConditionType.STRING_EQUAL && stringValue === condition.stringValue
+    }
+    return false
+}
+
 export const isValueConditionTrue = (condition: CLM.Condition, numberValue: number): boolean => {
     let isTrue = false
 

packages/ui/src/Utils/dialogUtils.tsx

@@ -11,7 +11,7 @@ import TagsReadOnly from '../components/TagsReadOnly'
 import { compareTwoStrings } from 'string-similarity'
 import { deepCopy, getDefaultEntityMap } from './util'
 import { ImportedAction } from '../types/models'
-import { getValueConditionName, findNumberFromMemory, isValueConditionTrue, isEnumConditionTrue } from './actionCondition'
+import { getValueConditionName, findNumberFromMemory, findStringFromMemory, isValueConditionTrue, isEnumConditionTrue, isStringConditionTrue, getStringConditionName } from './actionCondition'
 import { fromLogTag } from '../types'
 
 const MAX_SAMPLE_INPUT_LENGTH = 150
@@ -400,7 +400,20 @@ export function convertToScorerCondition(condition: CLM.Condition, entities: CLM
             name
         }
     }
-    // Other conditions (StringCondition in future)
+    else if (condition.stringValue) {
+        const name = getStringConditionName(entity, condition)
+        let match = false
+        if (memory) {
+            const value = findStringFromMemory(memory)
+            match = isStringConditionTrue(condition, value)
+        }
+
+        return {
+            match,
+            name
+        }
+    }
+    // Other conditions
     else {
         return {
             match: false,

packages/ui/src/components/ActionDetailsList.tsx

@@ -18,7 +18,7 @@ import { injectIntl, InjectedIntl, InjectedIntlProps } from 'react-intl'
 import { FM } from '../react-intl-messages'
 import './ActionDetailsList.css'
 import { autobind } from 'core-decorators'
-import { getValueConditionName, getEnumConditionName } from '../Utils/actionCondition'
+import { getValueConditionName, getEnumConditionName, getStringConditionName } from '../Utils/actionCondition'
 import * as MockResultUtil from '../Utils/mockResults'
 
 interface ComponentState {
@@ -344,6 +344,9 @@ function renderConditions(entityIds: string[], conditions: CLM.Condition[], allE
                     ? `Error - Missing Enum: ${condition.valueId}`
                     : getEnumConditionName(entity, enumValue)
             }
+            else if (condition.stringValue) {
+                name = getStringConditionName(entity, condition)
+            }
             else {
                 name = getValueConditionName(entity, condition)
             }

packages/ui/src/components/modals/ConditionModal.css

@@ -1,7 +1,7 @@
 .cl-condition-creator__expression {
     display: grid;
     grid-gap: 1em;
-    grid-template-columns: repeat(3, 1fr);
+    grid-template-columns: repeat(4, 1fr);
 }
 
 .cl-condition-creator__existing-conditions {