Deprecation/Removal: CookieNameChange Middleware edx-platform#1003

Announcements Deprecation
1

Hello.

We plan to deprecate and remove the CookieNameChange middleware from edx-platform. This middleware was intended as a temporary solution for cookie name migrations and is no longer needed.

DEPR Draft: [DEPR]: Remove CookieNameChange middleware · Issue #36834 · openedx/edx-platform · GitHub
Removal PR: Fix : Remove deprecated CookieNameChange middleware by ktyagiapphelix2u · Pull Request #36815 · openedx/edx-platform · GitHub

Please read openedx/edx-platform/issues/36834 for more information and to post any questions or comments. The proposed deadline for comments before acceptance is July 1, 2025.

Once the ticket is accepted, removal may happen shortly after acceptance, as noted in the ticket.

After acceptance, all future notifications around removal will only be posted to the GitHub issue, so be sure to watch that issue if you want further updates.

Thank you,
Krish

Additional Context for the Issue

  • The middleware is located at: middleware.py
  • It’s included in both LMS and CMS middleware stacks but inactive by default
  • The middleware was designed for transitioning between cookie names
  • Affected settings: COOKIE_NAME_CHANGE_ACTIVATE and COOKIE_NAME_CHANGE_EXPAND_INFO
2

Thanks @Krish_Tyagi. This announcement came a little early, and the first step is for us to Draft and update a Github issue using the DEPR template for new issues in the openedx/edx-platform repository. I’ll work with you to ensure that is more clear, and then we will update this announcement accordingly. Thank you!

@sarina: [inform] This is one more bit of anecdotal evidence that the OEP could use additional clarity. I’ll take this back to DEPR WG with some ideas for improvements.

[UPDATE]: Oops. I didn’t realize that change didn’t land yet. Let’s land it. :slight_smile:
@Krish_Tyagi: You can let us know if this updated version of OEP-21 would have been more clear.

3

@Krish_Tyagi: In the OEP is a template for announcing changes. You can use that template to update this announcement (or add a comment), pointing to the DEPR ticket: [DEPR]: Remove CookieNameChange middleware · Issue #36834 · openedx/edx-platform · GitHub.

Note: I updated the ticket to allow for removal as soon as this RFC is accepted.

4

@robrap Thank you for the guidance. I’ll update the announcement following the OEP template and include a link to the DEPR ticket.

I’ll add a comment to the discussion post with the properly formatted announcement that points directly to the DEPR ticket (#36834) as you suggested. This will ensure the community has a clear reference to the formal deprecation process documentation.

The updated announcement will follow the standard format with the appropriate timeline information and link to the GitHub issue where people can track future updates.

5

We plan to deprecate and remove CookieNameChange Middleware from edx-platform.

Please read [DEPR]: Remove CookieNameChange middleware · Issue #36834 · openedx/edx-platform · GitHub for more information and to post any questions or comments. The proposed deadline for comments before acceptance is 2025-06-20 (not July 1).

Once the ticket is accepted, removal can happen at any time, because breaking changes is already assumed to be unblocked.

After acceptance, all future notifications around removal will only be posted to the GitHub issue, so be sure to watch that issue if you want further updates.

Thank you.
Robert

@Krish_Tyagi: [inform] I’ve updated the announcement above and there is no further action required from you on this post. This is to provide an example for the future. Thank you.