com.xceptance.xlt.engine.XltDebugger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation

XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.

There is a newer version: 8.1.0

/*
 * Copyright (c) 2005-2022 Xceptance Software Technologies GmbH
 *
 * 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.xceptance.xlt.engine;

import net.sourceforge.htmlunit.corejs.javascript.debug.Debugger;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gargoylesoftware.htmlunit.WebClient;
import com.gargoylesoftware.htmlunit.javascript.DebugFrameImpl;
import com.gargoylesoftware.htmlunit.javascript.DebuggerImpl;
import com.gargoylesoftware.htmlunit.javascript.JavaScriptEngine;

/**
 * An implementation of Rhino's {@link Debugger} interface which can attach itself to a {@link WebClient} object to
 * receive JS debug events.
 */
public class XltDebugger extends DebuggerImpl
{
    /**
     * The logger to which debug messages will be printed.
     */
    private static final Logger debugFrameLogger = LoggerFactory.getLogger(DebugFrameImpl.class);

    /**
     * The original log level. Used to restore the log level.
     */
    // private static final Level defaultDebugFrameLogLevel = debugFrameLogger.getLevel();

    /**
     * The web client to which to attach the debugger if enabled.
     */
    private final WebClient webClient;

    /**
     * Whether the debugger is enabled.
     */
    private boolean enabled;

    public XltDebugger(final WebClient webClient)
    {
        this.webClient = webClient;
    }

    public boolean isEnabled()
    {
        return enabled;
    }

    public void setEnabled(final boolean enabled)
    {
        this.enabled = enabled;

        if (enabled)
        {
            // register this debugger with the web client
            ((JavaScriptEngine) webClient.getJavaScriptEngine()).getContextFactory().setDebugger(this);

            // switch the logger to level TRACE, otherwise we won't see anything
            // TODO: can't do this at the logging facade
            // debugFrameLogger.setLevel(Level.TRACE);
        }
        else
        {
            // unbind this debugger from the web client
            ((JavaScriptEngine) webClient.getJavaScriptEngine()).getContextFactory().setDebugger(null);

            // don't reset the log level as this might shut up the debugger of parallel users
            // debugFrameLogger.setLevel(defaultDebugFrameLogLevel);
        }
    }
}