/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.internal.id.indexed;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.DynamicTest.dynamicTest;
import static org.junit.jupiter.params.provider.Arguments.arguments;
import static org.neo4j.internal.id.indexed.IdRange.BITSET_COMMIT;
import static org.neo4j.internal.id.indexed.IdRange.BITSET_RESERVED;
import static org.neo4j.internal.id.indexed.IdRange.BITSET_REUSE;
import static org.neo4j.internal.id.indexed.IdRange.BITSET_SIZE;
import static org.neo4j.internal.id.indexed.IdRange.IdState.DELETED;
import static org.neo4j.internal.id.indexed.IdRange.IdState.FREE;
import static org.neo4j.internal.id.indexed.IdRange.IdState.USED;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Stream;
import org.apache.commons.lang3.tuple.Pair;
import org.eclipse.collections.impl.factory.primitive.LongLists;
import org.junit.jupiter.api.DynamicTest;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestFactory;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.Arguments;
import org.junit.jupiter.params.provider.MethodSource;
import org.neo4j.internal.id.indexed.IdRange.IdState;
import org.neo4j.test.RandomSupport;
import org.neo4j.test.extension.Inject;
import org.neo4j.test.extension.RandomExtension;

@ExtendWith(RandomExtension.class)
class IdRangeTest {
    @Inject
    private RandomSupport random;

    @Test
    void defaultStateIsUsed() {
        final var idRange = new IdRange(1);
        assertEquals(USED, idRange.getState(0));
    }

    @Test
    void setAndGet() {
        IdRange idRange = new IdRange(1);
        IdRange merger = new IdRange(1);
        assertEquals(USED, idRange.getState(0));

        merger.clear(1, true);
        merger.setBits(BITSET_COMMIT, 0, 1);
        idRange.mergeFrom(null, merger, false);
        assertEquals(DELETED, idRange.getState(0));

        merger.clear(1, true);
        merger.setBits(BITSET_REUSE, 0, 1);
        idRange.mergeFrom(null, merger, false);
        assertEquals(FREE, idRange.getState(0));

        merger.clear(1, false);
        merger.setBitsForAllTypes(0, 1);
        idRange.mergeFrom(null, merger, false);
        assertEquals(USED, idRange.getState(0));
    }

    @Test
    void clear() {
        final var idRange = new IdRange(1);
        idRange.setBits(BITSET_REUSE, 0, 1);
        idRange.setBits(BITSET_COMMIT, 1, 1);
        idRange.clear(1, false);
        assertEquals(USED, idRange.getState(0));
        assertEquals(USED, idRange.getState(1));
        assertEquals(USED, idRange.getState(2));
    }

    @TestFactory
    Collection<DynamicTest> merge() {
        return Arrays.asList(
                // USED -> USED is special case because 00 is the default initial state for any ID
                dynamicTest("USED -> USED", () -> testMerge(USED, USED, USED, false)),
                dynamicTest("USED -> DELETED", () -> testMerge(USED, DELETED, DELETED, false)),
                dynamicTest("USED -> FREE", () -> testMerge(USED, FREE, USED, false)),
                dynamicTest("DELETED -> USED", () -> testMerge(DELETED, USED, USED, false)),
                dynamicTest("DELETED -> DELETED", () -> testFailMerge(DELETED, DELETED)),
                dynamicTest("DELETED -> FREE", () -> testMerge(DELETED, FREE, FREE, false)),
                dynamicTest("FREE -> USED", () -> testMerge(FREE, USED, USED, false)),
                dynamicTest("FREE -> DELETED", () -> testMerge(FREE, DELETED, DELETED, false)),
                dynamicTest("FREE -> FREE", () -> testMerge(FREE, FREE, FREE, false)));
    }

    @TestFactory
    Collection<DynamicTest> mergeInRecoveryMode() {
        return Arrays.asList(
                dynamicTest("USED -> USED", () -> testMerge(USED, USED, USED, true)),
                dynamicTest("USED -> DELETED", () -> testMerge(USED, DELETED, DELETED, true)),
                dynamicTest("USED -> FREE", () -> testMerge(USED, FREE, USED, true)),
                dynamicTest("DELETED -> USED", () -> testMerge(DELETED, USED, USED, true)),
                dynamicTest("DELETED -> DELETED", () -> testMerge(DELETED, DELETED, DELETED, true)),
                dynamicTest("DELETED -> FREE", () -> testMerge(DELETED, FREE, FREE, true)),
                dynamicTest("FREE -> USED", () -> testMerge(FREE, USED, USED, true)),
                dynamicTest("FREE -> DELETED", () -> testMerge(FREE, DELETED, DELETED, true)),
                dynamicTest("FREE -> FREE", () -> testMerge(FREE, FREE, FREE, true)));
    }

