This repository contains the main components of the Common Search backend.
Your help is welcome! We have a complete guide on how to contribute.
This repository has 4 components:
- cosrlib: Python code for parsing, analyzing and indexing documents
- jobs: Spark jobs using cosrlib.
- urlserver: A service for getting metadata about URLs from static databases
- explainer: A web service for explaining and debugging results, hosted at explain.commonsearch.org
Here is how they fit in our general architecture:
Running cosr-back on your local machine is very simple. You only need to have Docker installed.
Once Docker is launched, just run:
make start_services
make docker_shell
You will enter the main container with the ability to run the tests or launch Spark jobs.
Make sure to start the services (make start_services) before trying any tests.
Inside Docker, you can run our full test suite easily:
make test
Alternatively, you can run it from outside Docker with:
make docker_test
You may also want to run only part of the tests, for instance all which do not use Elasticsearch:
py.test tests/ -v -m "not elasticsearch"
If you want to evaluate the speed of a component, for instance HTML parsing, you can repeat the tests N times and output a Python profile:
py.test tests/cosrlibtests/document/html/ -v --repeat 50 --profile
spark-submit jobs/spark/index.py --warc_limit 1 --only_homepages --profile
After this, if you have a cosr-front instance connected to the same Elasticsearch service, you will see the results!
The explainer allows you to debug results easily. Just run:
make docker_explainer
Then open http://192.168.99.100:9703 in your browser (Assuming 192.168.99.100 is the IP of your Docker host)
If for some reason you don't want to use Docker, you might be able to use your local Python install to run cosr-back. Please note that this is an unsupported method and might break at any time.
You would have to install the dependencies manually: Spark (symlinked in ./spark/), rocksdb, gumbo. Then:
make virtualenv
source venv/bin/activate
make import_local_testdata
make test