test(utils): add ut to package/utils

packages/utils/jest.config.js

@@ -11,6 +11,7 @@ const jestConfig = {
     '!**/node_modules/**',
     '!**/vendor/**',
   ],
+  setupFilesAfterEnv: ['./jest.setup.js'],
 };
 
 // 只对本仓库内的 pkg 做 mapping

packages/utils/jest.setup.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

packages/utils/package.json

@@ -9,7 +9,7 @@
   "main": "lib/index.js",
   "module": "es/index.js",
   "scripts": {
-    "test": "build-scripts test --config build.test.json",
+    "test": "build-scripts test --config build.test.json --jest-coverage",
     "build": "build-scripts build"
   },
   "dependencies": {
@@ -21,8 +21,11 @@
   },
   "devDependencies": {
     "@alib/build-scripts": "^0.1.18",
+    "@testing-library/jest-dom": "^6.1.4",
+    "@testing-library/react": "^11.2.7",
     "@types/node": "^13.7.1",
-    "@types/react": "^16"
+    "@types/react": "^16",
+    "react-dom": "^16.14.0"
   },
   "publishConfig": {
     "access": "public",

packages/utils/src/check-types/is-action-content-object.ts

@@ -1,5 +1,6 @@
 import { IPublicTypeActionContentObject } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isActionContentObject(obj: any): obj is IPublicTypeActionContentObject {
-  return obj && typeof obj === 'object';
+  return isObject(obj);
 }

packages/utils/src/check-types/is-custom-view.ts

@@ -2,7 +2,9 @@ import { isValidElement } from 'react';
 import { isReactComponent } from '../is-react';
 import { IPublicTypeCustomView } from '@alilc/lowcode-types';
 
-
 export function isCustomView(obj: any): obj is IPublicTypeCustomView {
-  return obj && (isValidElement(obj) || isReactComponent(obj));
+  if (!obj) {
+    return false;
+  }
+  return isValidElement(obj) || isReactComponent(obj);
 }

packages/utils/src/check-types/is-drag-any-object.ts

@@ -1,5 +1,9 @@
 import { IPublicEnumDragObjectType } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isDragAnyObject(obj: any): boolean {
-  return obj && obj.type !== IPublicEnumDragObjectType.NodeData && obj.type !== IPublicEnumDragObjectType.Node;
+  if (!isObject(obj)) {
+    return false;
+  }
+  return obj.type !== IPublicEnumDragObjectType.NodeData && obj.type !== IPublicEnumDragObjectType.Node;
 }

packages/utils/src/check-types/is-drag-node-data-object.ts

@@ -1,5 +1,9 @@
 import { IPublicEnumDragObjectType, IPublicTypeDragNodeDataObject } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isDragNodeDataObject(obj: any): obj is IPublicTypeDragNodeDataObject {
-  return obj && obj.type === IPublicEnumDragObjectType.NodeData;
+  if (!isObject(obj)) {
+    return false;
+  }
+  return obj.type === IPublicEnumDragObjectType.NodeData;
 }

packages/utils/src/check-types/is-drag-node-object.ts

@@ -1,5 +1,9 @@
 import { IPublicEnumDragObjectType, IPublicModelNode, IPublicTypeDragNodeObject } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isDragNodeObject<Node = IPublicModelNode>(obj: any): obj is IPublicTypeDragNodeObject<Node> {
-  return obj && obj.type === IPublicEnumDragObjectType.Node;
+  if (!isObject(obj)) {
+    return false;
+  }
+  return obj.type === IPublicEnumDragObjectType.Node;
 }

packages/utils/src/check-types/is-dynamic-setter.ts

@@ -1,7 +1,10 @@
+import { isFunction } from '../is-function';
 import { isReactClass } from '../is-react';
 import { IPublicTypeDynamicSetter } from '@alilc/lowcode-types';
 
-
 export function isDynamicSetter(obj: any): obj is IPublicTypeDynamicSetter {
-  return obj && typeof obj === 'function' && !isReactClass(obj);
+  if (!isFunction(obj)) {
+    return false;
+  }
+  return !isReactClass(obj);
 }

packages/utils/src/check-types/is-function.ts

@@ -0,0 +1,3 @@
+export function isFunction(obj: any): obj is Function {
+  return obj && typeof obj === 'function';
+}

packages/utils/src/check-types/is-i18n-data.ts

@@ -1,8 +1,9 @@
-
-// type checks
-
-import { IPublicTypeI18nData } from "@alilc/lowcode-types";
+import { IPublicTypeI18nData } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isI18nData(obj: any): obj is IPublicTypeI18nData {
-  return obj && obj.type === 'i18n';
+  if (!isObject(obj)) {
+    return false;
+  }
+  return obj.type === 'i18n';
 }

packages/utils/src/check-types/is-isfunction.ts

@@ -1,10 +1,26 @@
+import { IPublicTypeJSFunction } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
+
+interface InnerJsFunction {
+  type: 'JSExpression';
+  source: string;
+  value: string;
+  extType: 'function';
+}
+
 /**
  *  内部版本 的 { type: 'JSExpression', source: '', value: '', extType: 'function' } 能力上等同于 JSFunction
  */
-export function isInnerJsFunction(data: any) {
-  return data && data.type === 'JSExpression' && data.extType === 'function';
+export function isInnerJsFunction(data: any): data is InnerJsFunction {
+  if (!isObject(data)) {
+    return false;
+  }
+  return data.type === 'JSExpression' && data.extType === 'function';
 }
 
-export function isJSFunction(data: any): boolean {
-  return typeof data === 'object' && data && data.type === 'JSFunction' || isInnerJsFunction(data);
+export function isJSFunction(data: any): data is IPublicTypeJSFunction {
+  if (!isObject(data)) {
+    return false;
+  }
+  return data.type === 'JSFunction' || isInnerJsFunction(data);
 }

packages/utils/src/check-types/is-jsblock.ts

@@ -1,4 +1,9 @@
+import { IPublicTypeJSBlock } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
-export function isJSBlock(data: any): boolean {
-  return data && data.type === 'JSBlock';
+export function isJSBlock(data: any): data is IPublicTypeJSBlock {
+  if (!isObject(data)) {
+    return false;
+  }
+  return data.type === 'JSBlock';
 }

packages/utils/src/check-types/is-jsexpression.ts

@@ -1,4 +1,5 @@
 import { IPublicTypeJSExpression } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 /**
  * 为了避免把 { type: 'JSExpression', extType: 'function' } 误判为表达式，故增加如下逻辑。
@@ -11,5 +12,8 @@ import { IPublicTypeJSExpression } from '@alilc/lowcode-types';
  * @returns
  */
 export function isJSExpression(data: any): data is IPublicTypeJSExpression {
-  return data && data.type === 'JSExpression' && data.extType !== 'function';
+  if (!isObject(data)) {
+    return false;
+  }
+  return data.type === 'JSExpression' && data.extType !== 'function';
 }

packages/utils/src/check-types/is-jsslot.ts

@@ -1,5 +1,9 @@
 import { IPublicTypeJSSlot } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isJSSlot(data: any): data is IPublicTypeJSSlot {
-  return data && data.type === 'JSSlot';
+  if (!isObject(data)) {
+    return false;
+  }
+  return data.type === 'JSSlot';
 }

packages/utils/src/check-types/is-location-children-detail.ts

@@ -1,5 +1,9 @@
 import { IPublicTypeLocationChildrenDetail, IPublicTypeLocationDetailType } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isLocationChildrenDetail(obj: any): obj is IPublicTypeLocationChildrenDetail {
-  return obj && obj.type === IPublicTypeLocationDetailType.Children;
+  if (!isObject(obj)) {
+    return false;
+  }
+  return obj.type === IPublicTypeLocationDetailType.Children;
 }

packages/utils/src/check-types/is-location-data.ts

@@ -1,5 +1,9 @@
 import { IPublicTypeLocationData } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isLocationData(obj: any): obj is IPublicTypeLocationData {
-  return obj && obj.target && obj.detail;
+  if (!isObject(obj)) {
+    return false;
+  }
+  return 'target' in obj && 'detail' in obj;
 }

packages/utils/src/check-types/is-lowcode-project-schema.ts

@@ -1,6 +1,15 @@
-import { IPublicTypeComponentSchema, IPublicTypeProjectSchema } from "@alilc/lowcode-types";
-import { isComponentSchema } from "./is-component-schema";
+import { IPublicTypeComponentSchema, IPublicTypeProjectSchema } from '@alilc/lowcode-types';
+import { isComponentSchema } from './is-component-schema';
+import { isObject } from '../is-object';
 
 export function isLowcodeProjectSchema(data: any): data is IPublicTypeProjectSchema<IPublicTypeComponentSchema> {
-  return data && data.componentsTree && data.componentsTree.length && isComponentSchema(data.componentsTree[0]);
+  if (!isObject(data)) {
+    return false;
+  }
+
+  if (!('componentsTree' in data) || data.componentsTree.length === 0) {
+    return false;
+  }
+
+  return isComponentSchema(data.componentsTree[0]);
 }

packages/utils/src/check-types/is-node-schema.ts

@@ -1,5 +1,9 @@
 import { IPublicTypeNodeSchema } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isNodeSchema(data: any): data is IPublicTypeNodeSchema {
-  return data && data.componentName && !data.isNode;
+  if (!isObject(data)) {
+    return false;
+  }
+  return 'componentName' in data && !data.isNode;
 }

packages/utils/src/check-types/is-node.ts

@@ -1,5 +1,9 @@
 import { IPublicModelNode } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isNode<Node = IPublicModelNode>(node: any): node is Node {
-  return node && node.isNode;
+  if (!isObject(node)) {
+    return false;
+  }
+  return node.isNode;
 }

packages/utils/src/check-types/is-object.ts

@@ -0,0 +1,3 @@
+export function isObject(obj: any): boolean {
+  return obj && typeof obj === 'object';
+}

packages/utils/src/check-types/is-procode-component-type.ts

@@ -1,6 +1,10 @@
 import { IPublicTypeComponentMap, IPublicTypeProCodeComponent } from '@alilc/lowcode-types';
-
+import { isObject } from '../is-object';
 
 export function isProCodeComponentType(desc: IPublicTypeComponentMap): desc is IPublicTypeProCodeComponent {
+  if (!isObject(desc)) {
+    return false;
+  }
+
   return 'package' in desc;
 }

packages/utils/src/check-types/is-project-schema.ts

@@ -1,5 +1,9 @@
-import { IPublicTypeProjectSchema } from "@alilc/lowcode-types";
+import { IPublicTypeProjectSchema } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isProjectSchema(data: any): data is IPublicTypeProjectSchema {
-  return data && data.componentsTree;
+  if (!isObject(data)) {
+    return false;
+  }
+  return 'componentsTree' in data;
 }

packages/utils/src/check-types/is-setter-config.ts

@@ -1,7 +1,10 @@
 import { IPublicTypeSetterConfig } from '@alilc/lowcode-types';
 import { isCustomView } from './is-custom-view';
-
+import { isObject } from '../is-object';
 
 export function isSetterConfig(obj: any): obj is IPublicTypeSetterConfig {
-  return obj && typeof obj === 'object' && 'componentName' in obj && !isCustomView(obj);
+  if (!isObject(obj)) {
+    return false;
+  }
+  return 'componentName' in obj && !isCustomView(obj);
 }

packages/utils/src/check-types/is-setting-field.ts

@@ -1,5 +1,10 @@
-import { IPublicModelSettingField } from "@alilc/lowcode-types";
+import { IPublicModelSettingField } from '@alilc/lowcode-types';
+import { isObject } from '../is-object';
 
 export function isSettingField(obj: any): obj is IPublicModelSettingField {
-  return obj && obj.isSettingField;
+  if (!isObject(obj)) {
+    return false;
+  }
+
+  return 'isSettingField' in obj && obj.isSettingField;
 }

packages/utils/src/clone-enumerable-property.ts

@@ -11,8 +11,8 @@ const excludePropertyNames = [
   'arguments',
 ];
 
-export function cloneEnumerableProperty(target: any, origin: any) {
-  const compExtraPropertyNames = Object.keys(origin).filter(d => !excludePropertyNames.includes(d));
+export function cloneEnumerableProperty(target: any, origin: any, excludes = excludePropertyNames) {
+  const compExtraPropertyNames = Object.keys(origin).filter(d => !excludes.includes(d));
 
   compExtraPropertyNames.forEach((d: string) => {
     (target as any)[d] = origin[d];

packages/utils/src/is-object.ts

@@ -1,4 +1,4 @@
-export function isObject(value: any): value is Record<string, unknown> {
+export function isObject(value: any): value is Record<string, any> {
   return value !== null && typeof value === 'object';
 }
 

packages/utils/src/is-react.ts

@@ -2,27 +2,49 @@ import { ComponentClass, Component, FunctionComponent, ComponentType, createElem
 import { cloneEnumerableProperty } from './clone-enumerable-property';
 
 const hasSymbol = typeof Symbol === 'function' && Symbol.for;
-const REACT_FORWARD_REF_TYPE = hasSymbol ? Symbol.for('react.forward_ref') : 0xead0;
-const REACT_MEMO_TYPE = hasSymbol ? Symbol.for('react.memo') : 0xead3;
+export const REACT_FORWARD_REF_TYPE = hasSymbol ? Symbol.for('react.forward_ref') : 0xead0;
+export const REACT_MEMO_TYPE = hasSymbol ? Symbol.for('react.memo') : 0xead3;
 
 export function isReactClass(obj: any): obj is ComponentClass<any> {
-  return obj && obj.prototype && (obj.prototype.isReactComponent || obj.prototype instanceof Component);
+  if (!obj) {
+    return false;
+  }
+  if (obj.prototype && (obj.prototype.isReactComponent || obj.prototype instanceof Component)) {
+    return true;
+  }
+  return false;
 }
 
 export function acceptsRef(obj: any): boolean {
-  return obj?.prototype?.isReactComponent || isForwardOrMemoForward(obj);
+  if (!obj) {
+    return false;
+  }
+  if (obj?.prototype?.isReactComponent || isForwardOrMemoForward(obj)) {
+    return true;
+  }
+
+  return false;
 }
 
 export function isForwardRefType(obj: any): boolean {
-  return obj?.$$typeof && obj?.$$typeof === REACT_FORWARD_REF_TYPE;
+  if (!obj || !obj?.$$typeof) {
+    return false;
+  }
+  return obj?.$$typeof === REACT_FORWARD_REF_TYPE;
 }
 
-function isMemoType(obj: any): boolean {
-  return obj?.$$typeof && obj.$$typeof === REACT_MEMO_TYPE;
+export function isMemoType(obj: any): boolean {
+  if (!obj || !obj?.$$typeof) {
+    return false;
+  }
+  return obj.$$typeof === REACT_MEMO_TYPE;
 }
 
 export function isForwardOrMemoForward(obj: any): boolean {
-  return obj?.$$typeof && (
+  if (!obj || !obj?.$$typeof) {
+    return false;
+  }
+  return (
     // React.forwardRef(..)
     isForwardRefType(obj) ||
     // React.memo(React.forwardRef(..))