Allow to access survey elements properties in text processing and expressions fix #10692 (#10693)

* ValueGetterContextCore.getValue use inteface as one parameter

* Add context into text processing

* Support notification on dependencies property value changes

Author: andrewtelnov

packages/survey-core/src/base.ts

@@ -213,6 +213,7 @@ export class Base implements IObjectValueContext {
     Base.currentDependencis.addDependency(target, property);
   }
   public dependencies: { [key: string]: ComputedUpdater } = {};
+  private expressionDependencies: { [key: string]: { obj: Base, propertyName: string } } = {};
   public static get commentSuffix(): string {
     return settings.commentSuffix;
   }
@@ -338,7 +339,13 @@ export class Base implements IObjectValueContext {
     this.onPropertyValueChangedCallback = undefined;
     this.isDisposedValue = true;
     Object.keys(this.dependencies).forEach(key => this.dependencies[key].dispose());
-    // this.dependencies = {};
+    Object.keys(this.expressionDependencies).forEach(key => {
+      const item = this.expressionDependencies[key];
+      if (!item.obj.isDisposed) {
+        item.obj.unRegisterFunctionOnPropertyValueChanged(item.propertyName, key);
+      }
+    });
+    this.expressionDependencies = {};
     Object.keys(this.propertyHash).forEach(key => {
       const propVal = this.getPropertyValueCore(this.propertyHash, key);
       if (!!propVal && propVal.type == ComputedUpdater.ComputedUpdaterType) {
@@ -929,6 +936,20 @@ export class Base implements IObjectValueContext {
   public unRegisterFunctionOnPropertiesValueChanged(names: Array<string>, key: string = null): void {
     this.unregisterPropertyChangedHandlers(names, key);
   }
+  public addPropertyDependency(obj: Base, propertyName: string): void {
+    if (!obj || !propertyName) return;
+    const id = obj.uniqueId + "_" + propertyName;
+    if (!this.expressionDependencies[id]) {
+      obj.registerFunctionOnPropertyValueChanged(propertyName, () => {
+        this.onDependencyValueChanged(obj, propertyName);
+      }, id);
+      this.expressionDependencies[id] = { obj, propertyName };
+    }
+  }
+  private onDependencyValueChanged(obj: Base, propertyName: string): void {
+    this.runConditionCore(this.getDataFilteredProperties());
+    this.locStrsChanged();
+  }
   public createCustomLocalizableObj(name: string): LocalizableString {
     const locStr = this.getLocalizableString(name);
     if (locStr) return locStr;

packages/survey-core/src/conditionProcessValue.ts

@@ -1,3 +1,4 @@
+import { Base } from "./base";
 import { IQuestion } from "./base-interfaces";
 import { Helpers, HashTable } from "./helpers";
 
@@ -6,6 +7,9 @@ export interface IValueGetterItem {
   index?: number;
 }
 export interface IValueGetterInfo {
+  obj?: IObjectValueContext;
+  propObj?: any;
+  propName?: string;
   context?: IValueGetterContext;
   requireStrictCompare?: boolean;
   isFound?: boolean;
@@ -14,9 +18,17 @@ export interface IValueGetterInfo {
 export interface IObjectValueContext {
   getValueGetterContext(isUnwrapped?: boolean): IValueGetterContext;
 }
+export interface IValueGetterContextGetValueParams {
+  path: Array<IValueGetterItem>;
+  isRoot: boolean;
+  index: number;
+  createObjects?: boolean;
+  isProperty?: boolean;
+}
 export interface IValueGetterContext {
-  getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo;
+  getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo;
   getTextValue?(name: string, value: any, isDisplayValue: boolean): string;
+  getObj?(): Base;
   getRootObj?(): IObjectValueContext;
   getQuestion?(): IQuestion;
 }
@@ -31,6 +43,8 @@ export interface IReturnValue {
   isFound: boolean;
   value: any;
   question?: IQuestion;
+  propObj?: any;
+  propName?: string;
   strictCompare?: boolean;
 }
 export class ValueGetter {
@@ -60,6 +74,8 @@ export class ValueGetter {
     res.isFound = true;
     res.value = info.value;
     res.strictCompare = info.requireStrictCompare;
+    res.propObj = info.propObj;
+    res.propName = info.propName;
     if (info.context) {
       if (params.isText && info.context.getTextValue) {
         res.value = info.context.getTextValue(name, res.value, params.isDisplayValue);
@@ -119,8 +135,12 @@ export class ValueGetter {
   private run(name: string, context: IValueGetterContext, createObjects: boolean): any {
     if (!context) return undefined;
     let path = this.getPath(name);
-    const info = context.getValue(path, true, -1, createObjects);
-    return !!info && info.isFound ? info : undefined;
+    const isProperty = path.length > 0 && path[0].name[0] === "$";
+    if (isProperty) {
+      path[0].name = path[0].name.substring(1);
+    }
+    const info = context.getValue({ path, isRoot: true, index: -1, createObjects, isProperty });
+    return info?.isFound ? info : undefined;
   }
   public getPath(name: string): Array<IValueGetterItem> {
     const path: Array<IValueGetterItem> = [];
@@ -154,16 +174,21 @@ export class ValueGetter {
 }
 export class ValueGetterContextCore implements IValueGetterContext {
   constructor() {}
-  public getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo {
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
     let pIndex = 0;
+    const path = params.path;
     const res: IValueGetterInfo = { isFound: false, value: this.getInitialvalue(), context: this };
     while(pIndex < path.length) {
       pIndex = this.checkValueByPath(path, pIndex, res);
       if (!res.isFound) return undefined;
+      if (params.isProperty) {
+        if (!!res.obj) return new PropertyGetterContext(res.obj).getValue({ path: path.slice(1), isRoot: false, index: -1, isProperty: true });
+        if (!res.context) return undefined;
+      }
       const item = path[pIndex];
       pIndex++;
       if (res.context !== this && !!res.context) {
-        return res.context.getValue([].concat(path.slice(pIndex)), false, item.index, createObjects);
+        return res.context.getValue({ path: path.slice(pIndex), isRoot: false, index: item.index, createObjects: params.createObjects, isProperty: params.isProperty });
       }
       if (item.index !== undefined) {
         this.updateItemByIndex(item.index, res);
@@ -259,21 +284,35 @@ export class VariableGetterContext extends ValueGetterContextCore {
   }
 }
 export class PropertyGetterContext extends VariableGetterContext {
+  private lastObj: any;
+  private lastName: string;
   constructor(private obj: any) {
     super(obj);
   }
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
+    this.lastObj = undefined;
+    this.lastName = undefined;
+    const res = super.getValue(params);
+    if (res?.isFound) {
+      res.propObj = this.lastObj;
+      res.propName = this.lastName;
+    }
+    return res;
+  }
   protected getValueByItemCore(obj: any, name: string): any {
     if (!obj || !name) return undefined;
+    this.lastObj = obj;
+    this.lastName = name;
     return obj[name];
   }
 }
 export class VariableGetterContextEx extends VariableGetterContext {
   constructor(variables: HashTable<any>, private second: IValueGetterContext) {
     super(variables);
   }
-  public getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo {
-    const res = super.getValue(path, isRoot, index, createObjects);
-    return !this.second || res?.isFound ? res : this.second.getValue(path, isRoot, index, createObjects);
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
+    const res = super.getValue(params);
+    return !this.second || res?.isFound ? res : this.second.getValue(params);
   }
 }
 
@@ -304,6 +343,12 @@ export class ProcessValue {
   public getValueInfo(valueInfo: any) {
     if (!!this.context) {
       const cRes = this.getValueInfoByContext(valueInfo.name);
+      if (cRes.isFound) {
+        const obj: Base = this.context.getObj ? this.context.getObj() : null;
+        if (!!obj && !!cRes.propObj && (cRes.propObj instanceof Base)) {
+          obj.addPropertyDependency(cRes.propObj, cRes.propName);
+        }
+      }
       valueInfo.value = cRes.value;
       valueInfo.hasValue = cRes.isFound;
       valueInfo.strictCompare = cRes.strictCompare;

packages/survey-core/src/itemvalue.ts

@@ -13,22 +13,26 @@ import { IShortcutText, ISurvey } from "./base-interfaces";
 import { settings } from "./settings";
 import { BaseAction } from "./actions/action";
 import { Question } from "./question";
-import { IObjectValueContext, IValueGetterContext, IValueGetterInfo, IValueGetterItem, PropertyGetterContext } from "./conditionProcessValue";
+import { IObjectValueContext, IValueGetterContext, IValueGetterContextGetValueParams, IValueGetterInfo, IValueGetterItem, PropertyGetterContext } from "./conditionProcessValue";
 
 export class ItemValueGetterContext implements IValueGetterContext {
   constructor (protected item: ItemValue) {}
-  getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo {
-    const name = path.length > 0 ? path[0].name : "";
+  public getObj(): Base { return this.item; }
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
+    const path = params.path;
+    const name = path.length > 0 ? path[0].name.toLocaleLowerCase() : "";
     const expVar = settings.expressionVariables;
-    if (path.length === 1) {
-      if ([expVar.item, expVar.choice].indexOf(name.toLocaleLowerCase()) > -1) return { isFound: true, value: this.item.value, context: this };
+    const isItemVar = [expVar.item, expVar.choice, expVar.self].indexOf(name) > -1;
+    if (path.length === 1 && isItemVar) {
+      return { isFound: true, value: this.item.value, context: this };
     }
-    if (path.length > 1 && ([`$${expVar.item}`, `$${expVar.choice}`].indexOf(name.toLocaleLowerCase()) > -1)) {
-      return new PropertyGetterContext(this.item).getValue(path.slice(1), true, -1, false);
+    if (params.isProperty && path.length > 1 && isItemVar) {
+      params.path = path.slice(1);
+      return new PropertyGetterContext(this.item).getValue(params);
     }
     const owner: any = this.item.locOwner;
     if (owner && owner.getValueGetterContext) {
-      return owner.getValueGetterContext().getValue(path, isRoot, index, createObjects);
+      return owner.getValueGetterContext().getValue(params);
     }
     return undefined;
   }
@@ -61,7 +65,7 @@ export class ItemValue extends BaseAction implements ILocalizableOwner, IShortcu
     return !!this.locOwner ? this.locOwner.getRendererContext(locStr, this) : locStr;
   }
   public getProcessedText(text: string): string {
-    return this.locOwner ? this.locOwner.getProcessedText(text) : text;
+    return this.locOwner ? this.locOwner.getProcessedText(text, this) : text;
   }
 
   public static get Separator() {

packages/survey-core/src/localizablestring.ts

@@ -9,7 +9,7 @@ import { ItemValue } from "./itemvalue";
 export interface ILocalizableOwner {
   getLocale(): string;
   getMarkdownHtml(text: string, name: string, item?: any): string;
-  getProcessedText(text: string): string;
+  getProcessedText(text: string, context?: any): string;
   getRenderer(name: string, item?: ItemValue): string;
   getRendererContext(locStr: LocalizableString, item?: ItemValue): any;
 }

packages/survey-core/src/question.ts

@@ -18,7 +18,7 @@ import { CssClassBuilder } from "./utils/cssClassBuilder";
 import { getElementWidth, isContainerVisible } from "./utils/utils";
 import { PopupModel } from "./popup";
 import { ConsoleWarnings } from "./console-warnings";
-import { IObjectValueContext, IValueGetterContext, IValueGetterInfo, IValueGetterItem, ProcessValue, PropertyGetterContext, ValueGetter, ValueGetterContextCore, VariableGetterContext } from "./conditionProcessValue";
+import { IObjectValueContext, IValueGetterContext, IValueGetterContextGetValueParams, IValueGetterInfo, IValueGetterItem, ProcessValue, PropertyGetterContext, ValueGetter, ValueGetterContextCore, VariableGetterContext } from "./conditionProcessValue";
 import { ITheme } from "./themes";
 import { DomDocumentHelper, DomWindowHelper } from "./global_variables_utils";
 import { ITextArea, TextAreaModel } from "./utils/text-area";
@@ -55,21 +55,29 @@ interface ITriggerExpressionInfo {
 
 export class QuestionValueGetterContext implements IValueGetterContext {
   constructor (protected question: Question, protected isUnwrapped?: boolean) {}
-  getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo {
+  public getObj(): Base { return this.question; }
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
+    const path = params.path;
+    const index = params.index;
     const expVar = settings.expressionVariables;
-    if (path.length === 0 || (path.length === 1 && path[0].name === expVar.question)) return this.getQuestionValue(index);
-    //TODO make it more generic by supporting $name.property
-    if (path.length > 1 && path[0].name === "$" + expVar.question) {
-      return new PropertyGetterContext(this.question).getValue(path.slice(1), isRoot, index, createObjects);
-    }
-    if (path.length > 1 && path[0].name === "$" + expVar.parent && !!this.question.parentQuestion) {
-      return new PropertyGetterContext(this.question.parentQuestion).getValue(path.slice(1), isRoot, index, createObjects);
+    if (params.isProperty && path.length > 1) {
+      params.path = path.slice(1);
+      params.isRoot = false;
+      if (path[0].name === expVar.self) {
+        return new PropertyGetterContext(this.question).getValue(params);
+      }
+      if (path[0].name === expVar.parent && !!this.question.parentQuestion) {
+        return new PropertyGetterContext(this.question.parentQuestion).getValue(params);
+      }
     }
+    if (path.length === 0 || (path.length === 1 && path[0].name === expVar.self)) return this.getQuestionValue(index);
     if (path.length > 1 && path[0].name === expVar.panel) {
+      params.isRoot = false;
       const panel: any = this.question.parent;
       if (panel && panel.isPanel) {
         path.shift();
-        return new QuestionArrayGetterContext(panel.questions).getValue(path, false, index, createObjects);
+        return params.isProperty ? new PropertyGetterContext(panel).getValue(params) :
+          new QuestionArrayGetterContext(panel.questions).getValue(params);
       }
     }
     if (!this.question.isEmpty()) {
@@ -78,7 +86,8 @@ export class QuestionValueGetterContext implements IValueGetterContext {
         if (!Array.isArray(val || index >= val.length)) return undefined;
         val = val[index];
       }
-      return new VariableGetterContext(val).getValue(path, false, index, createObjects);
+      params.isProperty = false;
+      return new VariableGetterContext(val).getValue(params);
     }
     return undefined;
   }
@@ -90,7 +99,7 @@ export class QuestionValueGetterContext implements IValueGetterContext {
   getQuestion(): IQuestion { return this.question; }
   protected getSurveyValue(path: Array<IValueGetterItem>, index?: number): IValueGetterInfo {
     const survey = this.question.getSurvey();
-    if (survey) return (<any>survey).getValueGetterContext().getValue(path, false, index, false);
+    if (survey) return (<any>survey).getValueGetterContext().getValue({ path, isRoot: false, index });
     return undefined;
   }
   private getQuestionValue(index: number): IValueGetterInfo {
@@ -117,7 +126,7 @@ export abstract class QuestionItemValueGetterContext extends ValueGetterContextC
       if (!!name && q.valuePropertyName === name && !!objValue && objValue.hasOwnProperty(name)) {
         return { isFound: true, value: objValue[name], context: q.getValueGetterContext() };
       }
-      const res = q.getValueGetterContext().getValue(path, false, this.getIndex(), false);
+      const res = q.getValueGetterContext().getValue({ path, isRoot: false, index: this.getIndex() });
       if (!!res && res.isFound) return res;
     }
     return undefined;
@@ -158,6 +167,7 @@ export class QuestionArrayGetterContext extends ValueGetterContextCore {
       const qName = q.getFilteredName().toLocaleLowerCase();
       if (qName.toLocaleLowerCase() === lowName) {
         res.isFound = true;
+        res.obj = q;
         res.context = q.getValueGetterContext(qName.endsWith(unWrappedNameSuffix));
         break;
       }

packages/survey-core/src/question_custom.ts

@@ -23,7 +23,7 @@ import { SurveyError } from "./survey-error";
 import { CustomError } from "./error";
 import { ConsoleWarnings } from "./console-warnings";
 import { settings } from "./settings";
-import { IValueGetterContext, IValueGetterInfo, IValueGetterItem } from "./conditionProcessValue";
+import { IValueGetterContext, IValueGetterContextGetValueParams, IValueGetterInfo, PropertyGetterContext } from "./conditionProcessValue";
 import { ValidationContext } from "./question";
 
 /**
@@ -1069,14 +1069,18 @@ export class CompositeValueGetterContext extends QuestionValueGetterContext {
   constructor (protected question: Question) {
     super(question);
   }
-  public getValue(path: Array<IValueGetterItem>, isRoot: boolean, index: number, createObjects: boolean): IValueGetterInfo {
+  public getObj(): Base { return this.question; }
+  public getValue(params: IValueGetterContextGetValueParams): IValueGetterInfo {
     const cq = <QuestionCompositeModel>this.question;
-    if (path.length > 0 && (path.length > 1 || !isRoot)) {
+    const path = params.path;
+    if (path.length > 0 && (path.length > 1 || !params.isRoot)) {
       const isCompPrefix = path[0].name === settings.expressionVariables.composite;
       if (isCompPrefix) {
         path.shift();
       }
-      return new QuestionArrayGetterContext(cq.contentPanel.questions).getValue(path, false, index, createObjects);
+      params.isRoot = false;
+      return params.isProperty ? new PropertyGetterContext(cq.contentPanel).getValue(params) :
+        new QuestionArrayGetterContext(cq.contentPanel.questions).getValue(params);
     }
     return { isFound: false };
   }

packages/survey-core/src/question_imagepicker.ts

@@ -47,8 +47,8 @@ export class ImageItemValue extends ChoiceItem implements ILocalizableOwner {
   getRendererContext(locStr: LocalizableString): any {
     return !!this.locOwner ? this.locOwner.getRendererContext(locStr) : locStr;
   }
-  getProcessedText(text: string): string {
-    return !!this.locOwner ? this.locOwner.getProcessedText(text) : text;
+  getProcessedText(text: string, context?: any): string {
+    return !!this.locOwner ? this.locOwner.getProcessedText(text, context) : text;
   }
 
   public onErrorHandler(): void {