Introduction

This package represents the common setup a generic service app developped by CBIM should specifies. This is a comprehensive list of what it does

Pacakges that should not use this app

Here there is the list of exceptions:

• user-auth-service: this service provides the authentication and does not needs the models and the migrations from this package

Installation

Just pip install it:

pip install django-cbim-general-service

Configuration

First you need to add the app in INSTALLED_APPS.:

INSTALLED_APPS += "django_cbim_general_service"

If django_app_graphql is present, be sure to add this after the app. Furthermore, you need to add this app after the “auth” one.

Then you need to configure graphql:

INSTALLED_APPS = [
    # graphql
    'graphene_django',
    'django_filters',
    # make sure the django_app_graphql is the last app you add!
    'django_app_graphql',
]

Be sure to add them at the end of the INSTALLED_APPS, otherwise it won’t work. You also need to register a single authentication backend.

AUTHENTICATION_BACKENDS = [
    "PermissionCacherAuthenticationBackend",
]

This is the only backend you will need. The project uses a cache to store user,roles and permissions in runtime. You need to add one called users:

CACHES = {
    'users': {
        'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
        'LOCATION': 'users',
    }
}

Finally you need to configure graphene-jwt and django-app-graphql (if you are using it):

GRAPHENE = {
    "SCHEMA": "django_app_graphql.graphene.schema.schema",
    'SCHEMA_OUTPUT': 'graphqls-schema.json',
    'SCHEMA_INDENT': 2,
    'MIDDLEWARE': [
        "graphql_jwt.middleware.JSONWebTokenMiddleware",
        "django_app_graphql.middleware.GraphQLStackTraceInErrorMiddleware",
    ],
}

GRAPHENE_DJANGO_EXTRAS = {
    'DEFAULT_PAGINATION_CLASS': 'graphene_django_extras.paginations.LimitOffsetGraphqlPagination',
    'DEFAULT_PAGE_SIZE': 20,
    'MAX_PAGE_SIZE': 50,
    'CACHE_ACTIVE': True,
    'CACHE_TIMEOUT': 300  # seconds
}

# see https://django-graphql-jwt.domake.io/en/latest/refresh_token.html
GRAPHQL_JWT = {
    # This configures graphqls-jwt to add "token" input at each request to be authenticated
    'JWT_ALLOW_ARGUMENT': True,
    'JWT_ARGUMENT_NAME': "token",
    'JWT_VERIFY_EXPIRATION': True,
    'JWT_EXPIRATION_DELTA': timedelta(days=1),
    'JWT_ALGORITHM': "HS256",
    'JWT_REFRESH_EXPIRATION_DELTA': timedelta(days=7),
    'JWT_AUTH_HEADER_PREFIX': "Bearer",
    # VERY IMPORTANT TO MAKE EVERYTHING WORK!
    'JWT_DECODE_HANDLER': 'django_cbim_general_service.utils.jwt_decoder_handler',
    'JWT_PAYLOAD_GET_USERNAME_HANDLER': 'django_cbim_general_service.utils.get_jwt_payload_get_username',
    'JWT_GET_USER_BY_NATURAL_KEY_HANDLER': 'django_cbim_general_service.utils.get_user_by_natural_key_handler',
}

DJANGO_APP_GRAPHQL = {
    "BACKEND_TYPE": "graphene",
    "EXPOSE_GRAPHIQL": True,
    "GRAPHQL_SERVER_URL": "",
    "ENABLE_GRAPHQL_FEDERATION": True,
    "SAVE_GRAPHQL_SCHEMA": os.path.join("output", "schema.graphql"),
    "ADD_DUMMY_QUERIES_IF_ABSENT": True,
    "ADD_DUMMY_MUTATIONS_IF_ABSENT": True,
}

Documentation