Enhancement: Selenium Grid Capability

[msghasan]

Signed-off-by: Maimur Hasan [email protected]

Thanks for contributing to StormCrawler, your efforts are appreciated!

Developer Certificate of Origin

By contributing to StormCrawler, you accept and agree to the following terms and conditions (the Developer Certificate of Origin) for your present and future contributions submitted to StormCrawler.
Please refer to the Developer Certificate of Origin section in CONTRIBUTING.md for details.

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Before opening a PR, please check that:

• You've squashed your commits into a single one
• You've described what the PR does or at least point to a related issue
• You've signed-ff your commits with 'git commit -s'
• The code is properly formatted with 'mvn git-code-format:format-code -Dgcf.globPattern=**/*'

Thanks!

[msghasan]

missed a commit

[jnioche]

Thanks @msghasan! Very kind of you to share your work with the community

A few initial comments

• Formatting a bit off, please run mvn git-code-format:format-code -Dgcf.globPattern=**/* prior to committing
• Would be good to explain your approach in a comment in the PR + explain how you tested it
• remove config commented out Elastic/opensearch modules and add it to https://github.com/DigitalPebble/storm-crawler/blob/master/core/src/main/resources/crawler-default.yaml instead
• remove change to URLFrontier which is unrelated
• Add tests, possibly extending what we recently added in https://github.com/DigitalPebble/storm-crawler/blob/master/core/src/test/java/com/digitalpebble/stormcrawler/protocol/selenium/ProtocolTest.java

[msghasan]

@jnioche
I did all the changes you requested. But for writing a test it is not possible, i think the funcitonality of grid is not available with testcontainers.

testcontainers/testcontainers-java#5185

[msghasan]

Pull Request #1023 Explanation: Enhancing Selenium Grid Capability in Storm Crawler

This pull request aims to improve the functionality of Selenium Grid within the Storm Crawler framework. The implementation involves incorporating a Selenium Grid web address for retrieving remote objects. The key components include two classes: SeleniumGrid.java and its corresponding implementation, SeleniumGridImpl.java.

To manage the number of available browsers in the grid, a LinkedBlockingQueue is utilized. A dynamic check is performed every 5 minutes to ascertain the activity status of the driver object in the queue. We check the session id of the driver ojbect over the grid if it is available we keep the driver else we delete and create new drivers.

The implementation employs a Holder POJO class to store timing information for a driver object and the corresponding driver object added to the queue. In the event of non-session-related exceptions, specifically those arising from website loading issues, the browser object is not discarded; instead, it is reused within the queue.

Testing Approach:

Docker image of Selenium Grid was executed.
The crawler was initiated to assess the proper functioning of the grid and ensure pages were loading successfully.
The page http://gridhost/ui was visited to verify page loading (password: "secret" without quotes).
Grid status was checked at http://gridhost/status.
Through this method, the page source and screenshot of the page were successfully retrieved.
These testing steps were instrumental in validating the effectiveness of the enhanced Selenium Grid functionality in the Storm Crawler.

[jnioche]

@jnioche I did all the changes you requested. But for writing a test it is not possible, i think the funcitonality of grid is not available with testcontainers.

testcontainers/testcontainers-java#5185

I think it does expose the grid. I ran the existing test, called [http://localhost:32779/ui] (the port number might be different) and got the Grid UI. It would have only one node running on it but still, worth using it to test

[rzo1]

Can we implement something similar to RemoteDriverProtocol in order to test without running an actual SC crawl?

[jnioche]

Happy new year @msghasan!
Any change you could have a look at the remaining comments from @rzo1? It would be good to include your work in the next release.

[jnioche]

Closing because of lack of activity. Can be reopen later if someone wants to pick it up