...

Deprecation/Removal Evaluation is an internal page where the Architecture team started this process and that we can use for exploring possible items to remove.

...

Meeting Notes

DEPR Meeting Notes (2018-Oct to 2020-Nov)Meetings

Working Group Objectives

Part of the work that I would like to tackle as part of this group is:

...

• edX Internal Use Only

  • Views in LMS

  • Frontend Pages in edx-platform

Action Items

Agenda

Past Agenda

...

Agenda (1/5/21)

...

Update / Review DRAFT - Koa Platform Release Notes

• Diana Huang to add DEPR tickets to the notes - can review with group next meeting

...

Site Configuration & White Label

• update: it seems like the Open edX community isn’t interested in supporting this functionality

• Can we talk to enterprise about removing these with assistance from DEPR?

• We have code, templates, and data that all should be removed, but can be removed separately

• talk to the service owners about removing site-specific code as well. does it make sense to deprecate this directly?

• exclude: theming for now

...

Check in with Revenue team about https://openedx.atlassian.net/browse/DEPR-90

2021 Goals

...

White Label and Site Configuration code

• Action Item: write a DEPR ticket to gauge community reactions to the deprecation, offer up eduNext model as an alternative - Nimisha Asthagiri (Deactivated)

• Action Item: communicate with enterprise team about future plans to deprecate white label and get buy in and support - Diana Huang

Microfrontend/Frontend code

...

Koa has rudimentary support for MFEs

...

Lilac has plans to streamline MFE

...

How do we want to handle this removal of code?

• ID verification might be a good place to start?

  • has a DEPR ticket

• Learner profiles

• start anything currently ‘Accepted’

Old Mongo

...

blocked by old mongo courses on edge

• waiting for product to assess the state of edge

...

• • in

...

Phase out configuration?

• could be a big project goal

• looking into replacements

• write up a project plan on this once we get further on it

...

XServer

• In progress

EdxRestApiClient

...

review the list of services

...

• • edx-platform

...

XModule → XBlock

...

DEPR pipeline

• Can we provide a query or something to the eng directors regarding the engineering ops review?

• Focus on it next quarter?

•  Nimisha Asthagiri (Deactivated) write a DEPR ticket to gauge community reactions to the deprecation, offer up eduNext model as an alternative
•  Diana Huang communicate with enterprise team about future plans to deprecate white label and get buy in and support

Agenda (1/19/21) -

• XServer

  • This just needs a little bit of verification left

  • Just want to make sure we’re not breaking any courses unintentionally

• import shims

  • reviewing the last few PR that are importing the wrong way

  • going to be put into #slash-n-burn channel for group to review

  • woohoo!

• updates

  • XModule → XBlock conversions: XModule to XBlock Conversion

  • Old Mongo

    • getting rid of courses on edx.org in Q3

    • looking at what is on edge

  • part of the TNL OGSPs, so looking good

• white label + site configuration

  • still need to talk to enterprise about the future of this work

  • still used in other repos to split by sites

  • can we make a separate process for external deprecations? - where external teams are responsible for doing the deprecation work

• configuration repo

  • dependent on getting devstack and other docker containers off of being reliant on this

  • Open edX looking for alternatives right not

  • BTR - hoping Lilac will be the last Open edX release to use configuration

  • Open edX is only half of the solution - internal edX usages like sandboxes will also have to move off of it

Agenda (2/2/21)

• From Robert: I have a proposed slash-n-burn activity that goes along with our upcoming Toggle Doc-a-thon, but it concerns data clean-up and not code clean-up. I suspect that our Toggle State Report spreadsheet has many rows due old waffle data in our environments that is no longer used in code. The spreadsheet would be even more useful if this data could be cleaned up.

  • We’d need to confirm what data should be cleaned up.

  • We’d need to decide if clean-up would use manual deletion, or if we’d add a migration to hit all environments.

  • Could ARCHBOM be responsible for doing this cleanup?

    • Impact isn’t clear as of yet

    • Bring this back to ARCHBOM for discussion

  • How do we make the toggle report up to date and actionable?

• Review potential DEPR work suggested by Robert in #slash-n-burn after the doc-a-thon

  • USE_MICROSITES: https://github.com/search?q=org%3Aedx+USE_MICROSITES&type=code

  • ENABLE_STUDENT_NOTES: https://github.com/search?q=org%3Aedx+ENABLE_STUDENT_NOTES&type=code

  • XBLOCK_FS_STORAGE_BUCKET - unclear if this is okay to be removed

    • We should make a DEPR ticket for this setting to ensure no external XBlocks are using

• Look at new DEPR-140 for UserProfile.allow_certificates:

  • https://openedx.atlassian.net/browse/DEPR-140

  • Reach out to Justin to remind him of the DEPR process around announcement

    • Also ensure best practices around DB migrations are followed

• EdxRestApi update - https://openedx.atlassian.net/browse/DEPR-21

  • did an example one with e2e-tests

    • should we disable

  • credentials PR is a good example for what this looks like:

    • https://github.com/edx/credentials/pull/969

• https://openedx.atlassian.net/browse/DEPR-108

  • Follow up with Marco about this work - Sarina Canelake (Do Not Use) (Deactivated)

• Account pages and Learner Profile pages - https://openedx.atlassian.net/browse/DEPR-17

  • Unblocked - can be worked on by the team

