/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.runtime.taskmanager;

import org.apache.flink.api.common.JobStatus;
import org.apache.flink.api.common.time.Deadline;
import org.apache.flink.configuration.Configuration;
import org.apache.flink.configuration.MemorySize;
import org.apache.flink.configuration.NettyShuffleEnvironmentOptions;
import org.apache.flink.configuration.TaskManagerOptions;
import org.apache.flink.runtime.execution.CancelTaskException;
import org.apache.flink.runtime.execution.Environment;
import org.apache.flink.runtime.io.network.api.writer.RecordWriter;
import org.apache.flink.runtime.io.network.api.writer.RecordWriterBuilder;
import org.apache.flink.runtime.io.network.api.writer.ResultPartitionWriter;
import org.apache.flink.runtime.io.network.partition.ResultPartitionType;
import org.apache.flink.runtime.io.network.partition.consumer.InputGate;
import org.apache.flink.runtime.jobgraph.DistributionPattern;
import org.apache.flink.runtime.jobgraph.JobGraph;
import org.apache.flink.runtime.jobgraph.JobGraphTestUtils;
import org.apache.flink.runtime.jobgraph.JobVertex;
import org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable;
import org.apache.flink.runtime.jobmanager.scheduler.SlotSharingGroup;
import org.apache.flink.runtime.minicluster.MiniCluster;
import org.apache.flink.runtime.testutils.InternalMiniClusterExtension;
import org.apache.flink.runtime.testutils.MiniClusterResourceConfiguration;
import org.apache.flink.test.junit5.InjectMiniCluster;
import org.apache.flink.testutils.TestingUtils;
import org.apache.flink.testutils.executor.TestExecutorExtension;
import org.apache.flink.types.LongValue;
import org.apache.flink.util.TestLoggerExtension;
import org.apache.flink.util.concurrent.FutureUtils;
import org.apache.flink.util.concurrent.ScheduledExecutorServiceAdapter;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.extension.RegisterExtension;

import java.time.Duration;
import java.util.Arrays;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;

import static org.apache.flink.runtime.io.network.buffer.BufferBuilderTestUtils.isInBlockingBufferRequest;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;

@ExtendWith({TestLoggerExtension.class})
public class TaskCancelAsyncProducerConsumerITCase {

    @RegisterExtension
    static final TestExecutorExtension<ScheduledExecutorService> EXECUTOR_RESOURCE =
            TestingUtils.defaultExecutorExtension();

    // The Exceptions thrown by the producer/consumer Threads
    private static volatile Exception ASYNC_PRODUCER_EXCEPTION;
    private static volatile Exception ASYNC_CONSUMER_EXCEPTION;

    // The Threads producing/consuming the intermediate stream
    private static volatile Thread ASYNC_PRODUCER_THREAD;
    private static volatile Thread ASYNC_CONSUMER_THREAD;

    @RegisterExtension
    private static final InternalMiniClusterExtension MINI_CLUSTER_RESOURCE =
            new InternalMiniClusterExtension(
                    new MiniClusterResourceConfiguration.Builder()
                            .setConfiguration(getFlinkConfiguration())
                            .build());

    private static Configuration getFlinkConfiguration() {
        Configuration config = new Configuration();
        config.set(TaskManagerOptions.MEMORY_SEGMENT_SIZE, MemorySize.parse("4096"));
        config.set(NettyShuffleEnvironmentOptions.NETWORK_NUM_BUFFERS, 9);
        return config;
    }

