com.oracle.truffle.js.nodes.promise.AsyncHandlerRootNode Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2020, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.oracle.truffle.js.nodes.promise;

import com.oracle.truffle.api.TruffleStackTraceElement;
import com.oracle.truffle.js.runtime.builtins.JSFunctionObject;
import com.oracle.truffle.js.runtime.objects.JSDynamicObject;

/**
 * Implemented by built-in promise handler functions that contribute to async stack traces.
 */
public interface AsyncHandlerRootNode {
    /**
     * Extract the stack trace element and the promise associated with this handler, both optional.
     *
     * @param handlerFunction The handler callback function of the promise reaction.
     */
    default AsyncStackTraceInfo getAsyncStackTraceInfo(JSFunctionObject handlerFunction) {
        return new AsyncStackTraceInfo();
    }

    /**
     * Extract the stack trace element and the promise associated with this handler, both optional.
     * This method is only called for a promise reaction job which is associated with an argument.
     * Otherwise, the argument-less method is called instead.
     *
     * @param handlerFunction The handler callback function of this promise reaction job.
     * @param argument The argument the promise reaction handler was called with.
     */
    default AsyncStackTraceInfo getAsyncStackTraceInfo(JSFunctionObject handlerFunction, Object argument) {
        return getAsyncStackTraceInfo(handlerFunction);
    }

    final class AsyncStackTraceInfo {
        public final JSDynamicObject promise;
        public final TruffleStackTraceElement stackTraceElement;

        public AsyncStackTraceInfo(JSDynamicObject promise, TruffleStackTraceElement stackTraceElement) {
            this.promise = promise;
            this.stackTraceElement = stackTraceElement;
        }

        public AsyncStackTraceInfo() {
            this(null, null);
        }
    }
}