Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
Store	69	67	0%	23	46	0.510638351.1%	Show methods

Class Store

Class Store	Line # 69	Total Statements 67	% Filtered 0%	Complexity 23	Uncovered Elements 46	TOTAL Coverage 0.510638351.1%
Store()   Store()	7777	1.01	0.00%	1.01	1.01	0.0 0.00%
Store(CacheModule)   Store(CacheModule)	8181	1.01	0.00%	1.01	0.00	1.0 1.0100%
processCacheRequest(HttpServletRequest,HttpServletResponse,FilterChain,Cache,CachePolicyResult) : void   processCacheRequest(HttpServletRequest,HttpServletResponse,FilterChain,Cache,CachePolicyResult) : void	8686	36.036	0.00%	11.011	20.020	0.5652174 0.565217456.5%
makeCachedEntry(HttpServletRequest,CacheResponseWrapper,Cache,CachePolicyResult) : CachedEntry   makeCachedEntry(HttpServletRequest,CacheResponseWrapper,Cache,CachePolicyResult) : CachedEntry	152152	16.016	0.00%	4.04	8.08	0.6363636 0.636363663.6%
getTimeToLive(CacheResponseWrapper,Cache) : int   getTimeToLive(CacheResponseWrapper,Cache) : int	198198	1.01	0.00%	1.01	0.00	1.0 1.0100%
getCachePolicy(Cache) : CachePolicy   getCachePolicy(Cache) : CachePolicy	202202	1.01	0.00%	1.01	0.00	1.0 1.0100%
getTimeToLive(HttpServletRequest,CacheResponseWrapper) : int   getTimeToLive(HttpServletRequest,CacheResponseWrapper) : int	210210	11.011	0.00%	4.04	15.015	0.0 0.00%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.5106383	info.magnolia.module.cache.filter.CacheFilterTest.testIfWeAreNotWriteContentToResponseTwiceWhenTimeToLiveInSecondsIsZeroinfo.magnolia.module.cache.filter.CacheFilterTest.testIfWeAreNotWriteContentToResponseTwiceWhenTimeToLiveInSecondsIsZero	1PASS
	0.4893617	info.magnolia.module.cache.filter.CacheFilterTest.testLastModifiedHeaderCanBeOverriddenByFurtherFiltersAndIsProperlyStoredAndReturnedinfo.magnolia.module.cache.filter.CacheFilterTest.testLastModifiedHeaderCanBeOverriddenByFurtherFiltersAndIsProperlyStoredAndReturned	1PASS
	0.4893617	info.magnolia.module.cache.filter.CacheFilterTest.testErrorsAreCachedinfo.magnolia.module.cache.filter.CacheFilterTest.testErrorsAreCached	1PASS
	0.4893617	info.magnolia.module.cache.filter.CacheFilterTest.testStoresCompressedInCacheAndRendersinfo.magnolia.module.cache.filter.CacheFilterTest.testStoresCompressedInCacheAndRenders	1PASS
	0.4893617	info.magnolia.module.cache.filter.CacheFilterTest.testRedirectsAreCachedinfo.magnolia.module.cache.filter.CacheFilterTest.testRedirectsAreCached	1PASS
	0.4893617	info.magnolia.module.cache.filter.CacheFilterTest.testStoresInCacheAndRendersinfo.magnolia.module.cache.filter.CacheFilterTest.testStoresInCacheAndRenders	1PASS

 

Source view

