Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Default Helper Manager (RFC #756) #1348

Merged
merged 3 commits into from
Feb 5, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,153 @@ class HelperManagerTest extends RenderTest {
this.assertHTML('hello');
}

@test '(Default Helper Manager) plain functions work as helpers'(assert: Assert) {
let count = 0;

const hello = () => {
count++;
return 'plain function';
};

const Main = defineComponent({ hello }, '{{hello}}');

this.renderComponent(Main);

assert.equal(count, 1, 'rendered once');
this.assertHTML('plain function');

this.rerender();

assert.equal(count, 1, 'rendered once');
this.assertHTML('plain function');
}

@test '(Default Helper Manager) plain functions track positional args'(assert: Assert) {
let count = 0;

let obj = (x: string) => {
count++;
return x;
};
let args = trackedObj({ value: 'hello', unused: 'unused' });

this.renderComponent(defineComponent({ obj }, '{{obj @value @unused}}'), args);

assert.equal(count, 1, 'rendered once');
this.assertHTML('hello');

args.value = 'there';
this.rerender();

assert.equal(count, 2, 'rendered twice');
this.assertHTML('there');

args.unused = 'unused2';
this.rerender();

assert.equal(count, 3, 'rendered thrice');
this.assertHTML('there');
}

@test '(Default Helper Manager) plain functions entangle with any tracked data'(assert: Assert) {
let count = 0;
let trackedState = trackedObj({ value: 'hello' });

let obj = () => {
count++;
return trackedState.value;
};

this.renderComponent(defineComponent({ obj }, '{{obj}}'));

assert.equal(count, 1, 'rendered once');
this.assertHTML('hello');

trackedState.value = 'there';
this.rerender();
this.assertHTML('there');
assert.equal(count, 2, 'rendered twice');
}

@test '(Default Helper Manager) plain functions do not track unused named args'(assert: Assert) {
let count = 0;

let obj = (x: string, _options: Record<string, unknown>) => {
count++;
return x;
};
let args = trackedObj({ value: 'hello', unused: 'unused' });

this.renderComponent(defineComponent({ obj }, '{{obj @value namedOpt=@unused}}'), args);
assert.equal(count, 1, 'rendered once');
this.assertHTML('hello');

args.unused = 'unused2';
this.rerender();

assert.equal(count, 1, 'rendered once');
this.assertHTML('hello');
}

@test '(Default Helper Manager) plain functions tracked used named args'(assert: Assert) {
let count = 0;

let obj = (_x: string, options: Record<string, unknown>) => {
count++;
return options.namedOpt;
};

let args = trackedObj({ value: 'hello', used: 'used' });

this.renderComponent(defineComponent({ obj }, '{{obj @value namedOpt=@used}}'), args);
assert.equal(count, 1, 'rendered once');
this.assertHTML('used');

args.used = 'there';
this.rerender();

assert.equal(count, 2, 'rendered twice');
this.assertHTML('there');
}

@test '(Default Helper Manager) plain function helpers can have default values (missing data)'(
assert: Assert
) {
let count = 0;
let obj = (x = 'default value') => {
count++;
return x;
};

let args = trackedObj({});

this.renderComponent(defineComponent({ obj }, 'result: {{obj}}'), args);
this.assertHTML('result: default value');
assert.equal(count, 1, 'rendered once');
}

@test '(Default Helper Manager) plain function helpers can have overwritten default values'(
assert: Assert
) {
let count = 0;
let obj = (x = 'default value') => {
count++;
return x;
};

let args = trackedObj({ value: undefined });

this.renderComponent(defineComponent({ obj }, 'result: {{obj @value}}'), args);
this.assertHTML('result: default value');
assert.equal(count, 1, 'rendered once');

args.value = 'value';
this.rerender();

this.assertHTML('result: value');
assert.equal(count, 2, 'rendered twice');
}

@test 'tracks changes to named arguments'(assert: Assert) {
let count = 0;

Expand Down
44 changes: 44 additions & 0 deletions packages/@glimmer/manager/lib/internal/defaults.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { buildCapabilities } from '../util/capabilities';

import type { CapturedArguments as Arguments, HelperCapabilities } from '@glimmer/interfaces';

type FnArgs<Args extends Arguments = Arguments> =
| [...Args['positional'], Args['named']]
| [...Args['positional']];

type AnyFunction = (...args: any[]) => unknown;

interface State {
fn: AnyFunction;
args: Arguments;
}

export class FunctionHelperManager {
capabilities = buildCapabilities({
hasValue: true,
hasDestroyable: false,
hasScheduledEffect: false,
}) as HelperCapabilities;

createHelper(fn: AnyFunction, args: Arguments) {
return { fn, args };
}

getValue({ fn, args }: State) {
if (Object.keys(args.named).length > 0) {
let argsForFn: FnArgs<Arguments> = [...args.positional, args.named];

return fn(...argsForFn);
}

return fn(...args.positional);
}

getDebugName(fn: AnyFunction) {
if (fn.name) {
return `(helper function ${fn.name})`;
}

return '(anonymous helper function)';
}
}
11 changes: 10 additions & 1 deletion packages/@glimmer/manager/lib/internal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
Owner,
} from '@glimmer/interfaces';
import { CustomHelperManager } from '../public/helper';
import { FunctionHelperManager } from './defaults';

type InternalManager =
| InternalComponentManager
Expand Down Expand Up @@ -119,6 +120,8 @@ export function setInternalHelperManager<T extends object, O extends Owner>(
return setManager(HELPER_MANAGERS, manager, definition);
}

const DEFAULT_MANAGER = new CustomHelperManager(() => new FunctionHelperManager());

export function getInternalHelperManager(definition: object): CustomHelperManager | Helper;
export function getInternalHelperManager(
definition: object,
Expand All @@ -138,7 +141,13 @@ export function getInternalHelperManager(
);
}

const manager = getManager(HELPER_MANAGERS, definition);
let manager = getManager(HELPER_MANAGERS, definition);

// Functions are special-cased because functions are defined
// as the "default" helper, per: https://github.com/emberjs/rfcs/pull/756
if (manager === undefined && typeof definition === 'function') {
manager = DEFAULT_MANAGER;
}

if (manager) {
return manager;
Expand Down
17 changes: 16 additions & 1 deletion packages/@glimmer/manager/test/managers-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,26 @@ module('Managers', () => {
assert.ok(typeof instance === 'object', 'manager is an internal manager');
assert.ok(
typeof instance.getHelper({}) === 'function',
'manager can generatew helper function'
'manager can generate helper function'
);
assert.equal(instance['factory'], factory, 'manager has correct delegate factory');
});

test('it determines the default manager', (assert) => {
let myTestHelper = () => 0;
let instance = getInternalHelperManager(myTestHelper) as CustomHelperManager<object>;

assert.ok(typeof instance === 'object', 'manager is an internal manager');
assert.ok(
typeof instance.getHelper({}) === 'function',
'manager can generate helper function'
);
assert.strictEqual(
instance['factory']({})?.getDebugName?.(myTestHelper),
'(helper function myTestHelper)'
);
});

test('it works with internal helpers', (assert) => {
let helper = () => {
return UNDEFINED_REFERENCE;
Expand Down