spotify / sptpersistentcache Goto Github PK

View Code? Open in Web Editor NEW

1.2K 57.0 78.0 3.86 MB

Everyone tries to implement a cache at some point in their iOS app’s lifecycle, and this is ours.

License: Apache License 2.0

Ruby 0.37% Objective-C 95.74% C 1.85% Shell 2.04%

sptpersistentcache's Issues

Logo text looks weird for those, who is familiar with cyrillic alphabet

Logo reads as SPTPegsisteitCacne because of different alphabets mix :/

Initializing cache results in EXC_BAD_INSTRUCTION

By using the example of the readme I am trying to initialize the cache in my AppDelegate.m. Without doing anything further with it I am getting a EXC_BAD_INSTRUCTION (code=EXC_I386_INVOP, subcode=0x0) Exception in Thread 1.
With the find Zombie Objects setting i get the following terminal output:

2018-03-01 12:54:35.476398+0100 VideoCaching[50180:944549] *** -[NSPathStore2 release]: message sent to deallocated instance 0x7f8d6760e500

Improve example app

Yeah, it's a little bit lame. 😛

Need help about caching

I have an app, that is a comic book reader, so the user can download a book then read it later, even without internet.

I'm thinking to cache all pages(images) of the book with SPTPersistentCache.
I need to save each book in a different folder, ex: spider man will be saved on a folder spider-man/pages, minions will be saved on minions/pages and so on...

Also SPTPersistentCache can't garbage the books downloaded, it must keep the cache until the user delete that specific book. Also no disk size limite.

What I need is the very same way Spotify does with offline musics downloaded. Can I do that?

Cache fails to store large files

Whenever we try to save large files (>100MB, actual size depends on device capabilities) to cache, nothing happens except console log message like

*** mach_vm_map(size=997462016) failed (error code=3)
*** error: can't allocate region
*** set a breakpoint in malloc_error_break to debug

The problem is in SPTPersistentCache method

- (NSError *)storeDataSync:(NSData *)data
                    forKey:(NSString *)key
                       ttl:(NSUInteger)ttl
                    locked:(BOOL)isLocked
              withCallback:(SPTPersistentCacheResponseCallback)callback
                   onQueue:(dispatch_queue_t)queue

The following code does not work for large rawDataLength
NSMutableData *rawData = [NSMutableData dataWithCapacity:rawDataLength];

One way to handle large amounts of data is to fill temporary file with relatively small blocks of data first and then writing it atomically to target filePath

Wrong nullability flags on SPTPersistentCacheResponse

The interface of SPTPersistentCacheResponse tells the compiler that all its properties are NONNULL but it's obvious that it's not true, you cannot have result and error instantiated at the same time.

This is a big issue in Swift3 projects, because if you check directly the presence of record without checking result before, the app will crash at runtime, because the compiler cannot let you use optional access to these properties.

A corrected version of it could be

@interface SPTPersistentCacheResponse : NSObject

/**
 * @see SPTPersistentCacheResponseCode
 */
@property (nonatomic, assign, readonly) SPTPersistentCacheResponseCode result;
/**
 * Defines error of response if appliable
 */
@property (nonatomic, strong, readonly, nullable) NSError *error;
/**
 * @see SPTPersistentCacheRecord
 */
@property (nonatomic, strong, readonly, nullable) SPTPersistentCacheRecord *record;

@end

Deployment target triggers a compiler warning in Xcode 12+

Xcode 12 dropped support for iOS 8:
https://developer.apple.com/documentation/xcode-release-notes/xcode-12-release-notes

When compiling the project in Xcode for the simulator I get the following warning:

The iOS Simulator deployment target 'IPHONEOS_DEPLOYMENT_TARGET' is set to 8.0, but the range of supported deployment target versions is 9.0 to 14.0.99.

I can see that from the xcconfig file that deployment target is explicitly set to 8.0:
https://github.com/spotify/SPTPersistentCache/blob/master/ci/spotify_os.xcconfig#L21

I've increased to 12.0 locally for my project and it all builds ok. However I do not want to deviate the fork from the Spotify repo.

Would it be possible to bump to 9.0 at least please?

Release to CocoaPods

Need a new version?

There are a lot of commits after releasing 1.0. So should this project release a new version up to date ?

Scheduling of garbage collection

I'm considering how to schedule the garbage collector for an app that does not have long sessions. I understand that the current way of scheduling works fine for Spotify, since your app will be long running in the background.

Do you guys have any suggestions on how to handle scheduling in an app where the average user session is around 20 seconds? Scheduling it to run every 10 seconds seems unnecessary, but scheduling it to run at > 20 seconds could mean that the GC never runs for some users (since we need to unschedule when the app enters the background, to avoid an NSTimer keeping the app awake).