1		/**
2		* This file Copyright (c) 2008-2018 Magnolia International
3		* Ltd. (http://www.magnolia-cms.com). All rights reserved.
4		*
5		*
6		* This file is dual-licensed under both the Magnolia
7		* Network Agreement and the GNU General Public License.
8		* You may elect to use one or the other of these licenses.
9		*
10		* This file is distributed in the hope that it will be
11		* useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12		* implied warranty of MERCHANTABILITY or FITNESS FOR A
13		* PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14		* Redistribution, except as permitted by whichever of the GPL
15		* or MNA you select, is prohibited.
16		*
17		* 1. For the GPL license (GPL), you can redistribute and/or
18		* modify this file under the terms of the GNU General
19		* Public License, Version 3, as published by the Free Software
20		* Foundation. You should have received a copy of the GNU
21		* General Public License, Version 3 along with this program;
22		* if not, write to the Free Software Foundation, Inc., 51
23		* Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24		*
25		* 2. For the Magnolia Network Agreement (MNA), this file
26		* and the accompanying materials are made available under the
27		* terms of the MNA which accompanies this distribution, and
28		* is available at http://www.magnolia-cms.com/mna.html
29		*
30		* Any modifications to this file must keep this entire header
31		* intact.
32		*
33		*/
34		package info.magnolia.module.cache.executor;
35
36		import info.magnolia.cms.cache.CacheConstants;
37		import info.magnolia.context.MgnlContext;
38		import info.magnolia.jcr.util.NodeUtil;
39		import info.magnolia.module.ModuleRegistry;
40		import info.magnolia.module.cache.Cache;
41		import info.magnolia.module.cache.CacheModule;
42		import info.magnolia.module.cache.CachePolicy;
43		import info.magnolia.module.cache.CachePolicyResult;
44		import info.magnolia.module.cache.filter.CacheResponseWrapper;
45		import info.magnolia.module.cache.filter.CachedEntry;
46		import info.magnolia.module.cache.filter.CachedError;
47		import info.magnolia.module.cache.filter.CachedRedirect;
48		import info.magnolia.module.cache.filter.ContentCachedEntry;
49		import info.magnolia.module.cache.filter.DelegatingBlobCachedEntry;
50		import info.magnolia.module.cache.filter.InMemoryCachedEntry;
51		import info.magnolia.module.cache.filter.UncacheableEntry;
52		import info.magnolia.objectfactory.Components;
53
54		import java.io.IOException;
55
56		import javax.inject.Inject;
57		import javax.jcr.Node;
58		import javax.jcr.RepositoryException;
59		import javax.servlet.FilterChain;
60		import javax.servlet.ServletException;
61		import javax.servlet.http.HttpServletRequest;
62		import javax.servlet.http.HttpServletResponse;
63
64		import org.apache.commons.lang3.StringUtils;
65
66		/**
67		* Wraps the response and stores the content in a cache Entry.
68		*/
		51.1% Uncovered Elements: 46 (94) Complexity: 23 Complexity Density: 0.34
