Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup and javadoc HttpContent API #12069

Merged
merged 1 commit into from
Jul 25, 2024
Merged

Cleanup and javadoc HttpContent API #12069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 47 additions & 118 deletions ...re/jetty-http/src/main/java/org/eclipse/jetty/http/content/CachingHttpContentFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
import org.eclipse.jetty.io.ByteBufferPool;
import org.eclipse.jetty.io.Content;
import org.eclipse.jetty.io.IOResources;
import org.eclipse.jetty.io.Retainable;
import org.eclipse.jetty.io.RetainableByteBuffer;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.Callback;
Expand Down Expand Up @@ -187,8 +186,11 @@ protected void removeFromCache(CachingHttpContent content)
CachingHttpContent removed = _cache.remove(content.getKey());
if (removed != null)
{
// After the removed entry is released, the caching buffer has been re-pooled which
// makes the length invalid, so getContentLengthValue() must be called before release().
long contentLengthValue = removed.getContentLengthValue();
removed.release();
_cachedSize.addAndGet(-removed.getBytesOccupied());
_cachedSize.addAndGet(-contentLengthValue);
}
}

Expand Down Expand Up @@ -218,7 +220,7 @@ protected boolean isCacheable(HttpContent httpContent)
return false;

// Will it fit in the cache?
long len = httpContent.getBytesOccupied();
long len = httpContent.getContentLengthValue();
return (len <= _maxCachedFileSize && len <= _maxCacheSize);
}

Expand All @@ -230,11 +232,7 @@ public HttpContent getContent(String path) throws IOException
{
cachingHttpContent.setLastAccessedNanos(NanoTime.now());
if (cachingHttpContent.isValid())
{
// If retain fails the CachingHttpContent was already evicted.
if (cachingHttpContent.retain())
return (cachingHttpContent instanceof NotFoundHttpContent) ? null : cachingHttpContent;
}
return (cachingHttpContent instanceof NotFoundHttpContent) ? null : cachingHttpContent;
else
removeFromCache(cachingHttpContent);
}
Expand All @@ -247,27 +245,33 @@ public HttpContent getContent(String path) throws IOException
AtomicBoolean added = new AtomicBoolean();
cachingHttpContent = _cache.computeIfAbsent(path, key ->
{
CachingHttpContent cachingContent = (httpContent == null) ? newNotFoundContent(key) : newCachedContent(key, httpContent);
added.set(true);
_cachedSize.addAndGet(cachingContent.getBytesOccupied());
return cachingContent;
try
{
CachingHttpContent cachingContent = (httpContent == null) ? newNotFoundContent(key) : newCachedContent(key, httpContent);
long contentLengthValue = cachingContent.getContentLengthValue();
if (contentLengthValue < 0L)
{
if (LOG.isDebugEnabled())
LOG.debug("Content at path '{}' with unknown length is not cacheable: {}", path, httpContent);
return null;
}
added.set(true);
_cachedSize.addAndGet(contentLengthValue);
return cachingContent;
}
catch (Throwable x)
{
if (LOG.isDebugEnabled())
LOG.debug("Content at path '{}' is not cacheable: {}", path, httpContent, x);
return null;
}
});

// If retain fails the CachingHttpContent was already evicted.
if (!cachingHttpContent.retain())
return httpContent;

if (added.get())
{
// We want to shrink cache only if we have just added an entry.
shrinkCache();
}
else if (httpContent != null)
{
// If we did not add an entry we are using a cached version added by someone else,
// so we should release the local content taken from the authority.
httpContent.release();
}

return (cachingHttpContent instanceof NotFoundHttpContent) ? null : cachingHttpContent;
}
Expand All @@ -292,26 +296,21 @@ protected interface CachingHttpContent extends HttpContent

boolean isValid();

boolean retain();
void release();
}

