123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413 |
- /*
- * Copyright 2000-2014 Vaadin Ltd.
- *
- * 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.
- */
-
- package com.vaadin.client;
-
- import java.util.ArrayList;
- import java.util.Collections;
- import java.util.Comparator;
- import java.util.HashMap;
- import java.util.LinkedHashMap;
- import java.util.LinkedList;
- import java.util.Map;
- import java.util.logging.Logger;
-
- import com.google.gwt.core.client.Duration;
- import com.google.gwt.core.client.JavaScriptObject;
- import com.google.gwt.core.client.JsArray;
- import com.google.gwt.core.shared.GWT;
- import com.vaadin.client.debug.internal.ProfilerSection.Node;
- import com.vaadin.client.debug.internal.ProfilerSection.ProfilerResultConsumer;
-
- /**
- * Lightweight profiling tool that can be used to collect profiling data with
- * zero overhead unless enabled. To enable profiling, add
- * <code><set-property name="vaadin.profiler" value="true" /></code> to
- * your .gwt.xml file.
- *
- * @author Vaadin Ltd
- * @since 7.0.0
- */
- public class Profiler {
- /**
- * Class to include using deferred binding to enable the profiling.
- *
- * @author Vaadin Ltd
- * @since 7.0.0
- */
- public static class EnabledProfiler extends Profiler {
- @Override
- protected boolean isImplEnabled() {
- return true;
- }
- }
-
- private static final String evtGroup = "VaadinProfiler";
-
- private static final class GwtStatsEvent extends JavaScriptObject {
- protected GwtStatsEvent() {
- // JSO constructor
- }
-
- private native String getEvtGroup()
- /*-{
- return this.evtGroup;
- }-*/;
-
- private native double getMillis()
- /*-{
- return this.millis;
- }-*/;
-
- private native String getSubSystem()
- /*-{
- return this.subSystem;
- }-*/;
-
- private native String getType()
- /*-{
- return this.type;
- }-*/;
-
- private native String getModuleName()
- /*-{
- return this.moduleName;
- }-*/;
-
- public final String getEventName() {
- String group = getEvtGroup();
- if (evtGroup.equals(group)) {
- return getSubSystem();
- } else {
- return group + "." + getSubSystem();
- }
- }
- }
-
- private static ProfilerResultConsumer consumer;
-
- /**
- * Checks whether the profiling gathering is enabled.
- *
- * @return <code>true</code> if the profiling is enabled, else
- * <code>false</code>
- */
- public static boolean isEnabled() {
- // This will be fully inlined by the compiler
- Profiler create = GWT.create(Profiler.class);
- return create.isImplEnabled();
- }
-
- /**
- * Enters a named block. There should always be a matching invocation of
- * {@link #leave(String)} when leaving the block. Calls to this method will
- * be removed by the compiler unless profiling is enabled.
- *
- * @param name
- * the name of the entered block
- */
- public static void enter(String name) {
- if (isEnabled()) {
- logGwtEvent(name, "begin");
- }
- }
-
- /**
- * Leaves a named block. There should always be a matching invocation of
- * {@link #enter(String)} when entering the block. Calls to this method will
- * be removed by the compiler unless profiling is enabled.
- *
- * @param name
- * the name of the left block
- */
- public static void leave(String name) {
- if (isEnabled()) {
- logGwtEvent(name, "end");
- }
- }
-
- private static native final void logGwtEvent(String name, String type)
- /*-{
- $wnd.__gwtStatsEvent({
- evtGroup: @com.vaadin.client.Profiler::evtGroup,
- moduleName: @com.google.gwt.core.client.GWT::getModuleName()(),
- millis: (new Date).getTime(),
- sessionId: undefined,
- subSystem: name,
- type: type
- });
- }-*/;
-
- /**
- * Resets the collected profiler data. Calls to this method will be removed
- * by the compiler unless profiling is enabled.
- */
- public static void reset() {
- if (isEnabled()) {
- /*
- * Old implementations might call reset for initialization, so
- * ensure it is initialized here as well. Initialization has no side
- * effects if already done.
- */
- initialize();
-
- clearEventsList();
- }
- }
-
- /**
- * Initializes the profiler. This should be done before calling any other
- * function in this class. Failing to do so might cause undesired behavior.
- * This method has no side effects if the initialization has already been
- * done.
- * <p>
- * Please note that this method should be called even if the profiler is not
- * enabled because it will then remove a logger function that might have
- * been included in the HTML page and that would leak memory unless removed.
- * </p>
- *
- * @since 7.0.2
- */
- public static void initialize() {
- if (isEnabled()) {
- ensureLogger();
- } else {
- ensureNoLogger();
- }
- }
-
- /**
- * Outputs the gathered profiling data to the debug console.
- */
- public static void logTimings() {
- if (!isEnabled()) {
- getLogger().warning(
- "Profiler is not enabled, no data has been collected.");
- return;
- }
-
- LinkedList<Node> stack = new LinkedList<Node>();
- Node rootNode = new Node(null);
- stack.add(rootNode);
- JsArray<GwtStatsEvent> gwtStatsEvents = getGwtStatsEvents();
- if (gwtStatsEvents.length() == 0) {
- getLogger()
- .warning(
- "No profiling events recorded, this might happen if another __gwtStatsEvent handler is installed.");
- return;
- }
-
- for (int i = 0; i < gwtStatsEvents.length(); i++) {
- GwtStatsEvent gwtStatsEvent = gwtStatsEvents.get(i);
- String eventName = gwtStatsEvent.getEventName();
- String type = gwtStatsEvent.getType();
- boolean isBeginEvent = "begin".equals(type);
-
- Node stackTop = stack.getLast();
- boolean inEvent = eventName.equals(stackTop.getName())
- && !isBeginEvent;
-
- if (!inEvent && stack.size() >= 2
- && eventName.equals(stack.get(stack.size() - 2).getName())
- && !isBeginEvent) {
- // back out of sub event
- stackTop.leave(gwtStatsEvent.getMillis());
- stack.removeLast();
- stackTop = stack.getLast();
-
- inEvent = true;
- }
-
- if (type.equals("end")) {
- if (!inEvent) {
- getLogger().severe(
- "Got end event for " + eventName
- + " but is currently in "
- + stackTop.getName());
- return;
- }
- Node previousStackTop = stack.removeLast();
- previousStackTop.leave(gwtStatsEvent.getMillis());
- } else {
- if (!inEvent) {
- stackTop = stackTop.enterChild(eventName,
- gwtStatsEvent.getMillis());
- stack.add(stackTop);
- }
- if (!isBeginEvent) {
- // Create sub event
- stack.add(stackTop.enterChild(eventName + "." + type,
- gwtStatsEvent.getMillis()));
- }
- }
- }
-
- if (stack.size() != 1) {
- getLogger().warning(
- "Not all nodes are left, the last node is "
- + stack.getLast().getName());
- return;
- }
-
- Map<String, Node> totals = new HashMap<String, Node>();
- rootNode.sumUpTotals(totals);
-
- ArrayList<Node> totalList = new ArrayList<Node>(totals.values());
- Collections.sort(totalList, new Comparator<Node>() {
- @Override
- public int compare(Node o1, Node o2) {
- return (int) (o2.getTimeSpent() - o1.getTimeSpent());
- }
- });
-
- if (getConsumer() != null) {
- getConsumer().addProfilerData(stack.getFirst(), totalList);
- }
- }
-
- /**
- * Overridden in {@link EnabledProfiler} to make {@link #isEnabled()} return
- * true if GWT.create returns that class.
- *
- * @return <code>true</code> if the profiling is enabled, else
- * <code>false</code>
- */
- protected boolean isImplEnabled() {
- return false;
- }
-
- /**
- * Outputs the time passed since various events recored in
- * performance.timing if supported by the browser.
- */
- public static void logBootstrapTimings() {
- if (isEnabled()) {
- double now = Duration.currentTimeMillis();
-
- StringBuilder stringBuilder = new StringBuilder(
- "Time since window.performance.timing events");
- SimpleTree tree = new SimpleTree(stringBuilder.toString());
-
- String[] keys = new String[] { "navigationStart",
- "unloadEventStart", "unloadEventEnd", "redirectStart",
- "redirectEnd", "fetchStart", "domainLookupStart",
- "domainLookupEnd", "connectStart", "connectEnd",
- "requestStart", "responseStart", "responseEnd",
- "domLoading", "domInteractive",
- "domContentLoadedEventStart", "domContentLoadedEventEnd",
- "domComplete", "loadEventStart", "loadEventEnd" };
-
- LinkedHashMap<String, Double> timings = new LinkedHashMap<String, Double>();
-
- for (String key : keys) {
- double value = getPerformanceTiming(key);
- if (value == 0) {
- // Ignore missing value
- continue;
- }
- timings.put(key, Double.valueOf(now - value));
- }
-
- if (timings.isEmpty()) {
- getLogger()
- .info("Bootstrap timings not supported, please ensure your browser supports performance.timing");
- return;
- }
-
- if (getConsumer() != null) {
- getConsumer().addBootstrapData(timings);
- }
- }
- }
-
- private static final native double getPerformanceTiming(String name)
- /*-{
- if ($wnd.performance && $wnd.performance.timing && $wnd.performance.timing[name]) {
- return $wnd.performance.timing[name];
- } else {
- return 0;
- }
- }-*/;
-
- private static native JsArray<GwtStatsEvent> getGwtStatsEvents()
- /*-{
- return $wnd.vaadin.gwtStatsEvents || [];
- }-*/;
-
- /**
- * Add logger if it's not already there, also initializing the event array
- * if needed.
- */
- private static native void ensureLogger()
- /*-{
- if (typeof $wnd.__gwtStatsEvent != 'function') {
- if (typeof $wnd.vaadin.gwtStatsEvents != 'object') {
- $wnd.vaadin.gwtStatsEvents = [];
- }
- $wnd.__gwtStatsEvent = function(event) {
- $wnd.vaadin.gwtStatsEvents.push(event);
- return true;
- }
- }
- }-*/;
-
- /**
- * Remove logger function and event array if it seems like the function has
- * been added by us.
- */
- private static native void ensureNoLogger()
- /*-{
- if (typeof $wnd.vaadin.gwtStatsEvents == 'object') {
- delete $wnd.vaadin.gwtStatsEvents;
- if (typeof $wnd.__gwtStatsEvent == 'function') {
- $wnd.__gwtStatsEvent = function(){};
- }
- }
- }-*/;
-
- private static native JsArray<GwtStatsEvent> clearEventsList()
- /*-{
- $wnd.vaadin.gwtStatsEvents = [];
- }-*/;
-
- /**
- * Sets the profiler result consumer that is used to output the profiler
- * data to the user.
- * <p>
- * <b>Warning!</b> This is internal API and should not be used by
- * applications or add-ons.
- *
- * @since 7.1.4
- * @param profilerResultConsumer
- * the consumer that gets profiler data
- */
- public static void setProfilerResultConsumer(
- ProfilerResultConsumer profilerResultConsumer) {
- if (consumer != null) {
- throw new IllegalStateException("The consumer has already been set");
- }
- consumer = profilerResultConsumer;
- }
-
- private static ProfilerResultConsumer getConsumer() {
- return consumer;
- }
-
- private static Logger getLogger() {
- return Logger.getLogger(Profiler.class.getName());
- }
-
- }
|