I think ideally, SPTPersistentCache should have a way to manually start the GC instead of scheduling it. This would allow us to run it once when the app enters background before it gets terminated.

I could achieve this in the current way by scheduling it at 0 seconds when the app enters background, and then immediately unscheduling it. This seems kind of insecure though, since it could run 10 times or even cancel before it runs at all.

Any input is appreciated!

Can't access cache by sync methods

I expect to get the cache from the return value rather than in a block
Is there an alternative way to implement that makes it can return cache value directly?

- (BOOL)loadDataForKey:(NSString *)key
          withCallback:(SPTPersistentCacheResponseCallback _Nullable)callback
               onQueue:(dispatch_queue_t _Nullable)queue;

Framework Fails to Build

When embedding the SPTPersistentCacheFramework Xcode project in your Xcode project as a dependency, the project fails to build in file SPTPersistentCache.h

'SPTPersistentCache/SPTPersistentCacheImplementation.h' file not found

It doesn't seem like this file was added to SPTPersistentCacheFramework.xcodeproj

How to get URI of cached images?

I see in the code that there are functions to determine the URI of the cached images, however, they are not exposed. Are there any exposed functions, or recommended methods for determining the URI of a cached image? I need this for an application that will be using QMChatViewController, and the library only accepts URI paths for image attachments.

Thanks!

Static or dynamic lib doesnt work properly.

I added this framework going to select add files and import to xcproj file but icannot import any file. Have you ever tested for new projects?

Framework is missing CFBundleVersion value

The pre-built framework under Releases is missing the CFBundleVersion value in Info.plist. This means that apps containing the framework can't be submitted to the App Store. I just modified it locally to be '1.0.0'.

More info on the App Store error when uploading an app with this framework:
https://forums.developer.apple.com/thread/23778

Change the default cache path

We should change the default cache location the next time we release a breaking update. I think the earliest we can do that is with version 2.0 (which is a far ways off, not even planned).

Currently the path used is the temporary directory appended with a path component that is very specific.

[NSTemporaryDirectory() stringByAppendingPathComponent:@"/com.spotify.temppersistent.image.cache"];

