Skip to content

Commit

Permalink
feat!: remove legacy waffle flags (#211)
Browse files Browse the repository at this point in the history
This is a part of openedx/public-engineering#28

BREAKING CHANGE: Removed LegacyWaffle* classes. Although this is
a breaking change, all known uses have already been fixed.
  • Loading branch information
dyudyunov authored May 11, 2022
1 parent 2062533 commit fedeafb
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 230 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ Change Log
Unreleased
~~~~~~~~~~

[5.0.0] - 2022-04-22
--------------------

* BREAKING CHANGE: Removed LegacyWaffle* classes. Although this is a breaking change, all known uses have already been fixed.
* Handle the case where certain toggle names come in as ``None`` when generating summary reports.
* Add ADR for updating annotations for toggle life expectancy and use cases.

Expand Down
6 changes: 0 additions & 6 deletions docs/how_to/documenting_new_feature_toggles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,12 +196,6 @@ Refactor to use new toggle setting classes

Undocumented boolean Django Setting toggles defined in the Open edX codebase are probably not yet defined using a ``SettingToggle`` or ``SettingDictToggle``. Read about implementing these toggle classes in :doc:`implement_the_right_toggle_type`.

Refactor LegacyWaffle classes
------------------------------

* Import ``WaffleFlag`` instead of ``LegacyWaffleFlag`` or ``WaffleSwitch`` instead of ``LegacyWaffleSwitch``.
* Initialize these new classes with a single string that includes the fully namespaced toggle name, including the period.

Refactor direct waffle usage
----------------------------

Expand Down
2 changes: 1 addition & 1 deletion edx_toggles/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
Library and utilities for feature toggles.
"""

__version__ = '4.3.1'
__version__ = '5.0.0'

default_app_config = 'edx_toggles.apps.TogglesConfig' # pylint: disable=invalid-name
51 changes: 0 additions & 51 deletions edx_toggles/tests/test_legacy_waffle.py

This file was deleted.

6 changes: 0 additions & 6 deletions edx_toggles/toggles/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,4 @@
"""
from .internal.setting_toggle import SettingDictToggle, SettingToggle
from .internal.waffle.flag import NonNamespacedWaffleFlag, WaffleFlag
from .internal.waffle.legacy import (
LegacyWaffleFlag,
LegacyWaffleFlagNamespace,
LegacyWaffleSwitch,
LegacyWaffleSwitchNamespace
)
from .internal.waffle.switch import NonNamespacedWaffleSwitch, WaffleSwitch
166 changes: 0 additions & 166 deletions edx_toggles/toggles/internal/waffle/legacy.py

This file was deleted.

0 comments on commit fedeafb

Please sign in to comment.