Addon file caching (files in storage/tmp)

fafn · January 23, 2021, 4:13pm

Hi everyone!

Does anyone have any insights on how addon caching works?

I installed a custom addon which works fine but when I quickly wanted to change something in the .tag-file the changes didn’t show up in the UI.

After some digging I found parts of the custom tag in storage/tmp/14ac1d4f21cb0042eca0caab225d4581.js. My question is if it is safe to delete this file or if there is another way to tell Cockpit to re-read my .tag-file?

Thanks in advance!

raffaelj · January 25, 2021, 1:31pm

If you turn debug mode on, then assets get a timestamp suffix to prevent browser caching and the js caching mechanism will be ignored.

To enable debug mode, change your config/config.php to

return [
    'debug' => true,
    // other options...
];

If your host is localhost, debug is on by default if not disabled via config file.

If the .tag file extension isn’t .js, it shouldn’t end up in the js cache… Did you try to disable caching in your browser dev tools (in Firefox in the network tab, should be similar in chrome)?

I guess, that the addon overwrote a core component, which are stored in modules/Cockpit/assets/components.js, so the core components are in the cached js file.

You can delete everything inside storage/tmp. It will be regenerated, if needed.
You might want to keep .gitignore and index.html in this directory. So don’t delete these files.

assets timestamp:

github.com

agentejo/cockpit/blob/next/modules/Cockpit/views/layouts/app.php#L33


      
          {{ $app->helper('admin')->favicon('red') }}
          <meta name="viewport" content="width=device-width, initial-scale=1.0" />
          
          <script>
              // App constants
              var SITE_URL   = '{{ rtrim($app->filestorage->getUrl('site://'), '/') }}';
              var ASSETS_URL = '{{ rtrim($app->filestorage->getUrl('assets://'), '/') }}';
              var PUBLIC_STORAGE_URL = '{{ rtrim($app->pathToUrl('#pstorage:'), '/') }}';
          </script>
          
          {{ $app->assets($app('admin')->data->get('assets'), $app['debug'] ? time() : $app['cockpit/version']) }}
          
          <script src="@route('/cockpit.i18n.data')"></script>
          
          <script>
              App.$data = {{ json_encode($app('admin')->data->get('extract')) }};
              UIkit.modal.labels.Ok = App.i18n.get(UIkit.modal.labels.Ok);
              UIkit.modal.labels.Cancel = App.i18n.get(UIkit.modal.labels.Cancel);
          </script>
          
          @trigger('app.layout.header')

cache for js assets:

github.com

agentejo/cockpit/blob/next/lib/LimeExtra/App.php#L154-L200


      
          
          public function assets($src, $version=false){
          
              $list   = [];
              $js     = [];
              $debug  = $this->retrieve('debug');
              $jshash = '';
          
              foreach ((array)$src as $asset) {
          
                  $src = $asset;
          
                  if (\is_array($asset)) {
                      extract($asset);
                  }
          
                  if (@\substr($src, -3) == '.js') {
          
                      $ispath = \strpos($src, ':') !== false && !\preg_match('#^(|http\:|https\:)//#', $src);

This file has been truncated. show original

auto debug on localhost:

github.com

agentejo/cockpit/blob/next/bootstrap.php#L101


      
          $customConfig = [];
          
          // load custom config
          if (file_exists(COCKPIT_CONFIG_PATH)) {
              $customConfig = preg_match('/\.yaml$/', COCKPIT_CONFIG_PATH) ? Spyc::YAMLLoad(COCKPIT_CONFIG_PATH) : include(COCKPIT_CONFIG_PATH);
          }
          
          // load config
          $config = array_replace_recursive([
          
              'debug'        => preg_match('/(localhost|::1|\.local)$/', @$_SERVER['SERVER_NAME']),
              'app.name'     => 'Cockpit',
              'base_url'     => COCKPIT_BASE_URL,
              'base_route'   => COCKPIT_BASE_ROUTE,
              'docs_root'    => COCKPIT_DOCS_ROOT,
              'session.name' => md5(COCKPIT_ENV_ROOT),
              'session.init' => (COCKPIT_ADMIN && !COCKPIT_API_REQUEST) ? true : false,
              'sec-key'      => 'c3b40c4c-db44-s5h7-a814-b4931a15e5e1',
              'i18n'         => 'en',
              'database'     => ['server' => 'mongolite://'.(COCKPIT_STORAGE_FOLDER.'/data'), 'options' => ['db' => 'cockpitdb'], 'driverOptions' => [] ],
              'memory'       => ['server' => 'redislite://'.(COCKPIT_STORAGE_FOLDER.'/data/cockpit.memory.sqlite'), 'options' => [] ],

fafn · January 25, 2021, 4:34pm

Thanks for your reply! The debug mode did the trick.

I used your field-tags-autoupdate which I assume overwrote the regular tags.

Thanks again for all the awesome Cockpit Addons and the great Cockpit support you provide!

raffaelj · January 25, 2021, 6:01pm

I see. It doesn’t overwrite the core tag field, but the whole code is based on the core field.

I didn’t update this modified field for a while. Have a look at the changes to the core field, so the limit option is not available and the keycode for , (comma) is hardcoded, which fails for some keyboard layouts (e. g. Russian).

Feel free to update it and send a pull request if you need the changes or if you want to provide them to future users.

Topic		Replies	Views
Some questions about addons dev in v2 - Questions / FAQ? Cockpit v2	0	354	August 26, 2022
Caching Problem?	1	637	July 22, 2018
Google Drive addon Addons	3	1283	April 29, 2021
New Addon - Redis integration for caching Addons	7	1200	November 20, 2018
Is the deletion of files really permanent? Support	1	724	August 19, 2021

Addon file caching (files in storage/tmp)

Related topics