Skip to content

Conversation

@Agrendalath
Copy link
Member

@Agrendalath Agrendalath commented Mar 11, 2022

Description

As a part of the ModuleSystem removal, we want to get rid of its remaining attributes:

  • track_function,
  • publish.

Supporting information

Sandbox instance: https://pr30046.sandbox.opencraft.hosting/
Use staff@example.com:edx to log in.

Testing instructions

  1. We have replaced the remaining usages of track_function with publish, so it makes sense to check these two together.
  2. Log into the sandbox instance (private link) and check tracking logs for the next actions.
  3. Check that the grading is working. You can use this XBlock in the LMS and Preview. Check that the Studio view is working correctly too.
  4. Check that the "Show answer" button emits events.
  5. Check that the completion events are working (the completion is already enabled on the sandbox).

Other information

Private-ref: BB-5518

@openedx-webhooks
Copy link

openedx-webhooks commented Mar 11, 2022

Thanks for the pull request, @Agrendalath!

When this pull request is ready, tag your edX technical lead.

@openedx-webhooks openedx-webhooks added blended PR is managed through 2U's blended developmnt program needs triage labels Mar 11, 2022
@Agrendalath Agrendalath marked this pull request as draft March 11, 2022 16:15
@Agrendalath Agrendalath changed the title [BD-13] feat: remove static_url, track_function and rebind_noauth_module_to_user from ModuleSystem [BD-13] feat: deprecate static_url, track_function and rebind_noauth_module_to_user in ModuleSystem Mar 11, 2022
@Agrendalath Agrendalath force-pushed the agrendalath/bd-13-deprecate_modulesystem_properties branch 5 times, most recently from 9594229 to 8bed10e Compare March 16, 2022 01:34
@natabene natabene assigned jristau1984 and unassigned jristau1984 May 14, 2022
@natabene
Copy link
Contributor

@Agrendalath Just checking the status, as this has been open as a draft for a while.

@natabene
Copy link
Contributor

natabene commented Aug 8, 2022

Author will pick this up soon.

@Agrendalath Agrendalath changed the title [BD-13] feat: deprecate static_url, track_function and rebind_noauth_module_to_user in ModuleSystem [BD-13] feat: deprecate static_url, track_function and publish in ModuleSystem Aug 30, 2022
@Agrendalath Agrendalath force-pushed the agrendalath/bd-13-deprecate_modulesystem_properties branch 4 times, most recently from 45b735d to 4a118cb Compare September 5, 2022 17:48
@Agrendalath Agrendalath marked this pull request as ready for review September 5, 2022 17:55
@Agrendalath Agrendalath requested a review from pkulkark September 5, 2022 18:00
@Agrendalath
Copy link
Member Author

@ormsbee, would you like to do a sanity check of this PR?

@pkulkark
Copy link
Contributor

@Agrendalath I tried to test this out on the sandbox instance. But I got an error in the chemical equations problem:

image

@Agrendalath
Copy link
Member Author

@pkulkark, it was not related to the PR. It's an old sandbox, so I manually deleted all keys matching default:1:safe_exec.* from the cache. safe_exec is working correctly now.

@ormsbee
Copy link
Contributor

ormsbee commented Sep 13, 2022

@Agrendalath: Looking through this now...

Copy link
Contributor

@ormsbee ormsbee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything touching tracking events is higher risk because the generated log data often produces data that is not carefully analyzed until months later. You have these changes as separate commits, which is great. But please separate the static_url commit to its own PR. This PR can be kept for the event tracking/publishing changes, and may require separate testing.

@pdpinch, @ashultz0, @jristau1984: Do you have any concerns/thoughts regarding the validation for the XBlock event publishing/tracking log aspects of this PR?

@ashultz0
Copy link
Contributor

@ormsbee I don't think this touches any of the answer stuff we track for insights

@ormsbee
Copy link
Contributor

ormsbee commented Sep 13, 2022

@ashultz0: Really? I thought this was how all those events got to the tracking logs in the end...?

@ashultz0
Copy link
Contributor

Maybe I'm missing some of the context because I'm not familiar with this code.

Insights basically only looks at answers (and only our older types of answers), it doesn't engage with any of the completion stuff that seems to be what is being changed here.

Possibly the learner view looked at completion but 1) I don't think it did and 2) I don't have to research it because we are burning it to the ground with community OK anyway.

