0042595: StyleSheet components and StaticResource components do not follow the same criteria for development mode

Openbravo Issue Tracking System - Openbravo ERP

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0042595

Openbravo ERP

A. Platform

public

2019-12-18 13:25

2020-01-17 08:15

Reporter

marvintm

Assigned To

cberner

Priority

normal

Severity

minor

Reproducibility

have not tried

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

Target Version

Fixed in Version

3.0PR20Q2

Merge Request Status

Review Assigned To

caristu

OBNetwork customer

Web browser

Modules

Core

Support ticket

Regression level

Regression date

Regression introduced in release

Regression introduced by commit

Triggers an Emergency Pack

Summary

0042595: StyleSheet components and StaticResource components do not follow the same criteria for development mode

Description

Currently:

- Both StyleSheetResourceComponents and StaticResourceComponents are cached if the system is not in development.
- Both components are added to the manifest for ServiceWorkers functionality for mobile applications
- StyleSheetResource uses the cache information to generate the eTag in case the component is cached
- Manifest component uses the isindevelopment implementation of the StaticResourceComponent to know if it should be empty (in development), or should contain all resources (not in development).

The main issue is that the implementation of the "isInDevelopment" method in StyleSheetResourceComponent and the StaticResourceComponent are not the same, and can return different results depending on the configuration of the system, and this can lead to very confusing behaviour.

The problem is not very serious, as it doesn't affect production instances and only affects developers, but it can be quite annoying if you are developing CSS changes and the WebPOS is not set as in development, and other modules are set as in development.

Steps To Reproduce

The confusing behaviour we got was the following:
- We had an instance with a module which depended on the WebPOS set as in development. The rest of the modules were set as not in development.
- The StaticResourceComponent (correctly) considered that the instance was in development. The WebPOS was shown in development, the manifest was empty, and if the developer did a change in a js file, and refreshed the page, the JS file would be regenerated.
- However, the StyleSheetResourceComponent request, although it was triggered and reached the backend, returned 304 (not modified), because the eTag did not change.
- The reason for this is that the CSS was cached, and the eTag always returned the same checksum.

This was quite confusing because even though the system was in development, in order to test CSS changes you had to restart Tomcat everytime, which was quite annoying.

Proposed Solution

I think we should just follow the same criteria to decide if the system is in development in all parts of the application. In particular, I think the criteria currently followed by the StyleSheetCriteria is wrong, and the same criteria currently used by the StaticResourceComponent should be followed.

Additional Information