    /**
     * Tests that a task waiting on an async producer/consumer that is stuck in a blocking buffer
     * request can be properly cancelled.
     *
     * <p>This is currently required for the Flink Kafka sources, which spawn a separate Thread
     * consuming from Kafka and producing the intermediate streams in the spawned Thread instead of
     * the main task Thread.
     */
    @Test
    public void testCancelAsyncProducerAndConsumer(@InjectMiniCluster MiniCluster flink)
            throws Exception {
        Deadline deadline = Deadline.now().plus(Duration.ofMinutes(2));

        // Job with async producer and consumer
        JobVertex producer = new JobVertex("AsyncProducer");
        producer.setParallelism(1);
        producer.setInvokableClass(AsyncProducer.class);

        JobVertex consumer = new JobVertex("AsyncConsumer");
        consumer.setParallelism(1);
        consumer.setInvokableClass(AsyncConsumer.class);
        consumer.connectNewDataSetAsInput(
                producer, DistributionPattern.POINTWISE, ResultPartitionType.PIPELINED);

        SlotSharingGroup slot = new SlotSharingGroup();
        producer.setSlotSharingGroup(slot);
        consumer.setSlotSharingGroup(slot);

        JobGraph jobGraph = JobGraphTestUtils.streamingJobGraph(producer, consumer);

        // Submit job and wait until running
        flink.runDetached(jobGraph);

        FutureUtils.retrySuccessfulWithDelay(
                        () -> flink.getJobStatus(jobGraph.getJobID()),
                        Duration.ofMillis(10),
                        deadline,
                        status -> status == JobStatus.RUNNING,
                        new ScheduledExecutorServiceAdapter(EXECUTOR_RESOURCE.getExecutor()))
                .get(deadline.timeLeft().toMillis(), TimeUnit.MILLISECONDS);

        boolean producerBlocked = false;
        for (int i = 0; i < 50; i++) {
            Thread thread = ASYNC_PRODUCER_THREAD;

            if (thread != null && thread.isAlive()) {
                StackTraceElement[] stackTrace = thread.getStackTrace();
                producerBlocked = isInBlockingBufferRequest(stackTrace);
            }

            if (producerBlocked) {
                break;
            } else {
                // Retry
                Thread.sleep(500L);
            }
        }

        // Verify that async producer is in blocking request
        assertTrue(
                "Producer thread is not blocked: "
                        + Arrays.toString(ASYNC_PRODUCER_THREAD.getStackTrace()),
                producerBlocked);

        boolean consumerWaiting = false;
        for (int i = 0; i < 50; i++) {
            Thread thread = ASYNC_CONSUMER_THREAD;

            if (thread != null && thread.isAlive()) {
                consumerWaiting = thread.getState() == Thread.State.WAITING;
            }

            if (consumerWaiting) {
                break;
            } else {
                // Retry
                Thread.sleep(500L);
            }
        }

        // Verify that async consumer is in blocking request
        assertTrue("Consumer thread is not blocked.", consumerWaiting);

        flink.cancelJob(jobGraph.getJobID())
                .get(deadline.timeLeft().toMillis(), TimeUnit.MILLISECONDS);

        // wait until the job is canceled
        FutureUtils.retrySuccessfulWithDelay(
                        () -> flink.getJobStatus(jobGraph.getJobID()),
                        Duration.ofMillis(10),
                        deadline,
                        status -> status == JobStatus.CANCELED,
                        new ScheduledExecutorServiceAdapter(EXECUTOR_RESOURCE.getExecutor()))
                .get(deadline.timeLeft().toMillis(), TimeUnit.MILLISECONDS);

        // Verify the expected Exceptions
        assertNotNull(ASYNC_PRODUCER_EXCEPTION);
        assertEquals(CancelTaskException.class, ASYNC_PRODUCER_EXCEPTION.getClass());

        assertNotNull(ASYNC_CONSUMER_EXCEPTION);
        assertEquals(IllegalStateException.class, ASYNC_CONSUMER_EXCEPTION.getClass());
    }

    /** Invokable emitting records in a separate Thread (not the main Task thread). */
    public static class AsyncProducer extends AbstractInvokable {

        public AsyncProducer(Environment environment) {
            super(environment);
        }

        @Override
        public void invoke() throws Exception {
            Thread producer = new ProducerThread(getEnvironment().getWriter(0));

            // Publish the async producer for the main test Thread
            ASYNC_PRODUCER_THREAD = producer;

            producer.start();

            // Wait for the producer Thread to finish. This is executed in the
            // main Task thread and will be interrupted on cancellation.
            while (producer.isAlive()) {
                try {
                    producer.join();
                } catch (InterruptedException ignored) {
                }
            }
        }

        /** The Thread emitting the records. */
        private static class ProducerThread extends Thread {

            private final RecordWriter<LongValue> recordWriter;

            public ProducerThread(ResultPartitionWriter partitionWriter) {
                this.recordWriter = new RecordWriterBuilder<LongValue>().build(partitionWriter);
            }

            @Override
            public void run() {
                LongValue current = new LongValue(0);

                try {
                    while (true) {
                        current.setValue(current.getValue() + 1);
                        recordWriter.emit(current);
                        recordWriter.flushAll();
                    }
                } catch (Exception e) {
                    ASYNC_PRODUCER_EXCEPTION = e;
                }
            }
        }
    }

    /** Invokable consuming buffers in a separate Thread (not the main Task thread). */
    public static class AsyncConsumer extends AbstractInvokable {

        public AsyncConsumer(Environment environment) {
            super(environment);
        }

        @Override
        public void invoke() throws Exception {
            Thread consumer = new ConsumerThread(getEnvironment().getInputGate(0));

            // Publish the async consumer for the main test Thread
            ASYNC_CONSUMER_THREAD = consumer;

            consumer.start();

            // Wait for the consumer Thread to finish. This is executed in the
            // main Task thread and will be interrupted on cancellation.
            while (consumer.isAlive()) {
                try {
                    consumer.join();
                } catch (InterruptedException ignored) {
                }
            }
        }

        /** The Thread consuming buffers. */
        private static class ConsumerThread extends Thread {

            private final InputGate inputGate;

            public ConsumerThread(InputGate inputGate) {
                this.inputGate = inputGate;
            }

            @Override
            public void run() {
                try {
                    while (true) {
                        inputGate.getNext();
                    }
                } catch (Exception e) {
                    ASYNC_CONSUMER_EXCEPTION = e;
                }
            }
        }
    }
}