    @TestFactory
    Collection<DynamicTest> normalize() {
        return Arrays.asList(
                dynamicTest("USED", () -> testNormalize(USED, USED)),
                dynamicTest("DELETED", () -> testNormalize(DELETED, FREE)),
                dynamicTest("FREE", () -> testNormalize(FREE, FREE)),
                dynamicTest("FREE", () -> testNormalize(0x10, USED)));
    }

    @Test
    void shouldDetermineCorrectStateForBitsCombinations() {
        // COMMIT, REUSE, RESERVED
        assertEquals(USED, idStateGetsDeterminedAs(0, 0, 0));
        assertEquals(USED, idStateGetsDeterminedAs(0, 0, 1));
        assertEquals(USED, idStateGetsDeterminedAs(0, 1, 0));
        assertEquals(USED, idStateGetsDeterminedAs(0, 1, 1));
        assertEquals(DELETED, idStateGetsDeterminedAs(1, 0, 0));
        assertEquals(DELETED, idStateGetsDeterminedAs(1, 0, 1));
        assertEquals(FREE, idStateGetsDeterminedAs(1, 1, 0));
        assertEquals(DELETED, idStateGetsDeterminedAs(1, 1, 1));
    }

    @Test
    void shouldNormalizeAllPossibleStatesCorrectly() {
        // COMMIT, REUSE, RESERVED
        assertEquals(USED, idStateGetsNormalizedAs(0, 0, 0));
        assertEquals(USED, idStateGetsNormalizedAs(0, 0, 1));
        assertEquals(USED, idStateGetsNormalizedAs(0, 1, 0));
        assertEquals(USED, idStateGetsNormalizedAs(0, 1, 1));
        assertEquals(FREE, idStateGetsNormalizedAs(1, 0, 0));
        assertEquals(FREE, idStateGetsNormalizedAs(1, 0, 1));
        assertEquals(FREE, idStateGetsNormalizedAs(1, 1, 0));
        assertEquals(FREE, idStateGetsNormalizedAs(1, 1, 1));
    }

    @MethodSource("slotSizesAndOffsets")
    @ParameterizedTest
    void shouldSetCorrectBitsOfVariousSlotSizes(int offset, int slotSize) {
        // given
        IdRange idRange = new IdRange(2);

        // when
        idRange.setBits(BITSET_COMMIT, offset, slotSize);

        // then
        for (int i = 0; i < 128; i++) {
            IdState state = idRange.getState(i);
            IdState expectedState = i >= offset && i < offset + slotSize ? DELETED : USED;
            assertThat(state).isEqualTo(expectedState);
        }
    }

    @Test
    void shouldFindFreeId() {
        // given
        var idRange = new IdRange(2);
        long generation = 2;
        idRange.setGeneration(generation);
        int numBits = random.nextInt(1, 5);
        int bit = random.nextInt(128 - (numBits - 1));
        long baseId = random.nextLong(1_000);
        idRange.setBits(BITSET_COMMIT, bit, numBits);
        idRange.setBits(BITSET_REUSE, bit, numBits);

        // when
        var visitor = new Visitor();
        idRange.visitFreeIds(baseId, generation, visitor);

        // then
        assertThat(visitor.hasId(baseId + bit, numBits)).isTrue();
    }

    @Test
    void shouldNotFindNonFreeId() {
        // given
        var idRange = new IdRange(2);
        long generation = 2;
        idRange.setGeneration(generation);
        int numBits = random.nextInt(1, 5);
        int bit = random.nextInt(128 - (numBits - 1));
        long baseId = random.nextLong(1_000);
        idRange.setBits(BITSET_COMMIT, bit, numBits);

        // when
        var visitor = new Visitor();
        idRange.visitFreeIds(baseId, generation, visitor);

        // then
        assertThat(visitor.numIds()).isZero();
    }

