Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Component / Feature cohesion
  • Eliminate Deployment dependencies
  • Studio and LMS become mostly Frontend Views

5. Plugins and SOLID Principles: edx-platform becomes a Plugin Platform (In Progress)

Summary

To reverse the direction of the monolithic evolution of the edx-platform, it is necessary to have individual apps plugin to the platform and follow the S.O.D. of the SOLID principles as described in Django App Plugin.  Additionally, to support the varying feature requirements and experimentation by the open edX community (and within edx.org), a plugin framework provides a powerful flexibility that keeps the edX core as an invulnerable and stable platform but a welcoming enabler.

...

  • CatalogCourse
  • CourseRun
  • Content-Provider Organization
  • User-Provider Organization
  • Credit-Accessor Organization

9

...

...

. Testing Best Practice (Todo)

...

10. API Best Practice (Todo)

  • An early version of this is at edX REST API Conventions, but needs to be updated and fleshed out with more recent wisdom.

...

11. Domain-driven Design Principles

  • Build vs Buy → Core, Supporting, Generic
  • Location of code (which IDA? which app?) → Bounded Context Responsibilities and Boundaries
  • API as a Product → Domain models
  • Inter-service interfaces → Business use cases
  • Inter-service communication and relationships → Bounded Context life cycles versus Entity-based Services 

13. Plugins and SOLID Principles

...

12. Celery usage

  • celery-utils capabilities - LoggingTask and PersistOnFailureTask
  • Using kwargs instead of positional args
  • For real-time synchronization with management command as fallback of celery failures

15. User Identifiers

  • Some background here: /wiki/spaces/AN/pages/144441849
  • Current thoughts are to identify users by randomly generated UUIDs instead of username (privacy issues) or LMS user_id (database entry, which is guessable and leaks info on number of entries) or (anonymous_user_id, which is tied to a server-wide secret_key).