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

Move core service installation into core-services.js for easier refactoring #22732

Merged
merged 4 commits into from
Jun 11, 2019
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
9 changes: 3 additions & 6 deletions src/amp-shadow.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,11 @@
// src/polyfills.js must be the first import.
import './polyfills'; // eslint-disable-line sort-imports-es6-autofix/sort-imports-es6

import {
adoptShadowMode,
installBuiltins,
installRuntimeServices,
} from './runtime';
import {adoptShadowMode} from './runtime';
import {bodyAlwaysVisible} from './style-installer';
import {deactivateChunking} from './chunk';
import {doNotTrackImpression} from './impression';
import {installBuiltinElements, installRuntimeServices} from './core-services';
import {installDocService} from './service/ampdoc-impl';
import {internalRuntimeVersion} from './internal-version';

Expand All @@ -51,7 +48,7 @@ doNotTrackImpression();
bodyAlwaysVisible(self);

// Builtins.
installBuiltins(self);
installBuiltinElements(self);

// Final configuration and stubbing.
adoptShadowMode(self);
Expand Down
14 changes: 7 additions & 7 deletions src/amp.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@
import './polyfills'; // eslint-disable-line sort-imports-es6-autofix/sort-imports-es6

import {Services} from './services';
import {
adopt,
installAmpdocServices,
installBuiltins,
installRuntimeServices,
} from './runtime';
import {adopt} from './runtime';
import {cssText as ampDocCss} from '../build/ampdoc.css';
import {cssText as ampSharedCss} from '../build/ampshared.css';
import {fontStylesheetTimeout} from './font-stylesheet-timeout';
import {
installAmpdocServices,
installBuiltinElements,
installRuntimeServices,
} from './service/core-services';
import {installAutoLightboxExtension} from './auto-lightbox';
import {installDocService} from './service/ampdoc-impl';
import {installErrorReporting} from './error';
Expand Down Expand Up @@ -117,7 +117,7 @@ if (shouldMainBootstrapRun) {
});
startupChunk(self.document, function builtins() {
// Builtins.
installBuiltins(self);
installBuiltinElements(self);
});
startupChunk(self.document, function stub() {
// Pre-stub already known elements.
Expand Down
8 changes: 6 additions & 2 deletions src/inabox/amp-inabox-lite.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ import {
installGlobalNavigationHandlerForDoc,
} from '../service/navigation';
import {Services} from '../services';
import {adopt, installBuiltins, installRuntimeServices} from '../runtime';
import {adopt} from '../runtime';
import {cssText as ampDocCss} from '../../build/ampdoc.css';
import {cssText as ampSharedCss} from '../../build/ampshared.css';
import {fontStylesheetTimeout} from '../font-stylesheet-timeout';
import {getMode} from '../mode';
import {
installBuiltinElements,
installRuntimeServices,
} from '../service/core-services';
import {installDocService} from '../service/ampdoc-impl';
import {installErrorReporting} from '../error';
import {installIframeMessagingClient} from './inabox-iframe-messaging-client';
Expand Down Expand Up @@ -100,7 +104,7 @@ installStylesForDoc(
registerIniLoadListener(ampdoc);

// Builtins.
installBuiltins(self);
installBuiltinElements(self);
adopt(self);

// Pre-stub already known elements.
Expand Down
14 changes: 7 additions & 7 deletions src/inabox/amp-inabox.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@
import '../polyfills';
import {Navigation} from '../service/navigation';
import {Services} from '../services';
import {
adopt,
installAmpdocServices,
installBuiltins,
installRuntimeServices,
} from '../runtime';
import {adopt} from '../runtime';
import {cssText as ampDocCss} from '../../build/ampdoc.css';
import {cssText as ampSharedCss} from '../../build/ampshared.css';
import {fontStylesheetTimeout} from '../font-stylesheet-timeout';
import {getA4AId, registerIniLoadListener} from './utils';
import {getMode} from '../mode';
import {
installAmpdocServices,
installBuiltinElements,
installRuntimeServices,
} from '../service/core-services';
import {installDocService} from '../service/ampdoc-impl';
import {installErrorReporting} from '../error';
import {installIframeMessagingClient} from './inabox-iframe-messaging-client';
Expand Down Expand Up @@ -107,7 +107,7 @@ startupChunk(self.document, function initial() {
});
startupChunk(self.document, function builtins() {
// Builtins.
installBuiltins(self);
installBuiltinElements(self);
});
startupChunk(self.document, function adoptWindow() {
adopt(self);
Expand Down
83 changes: 6 additions & 77 deletions src/runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,7 @@
*/

import {BaseElement} from './base-element';
import {
BaseTemplate,
installTemplatesService,
registerExtendedTemplate,
} from './service/template-impl';
import {BaseTemplate, registerExtendedTemplate} from './service/template-impl';
import {CommonSignals} from './common-signals';
import {
LogLevel, // eslint-disable-line no-unused-vars
Expand Down Expand Up @@ -48,42 +44,21 @@ import {
import {disposeServicesForDoc} from './service';
import {getMode} from './mode';
import {hasRenderDelayingServices} from './render-delaying-services';
import {installActionServiceForDoc} from './service/action-impl';
import {installBatchedXhrService} from './service/batched-xhr-impl';
import {
installBuiltinElements,
installAmpdocServices,
installRuntimeServices,
} from './service/core-services';
import {
installExtensionsService,
stubLegacyElements,
} from './service/extensions-impl';
import {installCidService} from './service/cid-impl';
import {installCryptoService} from './service/crypto-impl';
import {installDocumentInfoServiceForDoc} from './service/document-info-impl';
import {installGlobalDocumentStateService} from './service/document-state';
import {installGlobalNavigationHandlerForDoc} from './service/navigation';
import {installGlobalSubmitListenerForDoc} from './document-submit';
import {installHiddenObserverForDoc} from './service/hidden-observer-impl';
import {installHistoryServiceForDoc} from './service/history-impl';
import {installInputService} from './input';
import {installPlatformService} from './service/platform-impl';
import {installResourcesServiceForDoc} from './service/resources-impl';
import {installStandardActionsForDoc} from './service/standard-actions-impl';
import {installStorageServiceForDoc} from './service/storage-impl';
import {installStylesForDoc} from './style-installer';
import {installTimerService} from './service/timer-impl';
import {installUrlForDoc} from './service/url-impl';
import {installUrlReplacementsServiceForDoc} from './service/url-replacements-impl';
import {
installViewerServiceForDoc,
setViewerVisibilityState,
} from './service/viewer-impl';
import {installViewportServiceForDoc} from './service/viewport/viewport-impl';
import {installVsyncService} from './service/vsync-impl';
import {installXhrService} from './service/xhr-impl';
import {internalRuntimeVersion} from './internal-version';
import {isExperimentOn, toggleExperiment} from './experiments';
import {parseUrlDeprecated} from './url';
import {reportErrorForWin} from './error';
import {setStyle} from './style';
import {setViewerVisibilityState} from './service/viewer-impl';
import {startupChunk} from './chunk';
import {stubElementsForDoc} from './service/custom-element-registry';

Expand All @@ -93,52 +68,6 @@ setReportError(reportErrorForWin.bind(null, self));
/** @const @private {string} */
const TAG = 'runtime';

/**
* Install runtime-level services.
* @param {!Window} global Global scope to adopt.
*/
export function installRuntimeServices(global) {
installCryptoService(global);
installBatchedXhrService(global);
installGlobalDocumentStateService(global);
installPlatformService(global);
installTemplatesService(global);
installTimerService(global);
installVsyncService(global);
installXhrService(global);
installInputService(global);
}

/**
* Install ampdoc-level services.
* @param {!./service/ampdoc-impl.AmpDoc} ampdoc
* @param {!Object<string, string>=} opt_initParams
*/
export function installAmpdocServices(ampdoc, opt_initParams) {
installUrlForDoc(ampdoc);
installCidService(ampdoc);
installDocumentInfoServiceForDoc(ampdoc);
installViewerServiceForDoc(ampdoc, opt_initParams);
installViewportServiceForDoc(ampdoc);
installHiddenObserverForDoc(ampdoc);
installHistoryServiceForDoc(ampdoc);
installResourcesServiceForDoc(ampdoc);
installUrlReplacementsServiceForDoc(ampdoc);
installActionServiceForDoc(ampdoc);
installStandardActionsForDoc(ampdoc);
installStorageServiceForDoc(ampdoc);
installGlobalNavigationHandlerForDoc(ampdoc);
installGlobalSubmitListenerForDoc(ampdoc);
}

/**
* Install builtins.
* @param {!Window} global Global scope to adopt.
*/
export function installBuiltins(global) {
installBuiltinElements(global);
}

/**
* Applies the runtime to a given global scope for a single-doc mode. Multi
* frame support is currently incomplete.
Expand Down
94 changes: 94 additions & 0 deletions src/service/core-services.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* Copyright 2019 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import {installActionServiceForDoc} from './action-impl';
import {installBatchedXhrService} from './batched-xhr-impl';
import {installCidService} from './cid-impl';
import {installCryptoService} from './crypto-impl';
import {installDocumentInfoServiceForDoc} from './document-info-impl';
import {installGlobalDocumentStateService} from './document-state';
import {installGlobalNavigationHandlerForDoc} from './navigation';
import {installGlobalSubmitListenerForDoc} from './document-submit';
import {installHiddenObserverForDoc} from './hidden-observer-impl';
import {installHistoryServiceForDoc} from './history-impl';
import {installImg} from '../../builtins/amp-img';
import {installInputService} from './input';
import {installLayout} from '../../builtins/amp-layout';
import {installPixel} from '../../builtins/amp-pixel';
import {installPlatformService} from './platform-impl';
import {installResourcesServiceForDoc} from './resources-impl';
import {installStandardActionsForDoc} from './standard-actions-impl';
import {installStorageServiceForDoc} from './storage-impl';
import {installTemplatesService} from './template-impl';
import {installTimerService} from './timer-impl';
import {installUrlForDoc} from './url-impl';
import {installUrlReplacementsServiceForDoc} from './url-replacements-impl';
import {installViewerServiceForDoc} from './viewer-impl';
import {installViewportServiceForDoc} from './viewport/viewport-impl';
import {installVsyncService} from './vsync-impl';
import {installXhrService} from './xhr-impl';

/**
* Install builtins.
* @param {!Window} win
* @restricted
*/
export function installBuiltinElements(win) {
installImg(win);
installPixel(win);
installLayout(win);
}

/**
* Install runtime-level services.
* @param {!Window} global Global scope to adopt.
* @restricted
*/
export function installRuntimeServices(global) {
installCryptoService(global);
installBatchedXhrService(global);
installGlobalDocumentStateService(global);
installPlatformService(global);
installTemplatesService(global);
installTimerService(global);
installVsyncService(global);
installXhrService(global);
installInputService(global);
}

/**
* Install ampdoc-level services.
* @param {!./ampdoc-impl.AmpDoc} ampdoc
* @param {!Object<string, string>=} opt_initParams
* @restricted
*/
export function installAmpdocServices(ampdoc, opt_initParams) {
// Order is important!
installUrlForDoc(ampdoc);
installCidService(ampdoc);
installDocumentInfoServiceForDoc(ampdoc);
installViewerServiceForDoc(ampdoc, opt_initParams);
installViewportServiceForDoc(ampdoc);
installHiddenObserverForDoc(ampdoc);
installHistoryServiceForDoc(ampdoc);
installResourcesServiceForDoc(ampdoc);
installUrlReplacementsServiceForDoc(ampdoc);
installActionServiceForDoc(ampdoc);
installStandardActionsForDoc(ampdoc);
installStorageServiceForDoc(ampdoc);
installGlobalNavigationHandlerForDoc(ampdoc);
installGlobalSubmitListenerForDoc(ampdoc);
}
14 changes: 0 additions & 14 deletions src/service/extensions-impl.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ import {getMode} from '../mode';
import {install as installCustomElements} from '../polyfills/custom-elements';
import {install as installDOMTokenListToggle} from '../polyfills/domtokenlist-toggle';
import {install as installDocContains} from '../polyfills/document-contains';
import {installImg} from '../../builtins/amp-img';
import {installLayout} from '../../builtins/amp-layout';
import {installPixel} from '../../builtins/amp-pixel';
import {installCustomElements as installRegisterElement} from 'document-register-element/build/document-register-element.patched';
import {installStylesForDoc, installStylesLegacy} from '../style-installer';
import {installTimerInEmbedWindow} from './timer-impl';
Expand Down Expand Up @@ -672,17 +669,6 @@ export class Extensions {
}
}

/**
* Install builtins.
* @param {!Window} win
* @restricted
*/
export function installBuiltinElements(win) {
installImg(win);
installPixel(win);
installLayout(win);
}

/**
* Copy builtins to a child window.
* @param {!Window} parentWin
Expand Down
4 changes: 2 additions & 2 deletions test/_init_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ import * as describes from '../testing/describes';
import * as log from '../src/log';
import {Services} from '../src/services';
import {activateChunkingForTesting} from '../src/chunk';
import {adopt} from '../src/runtime';
import {
adopt,
installAmpdocServices,
installRuntimeServices,
} from '../src/runtime';
} from '../src/service/core-services';
import {installDocService} from '../src/service/ampdoc-impl';
import {installYieldIt} from '../testing/yield';
import {removeElement} from '../src/dom';
Expand Down
2 changes: 1 addition & 1 deletion test/unit/test-performance.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import * as lolex from 'lolex';
import {Services} from '../../src/services';
import {getMode} from '../../src/mode';
import {installPerformanceService} from '../../src/service/performance-impl';
import {installRuntimeServices} from '../../src/runtime';
import {installRuntimeServices} from '../../src/service/core-services';

describes.realWin('performance', {amp: true}, env => {
let sandbox;
Expand Down
3 changes: 2 additions & 1 deletion test/unit/test-runtime.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@ import * as styles from '../../src/style-installer';
import {AmpDocShadow, AmpDocSingle} from '../../src/service/ampdoc-impl';
import {ElementStub} from '../../src/element-stub';
import {Services} from '../../src/services';
import {adopt, adoptShadowMode, installAmpdocServices} from '../../src/runtime';
import {adopt, adoptShadowMode} from '../../src/runtime';
import {createShadowRoot} from '../../src/shadow-embed';
import {deactivateChunking, runChunksForTesting} from '../../src/chunk';
import {
getServiceForDoc,
getServicePromise,
getServicePromiseOrNullForDoc,
} from '../../src/service';
import {installAmpdocServices} from '../../src/service/core-services';
import {installGlobalDocumentStateService} from '../../src/service/document-state';
import {installPlatformService} from '../../src/service/platform-impl';
import {installTimerService} from '../../src/service/timer-impl';
Expand Down
Loading