    @Test
    void shouldNotFindFreedReservedId() {
        // given
        var idRange = new IdRange(2);
        long generation = 2;
        idRange.setGeneration(generation);
        int numBits = random.nextInt(1, 5);
        int bit = random.nextInt(128 - (numBits - 1));
        long baseId = random.nextLong(1_000);
        idRange.setBits(BITSET_COMMIT, bit, numBits);
        idRange.setBits(BITSET_REUSE, bit, numBits);
        idRange.setBits(BITSET_RESERVED, bit, numBits);

        // when
        var visitor = new Visitor();
        idRange.visitFreeIds(baseId, generation, visitor);

        // then
        assertThat(visitor.numIds()).isZero();
    }

    @Test
    void shouldFindIdForDifferentGeneration() {
        // given
        var idRange = new IdRange(2);
        long generation = 2;
        idRange.setGeneration(generation);
        int numBits = random.nextInt(1, 5);
        int bit = random.nextInt(128 - (numBits - 1));
        long baseId = random.nextLong(1_000);
        idRange.setBits(BITSET_COMMIT, bit, numBits);

        // when
        var visitor = new Visitor();
        idRange.visitFreeIds(baseId, generation + 1, visitor);

        // then
        assertThat(visitor.hasId(baseId + bit, numBits)).isTrue();
    }

    @Test
    void shouldFindMultipleFreeIds() {
        // given
        var idRange = new IdRange(2);
        long generation = 2;
        idRange.setGeneration(generation);
        var expected = LongLists.mutable.empty();
        long baseId = random.nextLong(1_000);
        for (int i = 0, bit = random.nextInt(10); i < 10; i++, bit += random.nextInt(2, 10)) {
            expected.add(baseId + bit);
            idRange.setBits(BITSET_COMMIT, bit, 1);
            idRange.setBits(BITSET_REUSE, bit, 1);
        }

        // when
        var visitor = new Visitor();
        idRange.visitFreeIds(baseId, generation, visitor);

        // then
        var iterator = expected.longIterator();
        while (iterator.hasNext()) {
            var expectedId = iterator.next();
            assertThat(visitor.hasId(expectedId, 1)).isTrue();
        }
    }

    @Test
    void shouldIncludeCorrectIdRangeOnVerificationError() {
        // given
        var generation = 1L;
        var numLongs = 2;
        var idsPerEntry = numLongs * BITSET_SIZE;
        var idRange = new IdRange(numLongs, idsPerEntry);
        idRange.clear(generation, true);
        var bit = BITSET_SIZE + 5;
        idRange.setBits(BITSET_COMMIT, bit, 1);

        // when
        var addition = new IdRange(numLongs, idsPerEntry);
        addition.clear(generation, true);
        addition.setBits(BITSET_COMMIT, bit, 1);
        var key = new IdRangeKey(3);
        var expectedFirstId = key.getIdRangeIdx() * idsPerEntry + BITSET_SIZE;
        var expectedLastId = expectedFirstId + BITSET_SIZE - 1;
        assertThatThrownBy(() -> idRange.mergeFrom(key, addition, false))
                .hasMessageContaining("IDs %d-%d", expectedFirstId, expectedLastId);
    }

    @Test
    void shouldIncludeCorrectIdRangeOnVerificationErrorForSmallerIdsPerEntry() {
        // given
        var generation = 1L;
        var numLongs = 1;
        var idsPerEntry = BITSET_SIZE / 2;
        var idRange = new IdRange(numLongs, idsPerEntry);
        idRange.clear(generation, true);
        var bit = 7;
        idRange.setBits(BITSET_COMMIT, bit, 1);

        // when
        var addition = new IdRange(numLongs, idsPerEntry);
        addition.clear(generation, true);
        addition.setBits(BITSET_COMMIT, bit, 1);
        var key = new IdRangeKey(3);
        var expectedFirstId = key.getIdRangeIdx() * idsPerEntry;
        var expectedLastId = expectedFirstId + idsPerEntry - 1;
        assertThatThrownBy(() -> idRange.mergeFrom(key, addition, false))
                .hasMessageContaining("IDs %d-%d", expectedFirstId, expectedLastId);
    }

    private static Stream<Arguments> slotSizesAndOffsets() {
        List<Arguments> permutations = new ArrayList<>();
        for (int s = 1; s < 128; s++) {
            for (int o = 0; o < 128 - s; o++) {
                permutations.add(arguments(o, s));
            }
        }
        return permutations.stream();
    }

    private IdState idStateGetsNormalizedAs(int commitBit, int reuseBit, int reservedBit) {
        int numLongs = random.nextInt(1, 3);
        int offset = random.nextInt(numLongs * Long.SIZE);
        IdRange idRange = idRange(numLongs, offset, commitBit, reuseBit, reservedBit);
        idRange.normalize();
        return idRange.getState(offset);
    }

    private IdState idStateGetsDeterminedAs(int commitBit, int reuseBit, int reservedBit) {
        int numLongs = random.nextInt(1, 3);
        int offset = random.nextInt(numLongs * Long.SIZE);
        IdRange idRange = idRange(numLongs, offset, commitBit, reuseBit, reservedBit);
        return idRange.getState(offset);
    }

    private static IdRange idRange(int numLongs, int offset, int commitBit, int reuseBit, int reservedBit) {
        IdRange idRange = new IdRange(numLongs);
        potentiallySetBit(idRange, BITSET_COMMIT, commitBit, offset);
        potentiallySetBit(idRange, BITSET_REUSE, reuseBit, offset);
        potentiallySetBit(idRange, BITSET_RESERVED, reservedBit, offset);
        return idRange;
    }

    private static void potentiallySetBit(IdRange idRange, int type, int value, int offset) {
        if (value == 1) {
            idRange.setBits(type, offset, 1);
        }
    }

    private static void testNormalize(IdState beforeState, IdState afterState) {
        // given
        var range = initialIdRange(beforeState);

        // when
        range.normalize();

        // then
        assertEquals(afterState, range.getState(0));
    }

    private static void testNormalize(int beforeState, IdState afterState) {
        // given
        var range = new IdRange(1);
        range.clear(1, true);
        if ((beforeState & 0x01) != 0) {
            range.setBits(BITSET_COMMIT, 0, 1);
        }
        if ((beforeState & 0x10) != 0) {
            range.setBits(BITSET_REUSE, 0, 1);
        }

        // when
        range.normalize();

        // then
        assertEquals(afterState, range.getState(0));
    }

    private static void testFailMerge(IdState intoState, IdState fromState) {
        var into = initialIdRange(intoState);
        var from = idRange(intoState, fromState);
        assertThrows(
                IllegalStateException.class,
                () -> into.mergeFrom(new IdRangeKey(0), from, false),
                intoState + "!" + fromState);
    }

    private static void testMerge(IdState intoState, IdState fromState, IdState expected, boolean recoveryMode) {
        var into = initialIdRange(intoState);
        var from = idRange(intoState, fromState);
        into.mergeFrom(new IdRangeKey(0), from, recoveryMode);
        var actual = into.getState(0);
        assertEquals(expected, actual);
    }

    private static IdRange initialIdRange(IdState state) {
        final var idRange = new IdRange(1);
        switch (state) {
            case FREE:
                idRange.setBits(BITSET_REUSE, 0, 1);
            case DELETED:
                idRange.setBits(BITSET_COMMIT, 0, 1);
            case USED:
                break;
            default:
                throw new UnsupportedOperationException(state.name());
        }
        return idRange;
    }

    private static IdRange idRange(IdState intoState, IdState state) {
        final var idRange = new IdRange(1);
        switch (state) {
            case USED:
                idRange.clear(1, false);
                idRange.setBitsForAllTypes(0, 1);
                break;
            case DELETED:
                if (intoState == FREE) {
                    // If we're going from FREE to DELETED, the transition is to remove the reuse bit
                    idRange.clear(1, false);
                    idRange.setBits(BITSET_REUSE, 0, 1);
                } else {
                    // If we're going from USED to DELETED, the transition is to add the commit bit
                    idRange.clear(1, true);
                    idRange.setBits(BITSET_COMMIT, 0, 1);
                }
                break;
            case FREE:
                idRange.clear(1, true);
                idRange.setBits(BITSET_REUSE, 0, 1);
                break;
            default:
                throw new UnsupportedOperationException(state.name());
        }
        return idRange;
    }

    private static class Visitor implements IdRange.FreeIdVisitor {
        private final Set<Pair<Long, Integer>> ids = new HashSet<>();

        @Override
        public boolean visitFreeId(long id, int numberOfIds) {
            boolean added = ids.add(Pair.of(id, numberOfIds));
            assertThat(added).isTrue();
            return true;
        }

        private boolean hasId(long id, int numBits) {
            return ids.contains(Pair.of(id, numBits));
        }

        int numIds() {
            return ids.size();
        }
    }
}
