Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guarantee a session factory to be set. #895

Merged
merged 2 commits into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 41 additions & 7 deletions atramhasis/__init__.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
import logging
import os

from pyramid.config import Configurator
from pyramid.config import PHASE3_CONFIG
from pyramid.interfaces import ISessionFactory
from pyramid.session import SignedCookieSessionFactory
from pyramid.settings import aslist

from atramhasis.renderers import json_renderer_verbose

LOG = logging.getLogger(__name__)


DEFAULT_SETTINGS = {
"cache.tree.backend": "dogpile.cache.memory",
Expand All @@ -28,7 +34,7 @@ def includeme(config):
for key, value in DEFAULT_SETTINGS.items():
if key not in settings:
settings[key] = value

configure_session(config)
config.include('pyramid_jinja2')
config.include('pyramid_tm')
config.add_static_view('static', 'static', cache_max_age=3600)
Expand All @@ -47,6 +53,38 @@ def includeme(config):
config.scan()


def configure_session(config):
"""
Configure pyramid's session factory.

People can configure their own session factory, but if no factory is registered
atramhasis will try configuring its own.
"""

def check_session_factory_set():
session_factory = config.registry.queryUtility(ISessionFactory)
if session_factory:
return

settings = config.registry.settings
if 'atramhasis.session_factory.secret' not in settings:
msg = (
'No session factory is configured, and '
'atramhasis.session_factory.secret setting is missing.'
)
raise ValueError(msg)

LOG.info('Using default SignedCookieSessionFactory.')
default_session_factory = SignedCookieSessionFactory(
settings['atramhasis.session_factory.secret']
)
config.registry.registerUtility(default_session_factory, ISessionFactory)

config.action(
'check_session_factory_set', check_session_factory_set, order=PHASE3_CONFIG + 1
)


def main(global_config, **settings):
""" This function returns a Pyramid WSGI application.
"""
Expand All @@ -58,14 +96,10 @@ def main(global_config, **settings):

config = Configurator(settings=settings)

return load_app(config, settings)

return load_app(config)

def load_app(config, settings):
from pyramid.session import SignedCookieSessionFactory
atramhasis_session_factory = SignedCookieSessionFactory(settings['atramhasis.session_factory.secret'])
config.set_session_factory(atramhasis_session_factory)

def load_app(config):
includeme(config)

config.include('atramhasis.data:db')
Expand Down
2 changes: 1 addition & 1 deletion tests/test_views.py
Original file line number Diff line number Diff line change
Expand Up @@ -658,7 +658,7 @@ def __init__(self):
def setUp(self):
pyramid_settings = Settings(settings)
config = testing.setUp(settings=pyramid_settings)
atramhasis.load_app(config, pyramid_settings)
atramhasis.load_app(config)
self.request = DummyRequest()
self.request.application_url = "http://localhost:6543"
apply_request_extensions(self.request)
Expand Down