Python script promise_to always got error "No library '<Browser.browser.Browser object at 0x...>' found."

[Massukio]

Describe the bug
Python script promise_to always got error "No library '<Browser.browser.Browser object at 0x...>' found."

To Reproduce
test.py

from robot.api.deco import keyword
from Browser import Browser

@keyword
def test_keyword():
    lib = Browser()
    lib.new_browser(headless=False)
    lib.new_page(url='http://www.google.com')
    promise = lib.promise_to('Wait For Response')
    body = lib.wait_for(promise)

test.robot

*** Settings ***
Library  test.py

*** Test Cases ***
Test
    Test Keyword

test.robot result

==============================================================================
Test
==============================================================================
Test                                                                  | FAIL |
No library '<Browser.browser.Browser object at 0x000001B127FC01F0>' found.    
------------------------------------------------------------------------------
Test                                                                  | FAIL |
1 test, 0 passed, 1 failed
==============================================================================

Expected behavior
Run keyword succeed and the promise_to works properly

Desktop (please complete the following information):

• OS: Windows 10
• Browser: chrome
• Version: robotframework-browser==11.1.1

Additional context
Use the "Promise To" in robot file, the test can be executed and pass properly

test2.robot

*** Settings ***
Library  Browser

*** Test Cases ***
Test
    New Browser
    New Page    url=http://www.google.com
    ${promise}=  Promise To    Wait For Response
    ${body}=  Wait For  ${promise}

test2.robot result

==============================================================================
Test2
==============================================================================
Test                                                                  | PASS |
------------------------------------------------------------------------------
Test2                                                                 | PASS |
1 test, 1 passed, 0 failed
==============================================================================

[aaltat]

@allcontributors please add @Massukio for bugs

[allcontributors]

@aaltat

I've put up a pull request to add @Massukio! 🎉

[aaltat]

This is true and I can reproduce the problem. The problem lies in here, library expect that it is imported in RF side and finds itself. Most likely you can workaround the problem by importing the Browser library in RF side and using this
lib = BuiltIn().get_library_instance("Browser").

But your way should be made possible and therefore I am considering this a bug.

[luchoagomezt]

This is true and I can reproduce the problem. The problem lies in here, library expect that it is imported in RF side and finds itself. Most likely you can workaround the problem by importing the Browser library in RF side and using this lib = BuiltIn().get_library_instance("Browser").

But your way should be made possible and therefore I am considering this a bug.

@aaltat hello, I would like to help fixing this issue. Are the instructions in CONTRIBUTING.md all that I need to follow?

[aaltat]

Well, we do not have any specific guidelines. How to setup dev environment is explained in https://github.com/MarketSquare/robotframework-browser/blob/main/CONTRIBUTING.md#development-environment Please ask if you find problems or inconsistencies.

[luchoagomezt]

Well, we do not have any specific guidelines. How to setup dev environment is explained in https://github.com/MarketSquare/robotframework-browser/blob/main/CONTRIBUTING.md#development-environment Please ask if you find problems or inconsistencies.

Thanks, I create a local branch and tried to push it up stream, I received the following error:

remote: Permission to MarketSquare/robotframework-browser.git denied to luchoagomezt.
fatal: unable to access 'https://github.com/MarketSquare/robotframework-browser.git/': The requested URL returned error: 403

Do I need an authorization?

---

I added a test case to the code and ran inv utest, the error message shows that EXECUTION_CONTEXTS.current is a None object.

  browser_lib = EXECUTION_CONTEXTS.current.namespace._kw_store.get_library(

        self.library
    )

E AttributeError: 'NoneType' object has no attribute 'namespace'

args = ()
kw = 'Wait For Response'
self = <Browser.keywords.promises.Promises object at 0x000002455A810370>

Browser\keywords\promises.py:50: AttributeError

It looks like the code is trying to get the library, from a Robot Framework's global variable, should instead a reference to the playwright wrapper?

[aaltat]

remote: Permission to MarketSquare/robotframework-browser.git denied to luchoagomezt.
fatal: unable to access 'https://github.com/MarketSquare/robotframework-browser.git/': The requested URL returned error: 403

Darn, we have not document this part and we should. Well in mean time.
We do not allow direct push to the repository, instead you need to fork the repository and create a pull request. GitHub has documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork

I added a test case to the code and ran inv utest, the error message shows that EXECUTION_CONTEXTS.current is a
None object.

I remember when that was made, but it is some RF internal magic, which I am unfamiliar of. Perhaps summoning @Snooz82 @xylix or @mkorpela could share light why that is done like that. Also why we just do not use available library instance directly.

[luchoagomezt]

I remember when that was made, but it is some RF internal magic, which I am unfamiliar of. Perhaps summoning @Snooz82 @xylix or @mkorpela could share light why that is done like that. Also why we just do not use available library instance direct

I found that there isn't an entry for Promise To in playwrigt.proto, I believe this is this is required

[aaltat]

I found that there isn't an entry for Promise To in playwrigt.proto, I believe this is this is required

It is not needed, that keyword runs only in Python land.

[Snooz82]

I am not really on track, but Robot specific things can not be tested in pure python, without Robot execution context.

One thing that came to my mind to also import the library from a python lib would be first call BuiltIn().import_library and then get the imported Browser instance with BuiltIn().get_library_instance

Also had Browser these Listener features running, that only work with robot execution context.

Maybe we should mark the keywords that are only executable with execution context?!

Stuff like registering a keyword for failures male also no sense when running from pure python.

another thing to test would be Browser lib with RemoteLibrary...

[aaltat]

We do promote our Python API and this bug prevents extending library when promises are used. That is pretty big bug. Running our library trough Python unit test is just easy way to demonstrate the problem and there is also example which uses RF as executor.

I did look the code and it makes pretty big assumptions about the usage. Also I think there is room for improving the code. The failing part is the code which gets the arguments from Robot Framework, but it might be possible to solve that problem in other ways, example the argument specification is available in PLC.

[luchoagomezt]

We do promote our Python API and this bug prevents extending library when promises are used. That is pretty big bug. Running our library trough Python unit test is just easy way to demonstrate the problem and there is also example which uses RF as executor.

I did look the code and it makes pretty big assumptions about the usage. Also I think there is room for improving the code. The failing part is the code which gets the arguments from Robot Framework, but it might be possible to solve that problem in other ways, example the argument specification is available in PLC.

Thanks for the link to the PLC, I am studying the code now.

the following is a possible solution:

    if EXECUTION_CONTEXTS.current:
        browser_lib = EXECUTION_CONTEXTS.current.namespace._kw_store.get_library(
            self.library
        )
        handler = browser_lib.handlers[kw]
        positional, named = handler.resolve_arguments(
            args, EXECUTION_CONTEXTS.current.variables
        )
        named = dict(named)

        promise = self._executor.submit(handler.current_handler(), *positional, **named)
    else:
        # in this example the following line is using a hard coded method, I might use a dictionary to generalize this code
        promise = self._executor.submit(self._wait_for_download, *args)

    self.unresolved_promises.add(promise)
    while not (promise.running() or promise.done()):
        sleep(0.01)
    return promise