@player-ui/async-node-plugin 0.13.0-next.3 → 0.13.0-next.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AsyncNodePlugin.native.js +8 -1
- package/dist/AsyncNodePlugin.native.js.map +1 -1
- package/dist/cjs/index.cjs +10 -1
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/index.legacy-esm.js +10 -1
- package/dist/index.mjs +10 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/__tests__/index.test.ts +67 -0
- package/src/index.ts +18 -2
- package/types/index.d.ts +2 -0
package/dist/cjs/index.cjs
CHANGED
|
@@ -145,7 +145,13 @@ var AsyncNodePluginPlugin = class {
|
|
|
145
145
|
if (resolvedNode !== void 0) {
|
|
146
146
|
return resolvedNode;
|
|
147
147
|
}
|
|
148
|
-
|
|
148
|
+
if (context.inProgressNodes.has(node.id)) {
|
|
149
|
+
return node;
|
|
150
|
+
}
|
|
151
|
+
context.inProgressNodes.add(node.id);
|
|
152
|
+
(0, import_queue_microtask.default)(() => {
|
|
153
|
+
this.runAsyncNode(node, context, options).finally();
|
|
154
|
+
});
|
|
149
155
|
return node;
|
|
150
156
|
});
|
|
151
157
|
}
|
|
@@ -157,6 +163,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
157
163
|
this.parseNodeAndUpdate(node, context, result2, options);
|
|
158
164
|
}
|
|
159
165
|
);
|
|
166
|
+
context.inProgressNodes.delete(node.id);
|
|
160
167
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
161
168
|
} catch (e) {
|
|
162
169
|
const error = e instanceof Error ? e : new Error(String(e));
|
|
@@ -172,6 +179,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
172
179
|
"Async node handling failed and resolved with a fallback. Error:",
|
|
173
180
|
error
|
|
174
181
|
);
|
|
182
|
+
context.inProgressNodes.delete(node.id);
|
|
175
183
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
176
184
|
}
|
|
177
185
|
}
|
|
@@ -219,6 +227,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
219
227
|
apply(view) {
|
|
220
228
|
const context = {
|
|
221
229
|
nodeResolveCache: /* @__PURE__ */ new Map(),
|
|
230
|
+
inProgressNodes: /* @__PURE__ */ new Set(),
|
|
222
231
|
view
|
|
223
232
|
};
|
|
224
233
|
view.hooks.parser.tap("async", this.applyParser.bind(this));
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n} from \"@player-ui/player\";\nimport { AsyncParallelBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\nimport { omit } from \"timm\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * This object should be setup once per ViewInstance to keep any cached info just for that view to avoid conflicts of shared async node ids across different view states.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, any>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n\n asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\n/** Hook declaration for the AsyncNodePlugin */\ntype AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n /** Sync hook to manage errors coming from the onAsyncNode hook. Return a fallback node or null to render a fallback. The first argument of passed in the call is the error thrown. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncParallelBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n public asyncNode: AsyncParallelBailHook<\n [Node.Async, (result: any) => void],\n any\n > = new AsyncParallelBailHook();\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n const parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, view } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n view.updateAsync();\n }\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node;\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n return resolvedNode;\n }\n\n queueMicrotask(() => this.runAsyncNode(node, context, options));\n\n return node;\n });\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: any) {\n return obj && Object.prototype.hasOwnProperty.call(obj, \"async\");\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n const parsedAsync = parser.parseObject(\n omit(obj, \"async\"),\n nodeType,\n options,\n );\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map<string, any>(),\n view,\n };\n\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param transformedAssetType: transformed asset type for rendering\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, [\"values\"], multiNode);\n\n return wrapperAsset;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,iBAAoC;AAapC,wBAAoD;AACpD,6BAA2B;AAC3B,kBAAqB;;;ACfrB,oBAAwB;AAYjB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,YACG;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,sBAAQ,UAAU,IAAI,OAAO;AAC/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,sBAAQ,aAAa,KAAK;AACtC,gBAAY,sBAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,sBAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,sBAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,wBAAQ,SAAS,cAAc,CAAC,QAAQ,GAAG,SAAS;AAEpD,SAAO;AACT;;;ADmBO,IAAM,kBAAN,MAA8C;AAAA,EAInD,YAAY,SAAiC,cAA6B;AAkB1E,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,wCAAsB;AAAA,MACvC,kBAAkB,IAAI,+BAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AAEO,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AACL,SAAO,YAGH,IAAI,wCAAsB;AAG9B,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,UAAM,aACJ,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,KAAK,IAAI;AACnC,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,MACT;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,eAAO;AAAA,MACT;AAEA,iCAAAC,SAAe,MAAM,KAAK,aAAa,MAAM,SAAS,OAAO,CAAC;AAE9D,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACC,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AACA,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAEA,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAAS,wBAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAU;AAClC,WAAO,OAAO,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EACjE;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAC/B,gBAAM,cAAc,OAAO;AAAA,gBACzB,kBAAK,KAAK,OAAO;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AACA,gBAAM,mBAAe,0BAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAM,wBAAS;AAAA,cACf,OAAO;AAAA,YACT;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,UAAM,UAA8B;AAAA,MAClC,kBAAkB,oBAAI,IAAiB;AAAA,MACvC;AAAA,IACF;AAEA,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1D,SAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,WAAK,cAAc,UAAU,OAAO;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["import_player","queueMicrotask","result"]}
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n} from \"@player-ui/player\";\nimport { AsyncParallelBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\nimport { omit } from \"timm\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * This object should be setup once per ViewInstance to keep any cached info just for that view to avoid conflicts of shared async node ids across different view states.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, any>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n /** Map of async node id to promises being used to resolve them */\n inProgressNodes: Set<string>;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n\n asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\n/** Hook declaration for the AsyncNodePlugin */\ntype AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n /** Sync hook to manage errors coming from the onAsyncNode hook. Return a fallback node or null to render a fallback. The first argument of passed in the call is the error thrown. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncParallelBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n public asyncNode: AsyncParallelBailHook<\n [Node.Async, (result: any) => void],\n any\n > = new AsyncParallelBailHook();\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n const parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, view } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n view.updateAsync();\n }\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node;\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n return resolvedNode;\n }\n\n if (context.inProgressNodes.has(node.id)) {\n return node;\n }\n\n // Track that the node is in progress.\n context.inProgressNodes.add(node.id);\n queueMicrotask(() => {\n this.runAsyncNode(node, context, options).finally();\n });\n\n return node;\n });\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: any) {\n return obj && Object.prototype.hasOwnProperty.call(obj, \"async\");\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n const parsedAsync = parser.parseObject(\n omit(obj, \"async\"),\n nodeType,\n options,\n );\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map(),\n inProgressNodes: new Set(),\n view,\n };\n\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param transformedAssetType: transformed asset type for rendering\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, [\"values\"], multiNode);\n\n return wrapperAsset;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,iBAAoC;AAapC,wBAAoD;AACpD,6BAA2B;AAC3B,kBAAqB;;;ACfrB,oBAAwB;AAYjB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,YACG;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,sBAAQ,UAAU,IAAI,OAAO;AAC/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,sBAAQ,aAAa,KAAK;AACtC,gBAAY,sBAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,sBAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,sBAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,wBAAQ,SAAS,cAAc,CAAC,QAAQ,GAAG,SAAS;AAEpD,SAAO;AACT;;;ADqBO,IAAM,kBAAN,MAA8C;AAAA,EAInD,YAAY,SAAiC,cAA6B;AAkB1E,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,wCAAsB;AAAA,MACvC,kBAAkB,IAAI,+BAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AAEO,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AACL,SAAO,YAGH,IAAI,wCAAsB;AAG9B,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,UAAM,aACJ,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,KAAK,IAAI;AACnC,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,MACT;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,eAAO;AAAA,MACT;AAEA,UAAI,QAAQ,gBAAgB,IAAI,KAAK,EAAE,GAAG;AACxC,eAAO;AAAA,MACT;AAGA,cAAQ,gBAAgB,IAAI,KAAK,EAAE;AACnC,iCAAAC,SAAe,MAAM;AACnB,aAAK,aAAa,MAAM,SAAS,OAAO,EAAE,QAAQ;AAAA,MACpD,CAAC;AAED,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACC,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAAS,wBAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAU;AAClC,WAAO,OAAO,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EACjE;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAC/B,gBAAM,cAAc,OAAO;AAAA,gBACzB,kBAAK,KAAK,OAAO;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AACA,gBAAM,mBAAe,0BAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAM,wBAAS;AAAA,cACf,OAAO;AAAA,YACT;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,UAAM,UAA8B;AAAA,MAClC,kBAAkB,oBAAI,IAAI;AAAA,MAC1B,iBAAiB,oBAAI,IAAI;AAAA,MACzB;AAAA,IACF;AAEA,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1D,SAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,WAAK,cAAc,UAAU,OAAO;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["import_player","queueMicrotask","result"]}
|
package/dist/index.legacy-esm.js
CHANGED
|
@@ -109,7 +109,13 @@ var AsyncNodePluginPlugin = class {
|
|
|
109
109
|
if (resolvedNode !== void 0) {
|
|
110
110
|
return resolvedNode;
|
|
111
111
|
}
|
|
112
|
-
|
|
112
|
+
if (context.inProgressNodes.has(node.id)) {
|
|
113
|
+
return node;
|
|
114
|
+
}
|
|
115
|
+
context.inProgressNodes.add(node.id);
|
|
116
|
+
queueMicrotask(() => {
|
|
117
|
+
this.runAsyncNode(node, context, options).finally();
|
|
118
|
+
});
|
|
113
119
|
return node;
|
|
114
120
|
});
|
|
115
121
|
}
|
|
@@ -121,6 +127,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
121
127
|
this.parseNodeAndUpdate(node, context, result2, options);
|
|
122
128
|
}
|
|
123
129
|
);
|
|
130
|
+
context.inProgressNodes.delete(node.id);
|
|
124
131
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
125
132
|
} catch (e) {
|
|
126
133
|
const error = e instanceof Error ? e : new Error(String(e));
|
|
@@ -136,6 +143,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
136
143
|
"Async node handling failed and resolved with a fallback. Error:",
|
|
137
144
|
error
|
|
138
145
|
);
|
|
146
|
+
context.inProgressNodes.delete(node.id);
|
|
139
147
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
140
148
|
}
|
|
141
149
|
}
|
|
@@ -183,6 +191,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
183
191
|
apply(view) {
|
|
184
192
|
const context = {
|
|
185
193
|
nodeResolveCache: /* @__PURE__ */ new Map(),
|
|
194
|
+
inProgressNodes: /* @__PURE__ */ new Set(),
|
|
186
195
|
view
|
|
187
196
|
};
|
|
188
197
|
view.hooks.parser.tap("async", this.applyParser.bind(this));
|
package/dist/index.mjs
CHANGED
|
@@ -109,7 +109,13 @@ var AsyncNodePluginPlugin = class {
|
|
|
109
109
|
if (resolvedNode !== void 0) {
|
|
110
110
|
return resolvedNode;
|
|
111
111
|
}
|
|
112
|
-
|
|
112
|
+
if (context.inProgressNodes.has(node.id)) {
|
|
113
|
+
return node;
|
|
114
|
+
}
|
|
115
|
+
context.inProgressNodes.add(node.id);
|
|
116
|
+
queueMicrotask(() => {
|
|
117
|
+
this.runAsyncNode(node, context, options).finally();
|
|
118
|
+
});
|
|
113
119
|
return node;
|
|
114
120
|
});
|
|
115
121
|
}
|
|
@@ -121,6 +127,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
121
127
|
this.parseNodeAndUpdate(node, context, result2, options);
|
|
122
128
|
}
|
|
123
129
|
);
|
|
130
|
+
context.inProgressNodes.delete(node.id);
|
|
124
131
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
125
132
|
} catch (e) {
|
|
126
133
|
const error = e instanceof Error ? e : new Error(String(e));
|
|
@@ -136,6 +143,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
136
143
|
"Async node handling failed and resolved with a fallback. Error:",
|
|
137
144
|
error
|
|
138
145
|
);
|
|
146
|
+
context.inProgressNodes.delete(node.id);
|
|
139
147
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
140
148
|
}
|
|
141
149
|
}
|
|
@@ -183,6 +191,7 @@ var AsyncNodePluginPlugin = class {
|
|
|
183
191
|
apply(view) {
|
|
184
192
|
const context = {
|
|
185
193
|
nodeResolveCache: /* @__PURE__ */ new Map(),
|
|
194
|
+
inProgressNodes: /* @__PURE__ */ new Set(),
|
|
186
195
|
view
|
|
187
196
|
};
|
|
188
197
|
view.hooks.parser.tap("async", this.applyParser.bind(this));
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n} from \"@player-ui/player\";\nimport { AsyncParallelBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\nimport { omit } from \"timm\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * This object should be setup once per ViewInstance to keep any cached info just for that view to avoid conflicts of shared async node ids across different view states.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, any>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n\n asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\n/** Hook declaration for the AsyncNodePlugin */\ntype AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n /** Sync hook to manage errors coming from the onAsyncNode hook. Return a fallback node or null to render a fallback. The first argument of passed in the call is the error thrown. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncParallelBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n public asyncNode: AsyncParallelBailHook<\n [Node.Async, (result: any) => void],\n any\n > = new AsyncParallelBailHook();\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n const parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, view } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n view.updateAsync();\n }\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node;\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n return resolvedNode;\n }\n\n queueMicrotask(() => this.runAsyncNode(node, context, options));\n\n return node;\n });\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: any) {\n return obj && Object.prototype.hasOwnProperty.call(obj, \"async\");\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n const parsedAsync = parser.parseObject(\n omit(obj, \"async\"),\n nodeType,\n options,\n );\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map<string, any>(),\n view,\n };\n\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param transformedAssetType: transformed asset type for rendering\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, [\"values\"], multiNode);\n\n return wrapperAsset;\n};\n"],"mappings":";AAAA,SAAS,UAAU,iBAAiB;AAapC,SAAS,uBAAuB,oBAAoB;AACpD,OAAO,oBAAoB;AAC3B,SAAS,YAAY;;;ACfrB,SAAS,eAAe;AAYjB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,YACG;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,QAAQ,UAAU,IAAI,OAAO;AAC/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,QAAQ,aAAa,KAAK;AACtC,gBAAY,QAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,QAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,QAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,UAAQ,SAAS,cAAc,CAAC,QAAQ,GAAG,SAAS;AAEpD,SAAO;AACT;;;ADmBO,IAAM,kBAAN,MAA8C;AAAA,EAInD,YAAY,SAAiC,cAA6B;AAkB1E,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,sBAAsB;AAAA,MACvC,kBAAkB,IAAI,aAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AAEO,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AACL,SAAO,YAGH,IAAI,sBAAsB;AAG9B,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,UAAM,aACJ,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,KAAK,IAAI;AACnC,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,MACT;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,eAAO;AAAA,MACT;AAEA,qBAAe,MAAM,KAAK,aAAa,MAAM,SAAS,OAAO,CAAC;AAE9D,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACA,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AACA,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAEA,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAAS,SAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAU;AAClC,WAAO,OAAO,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EACjE;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAC/B,gBAAM,cAAc,OAAO;AAAA,YACzB,KAAK,KAAK,OAAO;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AACA,gBAAM,eAAe,UAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAM,SAAS;AAAA,cACf,OAAO;AAAA,YACT;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,UAAM,UAA8B;AAAA,MAClC,kBAAkB,oBAAI,IAAiB;AAAA,MACvC;AAAA,IACF;AAEA,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1D,SAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,WAAK,cAAc,UAAU,OAAO;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["result"]}
|
|
1
|
+
{"version":3,"sources":["../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/index.ts","../../../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/plugins/async-node/core/src/transform.ts"],"sourcesContent":["import { NodeType, getNodeID } from \"@player-ui/player\";\nimport type {\n Player,\n PlayerPlugin,\n Node,\n ParseObjectOptions,\n ParseObjectChildOptions,\n ViewInstance,\n Parser,\n ViewPlugin,\n Resolver,\n Resolve,\n} from \"@player-ui/player\";\nimport { AsyncParallelBailHook, SyncBailHook } from \"tapable-ts\";\nimport queueMicrotask from \"queue-microtask\";\nimport { omit } from \"timm\";\n\nexport * from \"./types\";\nexport * from \"./transform\";\n\n/** Object type for storing data related to a single `apply` of the `AsyncNodePluginPlugin`\n * This object should be setup once per ViewInstance to keep any cached info just for that view to avoid conflicts of shared async node ids across different view states.\n */\ntype AsyncPluginContext = {\n /** Map of async node id to resolved content */\n nodeResolveCache: Map<string, any>;\n /** The view instance this context is attached to. */\n view: ViewInstance;\n /** Map of async node id to promises being used to resolve them */\n inProgressNodes: Set<string>;\n};\n\nexport interface AsyncNodePluginOptions {\n /** A set of plugins to load */\n plugins?: AsyncNodeViewPlugin[];\n}\n\nexport interface AsyncNodeViewPlugin extends ViewPlugin {\n /** Use this to tap into the async node plugin hooks */\n applyPlugin: (asyncNodePlugin: AsyncNodePlugin) => void;\n\n asyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n}\nexport type AsyncHandler = (\n node: Node.Async,\n callback?: (result: any) => void,\n) => Promise<any>;\n\n/** Hook declaration for the AsyncNodePlugin */\ntype AsyncNodeHooks = {\n /** Async hook to get content for an async node */\n onAsyncNode: AsyncParallelBailHook<[Node.Async, (result: any) => void], any>;\n /** Sync hook to manage errors coming from the onAsyncNode hook. Return a fallback node or null to render a fallback. The first argument of passed in the call is the error thrown. */\n onAsyncNodeError: SyncBailHook<[Error, Node.Async], any>;\n};\n\n/**\n * Async node plugin used to resolve async nodes in the content\n * If an async node is present, allow users to provide a replacement node to be rendered when ready\n */\nexport class AsyncNodePlugin implements PlayerPlugin {\n private plugins: AsyncNodeViewPlugin[] | undefined;\n private playerInstance: Player | undefined;\n\n constructor(options: AsyncNodePluginOptions, asyncHandler?: AsyncHandler) {\n if (options?.plugins) {\n this.plugins = options.plugins;\n options.plugins.forEach((plugin) => {\n plugin.applyPlugin(this);\n });\n }\n\n if (asyncHandler) {\n this.hooks.onAsyncNode.tap(\n \"async\",\n async (node: Node.Async, callback) => {\n return await asyncHandler(node, callback);\n },\n );\n }\n }\n\n public readonly hooks: AsyncNodeHooks = {\n onAsyncNode: new AsyncParallelBailHook(),\n onAsyncNodeError: new SyncBailHook(),\n };\n\n getPlayerInstance(): Player | undefined {\n return this.playerInstance;\n }\n\n name = \"AsyncNode\";\n\n apply(player: Player): void {\n this.playerInstance = player;\n\n player.hooks.viewController.tap(this.name, (viewController) => {\n viewController.hooks.view.tap(this.name, (view) => {\n this.plugins?.forEach((plugin) => {\n plugin.apply(view);\n });\n });\n });\n }\n}\n\nexport class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {\n public asyncNode: AsyncParallelBailHook<\n [Node.Async, (result: any) => void],\n any\n > = new AsyncParallelBailHook();\n private basePlugin: AsyncNodePlugin | undefined;\n\n name = \"AsyncNode\";\n\n /**\n * Parses the node from the result and triggers an asynchronous view update if necessary.\n * @param node The asynchronous node that might be updated.\n * @param result The result obtained from resolving the async node. This could be any data structure or value.\n * @param options Options provided for node resolution, including a potential parseNode function to process the result.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private parseNodeAndUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n result: any,\n options: Resolve.NodeResolveOptions,\n ) {\n const parsedNode =\n options.parseNode && result ? options.parseNode(result) : undefined;\n\n this.handleAsyncUpdate(node, context, parsedNode);\n }\n\n /**\n * Updates the node asynchronously based on the result provided.\n * This method is responsible for handling the update logic of asynchronous nodes.\n * It checks if the node needs to be updated based on the new result and updates the mapping accordingly.\n * If an update is necessary, it triggers an asynchronous update on the view.\n * @param node The asynchronous node that might be updated.\n * @param newNode The new node to replace the async node.\n * @param view The view instance where the node resides. This can be undefined if the view is not currently active.\n */\n private handleAsyncUpdate(\n node: Node.Async,\n context: AsyncPluginContext,\n newNode?: Node.Node | null,\n ) {\n const { nodeResolveCache, view } = context;\n if (nodeResolveCache.get(node.id) !== newNode) {\n nodeResolveCache.set(node.id, newNode ? newNode : node);\n view.updateAsync();\n }\n }\n\n /**\n * Handles the asynchronous API integration for resolving nodes.\n * This method sets up a hook on the resolver's `beforeResolve` event to process async nodes.\n * @param resolver The resolver instance to attach the hook to.\n * @param view\n */\n applyResolver(resolver: Resolver, context: AsyncPluginContext): void {\n resolver.hooks.beforeResolve.tap(this.name, (node, options) => {\n if (!this.isAsync(node)) {\n return node;\n }\n\n const resolvedNode = context.nodeResolveCache.get(node.id);\n if (resolvedNode !== undefined) {\n return resolvedNode;\n }\n\n if (context.inProgressNodes.has(node.id)) {\n return node;\n }\n\n // Track that the node is in progress.\n context.inProgressNodes.add(node.id);\n queueMicrotask(() => {\n this.runAsyncNode(node, context, options).finally();\n });\n\n return node;\n });\n }\n\n private async runAsyncNode(\n node: Node.Async,\n context: AsyncPluginContext,\n options: Resolve.NodeResolveOptions,\n ) {\n try {\n const result = await this.basePlugin?.hooks.onAsyncNode.call(\n node,\n (result) => {\n this.parseNodeAndUpdate(node, context, result, options);\n },\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n } catch (e: unknown) {\n const error = e instanceof Error ? e : new Error(String(e));\n const result = this.basePlugin?.hooks.onAsyncNodeError.call(error, node);\n\n if (result === undefined) {\n const playerState = this.basePlugin?.getPlayerInstance()?.getState();\n\n if (playerState?.status === \"in-progress\") {\n playerState.fail(error);\n }\n\n return;\n }\n\n options.logger?.error(\n \"Async node handling failed and resolved with a fallback. Error:\",\n error,\n );\n\n // Stop tracking before the next update is triggered\n context.inProgressNodes.delete(node.id);\n this.parseNodeAndUpdate(node, context, result, options);\n }\n }\n\n private isAsync(node: Node.Node | null): node is Node.Async {\n return node?.type === NodeType.Async;\n }\n\n private isDeterminedAsync(obj: any) {\n return obj && Object.prototype.hasOwnProperty.call(obj, \"async\");\n }\n\n applyParser(parser: Parser): void {\n parser.hooks.parseNode.tap(\n this.name,\n (\n obj: any,\n nodeType: Node.ChildrenTypes,\n options: ParseObjectOptions,\n childOptions?: ParseObjectChildOptions,\n ) => {\n if (this.isDeterminedAsync(obj)) {\n const parsedAsync = parser.parseObject(\n omit(obj, \"async\"),\n nodeType,\n options,\n );\n const parsedNodeId = getNodeID(parsedAsync);\n\n if (parsedAsync === null || !parsedNodeId) {\n return childOptions ? [] : null;\n }\n\n const asyncAST = parser.createASTNode(\n {\n id: parsedNodeId,\n type: NodeType.Async,\n value: parsedAsync,\n },\n obj,\n );\n\n if (childOptions) {\n return asyncAST\n ? [\n {\n path: [...childOptions.path, childOptions.key],\n value: asyncAST,\n },\n ]\n : [];\n }\n\n return asyncAST;\n }\n },\n );\n }\n\n apply(view: ViewInstance): void {\n const context: AsyncPluginContext = {\n nodeResolveCache: new Map(),\n inProgressNodes: new Set(),\n view,\n };\n\n view.hooks.parser.tap(\"async\", this.applyParser.bind(this));\n view.hooks.resolver.tap(\"async\", (resolver) => {\n this.applyResolver(resolver, context);\n });\n }\n\n applyPlugin(asyncNodePlugin: AsyncNodePlugin): void {\n this.basePlugin = asyncNodePlugin;\n }\n}\n","import { Builder } from \"@player-ui/player\";\nimport type { AsyncTransformFunc } from \"./types\";\n\n/**\n * Util function to generate transform function for async asset\n * @param asset - async asset to apply beforeResolve transform\n * @param transformedAssetType: transformed asset type for rendering\n * @param wrapperAssetType: container asset type\n * @param flatten: flatten the streamed in content\n * @returns - wrapper asset with children of transformed asset and async node\n */\n\nexport const asyncTransform: AsyncTransformFunc = (\n assetId,\n wrapperAssetType,\n asset,\n flatten,\n) => {\n const id = \"async-\" + assetId;\n\n const asyncNode = Builder.asyncNode(id, flatten);\n let multiNode;\n let assetNode;\n\n if (asset) {\n assetNode = Builder.assetWrapper(asset);\n multiNode = Builder.multiNode(assetNode, asyncNode);\n } else {\n multiNode = Builder.multiNode(asyncNode);\n }\n\n const wrapperAsset = Builder.asset({\n id: wrapperAssetType + \"-\" + id,\n type: wrapperAssetType,\n });\n\n Builder.addChild(wrapperAsset, [\"values\"], multiNode);\n\n return wrapperAsset;\n};\n"],"mappings":";AAAA,SAAS,UAAU,iBAAiB;AAapC,SAAS,uBAAuB,oBAAoB;AACpD,OAAO,oBAAoB;AAC3B,SAAS,YAAY;;;ACfrB,SAAS,eAAe;AAYjB,IAAM,iBAAqC,CAChD,SACA,kBACA,OACA,YACG;AACH,QAAM,KAAK,WAAW;AAEtB,QAAM,YAAY,QAAQ,UAAU,IAAI,OAAO;AAC/C,MAAI;AACJ,MAAI;AAEJ,MAAI,OAAO;AACT,gBAAY,QAAQ,aAAa,KAAK;AACtC,gBAAY,QAAQ,UAAU,WAAW,SAAS;AAAA,EACpD,OAAO;AACL,gBAAY,QAAQ,UAAU,SAAS;AAAA,EACzC;AAEA,QAAM,eAAe,QAAQ,MAAM;AAAA,IACjC,IAAI,mBAAmB,MAAM;AAAA,IAC7B,MAAM;AAAA,EACR,CAAC;AAED,UAAQ,SAAS,cAAc,CAAC,QAAQ,GAAG,SAAS;AAEpD,SAAO;AACT;;;ADqBO,IAAM,kBAAN,MAA8C;AAAA,EAInD,YAAY,SAAiC,cAA6B;AAkB1E,SAAgB,QAAwB;AAAA,MACtC,aAAa,IAAI,sBAAsB;AAAA,MACvC,kBAAkB,IAAI,aAAa;AAAA,IACrC;AAMA,gBAAO;AA1BL,QAAI,SAAS,SAAS;AACpB,WAAK,UAAU,QAAQ;AACvB,cAAQ,QAAQ,QAAQ,CAAC,WAAW;AAClC,eAAO,YAAY,IAAI;AAAA,MACzB,CAAC;AAAA,IACH;AAEA,QAAI,cAAc;AAChB,WAAK,MAAM,YAAY;AAAA,QACrB;AAAA,QACA,OAAO,MAAkB,aAAa;AACpC,iBAAO,MAAM,aAAa,MAAM,QAAQ;AAAA,QAC1C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAOA,oBAAwC;AACtC,WAAO,KAAK;AAAA,EACd;AAAA,EAIA,MAAM,QAAsB;AAC1B,SAAK,iBAAiB;AAEtB,WAAO,MAAM,eAAe,IAAI,KAAK,MAAM,CAAC,mBAAmB;AAC7D,qBAAe,MAAM,KAAK,IAAI,KAAK,MAAM,CAAC,SAAS;AACjD,aAAK,SAAS,QAAQ,CAAC,WAAW;AAChC,iBAAO,MAAM,IAAI;AAAA,QACnB,CAAC;AAAA,MACH,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;AAEO,IAAM,wBAAN,MAA2D;AAAA,EAA3D;AACL,SAAO,YAGH,IAAI,sBAAsB;AAG9B,gBAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASC,mBACN,MACA,SACA,QACA,SACA;AACA,UAAM,aACJ,QAAQ,aAAa,SAAS,QAAQ,UAAU,MAAM,IAAI;AAE5D,SAAK,kBAAkB,MAAM,SAAS,UAAU;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWQ,kBACN,MACA,SACA,SACA;AACA,UAAM,EAAE,kBAAkB,KAAK,IAAI;AACnC,QAAI,iBAAiB,IAAI,KAAK,EAAE,MAAM,SAAS;AAC7C,uBAAiB,IAAI,KAAK,IAAI,UAAU,UAAU,IAAI;AACtD,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,cAAc,UAAoB,SAAmC;AACnE,aAAS,MAAM,cAAc,IAAI,KAAK,MAAM,CAAC,MAAM,YAAY;AAC7D,UAAI,CAAC,KAAK,QAAQ,IAAI,GAAG;AACvB,eAAO;AAAA,MACT;AAEA,YAAM,eAAe,QAAQ,iBAAiB,IAAI,KAAK,EAAE;AACzD,UAAI,iBAAiB,QAAW;AAC9B,eAAO;AAAA,MACT;AAEA,UAAI,QAAQ,gBAAgB,IAAI,KAAK,EAAE,GAAG;AACxC,eAAO;AAAA,MACT;AAGA,cAAQ,gBAAgB,IAAI,KAAK,EAAE;AACnC,qBAAe,MAAM;AACnB,aAAK,aAAa,MAAM,SAAS,OAAO,EAAE,QAAQ;AAAA,MACpD,CAAC;AAED,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,aACZ,MACA,SACA,SACA;AACA,QAAI;AACF,YAAM,SAAS,MAAM,KAAK,YAAY,MAAM,YAAY;AAAA,QACtD;AAAA,QACA,CAACA,YAAW;AACV,eAAK,mBAAmB,MAAM,SAASA,SAAQ,OAAO;AAAA,QACxD;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD,SAAS,GAAY;AACnB,YAAM,QAAQ,aAAa,QAAQ,IAAI,IAAI,MAAM,OAAO,CAAC,CAAC;AAC1D,YAAM,SAAS,KAAK,YAAY,MAAM,iBAAiB,KAAK,OAAO,IAAI;AAEvE,UAAI,WAAW,QAAW;AACxB,cAAM,cAAc,KAAK,YAAY,kBAAkB,GAAG,SAAS;AAEnE,YAAI,aAAa,WAAW,eAAe;AACzC,sBAAY,KAAK,KAAK;AAAA,QACxB;AAEA;AAAA,MACF;AAEA,cAAQ,QAAQ;AAAA,QACd;AAAA,QACA;AAAA,MACF;AAGA,cAAQ,gBAAgB,OAAO,KAAK,EAAE;AACtC,WAAK,mBAAmB,MAAM,SAAS,QAAQ,OAAO;AAAA,IACxD;AAAA,EACF;AAAA,EAEQ,QAAQ,MAA4C;AAC1D,WAAO,MAAM,SAAS,SAAS;AAAA,EACjC;AAAA,EAEQ,kBAAkB,KAAU;AAClC,WAAO,OAAO,OAAO,UAAU,eAAe,KAAK,KAAK,OAAO;AAAA,EACjE;AAAA,EAEA,YAAY,QAAsB;AAChC,WAAO,MAAM,UAAU;AAAA,MACrB,KAAK;AAAA,MACL,CACE,KACA,UACA,SACA,iBACG;AACH,YAAI,KAAK,kBAAkB,GAAG,GAAG;AAC/B,gBAAM,cAAc,OAAO;AAAA,YACzB,KAAK,KAAK,OAAO;AAAA,YACjB;AAAA,YACA;AAAA,UACF;AACA,gBAAM,eAAe,UAAU,WAAW;AAE1C,cAAI,gBAAgB,QAAQ,CAAC,cAAc;AACzC,mBAAO,eAAe,CAAC,IAAI;AAAA,UAC7B;AAEA,gBAAM,WAAW,OAAO;AAAA,YACtB;AAAA,cACE,IAAI;AAAA,cACJ,MAAM,SAAS;AAAA,cACf,OAAO;AAAA,YACT;AAAA,YACA;AAAA,UACF;AAEA,cAAI,cAAc;AAChB,mBAAO,WACH;AAAA,cACE;AAAA,gBACE,MAAM,CAAC,GAAG,aAAa,MAAM,aAAa,GAAG;AAAA,gBAC7C,OAAO;AAAA,cACT;AAAA,YACF,IACA,CAAC;AAAA,UACP;AAEA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,MAA0B;AAC9B,UAAM,UAA8B;AAAA,MAClC,kBAAkB,oBAAI,IAAI;AAAA,MAC1B,iBAAiB,oBAAI,IAAI;AAAA,MACzB;AAAA,IACF;AAEA,SAAK,MAAM,OAAO,IAAI,SAAS,KAAK,YAAY,KAAK,IAAI,CAAC;AAC1D,SAAK,MAAM,SAAS,IAAI,SAAS,CAAC,aAAa;AAC7C,WAAK,cAAc,UAAU,OAAO;AAAA,IACtC,CAAC;AAAA,EACH;AAAA,EAEA,YAAY,iBAAwC;AAClD,SAAK,aAAa;AAAA,EACpB;AACF;","names":["result"]}
|
package/package.json
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
"types"
|
|
7
7
|
],
|
|
8
8
|
"name": "@player-ui/async-node-plugin",
|
|
9
|
-
"version": "0.13.0-next.
|
|
9
|
+
"version": "0.13.0-next.5",
|
|
10
10
|
"main": "dist/cjs/index.cjs",
|
|
11
11
|
"peerDependencies": {
|
|
12
|
-
"@player-ui/player": "0.13.0-next.
|
|
12
|
+
"@player-ui/player": "0.13.0-next.5"
|
|
13
13
|
},
|
|
14
14
|
"devDependencies": {
|
|
15
15
|
"@player-ui/check-path-plugin": "workspace:*",
|
|
@@ -1438,6 +1438,73 @@ describe("view", () => {
|
|
|
1438
1438
|
});
|
|
1439
1439
|
});
|
|
1440
1440
|
});
|
|
1441
|
+
|
|
1442
|
+
// For tests dealing with the startup and cleanup of promises for async nodes.
|
|
1443
|
+
describe("Promise Management", () => {
|
|
1444
|
+
test("should not start async node handling if process has already started", async () => {
|
|
1445
|
+
const plugin = new AsyncNodePlugin({
|
|
1446
|
+
plugins: [new AsyncNodePluginPlugin()],
|
|
1447
|
+
});
|
|
1448
|
+
|
|
1449
|
+
// Create a promise that won't be resolved.
|
|
1450
|
+
const asyncTapFn = vi.fn();
|
|
1451
|
+
asyncTapFn.mockReturnValue(new Promise(() => {}));
|
|
1452
|
+
|
|
1453
|
+
plugin.hooks.onAsyncNode.tap("test", asyncTapFn);
|
|
1454
|
+
|
|
1455
|
+
const player = new Player({ plugins: [plugin] });
|
|
1456
|
+
player.start(basicFRFWithActions as any);
|
|
1457
|
+
|
|
1458
|
+
await vi.waitFor(() => {
|
|
1459
|
+
expect(asyncTapFn).toHaveBeenCalledOnce();
|
|
1460
|
+
});
|
|
1461
|
+
|
|
1462
|
+
// Clear the one call since it has already been checked.
|
|
1463
|
+
asyncTapFn.mockClear();
|
|
1464
|
+
const playerState = player.getState();
|
|
1465
|
+
expect(playerState.status).toBe("in-progress");
|
|
1466
|
+
// force an update while ignoring the cache.
|
|
1467
|
+
(playerState as InProgressState).controllers.view.currentView?.update();
|
|
1468
|
+
|
|
1469
|
+
// Should not be called again.
|
|
1470
|
+
expect(
|
|
1471
|
+
vi.waitFor(() => {
|
|
1472
|
+
expect(asyncTapFn).toHaveBeenCalledOnce();
|
|
1473
|
+
}),
|
|
1474
|
+
).rejects.toThrowError();
|
|
1475
|
+
});
|
|
1476
|
+
|
|
1477
|
+
test("should allow for handling to start again if the promise completes", async () => {
|
|
1478
|
+
const plugin = new AsyncNodePlugin({
|
|
1479
|
+
plugins: [new AsyncNodePluginPlugin()],
|
|
1480
|
+
});
|
|
1481
|
+
|
|
1482
|
+
// Create a promise that won't be resolved.
|
|
1483
|
+
const asyncTapFn = vi.fn();
|
|
1484
|
+
asyncTapFn.mockResolvedValue(null);
|
|
1485
|
+
|
|
1486
|
+
plugin.hooks.onAsyncNode.tap("test", asyncTapFn);
|
|
1487
|
+
|
|
1488
|
+
const player = new Player({ plugins: [plugin] });
|
|
1489
|
+
player.start(basicFRFWithActions as any);
|
|
1490
|
+
|
|
1491
|
+
await vi.waitFor(() => {
|
|
1492
|
+
expect(asyncTapFn).toHaveBeenCalledOnce();
|
|
1493
|
+
});
|
|
1494
|
+
|
|
1495
|
+
// Clear the one call since it has already been checked.
|
|
1496
|
+
asyncTapFn.mockClear();
|
|
1497
|
+
const playerState = player.getState();
|
|
1498
|
+
expect(playerState.status).toBe("in-progress");
|
|
1499
|
+
// force an update while ignoring the cache.
|
|
1500
|
+
(playerState as InProgressState).controllers.view.currentView?.update();
|
|
1501
|
+
|
|
1502
|
+
// Should be called again.
|
|
1503
|
+
vi.waitFor(() => {
|
|
1504
|
+
expect(asyncTapFn).toHaveBeenCalledOnce();
|
|
1505
|
+
});
|
|
1506
|
+
});
|
|
1507
|
+
});
|
|
1441
1508
|
});
|
|
1442
1509
|
|
|
1443
1510
|
describe("parser", () => {
|
package/src/index.ts
CHANGED
|
@@ -26,6 +26,8 @@ type AsyncPluginContext = {
|
|
|
26
26
|
nodeResolveCache: Map<string, any>;
|
|
27
27
|
/** The view instance this context is attached to. */
|
|
28
28
|
view: ViewInstance;
|
|
29
|
+
/** Map of async node id to promises being used to resolve them */
|
|
30
|
+
inProgressNodes: Set<string>;
|
|
29
31
|
};
|
|
30
32
|
|
|
31
33
|
export interface AsyncNodePluginOptions {
|
|
@@ -168,7 +170,15 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
168
170
|
return resolvedNode;
|
|
169
171
|
}
|
|
170
172
|
|
|
171
|
-
|
|
173
|
+
if (context.inProgressNodes.has(node.id)) {
|
|
174
|
+
return node;
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
// Track that the node is in progress.
|
|
178
|
+
context.inProgressNodes.add(node.id);
|
|
179
|
+
queueMicrotask(() => {
|
|
180
|
+
this.runAsyncNode(node, context, options).finally();
|
|
181
|
+
});
|
|
172
182
|
|
|
173
183
|
return node;
|
|
174
184
|
});
|
|
@@ -186,6 +196,9 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
186
196
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
187
197
|
},
|
|
188
198
|
);
|
|
199
|
+
|
|
200
|
+
// Stop tracking before the next update is triggered
|
|
201
|
+
context.inProgressNodes.delete(node.id);
|
|
189
202
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
190
203
|
} catch (e: unknown) {
|
|
191
204
|
const error = e instanceof Error ? e : new Error(String(e));
|
|
@@ -206,6 +219,8 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
206
219
|
error,
|
|
207
220
|
);
|
|
208
221
|
|
|
222
|
+
// Stop tracking before the next update is triggered
|
|
223
|
+
context.inProgressNodes.delete(node.id);
|
|
209
224
|
this.parseNodeAndUpdate(node, context, result, options);
|
|
210
225
|
}
|
|
211
226
|
}
|
|
@@ -267,7 +282,8 @@ export class AsyncNodePluginPlugin implements AsyncNodeViewPlugin {
|
|
|
267
282
|
|
|
268
283
|
apply(view: ViewInstance): void {
|
|
269
284
|
const context: AsyncPluginContext = {
|
|
270
|
-
nodeResolveCache: new Map
|
|
285
|
+
nodeResolveCache: new Map(),
|
|
286
|
+
inProgressNodes: new Set(),
|
|
271
287
|
view,
|
|
272
288
|
};
|
|
273
289
|
|
package/types/index.d.ts
CHANGED
|
@@ -10,6 +10,8 @@ type AsyncPluginContext = {
|
|
|
10
10
|
nodeResolveCache: Map<string, any>;
|
|
11
11
|
/** The view instance this context is attached to. */
|
|
12
12
|
view: ViewInstance;
|
|
13
|
+
/** Map of async node id to promises being used to resolve them */
|
|
14
|
+
inProgressNodes: Set<string>;
|
|
13
15
|
};
|
|
14
16
|
export interface AsyncNodePluginOptions {
|
|
15
17
|
/** A set of plugins to load */
|