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

[REFACTOR] Integrate DebugRenderTree #1192

Merged
merged 1 commit into from
Nov 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
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
1 change: 1 addition & 0 deletions packages/@glimmer/integration-tests/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export * from './lib/dom/assertions';
export * from './lib/dom/blocks';
export * from './lib/dom/simple-utils';
export * from './lib/markers';
export * from './lib/modes/env';
export * from './lib/modes/jit/delegate';
export * from './lib/modes/jit/resolver';
export * from './lib/modes/jit/register';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,14 @@ import {
CapturedNamedArguments,
ComponentManager,
WithStaticLayout,
RuntimeResolver,
ComponentCapabilities,
Environment,
VMArguments,
DynamicScope,
CompilableProgram,
Destroyable,
Template,
} from '@glimmer/interfaces';
import { keys, assign, unwrapTemplate, expect } from '@glimmer/util';
import { keys, assign, expect } from '@glimmer/util';
import { TEMPLATE_ONLY_CAPABILITIES } from './capabilities';
import { TestComponentDefinitionState } from './test-component';
import { TestComponentConstructor } from './types';
Expand Down Expand Up @@ -86,7 +85,7 @@ export interface EmberishGlimmerComponentState {
export class EmberishGlimmerComponentManager
implements
ComponentManager<EmberishGlimmerComponentState, TestComponentDefinitionState>,
WithStaticLayout<EmberishGlimmerComponentState, TestComponentDefinitionState, RuntimeResolver> {
WithStaticLayout<EmberishGlimmerComponentState, TestComponentDefinitionState> {
getCapabilities(state: TestComponentDefinitionState): ComponentCapabilities {
return state.capabilities;
}
Expand Down Expand Up @@ -126,8 +125,8 @@ export class EmberishGlimmerComponentManager
return { args, component, selfRef };
}

getStaticLayout({ template }: TestComponentDefinitionState): CompilableProgram {
return unwrapTemplate(expect(template, 'expected component layout')).asLayout();
getStaticLayout({ template }: TestComponentDefinitionState): Template {
return expect(template, 'expected component layout');
}

getSelf({ selfRef }: EmberishGlimmerComponentState): Reference<unknown> {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
import {
WithStaticLayout,
RuntimeResolver,
CompilableProgram,
ComponentCapabilities,
} from '@glimmer/interfaces';
import { WithStaticLayout, ComponentCapabilities, Template } from '@glimmer/interfaces';
import { TestComponentDefinitionState } from './test-component';
import { expect, unwrapTemplate } from '@glimmer/util';
import { expect } from '@glimmer/util';
import { Reference, NULL_REFERENCE } from '@glimmer/reference';

export class TemplateOnlyComponentManager
implements WithStaticLayout<null, TestComponentDefinitionState, RuntimeResolver> {
implements WithStaticLayout<null, TestComponentDefinitionState> {
getCapabilities(state: TestComponentDefinitionState): ComponentCapabilities {
return state.capabilities;
}
Expand All @@ -18,8 +13,8 @@ export class TemplateOnlyComponentManager
return state.name;
}

getStaticLayout({ template }: TestComponentDefinitionState): CompilableProgram {
return unwrapTemplate(expect(template, 'expected component layout')).asLayout();
getStaticLayout({ template }: TestComponentDefinitionState): Template {
return expect(template, 'expected component layout');
}

getSelf(): Reference {
Expand Down
3 changes: 2 additions & 1 deletion packages/@glimmer/integration-tests/lib/components/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { EmberishCurlyComponent } from './emberish-curly';
import { Dict } from '@glimmer/interfaces';
import { TemplateOnlyComponent } from '@glimmer/runtime';

export type ComponentKind = 'Glimmer' | 'Curly' | 'Dynamic' | 'TemplateOnly' | 'unknown';
export type ComponentKind = 'Glimmer' | 'Curly' | 'Dynamic' | 'TemplateOnly' | 'Custom' | 'unknown';

export interface TestComponentConstructor<T> {
new (): T;
Expand All @@ -14,6 +14,7 @@ export interface ComponentTypes {
Curly: TestComponentConstructor<EmberishCurlyComponent>;
Dynamic: TestComponentConstructor<EmberishCurlyComponent>;
TemplateOnly: TemplateOnlyComponent;
Custom: unknown;
unknown: unknown;
}

Expand Down
38 changes: 12 additions & 26 deletions packages/@glimmer/integration-tests/lib/modes/jit/delegate.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { PrecompileOptions } from '@glimmer/compiler';
import {
CapturedRenderNode,
ComponentDefinition,
Cursor,
Dict,
Expand All @@ -26,7 +27,7 @@ import {
runtimeContext,
} from '@glimmer/runtime';
import { ASTPluginBuilder } from '@glimmer/syntax';
import { assign, castToBrowser, castToSimple, unwrapTemplate } from '@glimmer/util';
import { assign, castToBrowser, castToSimple, expect, unwrapTemplate } from '@glimmer/util';
import {
ElementNamespace,
SimpleDocument,
Expand All @@ -37,22 +38,18 @@ import {
import { preprocess } from '../../compile';
import { TestMacros } from '../../compile/macros';
import { ComponentKind, ComponentTypes } from '../../components';
import { EmberishCurlyComponentFactory } from '../../components/emberish-curly';
import { EmberishGlimmerComponentFactory } from '../../components/emberish-glimmer';
import { UserHelper } from '../../helpers';
import { TestModifierConstructor } from '../../modifiers';
import RenderDelegate, { RenderDelegateOptions } from '../../render-delegate';
import { BaseEnv } from '../env';
import JitCompileTimeLookup from './compilation-context';
import {
componentHelper,
registerEmberishCurlyComponent,
registerEmberishGlimmerComponent,
registerComponent,
registerHelper,
registerInternalHelper,
registerModifier,
registerPartial,
registerTemplateOnlyComponent,
} from './register';
import { TestJitRegistry } from './registry';
import { renderTemplate } from './render';
Expand Down Expand Up @@ -93,7 +90,7 @@ export class JitRenderDelegate implements RenderDelegate {

constructor(options?: RenderDelegateOptions) {
this.doc = options?.doc ?? castToSimple(document);
this.env = assign(options?.env ?? {}, BaseEnv);
this.env = assign({}, options?.env ?? BaseEnv);
registerInternalHelper(this.registry, '-get-dynamic-var', getDynamicVar);
}

Expand All @@ -105,6 +102,13 @@ export class JitRenderDelegate implements RenderDelegate {
return this._context;
}

getCapturedRenderTree(): CapturedRenderNode[] {
return expect(
this.context.runtime.env.debugRenderTree,
'Attempted to capture the DebugRenderTree during tests, but it was not created. Did you enable it in the environment?'
).capture();
}

getInitialElement(): SimpleElement {
if (isBrowserTestDocument(this.doc)) {
return castToSimple(castToBrowser(this.doc).getElementById('qunit-fixture')!);
Expand Down Expand Up @@ -158,25 +162,7 @@ export class JitRenderDelegate implements RenderDelegate {
layout: Option<string>,
Class?: ComponentTypes[K]
) {
switch (type) {
case 'TemplateOnly':
return registerTemplateOnlyComponent(this.registry, name, layout!);
case 'Curly':
case 'Dynamic':
return registerEmberishCurlyComponent(
this.registry,
name,
(Class as any) as EmberishCurlyComponentFactory,
layout
);
case 'Glimmer':
return registerEmberishGlimmerComponent(
this.registry,
name,
(Class as any) as EmberishGlimmerComponentFactory,
layout!
);
}
registerComponent(this.registry, type, name, layout!, Class);
}

registerModifier(name: string, ModifierClass: TestModifierConstructor): void {
Expand Down
7 changes: 5 additions & 2 deletions packages/@glimmer/integration-tests/lib/modes/jit/registry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
Template,
WithStaticLayout,
} from '@glimmer/interfaces';
import { assert, dict } from '@glimmer/util';
import { assert, dict, unwrapTemplate } from '@glimmer/util';
import { getComponentTemplate } from '@glimmer/runtime';
import { TestComponentDefinitionState } from '../../components/test-component';

Expand Down Expand Up @@ -140,10 +140,13 @@ export class TestJitRegistry {
};
}

let template = unwrapTemplate(manager.getStaticLayout(state));
let layout = capabilities.wrapped ? template.asWrappedLayout() : template.asLayout();

return {
handle: handle,
capabilities,
compilable: manager.getStaticLayout(state),
compilable: layout,
};
}

Expand Down
3 changes: 2 additions & 1 deletion packages/@glimmer/integration-tests/lib/suites/components.ts
Original file line number Diff line number Diff line change
Expand Up @@ -730,8 +730,9 @@ export class GlimmerishComponents extends RenderTest {
let originalConsoleError = console.error;

console.error = (message: string) => {
console.log(message);
this.assert.ok(
message.match(/Error occurred while rendering:(\n\nBar\n {2}Foo)?/),
message.match(/Error occurred:\n\n(- While rendering:\nBar\n {2}Foo)?/),
'message logged'
);
};
Expand Down
Loading