Coverage for benefits/core/context_processors.py: 94%

1""" 

2The core application: context processors for enriching request context data. 

3""" 

4 

5from django.conf import settings 

6 

7from benefits.routes import routes as app_routes 

8 

9from . import models, session 

10 

11 

12def unique_values(original_list): 

13 # dict.fromkeys gets the unique values and preserves order 

14 return list(dict.fromkeys(original_list)) 

15 

16 

17def _agency_context(agency: models.TransitAgency): 

18 return { 

19 "eligibility_index_url": agency.eligibility_index_url, 

20 "help_templates": unique_values([f.help_template for f in agency.enrollment_flows.all() if f.help_template]), 

21 "info_url": agency.info_url, 

22 "long_name": agency.long_name, 

23 "phone": agency.phone, 

24 "short_name": agency.short_name, 

25 "slug": agency.slug, 

26 } 

27 

28 

29def agency(request): 

30 """Context processor adds some information about the active agency to the request context.""" 

31 agency = session.agency(request) 

32 

33 if agency is None: 

34 return {} 

35 

36 return {"agency": _agency_context(agency)} 

37 

38 

39def active_agencies(request): 

40 """Context processor adds some information about all active agencies to the request context.""" 

41 agencies = models.TransitAgency.all_active() 

42 

43 return {"active_agencies": [_agency_context(agency) for agency in agencies]} 

44 

45 

46def analytics(request): 

47 """Context processor adds some analytics information to request context.""" 

48 return {"analytics": {"api_key": settings.ANALYTICS_KEY, "uid": session.uid(request), "did": session.did(request)}} 

49 

50 

51def authentication(request): 

52 """Context processor adds authentication information to request context.""" 

53 flow = session.flow(request) 

54 

55 if flow: 

56 data = { 

57 "logged_in": session.logged_in(request), 

58 } 

59 

60 if flow.uses_claims_verification: 

61 data["sign_out_button_template"] = flow.claims_provider.sign_out_button_template 

62 data["sign_out_link_template"] = flow.claims_provider.sign_out_link_template 

63 

64 return {"authentication": data} 

65 else: 

66 return {} 

67 

68 

69def debug(request): 

70 """Context processor adds debug information to request context.""" 

71 return {"debug": session.context_dict(request)} 

72 

73 

74def enrollment(request): 

75 """Context processor adds enrollment information to request context.""" 

76 flow = session.flow(request) 

77 expiry = session.enrollment_expiry(request) 

78 reenrollment = session.enrollment_reenrollment(request) 

79 

80 data = { 

81 "expires": expiry, 

82 "reenrollment": reenrollment, 

83 "supports_expiration": flow.supports_expiration if flow else False, 

84 } 

85 

86 return {"enrollment": data} 

87 

88 

89def origin(request): 

90 """Context processor adds session.origin to request context.""" 

91 origin = session.origin(request) 

92 

93 if origin: 93 ↛ 96line 93 didn't jump to line 96 because the condition on line 93 was always true

94 return {"origin": origin} 

95 else: 

96 return {} 

97 

98 

99def routes(request): 

100 """Context processor adds information about each application route to the context.""" 

101 

102 return {"routes": app_routes.to_dict()}