protected class CachedHttpContent extends HttpContent.Wrapper implements CachingHttpContent
{
private final RetainableByteBuffer _buffer;
private final String _cacheKey;
private final HttpField _etagField;
private final long _contentLengthValue;
private volatile long _lastAccessed;
private final Set<CompressedContentFormat> _compressedFormats;
private final String _lastModifiedValue;
private final String _characterEncoding;
private final MimeTypes.Type _mimeType;
private final HttpField _contentLength;
private final Instant _lastModifiedInstant;
private final HttpField _lastModified;
private final long _bytesOccupied;
private final boolean _isValid;
private final Retainable.ReferenceCounter _referenceCount = new Retainable.ReferenceCounter();

public CachedHttpContent(String key, HttpContent httpContent)
{
Expand All @@ -326,50 +325,25 @@ public CachedHttpContent(String key, HttpContent httpContent)
etagField = new PreEncodedHttpField(HttpHeader.ETAG, eTagValue);
}
_etagField = etagField;
_contentLengthValue = httpContent.getContentLengthValue();
boolean isValid = true;
_contentLength = httpContent.getContentLength();
long contentLengthValue = httpContent.getContentLengthValue();

// Read the content into memory if the HttpContent does not already have a buffer.
RetainableByteBuffer buffer = null;
try
{
if (_contentLengthValue <= _maxCachedFileSize)
buffer = IOResources.toRetainableByteBuffer(httpContent.getResource(), _bufferPool, _useDirectByteBuffers);
}
catch (Throwable t)
{
isValid = false;
if (LOG.isDebugEnabled())
LOG.warn("Failed to read Resource: {}", httpContent.getResource(), t);
else
LOG.warn("Failed to read Resource: {} - {}", httpContent.getResource(), t.toString());
}
if (contentLengthValue < 0)
throw new IllegalArgumentException("Resource length is unknown");
if (contentLengthValue > _maxCachedFileSize)
throw new IllegalArgumentException("Resource is too large: length " + contentLengthValue + " > " + _maxCachedFileSize);

// Read the content into memory
_buffer = IOResources.toRetainableByteBuffer(httpContent.getResource(), _bufferPool, _useDirectByteBuffers);

_buffer = buffer;
_isValid = isValid;
_bytesOccupied = httpContent.getBytesOccupied();
_lastModifiedValue = httpContent.getLastModifiedValue();
_characterEncoding = httpContent.getCharacterEncoding();
_compressedFormats = httpContent.getPreCompressedContentFormats();
_mimeType = httpContent.getMimeType();
_contentLength = httpContent.getContentLength();
_lastModifiedInstant = httpContent.getLastModifiedInstant();
_lastModified = httpContent.getLastModified();
_lastAccessed = NanoTime.now();
}

@Override
public long getContentLengthValue()
{
return _contentLengthValue;
}

@Override
public long getBytesOccupied()
{
return _bytesOccupied;
}

@Override
public long getLastAccessedNanos()
{
Expand All @@ -393,30 +367,21 @@ public void writeTo(Content.Sink sink, long offset, long length, Callback callba
{
try
{
sink.write(true, BufferUtil.slice(_buffer.getByteBuffer(), (int)offset, (int)length), callback);
_buffer.retain();
sink.write(true, BufferUtil.slice(_buffer.getByteBuffer(), (int)offset, (int)length), Callback.from(_buffer::release, callback));
}
catch (Throwable x)
{
// BufferUtil.slice() may fail if offset and/or length are out of bounds.
_buffer.release();
callback.failed(x);
}
}

@Override
public boolean retain()
{
return _referenceCount.tryRetain();
}

@Override
public void release()
{
if (_referenceCount.release())
{
if (_buffer != null)
_buffer.release();
super.release();
}
_buffer.release();
}

@Override
Expand All @@ -431,12 +396,6 @@ public HttpField getETag()
return _etagField;
}

@Override
public String getETagValue()
{
return _etagField == null ? null : _etagField.getValue();
}

@Override
public String getCharacterEncoding()
{
Expand All @@ -456,27 +415,27 @@ public HttpField getContentLength()
}

@Override
public Instant getLastModifiedInstant()
public long getContentLengthValue()
{
return _lastModifiedInstant;
return _buffer.remaining();
}

@Override
public HttpField getLastModified()
public Instant getLastModifiedInstant()
{
return _lastModified;
return _lastModifiedInstant;
}

@Override
public String getLastModifiedValue()
public HttpField getLastModified()
{
return _lastModifiedValue;
return _lastModified;
}

@Override
public boolean isValid()
{
return _isValid;
return true;
}
}

Expand Down Expand Up @@ -516,12 +475,6 @@ public HttpField getContentType()
return null;
}

@Override
public String getContentTypeValue()
{
return null;
}

@Override
public String getCharacterEncoding()
{
Expand All @@ -540,12 +493,6 @@ public HttpField getContentEncoding()
return null;
}

@Override
public String getContentEncodingValue()
{
return null;
}

@Override
public HttpField getContentLength()
{
Expand All @@ -570,24 +517,12 @@ public HttpField getLastModified()
return null;
}

@Override
public String getLastModifiedValue()
{
return null;
}

@Override
public HttpField getETag()
{
return null;
}

@Override
public String getETagValue()
{
return null;
}

@Override
public Resource getResource()
{
Expand Down Expand Up @@ -616,11 +551,5 @@ public boolean isValid()
{
return true;
}

@Override
public boolean retain()
{
return true;
}
}
}
Loading
Loading