@nocobase/flow-engine 2.1.21 → 2.1.23

package/src/utils/dirtyAwareApiClient.ts

@@ -7,13 +7,28 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import type { ActionParams, APIClient, IResource, RequestOptions } from '@nocobase/sdk';
+import { APIClient } from '@nocobase/sdk';
+import type { ActionParams, IResource, RequestOptions } from '@nocobase/sdk';
 import type { FlowContext } from '../flowContext';
 import { getDataSourceKeyFromHeaders, markDataSourceDirty } from './dataSourceDirty';
 
 type ResourceActionFn = (params?: ActionParams, opts?: unknown) => Promise<unknown>;
 
 export const SKIP_DATA_SOURCE_DIRTY = '__nocobaseSkipDataSourceDirty';
+// Carries one logical mutation through APIClient's request/resource cross-dispatch.
+const DIRTY_DISPATCH_TOKEN = Symbol('nocobaseDirtyDispatchToken');
+
+type DirtyDispatchToken = {
+  marked: boolean;
+  requestKey?: string;
+  resourceKey?: string;
+  skip: boolean;
+};
+
+type DirtyDispatchFrame = {
+  key?: string;
+  token: DirtyDispatchToken;
+};
 
 type ResourceRequestOptions = RequestOptions & {
   resource?: unknown;
@@ -21,6 +36,7 @@ type ResourceRequestOptions = RequestOptions & {
   action?: unknown;
   headers?: unknown;
   [SKIP_DATA_SOURCE_DIRTY]?: boolean;
+  [DIRTY_DISPATCH_TOKEN]?: DirtyDispatchToken;
 };
 
 type DirtyResourceAction = {
@@ -329,6 +345,53 @@ function resolveDirtyResourceAction(
   return parseDirtyResourceActionFromUrl(options?.url, context);
 }
 
+function getDirtyResourceActionDispatchKey(
+  dirtyResourceAction: DirtyResourceAction | undefined,
+  headers: unknown,
+): string | undefined {
+  if (!dirtyResourceAction) {
+    return undefined;
+  }
+  return JSON.stringify([
+    dirtyResourceAction.dataSourceKey || getDataSourceKeyFromHeaders(headers),
+    dirtyResourceAction.resourceName,
+    dirtyResourceAction.actionName,
+  ]);
+}
+
+function getRequestDispatchKey(options: ResourceRequestOptions, context: FlowContext): string | undefined {
+  return getDirtyResourceActionDispatchKey(resolveDirtyResourceAction(options, context), options.headers);
+}
+
+function getResourceDispatchKey(name: unknown, of: unknown, headers: unknown): string | undefined {
+  const resourceName = String(name ?? '').trim();
+  if (!resourceName) {
+    return undefined;
+  }
+  return JSON.stringify([resourceName, String(of ?? ''), getDataSourceKeyFromHeaders(headers)]);
+}
+
+function getMatchingRequestToken(
+  token: DirtyDispatchToken | undefined,
+  requestKey: string | undefined,
+): DirtyDispatchToken | undefined {
+  // A matching key prevents helper requests inside an override from sharing the outer mutation token.
+  if (!token || !requestKey || (token.requestKey && token.requestKey !== requestKey)) {
+    return undefined;
+  }
+  return token;
+}
+
+function getMatchingResourceToken(
+  token: DirtyDispatchToken | undefined,
+  resourceKey: string | undefined,
+): DirtyDispatchToken | undefined {
+  if (!token || !resourceKey || (token.resourceKey && token.resourceKey !== resourceKey)) {
+    return undefined;
+  }
+  return token;
+}
+
 function markResourceActionDataSourceDirty(
   context: FlowContext,
   dirtyResourceAction: DirtyResourceAction,
@@ -342,12 +405,31 @@ function markResourceActionDataSourceDirty(
   });
 }
 
+function markResourceActionDataSourceDirtyOnce(
+  token: DirtyDispatchToken,
+  context: FlowContext,
+  dirtyResourceAction: DirtyResourceAction | undefined,
+  headers: unknown,
+) {
+  if (token.skip || token.marked || !dirtyResourceAction || !isMutatingResourceAction(dirtyResourceAction.actionName)) {
+    return;
+  }
+  token.marked = true;
+  markResourceActionDataSourceDirty(context, dirtyResourceAction, headers);
+}
+
+function isObjectRecord(value: unknown): value is Record<PropertyKey, unknown> {
+  return !!value && typeof value === 'object';
+}
+
 function createDirtyAwareResource(
   context: FlowContext,
   resource: IResource,
   resourceName: string,
   resourceOf: unknown,
   headers: unknown,
+  requestTokenStack: DirtyDispatchFrame[],
+  parentToken?: DirtyDispatchToken,
 ): IResource {
   return new Proxy(resource, {
     get(target, prop, receiver) {
@@ -358,10 +440,42 @@ function createDirtyAwareResource(
 
       const action = original as ResourceActionFn;
       return async (...args: Parameters<ResourceActionFn>) => {
-        const result = await action(...args);
+        const actionOptions = isObjectRecord(args[1]) ? args[1] : undefined;
         const dirtyResourceAction = resolveDirtyResourceActionFromResource(resourceName, resourceOf, prop, context);
-        if (dirtyResourceAction) {
-          markResourceActionDataSourceDirty(context, dirtyResourceAction, headers);
+        const requestKey = getDirtyResourceActionDispatchKey(dirtyResourceAction, headers);
+        const resourceKey = getResourceDispatchKey(resourceName, resourceOf, headers);
+        const inheritedToken =
+          getMatchingRequestToken(
+            actionOptions?.[DIRTY_DISPATCH_TOKEN] as DirtyDispatchToken | undefined,
+            requestKey,
+          ) || getMatchingRequestToken(parentToken, requestKey);
+        const token = inheritedToken || { marked: false, skip: false };
+        const ownsToken = !inheritedToken;
+        token.requestKey ||= requestKey;
+        token.resourceKey ||= resourceKey;
+        if (actionOptions?.[SKIP_DATA_SOURCE_DIRTY]) {
+          token.skip = true;
+        }
+        const forwardedArgs: Parameters<ResourceActionFn> =
+          actionOptions || args[1] == null
+            ? [
+                args[0],
+                {
+                  ...actionOptions,
+                  [DIRTY_DISPATCH_TOKEN]: token,
+                },
+              ]
+            : args;
+        let actionResult: Promise<unknown>;
+        requestTokenStack.push({ key: requestKey, token });
+        try {
+          actionResult = Reflect.apply(action, receiver, forwardedArgs);
+        } finally {
+          requestTokenStack.pop();
+        }
+        const result = await actionResult;
+        if (ownsToken) {
+          markResourceActionDataSourceDirtyOnce(token, context, dirtyResourceAction, headers);
         }
         return result;
       };
@@ -370,34 +484,232 @@ function createDirtyAwareResource(
 }
 
 function createDirtyAwareApiClient(api: DirtyAwareAPIClient, context: FlowContext): APIClient {
+  const baseResource = api.resource;
+  const baseRequest = api.request;
+  // SDK methods use the dispatch receiver; custom methods keep the original instance for private fields and state.
+  const shouldUseResourceDispatchReceiver = baseResource === APIClient.prototype.resource;
+  const shouldUseRequestDispatchReceiver = baseRequest === APIClient.prototype.request;
+  // Stacks cover synchronous delegation; the symbol token survives async overrides that forward arguments.
+  const resourceTokenStack: DirtyDispatchFrame[] = [];
+  const requestTokenStack: DirtyDispatchFrame[] = [];
+  let hasResourceOverride = false;
+  let resourceOverride: unknown;
+  let hasRequestOverride = false;
+  let requestOverride: unknown;
+
+  const getCurrentResource = () => (hasResourceOverride ? resourceOverride : resource) as APIClient['resource'];
+  const getCurrentRequest = () => (hasRequestOverride ? requestOverride : request) as APIClient['request'];
+
+  const dispatchResource = (
+    token: DirtyDispatchToken | undefined,
+    args: Parameters<APIClient['resource']>,
+  ): IResource => {
+    const resourceKey = getResourceDispatchKey(args[0], args[1], args[2]);
+    const activeToken = getMatchingResourceToken(token, resourceKey);
+    const shouldWrapActions = !!activeToken && hasResourceOverride;
+    if (activeToken) {
+      activeToken.resourceKey ||= resourceKey;
+      resourceTokenStack.push({ key: resourceKey, token: activeToken });
+    }
+    try {
+      const resourceInstance = Reflect.apply(getCurrentResource(), proxy, args);
+      if (!shouldWrapActions || !activeToken) {
+        return resourceInstance;
+      }
+      return new Proxy(resourceInstance, {
+        get(target, prop, receiver) {
+          const original = Reflect.get(target, prop, receiver);
+          if (typeof prop !== 'string' || typeof original !== 'function' || !isMutatingResourceAction(prop)) {
+            return original;
+          }
+
+          const action = original as ResourceActionFn;
+          return (...actionArgs: Parameters<ResourceActionFn>) => {
+            const actionOptions = isObjectRecord(actionArgs[1]) ? actionArgs[1] : undefined;
+            const forwardedArgs: Parameters<ResourceActionFn> =
+              actionOptions || actionArgs[1] == null
+                ? [
+                    actionArgs[0],
+                    {
+                      ...actionOptions,
+                      [DIRTY_DISPATCH_TOKEN]: activeToken,
+                    },
+                  ]
+                : actionArgs;
+            resourceTokenStack.push({ key: resourceKey, token: activeToken });
+            requestTokenStack.push({ key: activeToken.requestKey, token: activeToken });
+            try {
+              return Reflect.apply(action, receiver, forwardedArgs);
+            } finally {
+              requestTokenStack.pop();
+              resourceTokenStack.pop();
+            }
+          };
+        },
+      });
+    } finally {
+      if (activeToken) {
+        resourceTokenStack.pop();
+      }
+    }
+  };
+
+  const createDispatchReceiver = (token?: DirtyDispatchToken): DirtyAwareAPIClient => {
+    const receiver = Object.create(api) as DirtyAwareAPIClient;
+    Object.defineProperties(receiver, {
+      request: {
+        configurable: true,
+        value: (<T, R, D>(config: APIClientRequestConfig): Promise<R> => {
+          const options = config as ResourceRequestOptions;
+          const requestKey = getRequestDispatchKey(options, context);
+          const stackFrame = requestTokenStack.at(-1);
+          const activeToken =
+            getMatchingRequestToken(options?.[DIRTY_DISPATCH_TOKEN], requestKey) ||
+            (requestKey && stackFrame?.key === requestKey ? stackFrame.token : undefined) ||
+            getMatchingRequestToken(token, requestKey);
+          const { [DIRTY_DISPATCH_TOKEN]: _dirtyDispatchToken, ...cleanOptions } = options;
+          const configWithToken = activeToken ? { ...cleanOptions, [DIRTY_DISPATCH_TOKEN]: activeToken } : cleanOptions;
+          if (activeToken) {
+            activeToken.requestKey ||= requestKey;
+            requestTokenStack.push({ key: requestKey, token: activeToken });
+          }
+          try {
+            return Reflect.apply(getCurrentRequest(), proxy, [configWithToken]) as Promise<R>;
+          } finally {
+            if (activeToken) {
+              requestTokenStack.pop();
+            }
+          }
+        }) as APIClient['request'],
+      },
+      resource: {
+        configurable: true,
+        value: ((...args: Parameters<APIClient['resource']>) => {
+          const resourceKey = getResourceDispatchKey(args[0], args[1], args[2]);
+          const stackFrame = resourceTokenStack.at(-1);
+          const activeToken =
+            getMatchingResourceToken(token, resourceKey) ||
+            (resourceKey && stackFrame?.key === resourceKey ? stackFrame.token : undefined);
+          return dispatchResource(activeToken, args);
+        }) as APIClient['resource'],
+      },
+    });
+    return receiver;
+  };
+
   const resource: APIClient['resource'] = (name, of, headers, cancel) => {
-    const targetResource = api.resource(name, of, headers, cancel);
-    return createDirtyAwareResource(context, targetResource, name, of, headers);
+    const resourceKey = getResourceDispatchKey(name, of, headers);
+    const stackFrame = resourceTokenStack.at(-1);
+    const parentToken = resourceKey && stackFrame?.key === resourceKey ? stackFrame.token : undefined;
+    const receiver = createDispatchReceiver(parentToken);
+    const resourceInstance = Reflect.apply(baseResource, shouldUseResourceDispatchReceiver ? receiver : api, [
+      name,
+      of,
+      headers,
+      cancel,
+    ]);
+    return createDirtyAwareResource(context, resourceInstance, name, of, headers, requestTokenStack, parentToken);
   };
 
   const request = (<T, R, D>(config: APIClientRequestConfig): Promise<R> => {
     const options = config as ResourceRequestOptions;
+    const requestKey = getRequestDispatchKey(options, context);
+    const stackFrame = requestTokenStack.at(-1);
+    const inheritedToken =
+      getMatchingRequestToken(options?.[DIRTY_DISPATCH_TOKEN], requestKey) ||
+      (requestKey && stackFrame?.key === requestKey ? stackFrame.token : undefined);
+    const token = inheritedToken || { marked: false, skip: false };
+    const ownsToken = !inheritedToken;
+    token.requestKey ||= requestKey;
+    if (typeof options.resource === 'string') {
+      token.resourceKey ||= getResourceDispatchKey(options.resource, options.resourceOf, options.headers);
+    }
     const skipDataSourceDirty = options?.[SKIP_DATA_SOURCE_DIRTY];
-    const dirtyResourceAction = skipDataSourceDirty ? undefined : resolveDirtyResourceAction(options, context);
-    const { [SKIP_DATA_SOURCE_DIRTY]: _skipDataSourceDirty, ...cleanConfig } = options;
-    return api.request<T, R, D>(cleanConfig as typeof config).then((result) => {
-      if (dirtyResourceAction && isMutatingResourceAction(dirtyResourceAction.actionName)) {
-        markResourceActionDataSourceDirty(context, dirtyResourceAction, options.headers);
+    if (skipDataSourceDirty) {
+      token.skip = true;
+    }
+    const dirtyResourceAction = resolveDirtyResourceAction(options, context);
+    const {
+      [DIRTY_DISPATCH_TOKEN]: _dirtyDispatchToken,
+      [SKIP_DATA_SOURCE_DIRTY]: _skipDataSourceDirty,
+      ...cleanConfig
+    } = options;
+    const receiver = createDispatchReceiver(token);
+    return (
+      Reflect.apply(baseRequest, shouldUseRequestDispatchReceiver ? receiver : api, [cleanConfig]) as Promise<R>
+    ).then((result) => {
+      if (ownsToken) {
+        markResourceActionDataSourceDirtyOnce(token, context, dirtyResourceAction, options.headers);
       }
       return result;
     });
   }) as APIClient['request'];
 
+  const isLockedOwnProperty = (target: DirtyAwareAPIClient, prop: PropertyKey) => {
+    const descriptor = Reflect.getOwnPropertyDescriptor(target, prop);
+    return !!descriptor && !descriptor.configurable;
+  };
+
   const proxy = new Proxy(api, {
     get(target, prop, receiver) {
       if (prop === 'resource') {
-        return resource;
+        if (isLockedOwnProperty(target, prop)) {
+          return Reflect.get(target, prop, receiver);
+        }
+        return hasResourceOverride ? resourceOverride : resource;
       }
       if (prop === 'request') {
-        return request;
+        if (isLockedOwnProperty(target, prop)) {
+          return Reflect.get(target, prop, receiver);
+        }
+        return hasRequestOverride ? requestOverride : request;
       }
       return Reflect.get(target, prop, receiver);
     },
+    set(target, prop, value, receiver) {
+      if (prop === 'resource') {
+        const descriptor = Reflect.getOwnPropertyDescriptor(target, prop);
+        if (descriptor && (!descriptor.configurable || !Reflect.isExtensible(target))) {
+          return false;
+        }
+        hasResourceOverride = true;
+        resourceOverride = value;
+        return true;
+      }
+      if (prop === 'request') {
+        const descriptor = Reflect.getOwnPropertyDescriptor(target, prop);
+        if (descriptor && (!descriptor.configurable || !Reflect.isExtensible(target))) {
+          return false;
+        }
+        hasRequestOverride = true;
+        requestOverride = value;
+        return true;
+      }
+      return Reflect.set(target, prop, value, receiver);
+    },
+    deleteProperty(target, prop) {
+      if (prop !== 'resource' && prop !== 'request') {
+        return Reflect.deleteProperty(target, prop);
+      }
+      const descriptor = Reflect.getOwnPropertyDescriptor(target, prop);
+      if (descriptor && (!descriptor.configurable || !Reflect.isExtensible(target))) {
+        return false;
+      }
+      if (prop === 'resource') {
+        hasResourceOverride = false;
+        resourceOverride = undefined;
+      } else {
+        hasRequestOverride = false;
+        requestOverride = undefined;
+      }
+      return true;
+    },
+    defineProperty(target, prop, descriptor) {
+      if (prop === 'resource' || prop === 'request') {
+        return false;
+      }
+      return Reflect.defineProperty(target, prop, descriptor);
+    },
   }) as APIClient;
   dirtyAwareApiClientProxies.add(proxy);
   return proxy;