From aacadb31fcf59457ba81c53d96ed47ddc821f595 Mon Sep 17 00:00:00 2001
From: Leandro Roberto <leandroroberto.br@gmail.com>
Date: Mon, 18 Feb 2019 09:56:14 -0300
Subject: [PATCH] =?UTF-8?q?configura=20ativa=C3=A7=C3=A3o=20para=20channel?=
 =?UTF-8?q?s?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/instalacao31.rst                         | 36 +++++++++++++++++++
 sapl/rules/apps.py                            | 36 ++++++++++++-------
 sapl/settings.py                              |  4 +++
 .../templates/base/time_refresh_log_test.html |  2 +-
 sapl/webpack-stats.json                       |  2 +-
 5 files changed, 65 insertions(+), 15 deletions(-)

diff --git a/docs/instalacao31.rst b/docs/instalacao31.rst
index a9752990f..2cc2b7796 100644
--- a/docs/instalacao31.rst
+++ b/docs/instalacao31.rst
@@ -145,9 +145,14 @@ Criação da `SECRET_KEY <https://docs.djangoproject.com/es/1.9/ref/settings/#st
       SERVER_EMAIL = [Insira este parâmetro]
 
       SOLR_URL = '[Insira este parâmetro]'
+      USE_SOLR = '[Insira este parâmetro]'
+      SOLR_COLLECTION = '[Insira este parâmetro]'
       
       FRONTEND_CUSTOM = [True/False]
 
+      SITE_URL = '[Insira este parâmetro]'
+
+      TZ = 'America/Sao_Paulo'
 
     * Uma configuração mínima para atender os procedimentos acima seria::
 
@@ -282,3 +287,34 @@ Feito isso, e você ativando a variável de ambiente FRONTEND_CUSTOM=True (vide
 **Deste ponto em diante, é exigido o conhecimento que você pode adquirir em https://cli.vuejs.org/guide/ e em https://vuejs.org/v2/guide/ para colaborar com sapl-frontend**
 
 **OBS: após a separação do sapl para o sapl-frontend, o conteúdo da pasta static é compilado e minificado. É gerado pelo build do sapl-frontend e não deve-se tentar customizar ou criar elementos manipulando diretamente informações na pasta static.**
+
+Django-Channels
+===============
+
+Para ativar Django-Channels e a comunicação via websockets utilizada pelo entry-point sessao/online de sapl-frontend coloque no arquivo .env a variável:
+
+    USE_CHANNEL_LAYERS = True
+
+
+Ao ativar o channels, no ambiente de desenvolvimento é necessário ativar um servidor redis. Utilize/Instale o docker e execute:
+
+  sudo docker run -p 6379:6379 -d redis:5.0.3-stretch
+
+No caso de ambiente de produção, o container do docker sapl para produção já está configurado com redis.
+
+Testes do channels
+------------------
+
+Existe uma interface mínima de comunicação para testes dentro do sapl. Pode ser acessada utilizando:
+
+  http://localhost:8001/sapl/time-refresh/
+
+Se clicar em `pull`, o websocket de teste deve responder:
+
+  {"message": "OK"}
+
+De outro modo, ficando com esta interface aberta, abra outra janela e altere/inclua/apague algo em seu sapl. Será enviado um json que segue este padrão:
+
+  {"message": {"action": "post_save", "id": 16923, "app": "materia", "model": "autoria"}}
+
+O papel de /sapl/time-refresh/ é apenas isto, informar que houve ação no registro `id`, da `app` e `model`. Além de `action` que pode ser `post_save` ou `pre-delete`.
diff --git a/sapl/rules/apps.py b/sapl/rules/apps.py
index 9ab8d1c73..4d2a925af 100644
--- a/sapl/rules/apps.py
+++ b/sapl/rules/apps.py
@@ -4,6 +4,7 @@ import logging
 from asgiref.sync import async_to_sync
 from channels.layers import get_channel_layer
 import django.apps
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.contrib.auth.management import _get_all_permissions
 from django.core import exceptions
@@ -258,6 +259,9 @@ def cria_usuarios_padrao():
 
 def send_signal_for_websocket_time_refresh(inst, action):
 
+    if not settings.USE_CHANNEL_LAYERS:
+        return
+
     if hasattr(inst, '_meta') and not inst._meta.app_config is None and \
             inst._meta.app_config.name[:4] == 'sapl':
 
@@ -272,19 +276,26 @@ def send_signal_for_websocket_time_refresh(inst, action):
                                 map(lambda x: x[3], inspect.stack())))
 
         if not funcs:
-            channel_layer = get_channel_layer()
-
-            async_to_sync(channel_layer.group_send)(
-                "group_time_refresh_channel", {
-                    "type": "time_refresh.message",
-                    'message': {
-                        'action': action,
-                        'id': inst.id,
-                        'app': inst._meta.app_label,
-                        'model': inst._meta.model_name
+            try:
+                channel_layer = get_channel_layer()
+
+                async_to_sync(channel_layer.group_send)(
+                    "group_time_refresh_channel", {
+                        "type": "time_refresh.message",
+                        'message': {
+                            'action': action,
+                            'id': inst.id,
+                            'app': inst._meta.app_label,
+                            'model': inst._meta.model_name
+                        }
                     }
-                }
-            )
+                )
+            except Exception as e:
+                logger = logging.getLogger(__name__)
+                logger.info(_("Erro na comunicação com o backend do redis. "
+                              "Certifique se possuir um servidor de redis "
+                              "ativo funcionando como configurado em "
+                              "CHANNEL_LAYERS"))
 
 
 def revision_pre_delete_signal(sender, **kwargs):
@@ -296,7 +307,6 @@ def revision_pre_delete_signal(sender, **kwargs):
 
 @receiver(post_save, dispatch_uid='sapl_post_save_signal')
 def sapl_post_save_signal(sender, instance, using, **kwargs):
-
     send_signal_for_websocket_time_refresh(instance, 'post_save')
 
 
diff --git a/sapl/settings.py b/sapl/settings.py
index 0e8a8dab6..1ca615537 100644
--- a/sapl/settings.py
+++ b/sapl/settings.py
@@ -207,6 +207,10 @@ TEMPLATES = [
 
 WSGI_APPLICATION = 'sapl.wsgi.application'
 ASGI_APPLICATION = "sapl.routing.application"
+
+
+USE_CHANNEL_LAYERS = config('USE_CHANNEL_LAYERS', cast=bool, default=False)
+
 CHANNEL_LAYERS = {
     'default': {
         'BACKEND': 'channels_redis.core.RedisChannelLayer',
diff --git a/sapl/templates/base/time_refresh_log_test.html b/sapl/templates/base/time_refresh_log_test.html
index ed3adb7d5..245236d73 100644
--- a/sapl/templates/base/time_refresh_log_test.html
+++ b/sapl/templates/base/time_refresh_log_test.html
@@ -27,7 +27,7 @@
 
     document.querySelector('#chat-message-submit').onclick = function(e) {
         chatSocket.send(JSON.stringify({
-            'message': 'Olá'
+            'message': 'OK'
         }));
     };
 </script>
diff --git a/sapl/webpack-stats.json b/sapl/webpack-stats.json
index d4516dde0..bb25f2f67 100644
--- a/sapl/webpack-stats.json
+++ b/sapl/webpack-stats.json
@@ -1 +1 @@
-{"status":"done","publicPath":"/static/sapl/","chunks":{"chunk-vendors":[{"name":"css/chunk-vendors.3c9fe6b4.css","publicPath":"/static/sapl/css/chunk-vendors.3c9fe6b4.css","path":"../sapl/sapl/static/sapl/css/chunk-vendors.3c9fe6b4.css"},{"name":"js/chunk-vendors.0003dc37.js","publicPath":"/static/sapl/js/chunk-vendors.0003dc37.js","path":"../sapl/sapl/static/sapl/js/chunk-vendors.0003dc37.js"},{"name":"css/chunk-vendors.3c9fe6b4.css.map","publicPath":"/static/sapl/css/chunk-vendors.3c9fe6b4.css.map","path":"../sapl/sapl/static/sapl/css/chunk-vendors.3c9fe6b4.css.map"}],"compilacao":[{"name":"css/compilacao.3372b760.css","publicPath":"/static/sapl/css/compilacao.3372b760.css","path":"../sapl/sapl/static/sapl/css/compilacao.3372b760.css"},{"name":"js/compilacao.9853b958.js","publicPath":"/static/sapl/js/compilacao.9853b958.js","path":"../sapl/sapl/static/sapl/js/compilacao.9853b958.js"},{"name":"css/compilacao.3372b760.css.map","publicPath":"/static/sapl/css/compilacao.3372b760.css.map","path":"../sapl/sapl/static/sapl/css/compilacao.3372b760.css.map"}],"global":[{"name":"css/global.f7113e2c.css","publicPath":"/static/sapl/css/global.f7113e2c.css","path":"../sapl/sapl/static/sapl/css/global.f7113e2c.css"},{"name":"js/global.081db1b5.js","publicPath":"/static/sapl/js/global.081db1b5.js","path":"../sapl/sapl/static/sapl/js/global.081db1b5.js"},{"name":"css/global.f7113e2c.css.map","publicPath":"/static/sapl/css/global.f7113e2c.css.map","path":"../sapl/sapl/static/sapl/css/global.f7113e2c.css.map"}],"painel":[{"name":"css/painel.baa845ab.css","publicPath":"/static/sapl/css/painel.baa845ab.css","path":"../sapl/sapl/static/sapl/css/painel.baa845ab.css"},{"name":"js/painel.f4adb91b.js","publicPath":"/static/sapl/js/painel.f4adb91b.js","path":"../sapl/sapl/static/sapl/js/painel.f4adb91b.js"},{"name":"css/painel.baa845ab.css.map","publicPath":"/static/sapl/css/painel.baa845ab.css.map","path":"../sapl/sapl/static/sapl/css/painel.baa845ab.css.map"}]}}
\ No newline at end of file
+{"status":"done","publicPath":"/static/sapl/","chunks":{"chunk-vendors":[{"name":"css/chunk-vendors.3c9fe6b4.css","publicPath":"/static/sapl/css/chunk-vendors.3c9fe6b4.css","path":"../sapl/sapl/static/sapl/css/chunk-vendors.3c9fe6b4.css"},{"name":"js/chunk-vendors.0003dc37.js","publicPath":"/static/sapl/js/chunk-vendors.0003dc37.js","path":"../sapl/sapl/static/sapl/js/chunk-vendors.0003dc37.js"},{"name":"css/chunk-vendors.3c9fe6b4.css.map","publicPath":"/static/sapl/css/chunk-vendors.3c9fe6b4.css.map","path":"../sapl/sapl/static/sapl/css/chunk-vendors.3c9fe6b4.css.map"}],"compilacao":[{"name":"css/compilacao.3372b760.css","publicPath":"/static/sapl/css/compilacao.3372b760.css","path":"../sapl/sapl/static/sapl/css/compilacao.3372b760.css"},{"name":"js/compilacao.9853b958.js","publicPath":"/static/sapl/js/compilacao.9853b958.js","path":"../sapl/sapl/static/sapl/js/compilacao.9853b958.js"},{"name":"css/compilacao.3372b760.css.map","publicPath":"/static/sapl/css/compilacao.3372b760.css.map","path":"../sapl/sapl/static/sapl/css/compilacao.3372b760.css.map"}],"global":[{"name":"css/global.f7113e2c.css","publicPath":"/static/sapl/css/global.f7113e2c.css","path":"../sapl/sapl/static/sapl/css/global.f7113e2c.css"},{"name":"js/global.081db1b5.js","publicPath":"/static/sapl/js/global.081db1b5.js","path":"../sapl/sapl/static/sapl/js/global.081db1b5.js"},{"name":"css/global.f7113e2c.css.map","publicPath":"/static/sapl/css/global.f7113e2c.css.map","path":"../sapl/sapl/static/sapl/css/global.f7113e2c.css.map"}],"painel":[{"name":"css/painel.baa845ab.css","publicPath":"/static/sapl/css/painel.baa845ab.css","path":"../sapl/sapl/static/sapl/css/painel.baa845ab.css"},{"name":"js/painel.f4adb91b.js","publicPath":"/static/sapl/js/painel.f4adb91b.js","path":"../sapl/sapl/static/sapl/js/painel.f4adb91b.js"},{"name":"css/painel.baa845ab.css.map","publicPath":"/static/sapl/css/painel.baa845ab.css.map","path":"../sapl/sapl/static/sapl/css/painel.baa845ab.css.map"}]}}