Debugging enhancements

.vscode/launch.json

@@ -8,28 +8,34 @@
       "name": "Pytest",
       "type": "python",
       "request": "launch",
-      "module": "pdm",
-      "args": ["run", "pytest"]
+      "module": "pytest",
+      "args": [
+        "-x",
+        "-vv"
+      ],
+      "envFile": "${workspaceFolder}/.env.test"
     },
     {
-      "name": "Python: Django",
-      "type": "python",
-      "request": "launch",
-      "module": "pdm",
-      "args": ["run", "python", "manage.py", "runserver"],
-      "django": true,
-      "envFile": "${workspaceFolder}/src/app/settings/.env"
-    },
-    {
-      "name": "Python: Django - Docker",
+      "name": "Django Debug",
       "type": "python",
       "request": "launch",
       "program": "${workspaceFolder}/manage.py",
-      "args": ["runserver", "0.0.0.0:80"],
+      "args": [
+        "runserver_plus",
+        "0.0.0.0:8888"
+      ],
       "django": true,
+      "envFile": "${workspaceFolder}/.env",
       "env": {
-        "PYTHONPATH": "__pypackages__/3.9/lib"
-      }
+        // Override these settings, since docker will be running
+        // and the services will be mapped to the host machine
+        "SQL_HOST": "127.0.0.1",
+        "REDIS_HOST": "127.0.0.1",
+        // "CELERY_ALWAYS_EAGER": "1"
+        // Uncomment the above line so tasks aren't dispatched to a worker
+        // with that you can debug it, does not work for periodic tasks
+      },
+      "preLaunchTask": "Start Local Compose"
     }
   ]
 }

.vscode/tasks.json

@@ -0,0 +1,20 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Start Local Compose",
+      "type": "shell",
+      "command": "docker compose -f local.yml --env-file .env up --build",
+      "isBackground": true,
+      "problemMatcher": {
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "django_boilerplate-db_migration-1 exited with code 0",
+          "endsPattern": "Development server is running at"
+        }
+      }
+    }
+  ]
+}

README.md

@@ -781,17 +781,34 @@ Para iniciar a aplicação, vamos precisar criar um arquivo com as variáveis de
 cp .env_files/.env.example .env
 ```
 
-Com isso já é possível subir a aplicação, com o docker compose. Caso ainda não o tenha instalado, siga [estas instruções](https://docs.docker.com/compose/install/linux/). Caso já tenha instalado, basta executar o comando: `docker compose -f local.yml --env-file .env up --build`
+Com isso já é possível subir a aplicação, com o docker compose. Caso ainda não o tenha instalado, siga [estas instruções](https://docs.docker.com/compose/install/linux/).
+
+Caso já tenha instalado, basta executar o comando: `docker compose -f local.yml --env-file .env up --build`
+
+> Outra maneira de executar a aplicação é iniciar a Task definida no VSCode "Start Local Compose". Para isso, pressione `F1` e selecione a opção `Tasks: Run Task` e selecione a task "Start Local Compose".
 
 Após isso, a aplicação e suas dependências estarão disponíveis.
 
 > Caso você tenha um servidor de postgreSQL rodando em sua máquina, talvez seja necessário alterar a variável de ambiente SQL_PORT para não coincidir com a porta do servidor da sua máquina.
 
-Para visitar o Django, acesse [localhost:8000](http://localhost:8000)
+Para visitar o Django, acesse [localhost:8000](http://localhost:8000) ou caso tenha definido uma variável de ambiente `DJANGO_HTTP_PORT` acesse na porta correspondente.
 Para visitar o MailPit, acesse [localhost:8025](http://localhost:8025)
 Você talvez queira conectar o PgAdmin no banco da aplicação, para isso verifique as credencias nas suas variáveis de ambiente, o postgreSQL estará disponível em localhost na porta definida na variável SQL_PORT.
 
 
+### Debugging
+
+Muitas vezes é necessário debugar o projeto, por isso foi adicionado ao boilerplate algumas facilidades para debugar o projeto (principalmente a aplicação Django). Para iniciar a aplicação em modo de Debug, vá até a aba de "Run & Debug" utilizando o atalho `CTRL + Shift + D`, selecione a configuração "Django Debug" após isso pressione o botão de play ou pressione `F5`.
+
+> É importante citar que este comando irá subir os serviços definidos no compose `local.yml`, caso estes serviços já estejam em execução não há efeitos colaterais. Isso acontece por que antes de iniciar a configuração de debug, a tarefa "Start Local Compose" é iniciada.
+
+Após alguns segundos você terá duas instâncias da aplicação Django rodando em sua máquina.
+* Uma na porta `8000` (Ou na porta definida pela variável de ambiente `DJANGO_HTTP_PORT`): A aplicação que subiu junto com o compose, acessar esta instância da aplicação **não irá parar** nos breakpoints definidos no VSCode.
+* Outra na porta `8888`: A aplicação que foi iniciada pelo debugger do VSCode, por isso para debugar a aplicação, acesse através desta porta.
+
+🐛 Happy debugging! 🐛
+
+
 ## Deploy
 
 Normalmente o deploy das aplicações são realizados em uma VPS, como a Amazon EC2. O Boilerplate já vem configurado com CI/CD para o ambiente de Staging, porém é simples copiar e criar um outro worfklow para o ambiente de produção.