feat(): new brick eo-batch-agent

Author: weareoutman

bricks/basic/src/batch-agent/index.spec.ts

@@ -0,0 +1,41 @@
+import { describe, test, expect, jest } from "@jest/globals";
+import { act } from "react-dom/test-utils";
+import "./";
+import type { EoBatchAgent } from "./index.js";
+
+jest.mock("@next-core/theme", () => ({}));
+
+describe("eo-batch-agent", () => {
+  test("basic usage", async () => {
+    const element = document.createElement("eo-batch-agent") as EoBatchAgent;
+
+    const onTrigger = jest.fn();
+    element.addEventListener("trigger", (e) => {
+      onTrigger((e as CustomEvent).detail);
+    });
+
+    act(() => {
+      document.body.appendChild(element);
+    });
+
+    element.trigger("foo");
+    element.trigger("bar");
+    element.trigger("foo");
+    expect(onTrigger).not.toHaveBeenCalled();
+
+    await Promise.resolve();
+    expect(onTrigger).toHaveBeenCalledTimes(2);
+    expect(onTrigger).toHaveBeenNthCalledWith(1, { type: "foo" });
+    expect(onTrigger).toHaveBeenNthCalledWith(2, { type: "bar" });
+
+    element.trigger("bar");
+    expect(onTrigger).toHaveBeenCalledTimes(2);
+    await Promise.resolve();
+    expect(onTrigger).toHaveBeenCalledTimes(3);
+    expect(onTrigger).toHaveBeenNthCalledWith(3, { type: "bar" });
+
+    act(() => {
+      document.body.removeChild(element);
+    });
+  });
+});

bricks/basic/src/batch-agent/index.ts

@@ -0,0 +1,46 @@
+import {
+  createDecorators,
+  NextElement,
+  type EventEmitter,
+} from "@next-core/element";
+import styleText from "./styles.shadow.css";
+
+const { defineElement, event, method } = createDecorators();
+
+/**
+ * 批处理事件代理。
+ *
+ * 当多次触发同一类型事件时，只会在当前宏任务结束后触发一次该类型事件。
+ */
+export
+@defineElement("eo-batch-agent", {
+  styleTexts: [styleText],
+})
+class EoBatchAgent extends NextElement {
+  #enqueued = new Set<string>();
+
+  /**
+   * 事件被触发。
+   */
+  @event({ type: "trigger" })
+  accessor #triggerEvent!: EventEmitter<{ type: string }>;
+
+  /**
+   * 触发事件。
+   */
+  @method()
+  trigger(type: string): void {
+    if (this.#enqueued.has(type)) {
+      return;
+    }
+    this.#enqueued.add(type);
+    queueMicrotask(() => {
+      this.#enqueued.delete(type);
+      this.#triggerEvent.emit({ type });
+    });
+  }
+
+  protected _render() {
+    // Do nothing
+  }
+}

bricks/basic/src/batch-agent/styles.shadow.css

@@ -0,0 +1,3 @@
+:host {
+  display: none;
+}