69		public class Store extends AbstractExecutor {
70
71		private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(Store.class);
72		private final CacheModule cacheModule;
73
74		/**
75		* @deprecated since 5.2.3. Use {@link #Store(CacheModule)} instead.
76		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
77	0	public Store() {...
78	0	this.cacheModule = Components.getComponent(ModuleRegistry.class).getModuleInstance(CacheModule.class);
79		}
80
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
81	25	@Inject...
82		public Store(CacheModule cacheModule) {
83	25	this.cacheModule = cacheModule;
84		}
85
		56.5% Uncovered Elements: 20 (46) Complexity: 11 Complexity Density: 0.31
86	6	@Override...
87		public void processCacheRequest(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Cache cache, CachePolicyResult cachePolicyResult) throws IOException, ServletException {
88
89	6	CachedEntry cachedEntry = null;
90	6	final Object key = cachePolicyResult.getCacheKey();
91
92	6	final CacheResponseWrapper responseWrapper = new CacheResponseWrapper(response, CacheResponseWrapper.DEFAULT_THRESHOLD, false);
93	6	responseWrapper.setResponseExpirationDetectionEnabled();
94
95		// setting Last-Modified to when this resource was stored in the cache. This value might get overridden by further filters or servlets.
96	6	final long cacheStorageDate = System.currentTimeMillis();
97	6	responseWrapper.setDateHeader("Last-Modified", cacheStorageDate);
98
99	6	try {
100	6	chain.doFilter(request, responseWrapper);
101	6	if (responseWrapper.getStatus() == HttpServletResponse.SC_NOT_MODIFIED) {
102	0	response.setStatus(HttpServletResponse.SC_NOT_MODIFIED);
103		} else {
104	6	responseWrapper.flushBuffer();
105	6	cachedEntry = makeCachedEntry(request, responseWrapper, cache, cachePolicyResult);
106	6	if (cachedEntry.getTimeToLiveInSeconds() == 0) {
107	6	cachedEntry = new UncacheableEntry(cachedEntry);
108		}
109		}
110
111		} catch (IOException e) {
112	0	responseWrapper.cleanUp();
113	0	throw e;
114		} catch (ServletException e) {
115	0	responseWrapper.cleanUp();
116	0	throw e;
117		} catch (Throwable e) {
118	0	responseWrapper.cleanUp();
119	0	throw new RuntimeException("Failed to process request with: " + e.getMessage(), e);
120		}
121
122	6	if (cachedEntry == null) {
123		// put null to unblock the cache
124	0	cache.put(key, null);
125	0	return;
126		}
127
128	6	int timeToLiveInSeconds = cachedEntry.getTimeToLiveInSeconds();
129	6	cachePolicyResult.setCachedEntry(cachedEntry);
130
131	6	if (timeToLiveInSeconds == -1) {
132	6	cache.put(key, cachedEntry);
133		} else {
134	0	cache.put(key, cachedEntry, timeToLiveInSeconds);
135		}
136
137		// let policy know the uuid in case it wants to do something with it
138	6	final Node content = MgnlContext.getAggregationState().getMainContentNode();
139	6	try {
140	6	if (content != null && NodeUtil.isNodeType(content, "mix:referenceable")) {
141	0	final String uuid = content.getIdentifier();
142	0	String repo = content.getSession().getWorkspace().getName();
143	0	getCachePolicy(cache).persistCacheKey(repo, uuid, key);
144		}
145		} catch (RepositoryException e) {
146		// TODO dlipp: apply consistent ExceptionHandling
147	0	responseWrapper.cleanUp();
148	0	throw new RuntimeException(e);
149		}
150		}
151
		63.6% Uncovered Elements: 8 (22) Complexity: 4 Complexity Density: 0.25
152	6	protected CachedEntry makeCachedEntry(HttpServletRequest request, CacheResponseWrapper cachedResponse, Cache cache, CachePolicyResult cachePolicyResult) throws IOException {...
153		// query params are handled by the cache key
154	6	final String originalUrl = request.getRequestURL().toString();
155	6	int status = cachedResponse.getStatus();
156	6	int timeToLiveInSeconds = this.getTimeToLive(cachedResponse, cache);
157
158		// TODO : handle more of the 30x codes - although CacheResponseWrapper currently only sets the 302 or 304.
159	6	if (cachedResponse.getRedirectionLocation() != null) {
160	0	return new CachedRedirect(cachedResponse.getStatus(), cachedResponse.getRedirectionLocation(), originalUrl, timeToLiveInSeconds);
161		}
162
163	6	if (cachedResponse.isError()) {
164	0	return new CachedError(cachedResponse.getStatus(), originalUrl, timeToLiveInSeconds);
165		}
166
167	6	final long modificationDate = cachedResponse.getLastModified();
168	6	final String contentType = cachedResponse.getContentType();
169
170	6	ContentCachedEntry cacheEntry;
171	6	if (!cachedResponse.isThresholdExceeded()) {
172	6	cacheEntry = new InMemoryCachedEntry(cachedResponse.getBufferedContent(),
173		contentType,
174		cachedResponse.getCharacterEncoding(),
175		status,
176		cachedResponse.getHeaders(),
177		modificationDate,
178		originalUrl,
179		timeToLiveInSeconds);
180		} else {
181	0	cacheEntry = new DelegatingBlobCachedEntry(cachedResponse.getContentLength(),
182		contentType,
183		cachedResponse.getCharacterEncoding(),
184		status,
185		cachedResponse.getHeaders(),
186		modificationDate,
187		originalUrl,
188		timeToLiveInSeconds);
189
190		// TODO remove this once we use a blob store
191		// the file will be deleted once served in this request
192	0	((DelegatingBlobCachedEntry) cacheEntry).bindContentFileToCurrentRequest(request, cachedResponse.getContentFile());
193	0	cachedResponse.getThresholdingOutputStream().close();
194		}
195	6	return cacheEntry;
196		}
197
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
198	6	protected int getTimeToLive(CacheResponseWrapper cachedResponse, Cache cache) {...
199	6	return this.getCachePolicy(cache).getTtlVoters().vote(cachedResponse);
200		}
201
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
202	6	protected CachePolicy getCachePolicy(Cache cache) {...
203	6	return cacheModule.getContentCaching(cache.getName()).getCachePolicy();
204		}
205
206		//deprecated methods
207		/**
208		* @deprecated since 5.4. Use {@link #getTimeToLive(info.magnolia.module.cache.filter.CacheResponseWrapper, info.magnolia.module.cache.Cache)} instead.
209		*/
		0% Uncovered Elements: 15 (15) Complexity: 4 Complexity Density: 0.36
210	0	@Deprecated...
211		protected int getTimeToLive(HttpServletRequest request, CacheResponseWrapper cachedResponse) {
212	0	Object attribute = request.getAttribute(CacheConstants.HEADER_X_MAGNOLIA_CACHE);
213	0	if (attribute instanceof String) {
214	0	String attributeAsString = (String) attribute;
215	0	String[] splitted = StringUtils.split(attributeAsString, ",");
216	0	for (String headerValue : splitted) {
217	0	if (headerValue.contains(CacheConstants.HEADER_VALUE_TTL + "=")) {
218	0	String ttlString = StringUtils.substringAfter(headerValue, CacheConstants.HEADER_VALUE_TTL + "=");
219	0	try {
220	0	return Integer.parseInt(ttlString);
221		} catch (NumberFormatException e) {
222	0	log.error("Unparsable TTL in '{}' attribute: {}", CacheConstants.HEADER_X_MAGNOLIA_CACHE, headerValue);
223		}
224		}
225		}
226		}
227	0	return cachedResponse.getTimeToLiveInSeconds();
228		}
229
230		}