-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Delete hinter manager. #11752
Delete hinter manager. #11752
Conversation
Is this something we should mention in Eucalyptus notes? |
The old crowdsourced hinter code is no longer maintained and it is now slightly bit rotted. The only reason it is still in place is because it tests This PR will take a bit rotted no-longer-functional piece of code, and replaces it with half of a bit rotted no-longer-functional piece of code. I don't think that's a positive step in of itself. People sometimes decide to clean up code with bitrot. If half of it is ripped out, it's a bit of a trap; after such a cleanup, you still end up with a non-working system. It would be cleaner to just rip out the entire CSH XModule (as opposed to just the instructor view), and replace it with a small, independent, uncoupled test case which makes sure that (Note that the above is neither a 👍 or a 👎. I don't have enough context on what level of code quality we aim for at this point) |
The bok choy test failure is a known flaky bug. |
@robrap and @dianakhuang Please code review the deletion of this file. I created a techdebt story for the removal of the rest of the crowdsource module xblock. I imagine we would need to make sure no courses are including it, and add it to the list of deprecated xblocks. https://openedx.atlassian.net/browse/TNL-4195 |
👍 Works for me. |
@cahrens I don't believe removing the overall module would require that much work. This was a prototype used in one place in one course. I just confirmed this with a SQL query. This was never an edX feature. If you wanted to do this right -- just add a minimal test case for |
(specifically, the last time a hint was contributed was 2013-07-28) |
8dfc31b
to
b57cd35
Compare
It turns out that the logger already has dedicated unit tests, see https://github.com/edx/edx-platform/blob/master/common/static/js/spec/logger_spec.js. So I am proceeding with deleting all parts of crowdsource_xmodule. |
b57cd35
to
59f9076
Compare
@@ -24,6 +24,9 @@ | |||
return { | |||
/** | |||
* Emits an event. | |||
* | |||
* Note that this method is used by external XBlocks, and the API cannot change without |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These methods have dedicated unit tests in https://github.com/edx/edx-platform/blob/master/common/static/js/spec/logger_spec.js.
59f9076
to
d2db58b
Compare
Bok choy test failure is related to a known flaky issue, https://openedx.atlassian.net/browse/TNL-4151 (which is in our current sprint!). @robrap and @dianakhuang Please review the complete deletion of crowdsource module. @pmitros, if you care to give a thumbs-up it can stand in for one of the other reviews! |
👍 I'd suggest (not require) similar comments around the test cases as well (no need to re-review). Thank you for taking the lead on this. |
d2db58b
to
5432ef3
Compare
Bok choy failure is a known issue, in our current sprint. @dianakhuang please re-review now that this includes the complete deletion. |
👍 |
I came upon this code because I wanted to delete js/course_groups/cohorts.js, which is oddly imported in hint_manager.html (I can't see how the hint manager is at all related to cohorts).
This "instructor view" (not integrated into an instructor dashboard) was written for the crowdsource prototype xmodule by Felix Sun (an intern) in 2013-- #303. It does not appear to be enabled on edx or edge (following the URL pattern indicated in comments and urls.py).
@pmitros and I chatted about the old crowdsource xmodule. It can be deleted, except for one small test case that @pmitros would like to move out of the old code and preserve. There is an active PR to introduce a new crowdsource xblock, #9095.
@nedbat I don't think this needs to be mentioned in Eucalyptus due to its history.