fix: supportVariable SHOULD take precedence over supportVariableGlobally (alibaba#1997)

LeoYuan · web-flow · commit 503793fdfc4c · 2023-05-29T10:12:42.000+08:00
* fix: supportVariable should take precedence over supportVariableGlobally
diff --git a/packages/editor-skeleton/src/components/settings/settings-pane.tsx b/packages/editor-skeleton/src/components/settings/settings-pane.tsx
@@ -1,6 +1,6 @@
 import { Component, MouseEvent, Fragment, ReactNode } from 'react';
 import { shallowIntl, observer, obx, engineConfig, runInAction } from '@alilc/lowcode-editor-core';
-import { createContent, isJSSlot, isSetterConfig } from '@alilc/lowcode-utils';
+import { createContent, isJSSlot, isSetterConfig, shouldUseVariableSetter } from '@alilc/lowcode-utils';
 import { Skeleton, Stage } from '@alilc/lowcode-editor-skeleton';
 import { IPublicApiSetters, IPublicTypeCustomView, IPublicTypeDynamicProps } from '@alilc/lowcode-types';
 import { ISettingEntry, IComponentMeta, ISettingField, isSettingField, ISettingTopEntry } from '@alilc/lowcode-designer';
@@ -155,23 +155,29 @@ class SettingFieldView extends Component<SettingFieldViewProps, SettingFieldView
     const supportVariable = this.field.extraProps?.supportVariable;
     // supportVariableGlobally 只对标准组件生效，vc 需要单独配置
     const supportVariableGlobally = engineConfig.get('supportVariableGlobally', false) && isStandardComponent(componentMeta);
-    if (supportVariable || supportVariableGlobally) {
-      if (setterType === 'MixedSetter') {
-        // VariableSetter 不单独使用
-        if (Array.isArray(setterProps.setters) && !setterProps.setters.includes('VariableSetter')) {
-          setterProps.setters.push('VariableSetter');
-        }
-      } else {
-        setterType = 'MixedSetter';
-        setterProps = {
-          setters: [
-            setter,
-            'VariableSetter',
-          ],
-        };
-      }
+    const isUseVariableSetter = shouldUseVariableSetter(supportVariable, supportVariableGlobally);
+    if (isUseVariableSetter === false) {
+      return {
+        setterProps,
+        initialValue,
+        setterType,
+      };
     }
 
+    if (setterType === 'MixedSetter') {
+      // VariableSetter 不单独使用
+      if (Array.isArray(setterProps.setters) && !setterProps.setters.includes('VariableSetter')) {
+        setterProps.setters.push('VariableSetter');
+      }
+    } else {
+      setterType = 'MixedSetter';
+      setterProps = {
+        setters: [
+          setter,
+          'VariableSetter',
+        ],
+      };
+    }
     return {
       setterProps,
       initialValue,
diff --git a/packages/utils/src/misc.ts b/packages/utils/src/misc.ts
@@ -81,6 +81,7 @@ const stageList = [
   'init',
   'upgrade',
 ];
+
 /**
  * 兼容原来的数字版本的枚举对象
  * @param stage
@@ -108,4 +109,18 @@ export function deprecate(fail: any, message: string, alterative?: string) {
 
 export function isRegExp(obj: any): obj is RegExp {
   return obj && obj.test && obj.exec && obj.compile;
+}
+
+/**
+ * The prop supportVariable SHOULD take precedence over default global supportVariable.
+ * @param propSupportVariable prop supportVariable
+ * @param globalSupportVariable global supportVariable
+ * @returns
+ */
+export function shouldUseVariableSetter(
+  propSupportVariable: boolean | undefined,
+  globalSupportVariable: boolean,
+) {
+  if (propSupportVariable === false) return false;
+  return propSupportVariable || globalSupportVariable;
 }
diff --git a/packages/utils/test/src/misc.test.ts b/packages/utils/test/src/misc.test.ts
@@ -0,0 +1,9 @@
+import { shouldUseVariableSetter } from '../../src/misc';
+
+it('shouldUseVariableSetter', () => {
+  expect(shouldUseVariableSetter(false, true)).toBeFalsy();
+  expect(shouldUseVariableSetter(true, true)).toBeTruthy();
+  expect(shouldUseVariableSetter(true, false)).toBeTruthy();
+  expect(shouldUseVariableSetter(undefined, false)).toBeFalsy();
+  expect(shouldUseVariableSetter(undefined, true)).toBeTruthy();
+});