• Ecommerce - https://openedx.atlassian.net/browse/DEPR-42

  • Maybe hold off until decision made

• https://openedx.atlassian.net/browse/DEPR-120

  • Check in with Simon about this

• Everything else: ping reporters to ask them to send out announcements to the community to move the process forward

• Hackathon

  • Suggest - https://openedx.atlassian.net/browse/DEPR-21

  • Solicit suggestions from the Mobile team about DEPR related things

    • Repos that can be DEPR-ed?

Agenda (2/16/21)

• Hackathon readout

  • need to refactor the configuration and usage of edx-enterprise’s api client to use the single edx-enterprise user

  • need a review for course-discovery’s refactoring

• Check in on existing streams

  • some things moved into accepted

• pycontracts DEPR ticket to be written - Diana Huang

• Hack(?)

Agenda (3/2/21)

• Check-In: https://openedx.atlassian.net/browse/DEPR-142

  • needs review: https://github.com/edx/edx-platform/pull/26772

• Diana Huang needs to announce pycontracts DEPR ticket

• https://openedx.atlassian.net/browse/DEPR-58 update

  • still being held up by Edge content

    • okay to make it safe(?)

  • need to handle the edge cases

    • handle edge cases where course information is no longer available

    • will make it possible to ‘retire’ or ‘delete’ courses

• https://openedx.atlassian.net/browse/DEPR-124

  • will be removed at the end of the week

• XModule → XBlock conversion continuing

  • no DEPR ticket because backwards compatible

  • getting closer! actively worked on by OpenCraft

  • after this, still need to remove all the underlying peak/plateau confusion in the modulestore code

• https://openedx.atlassian.net/browse/DEPR-150

  • need to make a decision about django admin login before announcement

  • Feanil Patel to do this

Agenda (3/16/21)

• Last XModule removed from edx-platform!

  • Set up pinata celebration?

  • “One idea: When we retired Vertica recently, we each wrote Vertica tributes that were poems/odes/prose/limericks - and bbeggs read them all. That could be expanded to add PPT/Sheets presentations? And maybe fanfiction? Songs?” - Data Engineering

  • Round robin reading of odes

  • Mail everyone in the company one (1) piece of candy

  • Origami pinatas that people can make it at home

  • Ask Usman to stream himself destroying a pinata

    • Send him a jacket at least! 😞

  • Send something out digitally for people to do themselves

    • https://web-japan.org/kidsweb/virtual/origami2/exploring01_04.html

  • Sarina Canelake (Do Not Use) (Deactivated) to organize this.

• Removal dates for DEPR tickets: can we just say this is the acceptance date?

  • Yup, we can do this

  • Diana Huang to make these changes to the OEP

• https://openedx.atlassian.net/browse/DEPR-108

  • In progress, getting close

• https://openedx.atlassian.net/browse/DEPR-123

  • Community is not comfortable with replacing front ends with MFEs

  • No Tutor plugins or single-install support yet

  • Planning for Lilac to ship with a few MFEs as a sort of test case

• Can we measure the metric of DEPR work?

  • Community contributions - Sarina Canelake (Do Not Use) (Deactivated)

    • Contributions to front end code from anyone

  • Recouped cost of upgrade - Jeremy Bowman (Deactivated) Feanil Patel

    • Lines of code(?)

    • Repos(?)

    • Dependencies

    • Rough estimate of this work

  • Coverage metrics

  • Code complexity - Dave Ormsbee

    • Run automated tools before and after

    • Measure happiness with code before and after

      • Could use 2 question survey to see how people

    • Flavor complexity

  • Developer effectiveness

    • Multiple implementations is confusing

  • Import tree size of edx-platform Michael Terry (Deactivated)

    • Automated tools for this

    • proxy for code comprehensibility

      • How many other things do you need to understand to understand this file

  • Lines of code Diana Huang

    • Talk to Ned about this - instrumented for OSPR

• Meta discussion

  • How do we track non-DEPR work for the group?

    • Use wiki with checkboxes for now

  • Should we make another project?

  • Github projects

•  Diana Huang update OEP for removal dates, add communication field to link to Discourse discussion
•  Sarina Canelake (Do Not Use) (Deactivated) organize XModule pinata celebratin
•  Sarina Canelake (Do Not Use) (Deactivated) Discovery: Community contributions metrics
•  Jeremy Bowman (Deactivated)Feanil Patel Re-couped cost of upgrade metrics
•  Dave Ormsbee Discovery: code complexity metrics
•  Diana Huang Discovery: lines of code metrics
•  Michael Terry (Deactivated) Discovery: size of import tree metrics

Agenda (next time) -

• Discuss metrics

• Remove XQueue Watcher? Only 1 Partner uses it: MIT only for 7.QBWx and 6.00x courses. What is the purpose of this feature? Can it be either deprecated or deemed to be useful for other partners?

Project Backlog

• More documentation around deprecation

  • Removing a Djangoapp from an existing project

• How do we create a DEPR pipeline?

  • Review the Toggle Removal report

    • toggles are a good first step

    • anything we should add to the report that we’re not capturing today?

  • How do we engage other squads to help out?

  • How do we make it visible to squads what their DEPR status?

  • What are the organization code smells that might indicate DEPR needs?

  • How do we prioritize what to work on?

  • Metrics for analyzing the impact of DEPR work