(SPTPersistentCacheOptions.m#L51)

It would be better to set it to a more generically named path, such as:

[NSTemporaryDirectory() stringByAppendingPathComponent:@"/com.spotify.persistentcache.default"];

currentTimeCallback, do we need it?

Just wondering if we really need the currentTimeCallback parameter in SPTPersistentCacheOptions.

It makes the API more complex and I'm not sure if it's a common to require something different than the default implementation we provide.

@spotify/objc-dev

Using Extended File Attributes to Store Cache Record's Header

Did you consider using Extended File Attributes to store a cache record's header (SPTPersistentCacheRecordHeader struct) ? Looks like this approach should simplify the headers management a bit.

Retrieved UIImage has wrong size dimensions

I am creating a UIImage from the MapKit Snapshot. The image is fine, until I retrieve it from the cache, at which point, the image is doubled in size. I have tried converting to both PNG format, and JPEG format, with the same results for both.

The only thing I can think of is that it may have to do with the scale, when returning the image from cache

Doesn't compile under Xcode 10

@8W9aG Thank you in advance for taking a look at this.

SPTPersistentCache doesn't compile via standard Carthage pull under Xcode 10.

The error is:

CompileC /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/Objects-normal/armv7/SPTPersistentCache.o /Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/Sources/SPTPersistentCache.m normal armv7 objective-c com.apple.compilers.llvm.clang.1_0.compiler (in target: SPTPersistentCache-iOS)
    cd /Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/SPTPersistentCacheFramework
    export LANG=en_US.US-ASCII
    /Users/z002r44/Downloads/Xcode10.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/clang -x objective-c -arch armv7 -fmessage-length=0 -fdiagnostics-show-note-include-stack -fmacro-backtrace-limit=0 -std=gnu11 -fobjc-arc -fmodules -gmodules -fmodules-cache-path=/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/ModuleCache.noindex -fno-autolink -fmodules-prune-interval=86400 -fmodules-prune-after=345600 -fbuild-session-file=/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/ModuleCache.noindex/Session.modulevalidation -fmodules-validate-once-per-build-session -Wnon-modular-include-in-framework-module -Werror=non-modular-include-in-framework-module -fmodule-name=SPTPersistentCache -Wno-trigraphs -fpascal-strings -Os -fno-common -Werror=incompatible-pointer-types -Werror=implicit-function-declaration -Wmissing-field-initializers -Wmissing-prototypes -Werror=return-type -Wdocumentation -Wunreachable-code -Wnullable-to-nonnull-conversion -Wimplicit-atomic-properties -Werror=deprecated-objc-isa-usage -Wno-objc-interface-ivars -Werror=objc-root-class -Warc-repeated-use-of-weak -Wno-arc-maybe-repeated-use-of-weak -Wexplicit-ownership-type -Wimplicit-retain-self -Wduplicate-method-match -Wmissing-braces -Wparentheses -Wswitch -Wunused-function -Wunused-label -Wno-unused-parameter -Wunused-variable -Wunused-value -Wempty-body -Wuninitialized -Wconditional-uninitialized -Wunknown-pragmas -Wshadow -Wfour-char-constants -Wconversion -Wconstant-conversion -Wint-conversion -Wbool-conversion -Wenum-conversion -Wfloat-conversion -Wnon-literal-null-conversion -Wobjc-literal-conversion -Wassign-enum -Wsign-compare -Wshorten-64-to-32 -Wpointer-sign -Wnewline-eof -Wselector -Wstrict-selector-match -Wundeclared-selector -Wdeprecated-implementations -DNS_BLOCK_ASSERTIONS=1 -DOBJC_OLD_DISPATCH_PROTOTYPES=0 -isysroot /Users/z002r44/Downloads/Xcode10.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS12.0.sdk -fstrict-aliasing -Wprotocol -Wdeprecated-declarations -miphoneos-version-min=8.0 -g -Wsign-conversion -Winfinite-recursion -Wcomma -Wblock-capture-autoreleasing -Wstrict-prototypes -Wno-semicolon-before-method-body -fembed-bitcode -iquote /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/SPTPersistentCache-generated-files.hmap -I/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/SPTPersistentCache-own-target-headers.hmap -I/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/SPTPersistentCache-all-non-framework-target-headers.hmap -ivfsoverlay /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/all-product-headers.yaml -iquote /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/SPTPersistentCache-project-headers.hmap -I/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/BuildProductsPath/Release-iphoneos/include -I../include -I/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/DerivedSources/armv7 -I/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/DerivedSources -Weverything -Wno-error=deprecated -Wno-objc-missing-property-synthesis -Wno-gnu-conditional-omitted-operand -Wno-gnu -Wno-documentation-unknown-command -Wno-reserved-id-macro -Wno-auto-import -Wno-missing-variable-declarations -Wno-c++98-compat -Werror -Wno-direct-ivar-access -Wno-padded -F/Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/BuildProductsPath/Release-iphoneos -MMD -MT dependencies -MF /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/Objects-normal/armv7/SPTPersistentCache.d --serialize-diagnostics /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/Objects-normal/armv7/SPTPersistentCache.dia -c /Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/Sources/SPTPersistentCache.m -o /Users/z002r44/Library/Caches/org.carthage.CarthageKit/DerivedData/10.0_10A254a/SPTPersistentCache/1.1.1/Build/Intermediates.noindex/ArchiveIntermediates/SPTPersistentCache-iOS/IntermediateBuildFilesPath/SPTPersistentCacheFramework.build/Release-iphoneos/SPTPersistentCache-iOS.build/Objects-normal/armv7/SPTPersistentCache.o
/Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/Sources/SPTPersistentCache.m:737:80: error: implicit conversion from nullable pointer 'NSString * _Nullable' to non-nullable pointer type 'ObjectType _Nonnull' (aka 'id') [-Werror,-Wnullable-to-nonnull-conversion]
                                        userInfo:@{ NSLocalizedDescriptionKey: @(errorString) }];
                                                                               ^
/Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/Sources/SPTPersistentCache.m:965:30: warning: messaging unqualified id [-Wobjc-messaging-id]
        currentCacheSize += [image[SPTDataCacheFileAttributesKey][NSFileSize] integerValue];
                             ^
/Users/z002r44/Dustin-Harmony-iOS/Carthage/Checkouts/SPTPersistentCache/Sources/SPTPersistentCache.m:984:30: warning: messaging unqualified id [-Wobjc-messaging-id]
        currentCacheSize -= [image[SPTDataCacheFileAttributesKey][NSFileSize] integerValue];

I put in a PR to fix, but can't figure out why the CI process fails on the PR.
Would like to use SPTPersistentCache from master if possible, not from a fork that I took:
https://github.com/DanEdgarTarget/SPTPersistentCache

Thank you for any help.

"Messaging unqualified id" error in Xcode 11b1

Buildng the app with Xcode 11b1 results in 3 of the following errors:

Messaging unqualified id

in:

SPTPersistentCacheOptions.mL111
SPTPersistentCache.mL967
SPTPersistentCache.mL986

I admit I am a bit miffed on what the actual problem is. Despite a few years of exclusive Swift development, I feel like I should be able to infer what it doesn't like about the object being messaged in these 3 cases.

In the first, init is triggering the warning.
In the second two, integerValue.

spotify / sptpersistentcache Goto Github PK

sptpersistentcache's Issues

Recommend Projects

Recommend Topics

Recommend Org

Jobs