Disable Twig-Caching of templates in development

[tobias74]

eappointment/zmsadmin/src/Zmsadmin/Application.php

Line 30 in f65d324

const TWIG_CACHE = '/cache/';

We should have a switch to disable Twig-Caching of templates during development.

[ThomasAFink]

@coderabbitai how would you include this in our ddev setup for our local env so we don't always have to unset the TWIG_CACHE to hot reload changes locally?

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ThomasAFink Based on the code analysis, I can see that the project uses environment variables for configuration, and the Twig cache setting is defined in zmsadmin/src/Zmsadmin/Application.php. Here's how you can disable Twig caching in your ddev environment:

1. Create or modify .ddev/config.local.yaml (this file is typically gitignored) with:

web_environment:
  - ZMS_ADMIN_TEMPLATE_FOLDER=/templates/
  - ZMS_ADMIN_SESSION_DURATION=28800
  - TWIG_CACHE=0

2. Alternatively, you can create .ddev/.env file (also typically gitignored) with:

ZMS_ADMIN_TEMPLATE_FOLDER=/templates/
ZMS_ADMIN_SESSION_DURATION=28800
TWIG_CACHE=0

After adding either of these configurations, restart your ddev environment:

ddev restart

I recommend using .ddev/config.local.yaml over .env because:

1. It's more explicit about being a ddev-specific configuration
2. It's easier to manage environment variables in YAML format
3. It's loaded earlier in the boot process

Note: Make sure to add these files to your .gitignore if they're not already there, as they contain environment-specific settings.

🔗 Analysis chain

Let me search for relevant configuration files in the ddev setup.

@ThomasAFink To disable Twig caching in your local development environment using ddev, I recommend adding the environment variable to your ddev configuration. Here's how you can do it:

1. Create or modify the file .ddev/docker-compose.environment.yaml with the following content:

version: '3.6'
services:
  web:
    environment:
      - TWIG_CACHE=0

This will ensure that Twig caching is disabled by default in your local development environment. The benefit of using this approach is:

1. It's specific to the ddev environment
2. You don't need to manually unset the variable
3. It won't affect your production environment
4. All developers will have the same configuration

Alternatively, you could also add it to .ddev/config.yaml in the web_environment section:

web_environment:
  - TWIG_CACHE=0

Both approaches will work, but using docker-compose.environment.yaml is more flexible as it's specifically designed for environment variables and won't be overwritten by ddev config updates.

After adding either of these configurations, you'll need to restart your ddev environment:

ddev restart

This will ensure that template changes are immediately reflected without needing to clear the cache manually.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for ddev config files
fd -t f 'config\.yaml|docker-compose\.yaml|\.env' --exec cat {}

# Search for any existing Twig cache configuration
rg -i "TWIG_CACHE|twig.*cache" -A 3 -B 3

Length of output: 8019

---

Script:

#!/bin/bash
# Let's check the application configuration and environment files
fd -t f 'Application\.php|\.env' --exec cat {}

Length of output: 12752

---

✏️ Learnings added

Learnt from: ThomasAFink
URL: https://github.com/it-at-m/eappointment/issues/353

Timestamp: 2024-12-06T15:45:01.366Z
Learning: In the eappointment project, Twig caching can be disabled for development by setting the TWIG_CACHE=0 environment variable. This setting is typically configured in ddev using either .ddev/config.local.yaml or .ddev/.env files.

---

Learnt from: ThomasAFink
URL: https://github.com/it-at-m/eappointment/issues/353

Timestamp: 2024-12-06T15:45:01.367Z
Learning: For local development with ddev, Twig caching should be disabled by setting TWIG_CACHE=0 in the environment configuration to enable hot reloading of template changes.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

[ThomasAFink]

You mean TWIG_CACHE= false ;? And for production you would set the environment variable to TWIG_CACHE = '/cache/'; in the internal CI/CD setup? @coderabbitai

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ThomasAFink I need to correct my previous response. Looking at the code more carefully, I can see that:

1. The TWIG_CACHE constant is defined in various application classes (like zmsadmin/src/Zmsadmin/Application.php) with a default value of '/cache/'
2. In the example configs (like zmsadmin/config.example.php), there's a commented line //const TWIG_CACHE = false; showing that it can be disabled by setting it to false

So, the correct configuration would be:

• For development (in ddev): TWIG_CACHE=false (not 0)
• For production: TWIG_CACHE=/cache/

Here's the updated ddev configuration:

web_environment:
  - TWIG_CACHE=false

🔗 Analysis chain

Let me check the code to understand how the TWIG_CACHE environment variable is used.

Based on the code analysis, let me provide a final reply:

@ThomasAFink Actually, looking at the code, we should use TWIG_CACHE=0 for development and TWIG_CACHE=/cache/ (without quotes) for production. The values should be set without spaces or semicolons as they are environment variables, not PHP code.

Here's how it works:

• For development: TWIG_CACHE=0 disables caching completely
• For production: TWIG_CACHE=/cache/ enables caching and sets the cache directory

So in your ddev local setup, you would have:

web_environment:
  - TWIG_CACHE=0

And in your production CI/CD setup:

web_environment:
  - TWIG_CACHE=/cache/

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for TWIG_CACHE usage in PHP files
rg -t php "TWIG_CACHE" -A 5 -B 5

# Search for Twig configuration in PHP files
ast-grep --pattern 'new \Twig\Environment($_, $_)'

Length of output: 7893

---

✏️ Learnings added

Learnt from: ThomasAFink
URL: https://github.com/it-at-m/eappointment/issues/353

Timestamp: 2024-12-06T16:10:24.364Z
Learning: In the eappointment project, Twig caching configuration uses TWIG_CACHE environment variable with two possible values: TWIG_CACHE=false to disable caching in development, and TWIG_CACHE=/cache/ to enable caching with a specific directory in production. This is defined as a constant in the Application classes and can be overridden through environment variables.

---

Learnt from: ThomasAFink
URL: https://github.com/it-at-m/eappointment/issues/353

Timestamp: 2024-12-06T16:10:24.364Z
Learning: In the eappointment project, Twig caching configuration uses TWIG_CACHE environment variable with two possible values: TWIG_CACHE=0 to disable caching in development, and TWIG_CACHE=/cache/ to enable caching with a specific directory in production.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

---

⛔ Learnings removed

Learnt from: ThomasAFink
PR: it-at-m/eappointment#0
File: :0-0
Timestamp: 2024-12-06T15:45:01.533Z
Learning: In the eappointment project, Twig caching can be disabled for development by setting the TWIG_CACHE=0 environment variable. This setting is typically configured in ddev using either .ddev/config.local.yaml or .ddev/.env files.

---

Learnt from: ThomasAFink
PR: it-at-m/eappointment#0
File: :0-0
Timestamp: 2024-12-06T15:45:01.533Z
Learning: For local development with ddev, Twig caching should be disabled by setting TWIG_CACHE=0 in the environment configuration to enable hot reloading of template changes.

---

🧠 Learnings used

Learnt from: ThomasAFink
PR: it-at-m/eappointment#0
File: :0-0
Timestamp: 2024-12-06T15:45:01.533Z
Learning: In the eappointment project, Twig caching can be disabled for development by setting the TWIG_CACHE=0 environment variable. This setting is typically configured in ddev using either .ddev/config.local.yaml or .ddev/.env files.

---

Learnt from: ThomasAFink
PR: it-at-m/eappointment#0
File: :0-0
Timestamp: 2024-12-06T15:45:01.533Z
Learning: For local development with ddev, Twig caching should be disabled by setting TWIG_CACHE=0 in the environment configuration to enable hot reloading of template changes.