Skip to content

Visualize Your Ideas With Code

refactor: remove generator helpers

aarthificial57fee4d4e52d
diff --git a/packages/core/src/flow/run.ts b/packages/core/src/flow/run.ts
index 6cd94623..46ab98ec 100644
--- a/packages/core/src/flow/run.ts
+++ b/packages/core/src/flow/run.ts
@@ -1,5 +1,4 @@
-import {ThreadGenerator} from '../threading';
-import {GeneratorHelper} from '../helpers';
+import {setTaskName, ThreadGenerator} from '../threading';
/**
* Turn the given generator function into a threadable generator.
@@ -38,10 +37,10 @@ export function run(
let task;
if (typeof firstArg === 'string') {
task = runner!();
- GeneratorHelper.makeThreadable(task, firstArg);
+ setTaskName(task, firstArg);
} else {
task = firstArg();
- GeneratorHelper.makeThreadable(task, task);
+ setTaskName(task, task);
}
return task;
diff --git a/packages/core/src/helpers/GeneratorHelper.ts b/packages/core/src/helpers/GeneratorHelper.ts
deleted file mode 100644
index 3c213b7a..00000000
--- a/packages/core/src/helpers/GeneratorHelper.ts
+++ /dev/null
@@ -1,20 +0,0 @@
-export const GeneratorHelper = {
- makeThreadable(task: Generator, source: Generator | string): void {
- const prototype = Object.getPrototypeOf(task);
- if (!prototype.threadable) {
- prototype.threadable = true;
- prototype.name =
- typeof source === 'string'
- ? source
- : Object.getPrototypeOf(source).name;
- }
- },
-
- isThreadable(value: unknown): boolean {
- return typeof value === 'function' && value.prototype.threadable === true;
- },
-
- getName(task: Generator): string {
- return Object.getPrototypeOf(task).name ?? null;
- },
-};
diff --git a/packages/core/src/helpers/index.ts b/packages/core/src/helpers/index.ts
deleted file mode 100644
index ff7bf255..00000000
--- a/packages/core/src/helpers/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export * from './GeneratorHelper';
diff --git a/packages/core/src/threading/Thread.ts b/packages/core/src/threading/Thread.ts
index b6257177..597af42e 100644
--- a/packages/core/src/threading/Thread.ts
+++ b/packages/core/src/threading/Thread.ts
@@ -1,7 +1,7 @@
-import {GeneratorHelper} from '../helpers';
import {ThreadGenerator} from './ThreadGenerator';
-import {endThread, startThread, useLogger, useProject} from '../utils';
+import {endThread, startThread, useProject} from '../utils';
import {createSignal} from '../signals';
+import {setTaskName} from './names';
/**
* A class representing an individual thread.
@@ -76,13 +76,7 @@ export class Thread {
child.time(this.time());
this.children.push(child);
- if (!Object.getPrototypeOf(child.runner).threadable) {
- useLogger().warn(new Error(`Non-threadable task: ${child.runner}`));
- GeneratorHelper.makeThreadable(
- child.runner,
- `non-threadable ${this.children.length}`,
- );
- }
+ setTaskName(child.runner, `unknown ${this.children.length}`);
}
public cancel() {
diff --git a/packages/core/src/threading/index.ts b/packages/core/src/threading/index.ts
index a211b34f..f6cf7a78 100644
--- a/packages/core/src/threading/index.ts
+++ b/packages/core/src/threading/index.ts
@@ -3,8 +3,10 @@
*
* @packageDocumentation
*/
+
export * from './cancel';
export * from './join';
+export * from './names';
export * from './Thread';
export * from './ThreadGenerator';
export * from './threads';
diff --git a/packages/core/src/threading/names.ts b/packages/core/src/threading/names.ts
new file mode 100644
index 00000000..21d98971
--- /dev/null
+++ b/packages/core/src/threading/names.ts
@@ -0,0 +1,11 @@
+export function setTaskName(task: Generator, source: Generator | string): void {
+ const prototype = Object.getPrototypeOf(task);
+ if (!prototype.threadable) {
+ prototype.threadable = true;
+ prototype.name = typeof source === 'string' ? source : getTaskName(source);
+ }
+}
+
+export function getTaskName(task: Generator): string {
+ return Object.getPrototypeOf(task).name ?? null;
+}
diff --git a/packages/core/src/threading/threads.ts b/packages/core/src/threading/threads.ts
index 67c34952..6e9fc9e3 100644
--- a/packages/core/src/threading/threads.ts
+++ b/packages/core/src/threading/threads.ts
@@ -1,7 +1,7 @@
-import {GeneratorHelper} from '../helpers';
import {decorate, threadable} from '../decorators';
import {Thread} from './Thread';
import {isThreadGenerator, ThreadGenerator} from './ThreadGenerator';
+import {setTaskName} from './names';
/**
* Check if the given value is a [Promise][promise].
@@ -56,7 +56,7 @@ export function* threads(
callback?: ThreadsCallback,
): ThreadGenerator {
const root = factory();
- GeneratorHelper.makeThreadable(root, 'root');
+ setTaskName(root, 'root');
const rootThread = new Thread(root);
callback?.(rootThread);
diff --git a/packages/ui/src/components/sidebar/Threads.tsx b/packages/ui/src/components/sidebar/Threads.tsx
index c1e119ca..6ffe7e76 100644
--- a/packages/ui/src/components/sidebar/Threads.tsx
+++ b/packages/ui/src/components/sidebar/Threads.tsx
@@ -1,8 +1,7 @@
import styles from './Sidebar.module.scss';
-import type {Thread} from '@motion-canvas/core/lib/threading';
+import {type Thread, getTaskName} from '@motion-canvas/core/lib/threading';
import {isThreadable} from '@motion-canvas/core/lib/scenes/Threadable';
-import {GeneratorHelper} from '@motion-canvas/core/lib/helpers/GeneratorHelper';
import {
useCurrentFrame,
useCurrentScene,
@@ -35,9 +34,7 @@ interface ThreadViewProps {
function ThreadView({thread}: ThreadViewProps) {
return (
<div className={styles.thread}>
- <div className={styles.threadTitle}>
- {GeneratorHelper.getName(thread.runner)}
- </div>
+ <div className={styles.threadTitle}>{getTaskName(thread.runner)}</div>
{thread.children.length > 0 && (
<ul className={styles.threadList}>
{thread.children.map(value => (