1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
|
from __future__ import annotations
import logging
import random
from decimal import Decimal
from typing import Any, TypeVar
from django.conf import settings
from django.contrib.auth.models import AbstractBaseUser, Group
from django.db import models, router, transaction
from django.http import HttpRequest
from django.utils import timezone
from django.utils.translation import gettext_lazy as _
from waffle import (
get_waffle_sample_model,
get_waffle_switch_model,
get_waffle_flag_model,
managers,
)
from waffle.utils import get_setting, keyfmt, get_cache
logger = logging.getLogger('waffle')
CACHE_EMPTY = '-'
_BaseModelType = TypeVar("_BaseModelType", bound="BaseModel")
class BaseModel(models.Model):
SINGLE_CACHE_KEY = ''
ALL_CACHE_KEY = ''
class Meta:
abstract = True
def __str__(self) -> str:
return self.name
def natural_key(self) -> tuple[str]:
return (self.name,)
@classmethod
def _cache_key(cls, name: str) -> str:
return keyfmt(get_setting(cls.SINGLE_CACHE_KEY), name)
@classmethod
def get(cls: type[_BaseModelType], name: str) -> _BaseModelType:
cache = get_cache()
cache_key = cls._cache_key(name)
cached = cache.get(cache_key)
if cached == CACHE_EMPTY:
return cls(name=name)
if cached:
return cached
try:
obj = cls.get_from_db(name)
except cls.DoesNotExist:
cache.add(cache_key, CACHE_EMPTY)
return cls(name=name)
cache.add(cache_key, obj)
return obj
@classmethod
def get_from_db(cls: type[_BaseModelType], name: str) -> _BaseModelType:
objects = cls.objects
if get_setting('READ_FROM_WRITE_DB'):
objects = objects.using(router.db_for_write(cls))
return objects.get(name=name)
@classmethod
def get_all(cls: type[_BaseModelType]) -> list[_BaseModelType]:
cache = get_cache()
cache_key = get_setting(cls.ALL_CACHE_KEY)
cached = cache.get(cache_key)
if cached == CACHE_EMPTY:
return []
if cached:
return cached
objs = cls.get_all_from_db()
if not objs:
cache.add(cache_key, CACHE_EMPTY)
return []
cache.add(cache_key, objs)
return objs
@classmethod
def get_all_from_db(cls: type[_BaseModelType]) -> list[_BaseModelType]:
objects = cls.objects
if get_setting('READ_FROM_WRITE_DB'):
objects = objects.using(router.db_for_write(cls))
return list(objects.all())
def flush(self) -> None:
cache = get_cache()
keys = [
self._cache_key(self.name),
get_setting(self.ALL_CACHE_KEY),
]
cache.delete_many(keys)
def save(self, *args: Any, **kwargs: Any) -> None:
self.modified = timezone.now()
ret = super().save(*args, **kwargs)
if hasattr(transaction, 'on_commit'):
transaction.on_commit(self.flush)
else:
self.flush()
return ret
def delete(self, *args: Any, **kwargs: Any) -> tuple[int, dict[str, int]]:
ret = super().delete(*args, **kwargs)
if hasattr(transaction, 'on_commit'):
transaction.on_commit(self.flush)
else:
self.flush()
return ret
def set_flag(request: HttpRequest, flag_name: str, active: bool | None = True, session_only: bool = False) -> None:
"""Set a flag value on a request object."""
if not hasattr(request, 'waffles'):
request.waffles = {}
request.waffles[flag_name] = [active, session_only]
class AbstractBaseFlag(BaseModel):
"""A feature flag.
Flags are active (or not) on a per-request basis.
"""
name = models.CharField(
max_length=100,
unique=True,
help_text=_('The human/computer readable name.'),
verbose_name=_('Name'),
)
everyone = models.BooleanField(
blank=True,
null=True,
help_text=_(
'Flip this flag on (Yes) or off (No) for everyone, overriding all '
'other settings. Leave as Unknown to use normally.'),
verbose_name=_('Everyone'),
)
percent = models.DecimalField(
max_digits=3,
decimal_places=1,
null=True,
blank=True,
help_text=_('A number between 0.0 and 99.9 to indicate a percentage of '
'users for whom this flag will be active.'),
verbose_name=_('Percent'),
)
testing = models.BooleanField(
default=False,
help_text=_('Allow this flag to be set for a session for user testing'),
verbose_name=_('Testing'),
)
superusers = models.BooleanField(
default=True,
help_text=_('Flag always active for superusers?'),
verbose_name=_('Superusers'),
)
staff = models.BooleanField(
default=False,
help_text=_('Flag always active for staff?'),
verbose_name=_('Staff'),
)
authenticated = models.BooleanField(
default=False,
help_text=_('Flag always active for authenticated users?'),
verbose_name=_('Authenticated'),
)
languages = models.TextField(
blank=True,
default='',
help_text=_('Activate this flag for users with one of these languages (comma-separated list)'),
verbose_name=_('Languages'),
)
rollout = models.BooleanField(
default=False,
help_text=_('Activate roll-out mode?'),
verbose_name=_('Rollout'),
)
note = models.TextField(
blank=True,
help_text=_('Note where this Flag is used.'),
verbose_name=_('Note'),
)
created = models.DateTimeField(
default=timezone.now,
db_index=True,
help_text=_('Date when this Flag was created.'),
verbose_name=_('Created'),
)
modified = models.DateTimeField(
default=timezone.now,
help_text=_('Date when this Flag was last modified.'),
verbose_name=_('Modified'),
)
objects = managers.FlagManager()
SINGLE_CACHE_KEY = 'FLAG_CACHE_KEY'
ALL_CACHE_KEY = 'ALL_FLAGS_CACHE_KEY'
class Meta:
abstract = True
verbose_name = _('Flag')
verbose_name_plural = _('Flags')
def flush(self) -> None:
cache = get_cache()
keys = self.get_flush_keys()
cache.delete_many(keys)
def get_flush_keys(self, flush_keys: list[str] | None = None) -> list[str]:
flush_keys = flush_keys or []
flush_keys.extend([
self._cache_key(self.name),
get_setting('ALL_FLAGS_CACHE_KEY'),
])
return flush_keys
def is_active_for_user(self, user: AbstractBaseUser) -> bool | None:
if self.everyone:
return True
if self.authenticated and user.is_authenticated:
return True
if self.staff and getattr(user, 'is_staff', False):
return True
if self.superusers and getattr(user, 'is_superuser', False):
return True
return None
def _is_active_for_user(self, request: HttpRequest) -> bool | None:
user = getattr(request, "user", None)
if user:
return self.is_active_for_user(user)
return False
def _is_active_for_language(self, request: HttpRequest) -> bool | None:
if self.languages:
languages = [ln.strip() for ln in self.languages.split(',')]
if (hasattr(request, 'LANGUAGE_CODE')
and request.LANGUAGE_CODE in languages):
return True
return None
def is_active(self, request: HttpRequest, read_only: bool = False) -> bool | None:
if not self.pk:
log_level = get_setting('LOG_MISSING_FLAGS')
if log_level:
logger.log(log_level, 'Flag %s not found', self.name)
if get_setting('CREATE_MISSING_FLAGS'):
flag, _created = get_waffle_flag_model().objects.get_or_create(
name=self.name,
defaults={
'everyone': get_setting('FLAG_DEFAULT')
}
)
cache = get_cache()
cache.set(self._cache_key(self.name), flag)
return get_setting('FLAG_DEFAULT')
if get_setting('OVERRIDE'):
if self.name in request.GET:
return request.GET[self.name] == '1'
if self.everyone:
return True
elif self.everyone is False:
return False
if self.testing: # Testing mode is on.
tc = get_setting('TEST_COOKIE') % self.name
th = tc.replace('_', '-')
on = None
if tc in request.GET:
on = request.GET[tc] == '1'
elif th in request.headers:
on = request.headers[th] == '1'
if on is not None:
if not hasattr(request, 'waffle_tests'):
request.waffle_tests = {}
request.waffle_tests[self.name] = on
return on
if tc in request.COOKIES:
return request.COOKIES[tc] == 'True'
active_for_language = self._is_active_for_language(request)
if active_for_language is not None:
return active_for_language
active_for_user = self._is_active_for_user(request)
if active_for_user is not None:
return active_for_user
if self.percent and self.percent > 0:
if not hasattr(request, 'waffles'):
request.waffles = {}
elif self.name in request.waffles:
return request.waffles[self.name][0]
cookie = get_setting('COOKIE') % self.name
if cookie in request.COOKIES:
flag_active = request.COOKIES[cookie] == 'True'
if not read_only:
set_flag(request, self.name, flag_active, self.rollout)
return flag_active
if not read_only:
if Decimal(str(random.uniform(0, 100))) <= self.percent:
set_flag(request, self.name, True, self.rollout)
return True
set_flag(request, self.name, False, self.rollout)
else:
return None
return False
class AbstractUserFlag(AbstractBaseFlag):
groups = models.ManyToManyField(
Group,
blank=True,
help_text=_('Activate this flag for these user groups.'),
verbose_name=_('Groups'),
)
users = models.ManyToManyField(
settings.AUTH_USER_MODEL,
blank=True,
help_text=_('Activate this flag for these users.'),
verbose_name=_('Users'),
)
class Meta(AbstractBaseFlag.Meta):
abstract = True
verbose_name = _('Flag')
verbose_name_plural = _('Flags')
def get_flush_keys(self, flush_keys: list[str] | None = None) -> list[str]:
flush_keys = super().get_flush_keys(flush_keys)
flush_keys.extend([
keyfmt(get_setting('FLAG_USERS_CACHE_KEY'), self.name),
keyfmt(get_setting('FLAG_GROUPS_CACHE_KEY'), self.name),
])
return flush_keys
def _get_user_ids(self) -> set[Any]:
cache = get_cache()
cache_key = keyfmt(get_setting('FLAG_USERS_CACHE_KEY'), self.name)
cached = cache.get(cache_key)
if cached == CACHE_EMPTY:
return set()
if cached:
return cached
user_ids = set(self.users.all().values_list('pk', flat=True))
if not user_ids:
cache.add(cache_key, CACHE_EMPTY)
return set()
cache.add(cache_key, user_ids)
return user_ids
def _get_group_ids(self) -> set[Any]:
cache = get_cache()
cache_key = keyfmt(get_setting('FLAG_GROUPS_CACHE_KEY'), self.name)
cached = cache.get(cache_key)
if cached == CACHE_EMPTY:
return set()
if cached:
return cached
group_ids = set(self.groups.all().values_list('pk', flat=True))
if not group_ids:
cache.add(cache_key, CACHE_EMPTY)
return set()
cache.add(cache_key, group_ids)
return group_ids
def is_active_for_user(self, user: AbstractBaseUser) -> bool | None:
is_active = super().is_active_for_user(user)
if is_active:
return is_active
user_ids = self._get_user_ids()
if hasattr(user, 'pk') and user.pk in user_ids:
return True
if hasattr(user, 'groups'):
group_ids = self._get_group_ids()
if group_ids:
user_groups = set(user.groups.all().values_list('pk', flat=True))
if group_ids.intersection(user_groups):
return True
return None
class Flag(AbstractUserFlag):
"""A feature flag.
Flags are active (or not) on a per-request basis.
"""
class Meta(AbstractUserFlag.Meta):
swappable = 'WAFFLE_FLAG_MODEL'
verbose_name = _('Flag')
verbose_name_plural = _('Flags')
class AbstractBaseSwitch(BaseModel):
"""A feature switch.
Switches are active, or inactive, globally.
"""
name = models.CharField(
max_length=100,
unique=True,
help_text=_('The human/computer readable name.'),
verbose_name=_('Name'),
)
active = models.BooleanField(
default=False,
help_text=_('Is this switch active?'),
verbose_name=_('Active'),
)
note = models.TextField(
blank=True,
help_text=_('Note where this Switch is used.'),
verbose_name=_('Note'),
)
created = models.DateTimeField(
default=timezone.now,
db_index=True,
help_text=_('Date when this Switch was created.'),
verbose_name=_('Created'),
)
modified = models.DateTimeField(
default=timezone.now,
help_text=_('Date when this Switch was last modified.'),
verbose_name=_('Modified'),
)
objects = managers.SwitchManager()
SINGLE_CACHE_KEY = 'SWITCH_CACHE_KEY'
ALL_CACHE_KEY = 'ALL_SWITCHES_CACHE_KEY'
class Meta:
abstract = True
verbose_name = _('Switch')
verbose_name_plural = _('Switches')
def is_active(self) -> bool:
if not self.pk:
log_level = get_setting('LOG_MISSING_SWITCHES')
if log_level:
logger.log(log_level, 'Switch %s not found', self.name)
if get_setting('CREATE_MISSING_SWITCHES'):
switch, _created = get_waffle_switch_model().objects.get_or_create(
name=self.name, defaults={"active": get_setting("SWITCH_DEFAULT")}
)
cache = get_cache()
cache.set(self._cache_key(self.name), switch)
return get_setting('SWITCH_DEFAULT')
return self.active
class AbstractBaseSample(BaseModel):
"""A sample of users.
A sample is true some percentage of the time, but is not connected
to users or requests.
"""
name = models.CharField(
max_length=100,
unique=True,
help_text=_('The human/computer readable name.'),
verbose_name=_('Name'),
)
percent = models.DecimalField(
max_digits=4,
decimal_places=1,
help_text=_('A number between 0.0 and 100.0 to indicate a percentage of the time '
'this sample will be active.'),
verbose_name=_('Percent'),
)
note = models.TextField(
blank=True,
help_text=_('Note where this Sample is used.'),
verbose_name=_('Note'),
)
created = models.DateTimeField(
default=timezone.now,
db_index=True,
help_text=_('Date when this Sample was created.'),
verbose_name=_('Created'),
)
modified = models.DateTimeField(
default=timezone.now,
help_text=_('Date when this Sample was last modified.'),
verbose_name=_('Modified'),
)
objects = managers.SampleManager()
SINGLE_CACHE_KEY = 'SAMPLE_CACHE_KEY'
ALL_CACHE_KEY = 'ALL_SAMPLES_CACHE_KEY'
class Meta:
abstract = True
verbose_name = _('Sample')
verbose_name_plural = _('Samples')
def is_active(self) -> bool:
if not self.pk:
log_level = get_setting('LOG_MISSING_SAMPLES')
if log_level:
logger.log(log_level, 'Sample %s not found', self.name)
if get_setting('CREATE_MISSING_SAMPLES'):
default_percent = 100 if get_setting('SAMPLE_DEFAULT') else 0
sample, _created = get_waffle_sample_model().objects.get_or_create(
name=self.name, defaults={"percent": default_percent}
)
cache = get_cache()
cache.set(self._cache_key(self.name), sample)
return get_setting('SAMPLE_DEFAULT')
return Decimal(str(random.uniform(0, 100))) <= self.percent
class Switch(AbstractBaseSwitch):
"""A feature switch.
Switches are active, or inactive, globally.
"""
class Meta(AbstractBaseSwitch.Meta):
swappable = 'WAFFLE_SWITCH_MODEL'
verbose_name = _('Switch')
verbose_name_plural = _('Switches')
class Sample(AbstractBaseSample):
"""A sample of users.
A sample is true some percentage of the time, but is not connected
to users or requests.
"""
class Meta(AbstractBaseSample.Meta):
swappable = 'WAFFLE_SAMPLE_MODEL'
verbose_name = _('Sample')
verbose_name_plural = _('Samples')
|