@Agrendalath Agrendalath force-pushed the agrendalath/bd-13-deprecate_modulesystem_properties branch from 4a118cb to 35ece1f Compare September 14, 2022 17:51
@Agrendalath
Copy link
Member Author

@ormsbee, thank you for reviewing this. I separated the static_url deprecation to #30992.

@ashultz0, this service also handles events like problem_check (analytics seem to be using it here), showanswer (listed here), etc. This PR should not alter events in any way, but this service will be passing them to the track_function, so it introduces some risk.

@ashultz0
Copy link
Contributor

thanks @Agrendalath

problem_check is the big one for the answers view so we can just validate that they are still happening as expected afterwards

@Agrendalath Agrendalath changed the title [BD-13] feat: deprecate static_url, track_function and publish in ModuleSystem [BD-13] feat: deprecate track_function and publish in ModuleSystem Sep 14, 2022
Copy link
Contributor

@pkulkark pkulkark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't done a deep code review since @ormsbee is doing that. I tested it out on the sandbox and confirm that it's working as described in the testing instructions. LGTM 👍

P.S @Agrendalath I assume you'll be rebasing with latest master once the review is done?

@Agrendalath
Copy link
Member Author

@pkulkark,

P.S @Agrendalath I assume you'll be rebasing with latest master once the review is done?

Of course. Each of these BD-13 will have a conflict with the master branch once the other BD-13 PR is merged.

@Agrendalath Agrendalath force-pushed the agrendalath/bd-13-deprecate_modulesystem_properties branch from ffde7d9 to a85f6ed Compare September 21, 2022 17:13
@Agrendalath Agrendalath changed the title [BD-13] feat: deprecate track_function and publish in ModuleSystem feat: deprecate track_function and publish in ModuleSystem [BD-13] Sep 21, 2022
@Agrendalath
Copy link
Member Author

@ormsbee, what are the next steps for this PR? Are we waiting for more feedback before moving forward?

@Agrendalath Agrendalath force-pushed the agrendalath/bd-13-deprecate_modulesystem_properties branch from a85f6ed to 9b778e7 Compare September 26, 2022 12:31
@ormsbee
Copy link
Contributor

ormsbee commented Oct 18, 2022

@schenedx, @jristau1984: This was the tracking log related code refactoring PR we discussed today.

@schenedx
Copy link
Contributor

@ormsbee We found the tracking logs are sent to Segment app on edX side. Because of that, we can quickly verify this PR on stage and prod.
Once you feel like this PR is ready, please let me know so we can merge, deploy and test with our people on the look out

@schenedx
Copy link
Contributor

@ormsbee OK, So I made a mistake conceptually. I thought the logs sent to segment app is the same as tracking logs.
This is not the case. Tracking logs are log files written into the disk, and ansible has a role to copy those logs into S3 bucket edx-all-tracking-logs. See reference here.
Segment logs are sent to the segment app directly and segment will store those logs inside of S3 into a different S3 bucket. What I don't know is if these two logs are going to be logging different events, or same events or sometimes different sometimes same.
Let's assume the worst that they are logging different events, I believe this logging is affecting pure tracking logs. In order to see the effect of this change, we'd have to monitor the prod instance tracking log writes unto EC2 disk. That's an SRE thing.
I will help get SRE attention onto this PR.

@e0d
Copy link
Contributor

e0d commented Nov 4, 2022

@ormsbee @schenedx what remains to be reviewed here to get this over the line?

@schenedx
Copy link
Contributor

schenedx commented Nov 4, 2022

@e0d I asked @ormsbee to help me validate if the code in this change would touch segment tracking events as well. That said, I also wanted to get 2U SRE to be helping me with testing this change on the stage environment to ensure tracking logs are still created. Cannot validate that with the current access I have.

@schenedx
Copy link
Contributor

schenedx commented Nov 8, 2022

@e0d I am planning to merge this PR and validate on stage Monday, Nov 14th. 2022

Copy link
Contributor

@schenedx schenedx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@schenedx schenedx merged commit f419d6b into openedx:master Nov 15, 2022
@openedx-webhooks
Copy link

@Agrendalath 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@Agrendalath Agrendalath deleted the agrendalath/bd-13-deprecate_modulesystem_properties branch November 15, 2022 15:49
@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blended PR is managed through 2U's blended developmnt program

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

10 participants