Skip to content

GitLab

T
tangled
Commit c529c8f3 authored by Rakina Zata Amni's avatar Rakina Zata Amni Committed by Commit Bot
Browse files
Options

Revert "Split MainPageBehavior between browser and OS settings." 

This reverts commit e1e445e8.

Reason for revert: Possibly causing compile failure: https://ci.chromium.org/p/chromium/builders/ci/Linux%20Chromium%20OS%20ASan%20LSan%20Builder/50257

Original change's description:
> Split MainPageBehavior between browser and OS settings.
> 
> This is a prerequisite to implement lazy loading for Polymer 3.
> 
> Bug: 1045266
> Change-Id: I92c428cd2c18d6f4096ee5fbdd26ae77efb831ec
> Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2321954
> Reviewed-by: Kyle Horimoto <khorimoto@chromium.org>
> Reviewed-by: dpapad <dpapad@chromium.org>
> Commit-Queue: Jon Mann <jonmann@chromium.org>
> Cr-Commit-Position: refs/heads/master@{#792491}

TBR=khorimoto@chromium.org,dpapad@chromium.org,jonmann@chromium.org

Change-Id: I0416e8fcda1d9c03eaccc1dfad3082c88568928b
No-Presubmit: true
No-Tree-Checks: true
No-Try: true
Bug: 1045266, 1110567
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2325470Reviewed-by: default avatarRakina Zata Amni <rakina@chromium.org>
Commit-Queue: Rakina Zata Amni <rakina@chromium.org>
Cr-Commit-Position: refs/heads/master@{#792509}
parent 4197cbc7
Hide whitespace changes
Inline Side-by-side
Showing with 29 additions and 460 deletions
chrome/browser/resources/settings/chromeos/BUILD.gn
View file @ c529c8f3
......@@ -274,8 +274,7 @@ group("closure_compile_module") {
#"os_search_page:closure_compile_module",
#"os_settings_main:closure_compile_module",
#"os_settings_menu:closure_compile_module",
"os_settings_page:closure_compile_module",
#"os_settings_page:closure_compile_module",
#"os_settings_search_box:closure_compile_module",
#"os_settings_ui:closure_compile_module",
#"os_toolbar:closure_compile_module",
......
chrome/browser/resources/settings/chromeos/os_settings_main/BUILD.gn
View file @ c529c8f3
......@@ -13,7 +13,7 @@ js_library("os_settings_main") {
"..:os_page_visibility",
"../..:router",
"../..:search_settings",
"../os_settings_page:main_page_behavior",
"../../settings_page:main_page_behavior",
"../os_settings_page:os_settings_page",
"//third_party/polymer/v1_0/components-chromium/iron-a11y-announcer:iron-a11y-announcer-extracted",
"//ui/webui/resources/js:assert",
......
chrome/browser/resources/settings/chromeos/os_settings_page/BUILD.gn
View file @ c529c8f3
......@@ -3,23 +3,18 @@
# found in the LICENSE file.
import("//third_party/closure_compiler/compile_js.gni")
import("//ui/webui/resources/tools/js_modulizer.gni")
import("../os_settings.gni")
js_type_check("closure_compile") {
deps = [
":main_page_behavior",
":os_settings_page",
]
deps = [ ":os_settings_page" ]
}
js_library("os_settings_page") {
deps = [
":main_page_behavior",
"..:os_page_visibility",
"..:os_route",
"../..:router",
"../..:search_settings",
"../../settings_page:main_page_behavior",
"../os_apps_page:android_apps_browser_proxy",
"//ui/webui/resources/js:load_time_data",
"//ui/webui/resources/js:web_ui_listener_behavior",
......@@ -27,24 +22,13 @@ js_library("os_settings_page") {
externs_list = [ "$externs_path/pending.js" ]
}
js_library("main_page_behavior") {
deps = [
"../..:router",
"../../settings_page:settings_section",
"//ui/webui/resources/js:assert",
"//ui/webui/resources/js:util",
]
externs_list = [ "$externs_path/pending.js" ]
}
# TODO: Uncomment as the Polymer3 migration makes progress.
js_type_check("closure_compile_module") {
is_polymer3 = true
deps = [
# ":os_settings_page.m",
":main_page_behavior.m",
]
}
#js_type_check("closure_compile_module") {
# is_polymer3 = true
# deps = [
# ":os_settings_page.m"
# ]
#}
js_library("os_settings_page.m") {
sources = [ "$root_gen_dir/chrome/browser/resources/settings/chromeos/os_settings_page/os_settings_page.m.js" ]
......@@ -54,25 +38,10 @@ js_library("os_settings_page.m") {
extra_deps = [ ":os_settings_page_module" ]
}
js_library("main_page_behavior.m") {
sources = [ "$root_gen_dir/chrome/browser/resources/settings/chromeos/os_settings_page/main_page_behavior.m.js" ]
deps = [
"../..:router.m",
"../../settings_page:settings_section.m",
"//third_party/polymer/v3_0/components-chromium/polymer:polymer_bundled",
"//ui/webui/resources/js:assert.m",
"//ui/webui/resources/js:util.m",
]
extra_deps = [ ":modulize" ]
}
import("//tools/polymer/polymer.gni")
group("polymer3_elements") {
public_deps = [
":modulize",
":os_settings_page_module",
]
public_deps = [ ":os_settings_page_module" ]
}
polymer_modulizer("os_settings_page") {
......@@ -80,8 +49,3 @@ polymer_modulizer("os_settings_page") {
html_file = "os_settings_page.html"
html_type = "dom-module"
}
js_modulizer("modulize") {
input_files = [ "main_page_behavior.js" ]
namespace_rewrites = os_settings_namespace_rewrites
}
chrome/browser/resources/settings/chromeos/os_settings_page/main_page_behavior.html deleted 100644 → 0
View file @ 4197cbc7
<link rel="import" href="chrome://resources/html/polymer.html">
<link rel="import" href="chrome://resources/html/assert.html">
<link rel="import" href="../../router.html">
<script src="main_page_behavior.js"></script>
chrome/browser/resources/settings/chromeos/os_settings_page/main_page_behavior.js deleted 100644 → 0
View file @ 4197cbc7
// Copyright 2016 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
// clang-format off
// #import {assert} from 'chrome://resources/js/assert.m.js';
// #import {beforeNextRender} from 'chrome://resources/polymer/v3_0/polymer/polymer_bundled.min.js';
// #import {Route, Router, MinimumRoutes} from '../../router.m.js';
// clang-format on
cr.define('settings', function() {
/**
* @enum {string}
* A categorization of every possible Settings URL, necessary for implementing
* a finite state machine.
*/
/* #export */ const RouteState = {
// Initial state before anything has loaded yet.
INITIAL: 'initial',
// A dialog that has a dedicated URL (e.g. /importData).
DIALOG: 'dialog',
// A section (basically a scroll position within the top level page, e.g,
// /appearance.
SECTION: 'section',
// A subpage, or sub-subpage e.g, /searchEngins.
SUBPAGE: 'subpage',
// The top level Settings page, '/'.
TOP_LEVEL: 'top-level',
};
/**
* @param {?settings.Route} route
* @return {!settings.RouteState}
*/
function classifyRoute(route) {
if (!route) {
return RouteState.INITIAL;
}
const routes = /** @type {!settings.MinimumRoutes} */ (
settings.Router.getInstance().getRoutes());
if (route === routes.BASIC || route === routes.ABOUT) {
return RouteState.TOP_LEVEL;
}
if (route.isSubpage()) {
return RouteState.SUBPAGE;
}
if (route.isNavigableDialog) {
return RouteState.DIALOG;
}
return RouteState.SECTION;
}
/**
* Responds to route changes by expanding, collapsing, or scrolling to
* sections on the page. Expanded sections take up the full height of the
* container. At most one section should be expanded at any given time.
* @polymerBehavior
*/
/* #export */ const MainPageBehavior = {
properties: {
/**
* Whether a search operation is in progress or previous search results
* are being displayed.
* @private {boolean}
*/
inSearchMode: {
type: Boolean,
value: false,
observer: 'inSearchModeChanged_',
},
},
/** @type {?HTMLElement} */
scroller: null,
/**
* A map holding all valid state transitions.
* @private {!Map<!settings.RouteState, !settings.RouteState>}
*/
validTransitions_: (function() {
const allStates = new Set([
RouteState.DIALOG,
RouteState.SECTION,
RouteState.SUBPAGE,
RouteState.TOP_LEVEL,
]);
return new Map([
[RouteState.INITIAL, allStates],
[
RouteState.DIALOG, new Set([
RouteState.SECTION,
RouteState.SUBPAGE,
RouteState.TOP_LEVEL,
])
],
[RouteState.SECTION, allStates],
[RouteState.SUBPAGE, allStates],
[RouteState.TOP_LEVEL, allStates],
]);
})(),
/** @override */
attached() {
this.scroller = this.domHost ? this.domHost.parentNode : document.body;
},
/**
* Method to be defined by users of MainPageBehavior.
* @param {!settings.Route} route
* @return {boolean} Whether the given route is part of |this| page.
*/
containsRoute(route) {
return false;
},
/**
* @param {boolean} current
* @param {boolean} previous
* @private
*/
inSearchModeChanged_(current, previous) {
// Ignore 1st occurrence which happens while the element is being
// initialized.
if (previous === undefined) {
return;
}
if (!this.inSearchMode) {
const route = settings.Router.getInstance().getCurrentRoute();
if (this.containsRoute(route) &&
classifyRoute(route) === RouteState.SECTION) {
// Re-fire the showing-section event to trigger settings-main
// recalculation of the overscroll, now that sections are not
// hidden-by-search.
this.fire('showing-section', this.getSection(route.section));
}
}
},
/**
* @param {!settings.Route} route
* @return {boolean}
* @private
*/
shouldExpandAdvanced_(route) {
const routes = /** @type {!settings.MinimumRoutes} */ (
settings.Router.getInstance().getRoutes());
return (this.tagName === 'OS-SETTINGS-PAGE') &&
routes.ADVANCED && routes.ADVANCED.contains(route);
},
/**
* Finds the settings section corresponding to the given route. If the
* section is lazily loaded it force-renders it.
* Note: If the section resides within "advanced" settings, a
* 'hide-container' event is fired (necessary to avoid flashing). Callers
* are responsible for firing a 'show-container' event.
* @param {!settings.Route} route
* @return {!Promise<!SettingsSectionElement>}
* @private
*/
ensureSectionForRoute_(route) {
const section = this.getSection(route.section);
if (section !== null) {
return Promise.resolve(section);
}
// The function to use to wait for <dom-if>s to render.
const waitFn = Polymer.RenderStatus.beforeNextRender.bind(null, this);
return new Promise(resolve => {
if (this.shouldExpandAdvanced_(route)) {
this.fire('hide-container');
waitFn(() => {
this.$$('#advancedPageTemplate').get().then(() => {
resolve(this.getSection(route.section));
});
});
} else {
waitFn(() => {
resolve(this.getSection(route.section));
});
}
});
},
/**
* @param {!settings.Route} route
* @private
*/
enterSubpage_(route) {
this.lastScrollTop_ = this.scroller.scrollTop;
this.scroller.scrollTop = 0;
this.classList.add('showing-subpage');
this.fire('subpage-expand');
// Explicitly load the lazy_load.html module, since all subpages reside in
// the lazy loaded module.
/* #ignore */ Polymer.importHref(
/* #ignore */ '/chromeos/lazy_load.html', () => {});
// TODO(jonmann): Implement lazy loading in Polymer 3.
// Polymer 3 codepath, do not delete next line comment.
// #polymer3 // ensureLazyLoaded();
this.ensureSectionForRoute_(route).then(section => {
section.classList.add('expanded');
// Fire event used by a11y tests only.
this.fire('settings-section-expanded');
this.fire('show-container');
});
},
/**
* @param {!settings.Route} oldRoute
* @return {!Promise<void>}
* @private
*/
enterMainPage_(oldRoute) {
const oldSection = this.getSection(oldRoute.section);
oldSection.classList.remove('expanded');
this.classList.remove('showing-subpage');
return new Promise((res, rej) => {
requestAnimationFrame(() => {
if (settings.Router.getInstance().lastRouteChangeWasPopstate()) {
this.scroller.scrollTop = this.lastScrollTop_;
}
this.fire('showing-main-page');
res();
});
});
},
/**
* @param {!settings.Route} route
* @private
*/
scrollToSection_(route) {
this.ensureSectionForRoute_(route).then(section => {
if (!this.inSearchMode) {
this.fire('showing-section', section);
}
this.fire('show-container');
});
},
/**
* Detects which state transition is appropriate for the given new/old
* routes.
* @param {!settings.Route} newRoute
* @param {settings.Route} oldRoute
* @private
*/
getStateTransition_(newRoute, oldRoute) {
const containsNew = this.containsRoute(newRoute);
const containsOld = this.containsRoute(oldRoute);
if (!containsNew && !containsOld) {
// Nothing to do, since none of the old/new routes belong to this page.
return null;
}
// Case where going from |this| page to an unrelated page. For example:
// |this| is os-settings-page AND
// oldRoute is /searchEngines AND
// newRoute is /help.
if (containsOld && !containsNew) {
return [classifyRoute(oldRoute), RouteState.TOP_LEVEL];
}
// Case where return from an unrelated page to |this| page. For example:
// |this| is os-settings-page AND
// oldRoute is /help AND
// newRoute is /searchEngines
if (!containsOld && containsNew) {
return [RouteState.TOP_LEVEL, classifyRoute(newRoute)];
}
// Case where transitioning between routes that both belong to |this|
// page.
return [classifyRoute(oldRoute), classifyRoute(newRoute)];
},
/**
* @param {!settings.Route} newRoute
* @param {settings.Route} oldRoute
*/
currentRouteChanged(newRoute, oldRoute) {
const transition = this.getStateTransition_(newRoute, oldRoute);
if (transition === null) {
return;
}
const oldState = transition[0];
const newState = transition[1];
assert(this.validTransitions_.get(oldState).has(newState));
if (oldState === RouteState.TOP_LEVEL) {
if (newState === RouteState.SECTION) {
this.scrollToSection_(newRoute);
} else if (newState === RouteState.SUBPAGE) {
this.enterSubpage_(newRoute);
}
// Nothing to do here for the case of RouteState.DIALOG or TOP_LEVEL.
// The latter happens when navigating from '/?search=foo' to '/'
// (clearing search results).
return;
}
if (oldState === RouteState.SECTION) {
if (newState === RouteState.SECTION) {
this.scrollToSection_(newRoute);
} else if (newState === RouteState.SUBPAGE) {
this.enterSubpage_(newRoute);
} else if (newState === RouteState.TOP_LEVEL) {
this.scroller.scrollTop = 0;
}
// Nothing to do here for the case of RouteState.DIALOG.
return;
}
if (oldState === RouteState.SUBPAGE) {
if (newState === RouteState.SECTION) {
this.enterMainPage_(oldRoute);
// Scroll to the corresponding section, only if the user explicitly
// navigated to a section (via the menu).
if (!settings.Router.getInstance().lastRouteChangeWasPopstate()) {
this.scrollToSection_(newRoute);
}
} else if (newState === RouteState.SUBPAGE) {
// Handle case where the two subpages belong to
// different sections, but are linked to each other. For example
// /storage and /accounts (in ChromeOS).
if (!oldRoute.contains(newRoute) && !newRoute.contains(oldRoute)) {
this.enterMainPage_(oldRoute).then(() => {
this.enterSubpage_(newRoute);
});
return;
}
// Handle case of subpage to sub-subpage navigation.
if (oldRoute.contains(newRoute)) {
this.scroller.scrollTop = 0;
return;
}
// When going from a sub-subpage to its parent subpage, scroll
// position is automatically restored, because we focus the
// sub-subpage entry point.
} else if (newState === RouteState.TOP_LEVEL) {
this.enterMainPage_(oldRoute);
} else if (newState === RouteState.DIALOG) {
// The only known case currently for such a transition is from
// /storage to /clearBrowserData.
this.enterMainPage_(oldRoute);
}
return;
}
if (oldState === RouteState.INITIAL) {
if (newState === RouteState.SECTION) {
this.scrollToSection_(newRoute);
} else if (newState === RouteState.SUBPAGE) {
this.enterSubpage_(newRoute);
}
// Nothing to do here for the case of RouteState.DIALOG and TOP_LEVEL.
return;
}
if (oldState === RouteState.DIALOG) {
if (newState === RouteState.SUBPAGE) {
// The only known case currently for such a transition is from
// /clearBrowserData back to /storage.
this.enterSubpage_(newRoute);
}
// Nothing to do for all other cases.
}
},
/**
* TODO(dpapad): Rename this to |querySection| to distinguish it from
* ensureSectionForRoute_() which force-renders the section as needed.
* Helper function to get a section from the local DOM.
* @param {string} section Section name of the element to get.
* @return {?SettingsSectionElement}
*/
getSection(section) {
if (!section) {
return null;
}
return /** @type {?SettingsSectionElement} */ (
this.$$(`settings-section[section="${section}"]`));
},
};
// #cr_define_end
return {MainPageBehavior, RouteState};
});
chrome/browser/resources/settings/chromeos/os_settings_page/os_settings_page.html
View file @ c529c8f3
......@@ -4,7 +4,6 @@
<link rel="import" href="chrome://resources/cr_elements/hidden_style_css.html">
<link rel="import" href="chrome://resources/cr_elements/shared_vars_css.html">
<link rel="import" href="chrome://resources/html/web_ui_listener_behavior.html">
<link rel="import" href="main_page_behavior.html">
<link rel="import" href="../os_a11y_page/os_a11y_page.html">
<link rel="import" href="../os_apps_page/android_apps_browser_proxy.html">
<link rel="import" href="../os_apps_page/os_apps_page.html">
......@@ -12,6 +11,7 @@
<link rel="import" href="../os_search_page/os_search_page.html">
<link rel="import" href="../personalization_page/personalization_page.html">
<link rel="import" href="../../controls/settings_idle_load.html">
<link rel="import" href="../../settings_page/main_page_behavior.html">
<link rel="import" href="../../settings_page/settings_section.html">
<link rel="import" href="../../settings_page_css.html">
<link rel="import" href="../bluetooth_page/bluetooth_page.html">
......
chrome/browser/resources/settings/os_settings_resources.grd
View file @ c529c8f3
......@@ -412,10 +412,10 @@
file="settings_page_css.html"
compress="false" type="chrome_html" />
<structure name="IDR_OS_SETTINGS_MAIN_PAGE_BEHAVIOR_HTML"
file="chromeos/os_settings_page/main_page_behavior.html"
file="settings_page/main_page_behavior.html"
compress="false" type="chrome_html" />
<structure name="IDR_OS_SETTINGS_MAIN_PAGE_BEHAVIOR_JS"
file="chromeos/os_settings_page/main_page_behavior.js"
file="settings_page/main_page_behavior.js"
compress="false" type="chrome_html"
preprocess="true" />
<structure name="IDR_OS_SETTINGS_SETTINGS_VARS_CSS_HTML"
......
chrome/browser/resources/settings/settings_page/main_page_behavior.js
View file @ c529c8f3
......@@ -9,7 +9,6 @@
// #import {Route, Router, MinimumRoutes} from '../router.m.js';
// clang-format on
// TODO(dpapad): Fully migrate this file to polymer 3.
cr.define('settings', function() {
/**
* @enum {string}
......@@ -148,7 +147,12 @@ cr.define('settings', function() {
shouldExpandAdvanced_(route) {
const routes = /** @type {!settings.MinimumRoutes} */ (
settings.Router.getInstance().getRoutes());
return this.tagName === 'SETTINGS-BASIC-PAGE' &&
return (
this.tagName === 'SETTINGS-BASIC-PAGE'
// <if expr="chromeos">
|| this.tagName === 'OS-SETTINGS-PAGE'
// </if>
) &&
routes.ADVANCED && routes.ADVANCED.contains(route);
},
......@@ -199,8 +203,16 @@ cr.define('settings', function() {
// Explicitly load the lazy_load.html module, since all subpages reside in
// the lazy loaded module.
// TODO(dpapad): On chrome://os-settings the lazy_load.html file resides
// at a different path. Remove conditional logic once this file is not
// shared between chrome://settings and chrome://os-settings.
// Polymer 2 codepath
/* #ignore */ Polymer.importHref('/lazy_load.html', () => {});
/* #ignore */ const lazyLoadPathPrefix =
/* #ignore */ window.location.origin === 'chrome://settings' ?
/* #ignore */ '' :
/* #ignore */ '/chromeos';
/* #ignore */ Polymer.importHref(
/* #ignore */ `${lazyLoadPathPrefix}/lazy_load.html`, () => {});
// Polymer 3 codepath, do not delete next line comment.
// #polymer3 ensureLazyLoaded();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment