#coding:utf-8
"""
ID:          issue-7350
ISSUE:       https://github.com/FirebirdSQL/firebird/issues/7350
TITLE:       SKIP LOCKED clause for SELECT WITH LOCK, UPDATE and DELETE
DESCRIPTION: test verifies ability to get records from table which already has several locked rows by another transaction.
             Check performs for several type of queries:
                 1) DSQL 
                 2) PSQL which uses static SQL code
                 3) PSQL which uses ES/EDS mechanism.
             Two type of access mode is checked: READ and READ_WRITE
             Both WAIT and NO WAIT modes are used, but for WAIT we have to skip exectuion for TABLE STABILITY.
             All kinds of transaction isolation levels are involved: TABLE STABILITY; SNAPSHOT; RC READ_CONSISTENCY; RC REC_VER and RC NO_REC_VER.
NOTES:
    [22.11.2023] pzotov
    1. Parameter ReadConsistency in firebird.conf must be set to 0, i.e. NOT-default value.
    2. TIL = "RC NO_record_version" can be used to check feature since gh-7811 was fixed (20.11.2023 in master)
    3. Only persistent table is checked. For session-level GTT (using two transactions for single attach)
       it is unable to run 'select ... with lock' or 'update/delete ... skip locked': exception raises with message
       "SQLSTATE = HY000 / Cannot select temporary table ... WITH LOCK"
       Discussed with dimitr and hvlad, 13.09.2023
    4. Added WAIT mode to be checked after fixed https://github.com/FirebirdSQL/firebird/issues/7700
       ( https://github.com/FirebirdSQL/firebird/commit/5b14baa37b6ee214cd8ccc21f2e99dce119fe60e )
       NOTE: before fix gh-7700, following statement hanged:
         set transaction read committed record_version WAIT;
         select id from test order by id with lock skip locked
    5. Here we check only 'SELECT ... WITH LOCK' behavour. Results of UPDATE and DELETE are checked in gh_7810_test.py

    [25.11.2023] pzotov
    Writing code requires more care since 6.0.0.150: ISQL does not allow to specify THE SAME terminator twice,
    i.e.
    set term @; select 1 from rdb$database @ set term @; - will not compile ("Unexpected end of command" raises).

    Checked on 6.0.0.137 (SS/CS), 5.0.0.1274 (SS/CS).

    [27.11.2023] pzotov
    Removed branched for 5.x vs 6.x, code now the same for 5.x and 6.x
    Checked on 5.0.0.1280 (intermediate build 27.11.2023, after backporting, commit dc2d85c17b41fb6c378bffc0896338c4f8856998).
"""

import pytest
from firebird.qa import *
from firebird.driver import tpb, Isolation, TraLockResolution, TraAccessMode, DatabaseError
import time

db = db_factory()
substitutions = [ ('transaction number is \\d+', 'transaction number is'),
                  ("-At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL' line.*", "-At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'"),
                  ("-At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE' line.*", "-At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'"),
                  ('Data source : Firebird::localhost:.*', 'Data source : Firebird::localhost:')
                ]
act = python_act('db', substitutions = substitutions)

CHECK_SQL = 'select id from test order by id with lock skip locked'

expected_stdout = f"""
    QUERY_TYPE = DSQL, TIL = SERIALIZABLE, ACCESS = READ, WAIT = NO_WAIT:
    lock conflict on no wait transaction
    -Acquire lock for relation (TEST) failed
    -901
    335544345
    335544382
    QUERY_TYPE = DSQL, TIL = SNAPSHOT, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = SNAPSHOT, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -817
    335544361
    QUERY_TYPE = DSQL, TIL = SERIALIZABLE, ACCESS = WRITE, WAIT = NO_WAIT:
    lock conflict on no wait transaction
    -Acquire lock for relation (TEST) failed
    -901
    335544345
    335544382
    QUERY_TYPE = DSQL, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = DSQL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = SERIALIZABLE, ACCESS = READ, WAIT = NO_WAIT:
    lock conflict on no wait transaction
    -Acquire lock for relation (TEST) failed
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -901
    335544345
    335544382
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = SNAPSHOT, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = SNAPSHOT, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    attempted update during read-only transaction
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -817
    335544361
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = SERIALIZABLE, ACCESS = WRITE, WAIT = NO_WAIT:
    lock conflict on no wait transaction
    -Acquire lock for relation (TEST) failed
    -At procedure 'SP_GET_UNLOCKED_ROWS_LOCAL'
    -901
    335544345
    335544382
    335544842
    QUERY_TYPE = PSQL_LOCAL, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_LOCAL, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = SERIALIZABLE, ACCESS = READ, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544345 : lock conflict on no wait transaction
    335544382 : Acquire lock for relation (TEST) failed
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = SNAPSHOT, ACCESS = READ, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = SNAPSHOT, ACCESS = READ, WAIT = WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = READ, WAIT = WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = READ, WAIT = WAIT:
    Execute statement error at isc_dsql_fetch :
    335544361 : attempted update during read-only transaction
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = SERIALIZABLE, ACCESS = WRITE, WAIT = NO_WAIT:
    Execute statement error at isc_dsql_fetch :
    335544345 : lock conflict on no wait transaction
    335544382 : Acquire lock for relation (TEST) failed
    Statement : select id from test order by id with lock skip locked
    Data source : Firebird::localhost:
    -At procedure 'SP_GET_UNLOCKED_ROWS_REMOTE'
    -901
    335544926
    335544842
    QUERY_TYPE = PSQL_REMOTE, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = SNAPSHOT, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_READ_CONSISTENCY, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = NO_WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
    QUERY_TYPE = PSQL_REMOTE, TIL = READ_COMMITTED_NO_RECORD_VERSION, ACCESS = WRITE, WAIT = WAIT:
    ID=2
    ID=3
    ID=4
    ID=6
    ID=7
    ID=8
    ID=10
"""

@pytest.mark.es_eds
@pytest.mark.version('>=5.0')
def test_1(act: Action, capsys):

    init_sql = f"""
        set term ^;
        recreate table test(id int primary key, f01 int)
        -- recreate global temporary table test(id int primary key, f01 int) on commit preserve rows
        ^
        create or alter procedure sp_get_unlocked_rows_local returns(id int) as
        begin
            for
                {CHECK_SQL}
                into id
            do
                suspend;
        end
        ^
        create or alter procedure sp_get_unlocked_rows_remote returns(id int) as
        begin
            for
                execute statement '{CHECK_SQL}'
                on external 'localhost:' || rdb$get_context('SYSTEM', 'DB_NAME')
                as user '{act.db.user}' password '{act.db.password}'
                into id
            do
                suspend;
        end
        ^
        set term ;^
        commit;

        insert into test(id, f01) select row_number()over(), 0 from rdb$types rows 10;
        commit;
    """ 
    act.isql(switches=['-q'], input = init_sql, combine_output = True)
    assert act.clean_stdout == ''
    act.reset()

    tpb_isol_set = (Isolation.SERIALIZABLE, Isolation.SNAPSHOT, Isolation.READ_COMMITTED_READ_CONSISTENCY, Isolation.READ_COMMITTED_RECORD_VERSION, Isolation.READ_COMMITTED_NO_RECORD_VERSION)
    tpb_wait_set = (TraLockResolution.NO_WAIT,TraLockResolution.WAIT)
    tpb_mode_set = (TraAccessMode.READ, TraAccessMode.WRITE)
    query_types_set = ('DSQL', 'PSQL_LOCAL', 'PSQL_REMOTE')

    with act.db.connect() as con_rows_locker, act.db.connect() as con_free_seeker:
        con_rows_locker.execute_immediate('update test set f01 = 1 where id in (1,5,9)')
        for query_type in query_types_set:
            for x_mode in tpb_mode_set:
                for x_isol in tpb_isol_set:
                    for x_wait in tpb_wait_set:
                        skip_flag = x_isol in (Isolation.SERIALIZABLE,) and x_wait == TraLockResolution.WAIT
                        if skip_flag:
                            
                            #######################################
                            ###    D O    N O T    C H E C K    ###
                            #######################################
                            #
                            # 1. Isolation.SERIALIZABLE requires that the whole table must not be changed by anyone else.
                            # 2. [WAS ACTUAL BEFORE GH-7810 FIXED; CURRENTLY REMAINS NEEDED FB 5.X]
                            #    Isolation.READ_COMMITTED_NO_RECORD_VERSION can not be used due to implementation details, see:
                            #    Adriano, 26-feb-2023, https://github.com/FirebirdSQL/firebird/pull/7350#issuecomment-1445408462
                            #    "WITH LOCK [SKIP LOCKED] needs a record read before, but this locked records cannot be read with NO RECORD VERSION.
                            #    Considering that this transaction mode is replaced by default I would only document it as in fact I don't think
                            #    there are anything we could do."

                            continue

                        custom_tpb = tpb(isolation = x_isol, access_mode = x_mode, lock_timeout = -1 if x_wait == TraLockResolution.WAIT else 0)
                        #custom_tpb = TPB(isolation = x_isol, access_mode = x_mode, lock_timeout = 0).get_buffer()
                        tx_free_seeker = con_free_seeker.transaction_manager(custom_tpb)
                        cur_free_seeker = tx_free_seeker.cursor()
                        tx_free_seeker.begin()
                        try:
                            print('\n')
                            print(f'QUERY_TYPE = {query_type}, TIL = {x_isol.name}, ACCESS = {x_mode.name}, WAIT = {x_wait.name}:')
                            if query_type == 'DSQL':
                                cur_free_seeker.execute(f'{CHECK_SQL}')
                            elif query_type == 'PSQL_LOCAL':
                                cur_free_seeker.execute('select id from sp_get_unlocked_rows_local')
                            elif query_type == 'PSQL_REMOTE':
                                cur_free_seeker.execute('select id from sp_get_unlocked_rows_remote')
                            for r in cur_free_seeker:
                                 print('ID='+str(r[0]))
                        except DatabaseError as e:
                            print(e.__str__())
                            print(e.sqlcode)
                            for g in e.gds_codes:
                                print(g)
                        finally:
                            tx_free_seeker.rollback()

    act.expected_stdout = expected_stdout
    act.stdout = capsys.readouterr().out
    assert act.clean_stdout == act.clean_expected_stdout