Debug on plugins

cacciaresi · November 15, 2019, 12:18pm

Hello, I’m trying to debug an issue related with the integration between discovery and lms services, is there any way to debug a plugin in tutor? The goal would be to set a breakpoint in discovery source code.

Thanks a lot!

regis · November 17, 2019, 7:38pm

Not out of the box, no, as there is currently no way to define development-only settings for third party services, like discovery. This is likely to change in the next release, though, as there will be a dedicated docker-compose.yml file for development: tutor/tutor/templates/dev/docker-compose.yml at master · overhangio/tutor · GitHub

However, you should be able to debug the discovery service by manually mounting your local discovery repo inside the discovery image – this is pretty much what I did while I was developing the tutor-discovery plugin.

Let us know if this any use to you!

kmurthyhegde · April 21, 2020, 8:24am

@regis wanted to check if anything has changed on this in the newer releases, wrt dubugging of discovery service code?

regis · April 21, 2020, 10:01am

Yes. There are now development settings and the docker-compose command configuration is overridden such that it’s possible to mount a local course_discovery folder. When changes are made to this folder, the development server will restart automatically:

github.com

overhangio/tutor-discovery/blob/master/tutordiscovery/templates/discovery/apps/settings/tutor/development.py

from ..devstack import *

{% include "discovery/apps/settings/partials/common.py" %}

BACKEND_SERVICE_EDX_OAUTH2_KEY = "{{ DISCOVERY_OAUTH2_KEY_DEV }}"
BACKEND_SERVICE_EDX_OAUTH2_SECRET = "{{ DISCOVERY_OAUTH2_SECRET }}"
BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL = "http://lms:8000/oauth2"

SOCIAL_AUTH_EDX_OAUTH2_KEY = "{{ DISCOVERY_OAUTH2_KEY_SSO_DEV }}"
SOCIAL_AUTH_EDX_OAUTH2_SECRET = "{{ DISCOVERY_OAUTH2_SECRET_SSO }}"
SOCIAL_AUTH_EDX_OAUTH2_ISSUER = "http://{{ LMS_HOST }}:8000"
SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT = SOCIAL_AUTH_EDX_OAUTH2_ISSUER
SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = SOCIAL_AUTH_EDX_OAUTH2_ISSUER
SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL = SOCIAL_AUTH_EDX_OAUTH2_ISSUER + "/logout"

# Disable API caching, which makes it a pain to troubleshoot issues
USE_API_CACHING = False

DISCOVERY_BASE_URL = "http://{{ DISCOVERY_HOST }}:8381"
MEDIA_URL = DISCOVERY_BASE_URL + "/media/"

This file has been truncated. show original

github.com

overhangio/tutor-discovery/blob/master/tutordiscovery/patches/local-docker-compose-dev-services

discovery:
  environment:
    DJANGO_SETTINGS_MODULE: course_discovery.settings.tutor.development
  command: ./manage.py runserver 0.0.0.0:8381
  stdin_open: true
  tty: true
  ports:
    - "8381:8381"
  networks:
    default:
      aliases:
        - "{{ DISCOVERY_HOST }}"

You can use an approach similar to the one used to debug edx-platform:

https://docs.tutor.overhang.io/dev.html#point-to-a-local-edx-platform

Note however that these changes are undocumented and you are left on your own to hack on course discovery. It is assumed that if you want to debug course discovery, then you should be able to reverse-engineer the plugin and guess the changes that you need to make by yourself. The reason for that is that I have not made extensive discovery/ecommerce debugging for some time. I will be more than happy to merge pull requests that document the required changes, though.