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

fix(ivy): support env where requestAnimationFrame is not available #26779

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 8 additions & 9 deletions packages/core/src/render3/component.ts
Expand Up @@ -21,11 +21,11 @@ import {CLEAN_PROMISE, createLViewData, createNodeAtIndex, createTView, getOrCre
import {ComponentDef, ComponentType} from './interfaces/definition';
import {TElementNode, TNodeFlags, TNodeType} from './interfaces/node';
import {PlayerHandler} from './interfaces/player';
import {RElement, RNode, Renderer3, RendererFactory3, domRendererFactory3} from './interfaces/renderer';
import {RElement, Renderer3, RendererFactory3, domRendererFactory3} from './interfaces/renderer';
import {CONTEXT, HEADER_OFFSET, HOST, HOST_NODE, INJECTOR, LViewData, LViewFlags, RootContext, RootContextFlags, TVIEW} from './interfaces/view';
import {publishDefaultGlobalUtils} from './publish_global_util';
import {enterView, leaveView, resetComponentState} from './state';
import {getRootView, readElementValue, readPatchedLViewData, stringify} from './util';
import {defaultScheduler, getRootView, readElementValue, readPatchedLViewData, stringify} from './util';


/** Options that control how the component should be bootstrapped. */
Expand Down Expand Up @@ -117,8 +117,7 @@ export function renderComponent<T>(
const hostRNode = locateHostElement(rendererFactory, opts.host || componentTag);
const rootFlags = componentDef.onPush ? LViewFlags.Dirty | LViewFlags.IsRoot :
LViewFlags.CheckAlways | LViewFlags.IsRoot;
const rootContext = createRootContext(
opts.scheduler || requestAnimationFrame.bind(window), opts.playerHandler || null);
const rootContext = createRootContext(opts.scheduler, opts.playerHandler);

const renderer = rendererFactory.createRenderer(hostRNode, componentDef);
const rootView: LViewData = createLViewData(
Expand All @@ -132,7 +131,7 @@ export function renderComponent<T>(
const componentView =
createRootComponentView(hostRNode, componentDef, rootView, renderer, sanitizer);
component = createRootComponent(
hostRNode, componentView, componentDef, rootView, rootContext, opts.hostFeatures || null);
componentView, componentDef, rootView, rootContext, opts.hostFeatures || null);

refreshDescendantViews(rootView, null);
} finally {
Expand Down Expand Up @@ -184,8 +183,8 @@ export function createRootComponentView(
* renderComponent() and ViewContainerRef.createComponent().
*/
export function createRootComponent<T>(
hostRNode: RNode | null, componentView: LViewData, componentDef: ComponentDef<T>,
rootView: LViewData, rootContext: RootContext, hostFeatures: HostFeature[] | null): any {
componentView: LViewData, componentDef: ComponentDef<T>, rootView: LViewData,
rootContext: RootContext, hostFeatures: HostFeature[] | null): any {
const tView = rootView[TVIEW];
// Create directive instance with factory() and store at next index in viewData
const component = instantiateRootComponent(tView, rootView, componentDef);
Expand All @@ -201,10 +200,10 @@ export function createRootComponent<T>(


export function createRootContext(
scheduler: (workFn: () => void) => void, playerHandler?: PlayerHandler|null): RootContext {
scheduler?: (workFn: () => void) => void, playerHandler?: PlayerHandler|null): RootContext {
return {
components: [],
scheduler: scheduler,
scheduler: scheduler || defaultScheduler,
clean: CLEAN_PROMISE,
playerHandler: playerHandler || null,
flags: RootContextFlags.Empty
Expand Down
15 changes: 5 additions & 10 deletions packages/core/src/render3/component_ref.ts
Expand Up @@ -26,7 +26,7 @@ import {TElementNode, TNode, TNodeType, TViewNode} from './interfaces/node';
import {RElement, RendererFactory3, domRendererFactory3} from './interfaces/renderer';
import {FLAGS, HEADER_OFFSET, INJECTOR, LViewData, LViewFlags, RootContext, TVIEW} from './interfaces/view';
import {enterView, leaveView} from './state';
import {getTNode} from './util';
import {defaultScheduler, getTNode} from './util';
import {createElementRef} from './view_engine_compatibility';
import {RootViewRef, ViewRef} from './view_ref';

Expand Down Expand Up @@ -62,10 +62,7 @@ export const ROOT_CONTEXT = new InjectionToken<RootContext>(
*/
export const SCHEDULER = new InjectionToken<((fn: () => void) => void)>('SCHEDULER_TOKEN', {
providedIn: 'root',
factory: () => {
const useRaf = typeof requestAnimationFrame !== 'undefined' && typeof window !== 'undefined';
return useRaf ? requestAnimationFrame.bind(window) : setTimeout;
},
factory: () => defaultScheduler,
});

/**
Expand Down Expand Up @@ -118,9 +115,8 @@ export class ComponentFactory<T> extends viewEngine_ComponentFactory<T> {

const rootFlags = this.componentDef.onPush ? LViewFlags.Dirty | LViewFlags.IsRoot :
LViewFlags.CheckAlways | LViewFlags.IsRoot;
const rootContext: RootContext = ngModule && !isInternalRootView ?
ngModule.injector.get(ROOT_CONTEXT) :
createRootContext(requestAnimationFrame.bind(window));
const rootContext: RootContext =
ngModule && !isInternalRootView ? ngModule.injector.get(ROOT_CONTEXT) : createRootContext();

const renderer = rendererFactory.createRenderer(hostRNode, this.componentDef);
// Create the root view. Uses empty TView and ContentTemplate.
Expand Down Expand Up @@ -174,8 +170,7 @@ export class ComponentFactory<T> extends viewEngine_ComponentFactory<T> {
// executed here?
// Angular 5 reference: https://stackblitz.com/edit/lifecycle-hooks-vcref
component = createRootComponent(
hostRNode, componentView, this.componentDef, rootView, rootContext,
[LifecycleHooksFeature]);
componentView, this.componentDef, rootView, rootContext, [LifecycleHooksFeature]);

refreshDescendantViews(rootView, RenderFlags.Create);
} finally {
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/render3/instructions.ts
Expand Up @@ -358,7 +358,7 @@ export function renderEmbeddedTemplate<T>(
let oldView: LViewData;
if (viewToRender[FLAGS] & LViewFlags.IsRoot) {
// This is a root view inside the view tree
tickRootContext(viewToRender[CONTEXT] as RootContext);
tickRootContext(getRootContext(viewToRender));
} else {
try {
setIsParent(true);
Expand Down
11 changes: 10 additions & 1 deletion packages/core/src/render3/util.ts
Expand Up @@ -7,6 +7,7 @@
*/

import {devModeEqual} from '../change_detection/change_detection_util';
import {global} from '../util';

import {assertDefined, assertLessThan} from './assert';
import {ACTIVE_INDEX, LContainer} from './interfaces/container';
Expand Down Expand Up @@ -154,7 +155,10 @@ export function getRootView(target: LViewData | {}): LViewData {
}

export function getRootContext(viewOrComponent: LViewData | {}): RootContext {
return getRootView(viewOrComponent)[CONTEXT] as RootContext;
const rootView = getRootView(viewOrComponent);
ngDevMode &&
assertDefined(rootView[CONTEXT], 'RootView has no context. Perhaps it is disconnected?');
return rootView[CONTEXT] as RootContext;
}

/**
Expand Down Expand Up @@ -241,3 +245,8 @@ export function getParentInjectorTNode(
}
return parentTNode;
}

export const defaultScheduler =
(typeof requestAnimationFrame !== 'undefined' && requestAnimationFrame || // browser only
setTimeout // everything else
).bind(global);
Expand Up @@ -434,6 +434,9 @@
{
"name": "decreaseElementDepthCount"
},
{
"name": "defaultScheduler"
},
{
"name": "defineComponent"
},
Expand Down
18 changes: 18 additions & 0 deletions packages/core/test/bundling/hello_world/bundle.golden_symbols.json
Expand Up @@ -119,6 +119,15 @@
{
"name": "ViewEncapsulation"
},
{
"name": "__self"
},
{
"name": "__window"
},
{
"name": "_global"
},
{
"name": "_renderCompCount"
},
Expand Down Expand Up @@ -182,6 +191,9 @@
{
"name": "createViewQuery"
},
{
"name": "defaultScheduler"
},
{
"name": "defineComponent"
},
Expand Down Expand Up @@ -305,6 +317,12 @@
{
"name": "getRendererFactory"
},
{
"name": "getRootContext"
},
{
"name": "getRootView"
},
{
"name": "getTView"
},
Expand Down
Expand Up @@ -680,6 +680,9 @@
{
"name": "defaultErrorLogger"
},
{
"name": "defaultScheduler"
},
{
"name": "defineComponent"
},
Expand Down Expand Up @@ -929,6 +932,12 @@
{
"name": "getRendererFactory"
},
{
"name": "getRootContext"
},
{
"name": "getRootView"
},
{
"name": "getSymbolIterator$1"
},
Expand Down
3 changes: 3 additions & 0 deletions packages/core/test/bundling/todo/bundle.golden_symbols.json
Expand Up @@ -491,6 +491,9 @@
{
"name": "decreaseElementDepthCount"
},
{
"name": "defaultScheduler"
},
{
"name": "defineComponent"
},
Expand Down
Expand Up @@ -1415,6 +1415,9 @@
{
"name": "defaultKeyValueDiffers"
},
{
"name": "defaultScheduler"
},
{
"name": "defineComponent"
},
Expand Down