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

Respect Cache-Control headers #462

Merged
merged 12 commits into from
Jun 13, 2018
Merged

Respect Cache-Control headers #462

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
34a842c
Update Cartfile and update (PINCache)
Jun 4, 2018
f047d3c
Respect Cache-Control headers
wiseoldduck Jun 8, 2018
4534575
Cleanup and clarification
wiseoldduck Jun 8, 2018
9a79eba
Merge branch 'master' of https://github.com/pinterest/PINRemoteImage …
Jun 9, 2018
ba0e9a8
Update PINRemoteImageManager.m
wiseoldduck Jun 10, 2018
c5fad07
Code review updates
wiseoldduck Jun 10, 2018
b1ae25f
extract ignoreHeaders into an explicit BOOL
wiseoldduck Jun 10, 2018
4dca22a
Code review updates
wiseoldduck Jun 11, 2018
c3eb246
Code review updates
wiseoldduck Jun 12, 2018
eacd424
Update test to verify download result types as well as presence in di…
wiseoldduck Jun 12, 2018
b04831b
Use non-ttl cache by default (there are performance concerns with cur…
wiseoldduck Jun 12, 2018
86b9ece
memoryCache does support TTL! Let's use it.
wiseoldduck Jun 13, 2018
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## master
* Add your own contributions to the next release on the line below this with your name.
- [new] Respect Cache-Control and Expires headers if the cache supports TTL [#462](https://github.com/pinterest/PINRemoteImage/pull/462) [wiseoldduck](https://github.com/wiseoldduck)
- [new] Updated to latest PINCache beta 7. [wiseoldduck](https://github.com/wiseoldduck)
- [iOS11] Fix warnings [#428](https://github.com/pinterest/PINRemoteImage/pull/428) [Eke](https://github.com/Eke)
- [new / beta] Native Support for GIFs and animated WebP [#453](https://github.com/pinterest/PINRemoteImage/pull/453) [garrettmoon](https://github.com/garrettmoon)
Expand Down
2 changes: 1 addition & 1 deletion PINRemoteImage.podspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Pod::Spec.new do |s|

s.subspec "PINCache" do |pc|
pc.dependency 'PINRemoteImage/Core'
pc.dependency 'PINCache', '=3.0.1-beta.6'
pc.dependency 'PINCache', '=3.0.1-beta.7'
pc.ios.deployment_target = ios_deployment
pc.tvos.deployment_target = tvos_deployment
pc.osx.deployment_target = osx_deployment
Expand Down
90 changes: 6 additions & 84 deletions PINRemoteImage.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,48 +32,6 @@
139D4FE21F672B0D00DE64E0 /* PINRemoteImageDownloadQueue.m in Sources */ = {isa = PBXBuildFile; fileRef = 68B1F2801E679D7A00ED87C4 /* PINRemoteImageDownloadQueue.m */; };
139D4FE31F672B0D00DE64E0 /* PINResume.m in Sources */ = {isa = PBXBuildFile; fileRef = 68B7E3B11E736C73000FC887 /* PINResume.m */; };
139D4FE41F672B0D00DE64E0 /* PINSpeedRecorder.m in Sources */ = {isa = PBXBuildFile; fileRef = 6860CB071F578287005E886E /* PINSpeedRecorder.m */; };
139D50781F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50791F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507A1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507B1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507C1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507D1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507E1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D507F1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50801F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50811F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50821F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50831F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50841F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50851F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50861F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50871F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50881F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50891F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508A1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508B1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508C1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508D1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508E1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D508F1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50901F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50911F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50921F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50931F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50941F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50951F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50961F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50971F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50981F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50991F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509A1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509B1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509C1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509D1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509E1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D509F1F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50A01F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50A11F672BAD00DE64E0 /* (null) in Headers */ = {isa = PBXBuildFile; };
139D50A31F672BBF00DE64E0 /* PINImage+ScaledImage.h in Headers */ = {isa = PBXBuildFile; fileRef = 68A6B1DA1E5248BF003A92D1 /* PINImage+ScaledImage.h */; };
139D50A41F672BBF00DE64E0 /* PINImage+DecodedImage.h in Headers */ = {isa = PBXBuildFile; fileRef = 9DD47FA01C699FDC00F12CA0 /* PINImage+DecodedImage.h */; };
139D50A51F672BBF00DE64E0 /* PINImage+WebP.h in Headers */ = {isa = PBXBuildFile; fileRef = 9DD47FA21C699FDC00F12CA0 /* PINImage+WebP.h */; };
Expand Down Expand Up @@ -480,6 +438,7 @@
9DD47FA51C699FDC00F12CA0 /* PINImage+DecodedImage.m in Sources */ = {isa = PBXBuildFile; fileRef = 9DD47FA11C699FDC00F12CA0 /* PINImage+DecodedImage.m */; };
9DD47FA61C699FDC00F12CA0 /* PINImage+WebP.h in Headers */ = {isa = PBXBuildFile; fileRef = 9DD47FA21C699FDC00F12CA0 /* PINImage+WebP.h */; };
9DD47FA71C699FDC00F12CA0 /* PINImage+WebP.m in Sources */ = {isa = PBXBuildFile; fileRef = 9DD47FA31C699FDC00F12CA0 /* PINImage+WebP.m */; };
ACD28AB87FABF6BA3B9BF4E4 /* NSDate+PINCacheTests.m in Sources */ = {isa = PBXBuildFile; fileRef = ACD28D963D79EEC14EE071CE /* NSDate+PINCacheTests.m */; };
F165DFD91BD0504A0008C6E8 /* PINRemoteImageMacros.h in Headers */ = {isa = PBXBuildFile; fileRef = F165DFD81BD0504A0008C6E8 /* PINRemoteImageMacros.h */; settings = {ATTRIBUTES = (Public, ); }; };
F1B918FF1BCF23C900710963 /* PINRemoteImageCategoryManager.m in Sources */ = {isa = PBXBuildFile; fileRef = F1B918DC1BCF23C800710963 /* PINRemoteImageCategoryManager.m */; };
F1B919001BCF23C900710963 /* NSData+ImageDetectors.h in Headers */ = {isa = PBXBuildFile; fileRef = F1B918DE1BCF23C800710963 /* NSData+ImageDetectors.h */; settings = {ATTRIBUTES = (Public, ); }; };
Expand Down Expand Up @@ -815,6 +774,8 @@
9DD47FA11C699FDC00F12CA0 /* PINImage+DecodedImage.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "PINImage+DecodedImage.m"; sourceTree = "<group>"; };
9DD47FA21C699FDC00F12CA0 /* PINImage+WebP.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "PINImage+WebP.h"; sourceTree = "<group>"; };
9DD47FA31C699FDC00F12CA0 /* PINImage+WebP.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "PINImage+WebP.m"; sourceTree = "<group>"; };
ACD288C6E6B13E6DA226D252 /* NSDate+PINCacheTests.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSDate+PINCacheTests.h"; sourceTree = "<group>"; };
ACD28D963D79EEC14EE071CE /* NSDate+PINCacheTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSDate+PINCacheTests.m"; sourceTree = "<group>"; };
F165DFD81BD0504A0008C6E8 /* PINRemoteImageMacros.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PINRemoteImageMacros.h; sourceTree = "<group>"; };
F1B918D11BCF239200710963 /* PINRemoteImage.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = PINRemoteImage.framework; sourceTree = BUILT_PRODUCTS_DIR; };
F1B918D61BCF239200710963 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1136,6 +1097,8 @@
6864A9201F6D94AF007BB848 /* PINRemoteImageTests-Bridging-Header.h */,
683128F31F95045200D5B4A8 /* PINAnimatedImage+PINAnimatedImageTesting.h */,
683128F41F95045200D5B4A8 /* PINAnimatedImage+PINAnimatedImageTesting.m */,
ACD288C6E6B13E6DA226D252 /* NSDate+PINCacheTests.h */,
ACD28D963D79EEC14EE071CE /* NSDate+PINCacheTests.m */,
);
path = Tests;
sourceTree = "<group>";
Expand Down Expand Up @@ -1375,12 +1338,8 @@
139D50B11F672BBF00DE64E0 /* PINResume.h in Headers */,
139D50B21F672BBF00DE64E0 /* PINSpeedRecorder.h in Headers */,
68D734E11F75FE4500B9C95D /* common_dec.h in Headers */,
139D50781F672BAD00DE64E0 /* (null) in Headers */,
139D50791F672BAD00DE64E0 /* (null) in Headers */,
68912D87208FDB4900F5FE0E /* PINRemoteWeakProxy.h in Headers */,
139D507A1F672BAD00DE64E0 /* (null) in Headers */,
68D7344F1F75FDDE00B9C95D /* PINWebPAnimatedImage.h in Headers */,
139D507B1F672BAD00DE64E0 /* (null) in Headers */,
68D734721F75FE2700B9C95D /* mux.h in Headers */,
68D734ED1F75FE4500B9C95D /* webpi_dec.h in Headers */,
68D734711F75FE2700B9C95D /* mux_types.h in Headers */,
Expand All @@ -1390,62 +1349,24 @@
68D734801F75FE3400B9C95D /* cost_enc.h in Headers */,
68D734531F75FE2100B9C95D /* bit_reader_inl_utils.h in Headers */,
68D734661F75FE2100B9C95D /* random_utils.h in Headers */,
139D507C1F672BAD00DE64E0 /* (null) in Headers */,
139D507D1F672BAD00DE64E0 /* (null) in Headers */,
139D507E1F672BAD00DE64E0 /* (null) in Headers */,
139D507F1F672BAD00DE64E0 /* (null) in Headers */,
139D50801F672BAD00DE64E0 /* (null) in Headers */,
68D734DF1F75FE4500B9C95D /* alphai_dec.h in Headers */,
689613E1208FD8B700D2095C /* PINAnimatedImageView.h in Headers */,
68D7344D1F75FDD600B9C95D /* PINCachedAnimatedImage.h in Headers */,
139D50811F672BAD00DE64E0 /* (null) in Headers */,
139D50821F672BAD00DE64E0 /* (null) in Headers */,
139D50831F672BAD00DE64E0 /* (null) in Headers */,
139D50841F672BAD00DE64E0 /* (null) in Headers */,
68D7349F1F75FE3C00B9C95D /* common_sse2.h in Headers */,
139D50851F672BAD00DE64E0 /* (null) in Headers */,
139D50861F672BAD00DE64E0 /* (null) in Headers */,
68D734571F75FE2100B9C95D /* bit_writer_utils.h in Headers */,
68D734701F75FE2700B9C95D /* format_constants.h in Headers */,
139D50871F672BAD00DE64E0 /* (null) in Headers */,
68D7347D1F75FE3400B9C95D /* backward_references_enc.h in Headers */,
68D734C91F75FE3C00B9C95D /* mips_macro.h in Headers */,
139D50881F672BAD00DE64E0 /* (null) in Headers */,
139D50891F672BAD00DE64E0 /* (null) in Headers */,
139D508A1F672BAD00DE64E0 /* (null) in Headers */,
139D508B1F672BAD00DE64E0 /* (null) in Headers */,
139D508C1F672BAD00DE64E0 /* (null) in Headers */,
68D734E81F75FE4500B9C95D /* vp8_dec.h in Headers */,
68D734821F75FE3400B9C95D /* delta_palettization_enc.h in Headers */,
68D734511F75FDE500B9C95D /* PINGIFAnimatedImage.h in Headers */,
68D734861F75FE3400B9C95D /* histogram_enc.h in Headers */,
139D508D1F672BAD00DE64E0 /* (null) in Headers */,
139D508E1F672BAD00DE64E0 /* (null) in Headers */,
139D508F1F672BAD00DE64E0 /* (null) in Headers */,
139D50901F672BAD00DE64E0 /* (null) in Headers */,
139D50911F672BAD00DE64E0 /* (null) in Headers */,
68D734601F75FE2100B9C95D /* huffman_utils.h in Headers */,
139D50921F672BAD00DE64E0 /* (null) in Headers */,
68D7346A1F75FE2100B9C95D /* thread_utils.h in Headers */,
68D734BB1F75FE3C00B9C95D /* lossless_common.h in Headers */,
139D50931F672BAD00DE64E0 /* (null) in Headers */,
139D50941F672BAD00DE64E0 /* (null) in Headers */,
68D734931F75FE3400B9C95D /* vp8i_enc.h in Headers */,
139D50951F672BAD00DE64E0 /* (null) in Headers */,
139D50961F672BAD00DE64E0 /* (null) in Headers */,
139D50971F672BAD00DE64E0 /* (null) in Headers */,
139D50981F672BAD00DE64E0 /* (null) in Headers */,
689613DB208FD89900D2095C /* PINAnimatedImageView+PINRemoteImage.h in Headers */,
139D50991F672BAD00DE64E0 /* (null) in Headers */,
139D509A1F672BAD00DE64E0 /* (null) in Headers */,
139D509B1F672BAD00DE64E0 /* (null) in Headers */,
139D509C1F672BAD00DE64E0 /* (null) in Headers */,
68D734AD1F75FE3C00B9C95D /* dsp.h in Headers */,
139D509D1F672BAD00DE64E0 /* (null) in Headers */,
139D509E1F672BAD00DE64E0 /* (null) in Headers */,
139D509F1F672BAD00DE64E0 /* (null) in Headers */,
139D50A01F672BAD00DE64E0 /* (null) in Headers */,
139D50A11F672BAD00DE64E0 /* (null) in Headers */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -1901,6 +1822,7 @@
6864A9221F6D94AF007BB848 /* PINAnimatedImageTests.swift in Sources */,
68A0FC1C1E523434000B552D /* PINRemoteImageTests.m in Sources */,
683128F51F95045200D5B4A8 /* PINAnimatedImage+PINAnimatedImageTesting.m in Sources */,
ACD28AB87FABF6BA3B9BF4E4 /* NSDate+PINCacheTests.m in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down
5 changes: 5 additions & 0 deletions Source/Classes/PINCache/PINCache+PINRemoteImageCaching.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,11 @@ -(void)objectFromDiskForKey:(NSString *)key completion:(PINRemoteImageCachingObj
}];
}

-(void)setObjectOnDisk:(id)object forKey:(NSString *)key withAgeLimit:(NSTimeInterval)ageLimit
{
[self.diskCache setObject:object forKey:key withAgeLimit:ageLimit];
}

-(void)setObjectOnDisk:(id)object forKey:(NSString *)key
{
[self.diskCache setObject:object forKey:key];
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super minor: maybe have this call [self setObjectOnDisk:object forKey:key withAgeLimit:0];?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK

Expand Down
1 change: 1 addition & 0 deletions Source/Classes/PINRemoteImageCaching.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ typedef void (^PINRemoteImageCachingObjectBlock)(id<PINRemoteImageCaching> cache
@optional

- (void)removeObjectForKeyFromMemory:(NSString *)key;
- (void)setObjectOnDisk:(id)object forKey:(NSString *)key withAgeLimit:(NSTimeInterval)ageLimit;

@end

Expand Down
8 changes: 8 additions & 0 deletions Source/Classes/PINRemoteImageManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@ typedef NS_OPTIONS(NSUInteger, PINRemoteImageManagerDownloadOptions) {
PINRemoteImageManagerDownloadOptionsIgnoreCache = 1 << 4,
/** Skip download retry */
PINRemoteImageManagerDownloadOptionsSkipRetry = 1 << 5,
/**
* Do not honor HTTP Cache-Control headers
* Currently PINRemoteImage will by default respect 'no-store', 'no-cache', 'max-age', 'Expires', and 'must-revalidate'. Set this flag to ignore those headers.
* TODO: Currently PINRemoteImage will re-download images that only must be re-validated. In the future this could be improved with revalidation behavior that stores ETag or Last-Modified values and only
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor / optional: "By default, PINRemoteImage will respect...".

Could also drop "Currently" in the next line, as presumably that will be updated if it becomes supported in the future. The next line also seems like it could use a line break to stay within a ~120 (or a bit more) column width — which isn't a hard rule for these frameworks, but up to ~150 works pretty well for Obj-C.

Great comment overall, thanks for including the IETF and Mozilla links!

* makes HEAD requests to see if these headers are unchanged.
* see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control
* https://tools.ietf.org/html/rfc7234*/
PINRemoteImageManagerDownloadOptionsIgnoreCacheControlHeaders = 1 << 6
};

/**
Expand Down
Loading