Run a StemWeb algorithm and fetch results (backend)

[tla]

Description

Reimplement the functionality to send data to Stemweb and receive the results. This needs both frontend and backend work.

Requirements

• Integrate the docker stack of Stemweb into that of Stemmaweb
• Create middleware endpoint to interact with Stemweb's API
• Create a service class StemwebService on the frontend to access Stemweb through the middleware

[peter-gy]

@tla Could you please clarify what is meant by this issue exactly? It is possible that I have already implemented this without referencing this issue in the corresponding PR.

[tla]

This is yet another service (DHUniWien/Stemweb) that runs through stemmaweb (and has its own set of containers in the docker stack). You haven't implemented it; we can discuss it further at the next meeting.

[peter-gy]

Ok perfect, I am looking forward to getting more details about the service. I thought that this issue was referring to the main result fetching after a user visits the home page.

[peter-gy]

I dumped all available routes of Stemweb for future reference:

Path	View Function	URL Name
/	Stemweb.home.views.home
/admin/	django.contrib.admin.sites.index	admin:index
/admin/<app_label>/	django.contrib.admin.sites.app_index	admin:app_list
/admin/	django.contrib.admin.sites.catch_all_view
/admin/algorithms/algorithm/	django.contrib.admin.options.changelist_view	admin:algorithms_algorithm_changelist
/admin/algorithms/algorithm/path:object_id/	django.views.generic.base.RedirectView
/admin/algorithms/algorithm/path:object_id/change/	django.contrib.admin.options.change_view	admin:algorithms_algorithm_change
/admin/algorithms/algorithm/path:object_id/delete/	django.contrib.admin.options.delete_view	admin:algorithms_algorithm_delete
/admin/algorithms/algorithm/path:object_id/history/	django.contrib.admin.options.history_view	admin:algorithms_algorithm_history
/admin/algorithms/algorithm/add/	django.contrib.admin.options.add_view	admin:algorithms_algorithm_add
/admin/algorithms/algorithmarg/	django.contrib.admin.options.changelist_view	admin:algorithms_algorithmarg_changelist
/admin/algorithms/algorithmarg/path:object_id/	django.views.generic.base.RedirectView
/admin/algorithms/algorithmarg/path:object_id/change/	django.contrib.admin.options.change_view	admin:algorithms_algorithmarg_change
/admin/algorithms/algorithmarg/path:object_id/delete/	django.contrib.admin.options.delete_view	admin:algorithms_algorithmarg_delete
/admin/algorithms/algorithmarg/path:object_id/history/	django.contrib.admin.options.history_view	admin:algorithms_algorithmarg_history
/admin/algorithms/algorithmarg/add/	django.contrib.admin.options.add_view	admin:algorithms_algorithmarg_add
/admin/auth/group/	django.contrib.admin.options.changelist_view	admin:auth_group_changelist
/admin/auth/group/path:object_id/	django.views.generic.base.RedirectView
/admin/auth/group/path:object_id/change/	django.contrib.admin.options.change_view	admin:auth_group_change
/admin/auth/group/path:object_id/delete/	django.contrib.admin.options.delete_view	admin:auth_group_delete
/admin/auth/group/path:object_id/history/	django.contrib.admin.options.history_view	admin:auth_group_history
/admin/auth/group/add/	django.contrib.admin.options.add_view	admin:auth_group_add
/admin/auth/user/	django.contrib.admin.options.changelist_view	admin:auth_user_changelist
/admin/auth/user//password/	django.contrib.auth.admin.user_change_password	admin:auth_user_password_change
/admin/auth/user/path:object_id/	django.views.generic.base.RedirectView
/admin/auth/user/path:object_id/change/	django.contrib.admin.options.change_view	admin:auth_user_change
/admin/auth/user/path:object_id/delete/	django.contrib.admin.options.delete_view	admin:auth_user_delete
/admin/auth/user/path:object_id/history/	django.contrib.admin.options.history_view	admin:auth_user_history
/admin/auth/user/add/	django.contrib.auth.admin.add_view	admin:auth_user_add
/admin/autocomplete/	django.contrib.admin.sites.autocomplete_view	admin:autocomplete
/admin/doc/	django.contrib.admindocs.views.BaseAdminDocsView	django-admindocs-docroot
/admin/doc/bookmarklets/	django.contrib.admindocs.views.BookmarkletsView	django-admindocs-bookmarklets
/admin/doc/filters/	django.contrib.admindocs.views.TemplateFilterIndexView	django-admindocs-filters
/admin/doc/models/	django.contrib.admindocs.views.ModelIndexView	django-admindocs-models-index
/admin/doc/models/<app_label>.<model_name>/	django.contrib.admindocs.views.ModelDetailView	django-admindocs-models-detail
/admin/doc/tags/	django.contrib.admindocs.views.TemplateTagIndexView	django-admindocs-tags
/admin/doc/templates/path:template/	django.contrib.admindocs.views.TemplateDetailView	django-admindocs-templates
/admin/doc/views/	django.contrib.admindocs.views.ViewIndexView	django-admindocs-views-index
/admin/doc/views//	django.contrib.admindocs.views.ViewDetailView	django-admindocs-views-detail
/admin/jsi18n/	django.contrib.admin.sites.i18n_javascript	admin:jsi18n
/admin/login/	django.contrib.admin.sites.login	admin:login
/admin/logout/	django.contrib.admin.sites.logout	admin:logout
/admin/password_change/	django.contrib.admin.sites.password_change	admin:password_change
/admin/password_change/done/	django.contrib.admin.sites.password_change_done	admin:password_change_done
/admin/r/int:content_type_id/path:object_id/	django.contrib.contenttypes.views.shortcut	admin:view_on_site
/admin/sites/site/	django.contrib.admin.options.changelist_view	admin:sites_site_changelist
/admin/sites/site/path:object_id/	django.views.generic.base.RedirectView
/admin/sites/site/path:object_id/change/	django.contrib.admin.options.change_view	admin:sites_site_change
/admin/sites/site/path:object_id/delete/	django.contrib.admin.options.delete_view	admin:sites_site_delete
/admin/sites/site/path:object_id/history/	django.contrib.admin.options.history_view	admin:sites_site_history
/admin/sites/site/add/	django.contrib.admin.options.add_view	admin:sites_site_add
/algorithms/<algo_id>/	Stemweb.algorithms.views.details	algorithms_details_url
/algorithms/available/	Stemweb.algorithms.views.available	algorithms_available_url
/algorithms/base/	Stemweb.algorithms.views.base	algorithms_base_url
/algorithms/delete/	Stemweb.algorithms.views.delete_runs	algorithms_delete_runs_url
/algorithms/jobstatus/<run_id>/	Stemweb.algorithms.views.jobstatus	algorithms_jobstatus_url
/algorithms/process/<algo_id>/	Stemweb.algorithms.views.process	algorithms_process_url
/algorithms/processtest/	Stemweb.algorithms.views.processtest	algorithms_test_url
/algorithms/results/<run_id>/	Stemweb.algorithms.views.results	algorithms_run_results_url
/algorithms/run/<algo_id>/	Stemweb.algorithms.views.run	algorithms_run_algorithm_url
/algorithms/testresponse/	Stemweb.algorithms.views.testresponse	algorithms_testresponse_url
/algorithms/testserver/	Stemweb.algorithms.views.testserver	algorithms_testserver_url
/files/<file_id>/	Stemweb.files.views.details	files_details_url
/files/base	Stemweb.files.views.base	files_base_url
/files/upload	Stemweb.files.views.upload	files_upload_url
/home	Stemweb.home.views.home	stemweb_home_url
/media/	django.views.static.serve	stemweb_media_root_url
/script_failure	Stemweb.home.views.script_failure	stemweb_script_failure_url
/server_error	Stemweb.home.views.server_error	stemweb_server_error_url

[tla]

OK - also for reference, the only ones we need to care about are the ones specified in the white paper. These are:

• /algorithms/available
• /algorithms/jobstatus/<run_id>/
• /algorithms/process/<algo_id>/

[tla]

OK - also for reference, the only ones we need to care about are the ones specified in the white paper. These are:

* /algorithms/available

* /algorithms/jobstatus/<run_id>/

* /algorithms/process/<algo_id>/

It's also worth clarifying: we do have to implement one endpoint, referred to in the white paper as /stemmatology/result but it can be called whatever we want, which Stemweb will call when it is ready to send a result for a particular request. In the master branch this is /stemweb/result. It will receive a result and should take care of adding the result's content as a new stemma to the tradition in question.

[jorisvanzundert]

Just as a reminder: https://github.com/DHUniWien/Stemweb/tree/main/client
This has some example requests and responses from Stemweb, which might comen in useful when working on the front end.