/*
 * Copyright (c) 2020, 2020, 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.trufflenode.test;

import com.oracle.truffle.api.Option;
import com.oracle.truffle.api.TruffleContext;
import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.instrumentation.ContextsListener;
import com.oracle.truffle.api.instrumentation.ExecutionEventNode;
import com.oracle.truffle.api.instrumentation.SourceSectionFilter;
import com.oracle.truffle.api.instrumentation.StandardTags;
import com.oracle.truffle.api.instrumentation.TruffleInstrument;
import com.oracle.truffle.api.interop.InteropLibrary;
import com.oracle.truffle.api.interop.UnknownIdentifierException;
import com.oracle.truffle.api.interop.UnsupportedMessageException;
import com.oracle.truffle.api.interop.UnsupportedTypeException;
import com.oracle.truffle.api.nodes.LanguageInfo;
import com.oracle.truffle.js.nodes.instrumentation.JSTags;
import org.graalvm.options.OptionCategory;
import org.graalvm.options.OptionDescriptors;
import org.graalvm.options.OptionKey;

@Option.Group(ForeignCallTestingInstrument.ID)
@TruffleInstrument.Registration(id = ForeignCallTestingInstrument.ID, name = "Test Instrument", services = {ForeignCallTestingInstrument.class})
public class ForeignCallTestingInstrument extends TruffleInstrument implements ContextsListener {
    static final String ID = "testing-agent";
    private TruffleInstrument.Env env;

    public ForeignCallTestingInstrument() {
        super();
    }

    @Option(name = "", help = "Enable testing instrument.", category = OptionCategory.USER) //
    static final OptionKey<Boolean> ENABLED = new OptionKey<>(true);

    @Override
    protected OptionDescriptors getOptionDescriptors() {
        return new ForeignCallTestingInstrumentOptionDescriptors();
    }

    @Override
    protected void onCreate(final TruffleInstrument.Env environment) {
        this.env = environment;
        environment.getInstrumenter().attachContextsListener(this, false);
        environment.registerService(this);
        SourceSectionFilter sourceSectionFilter = SourceSectionFilter.newBuilder().tagIs(JSTags.ALL).build();
        SourceSectionFilter inputGeneratingObjects = SourceSectionFilter.newBuilder().tagIs(
                        StandardTags.ExpressionTag.class,
                        StandardTags.StatementTag.class,
                        JSTags.InputNodeTag.class).build();
        environment.getInstrumenter().attachExecutionEventFactory(sourceSectionFilter, inputGeneratingObjects, context -> new ExecutionEventNode() {
            @Child private InteropLibrary dispatch = InteropLibrary.getFactory().createDispatched(5);

            @Override
            public void onEnter(VirtualFrame frame) {
                /*
                 * Simulate an instrumentation agent that executes JS callbacks (via interop) for
                 * every expression executed. The call does not have side effects and should not
                 * affect the application's execution semantics.
                 */
                try {
                    InteropLibrary interopLibrary = InteropLibrary.getFactory().getUncached();
                    if (interopLibrary.isMemberReadable(env.getPolyglotBindings(), "emptyFunction")) {
                        Object func = interopLibrary.readMember(env.getPolyglotBindings(), "emptyFunction");
                        dispatch.execute(func);
                    }
                } catch (Exception e) {
                    throw new AssertionError(e);
                }
            }
        });
    }

    @Override
    public void onLanguageContextInitialized(TruffleContext context, LanguageInfo language) {
        // Leak a global value that can be used by tests to assert that the instrumentation agent is
        // enabled.
        try {
            InteropLibrary.getFactory().getUncached().writeMember(env.getPolyglotBindings(), "testingControlValue", 42);
        } catch (UnsupportedMessageException | UnknownIdentifierException | UnsupportedTypeException e) {
            throw new AssertionError(e);
        }
    }

    @Override
    protected void onDispose(final TruffleInstrument.Env environment) {
    }

    @Override
    public void onContextCreated(TruffleContext context) {
    }

    @Override
    public void onLanguageContextCreated(TruffleContext context, LanguageInfo language) {
    }

    @Override
    public void onLanguageContextFinalized(TruffleContext context, LanguageInfo language) {
    }

    @Override
    public void onLanguageContextDisposed(TruffleContext context, LanguageInfo language) {
    }

    @Override
    public void onContextClosed(TruffleContext context) {
    }
}