Merge pull request #98 from CatchABus/feat-cached-response-remove

feat: Added support for removing cached responses using url

Author: farfromrefug

packages/https/platforms/android/java/com/nativescript/https/CacheUtils.java

@@ -0,0 +1,26 @@
+package com.nativescript.https;
+
+import java.util.Iterator;
+import okhttp3.Cache;
+
+public class CacheUtils {
+    public static void removeCachedResponse(String url, Cache cache) {
+        Iterator<String> it;
+        try {
+          it = cache.urls();
+        } catch (Exception e) {
+          it = null;
+        }
+
+        if (it != null) {
+            while (it.hasNext()) {
+                String cacheUrl = it.next();
+
+                if (cacheUrl.equals(url)) {
+                    it.remove();
+                    break;
+                }
+            }
+        }
+    }
+}

packages/https/platforms/android/native-api-usage.json

@@ -30,6 +30,7 @@
         "java.net:CookiePolicy",
         "com.nativescript.https:QuotePreservingCookieJar",
         "com.nativescript.https:CacheInterceptor",
+        "com.nativescript.https:CacheUtils",
         "com.nativescript.https:OkHttpResponse",
         "java.util:Collections",
         "java.security.cert:CertificateFactory",

src/https/request.android.ts

@@ -51,6 +51,12 @@ export function clearCache() {
     }
 }
 
+export function removeCachedResponse(url: string) {
+    if (cache) {
+        com.nativescript.https.CacheUtils.removeCachedResponse(url, cache);
+    }
+}
+
 // TODO: rewrite this to not have to handle
 // every single property
 let _timeout = 10;

src/https/request.d.ts

@@ -111,6 +111,7 @@ export declare function request<T = any, U extends boolean = true>(
 ): U extends true ? Promise<HttpsResponse<HttpsResponseLegacy<T>>> : Promise<HttpsResponse<T>>;
 export function setCache(options?: CacheOptions);
 export function clearCache();
+export function removeCachedResponse(url: string);
 export function createRequest(opts: HttpsRequestOptions): HttpsRequest;
 export function cancelRequest(tag: string);
 export function cancelAllRequests();

src/https/request.ios.ts

@@ -1,5 +1,4 @@
 import { File, ImageSource, Utils } from '@nativescript/core';
-import { dispatchToMainThread} from '@nativescript/core/utils';
 import { CacheOptions, HttpsFormDataParam, HttpsRequest, HttpsRequestOptions, HttpsResponse, HttpsSSLPinningOptions, HttpsResponseLegacy as IHttpsResponseLegacy } from '.';
 import { getFilenameFromUrl, parseJSON } from './request.common';
 export { addInterceptor, addNetworkInterceptor } from './request.common';
@@ -19,6 +18,10 @@ export function clearCache() {
     NSURLCache.sharedURLCache.removeAllCachedResponses();
 }
 
+export function removeCachedResponse(url: string) {
+    NSURLCache.sharedURLCache.removeCachedResponseForRequest(createNSRequest(url));
+}
+
 interface Ipolicies {
     def: AFSecurityPolicy;
     secured: boolean;
@@ -97,6 +100,10 @@ function getData(data) {
     return content;
 }
 
+function createNSRequest(url: string): NSMutableURLRequest {
+    return NSMutableURLRequest.alloc().initWithURL(NSURL.URLWithString(url));
+}
+
 class HttpsResponseLegacy implements IHttpsResponseLegacy {
     //     private callback?: com.nativescript.https.OkhttpResponse.OkHttpResponseAsyncCallback;
     constructor(private data: NSDictionary<string, any> & NSData & NSArray<any>, public contentLength, private url: string) {}
@@ -168,7 +175,6 @@ class HttpsResponseLegacy implements IHttpsResponseLegacy {
         this.stringResponse = data;
         this.jsonResponse = parseJSON(data);
         return this.jsonResponse as T;
-       
     }
     toJSONAsync<T>() {
         return Promise.resolve<T>(this.toJSON());
@@ -370,10 +376,9 @@ export function createRequest(opts: HttpsRequestOptions, useLegacy: boolean = tr
 
     const progress = opts.onProgress
         ? (progress: NSProgress) => {
-            dispatchToMainThread(()=>{
+            Utils.dispatchToMainThread(() => {
               opts.onProgress(progress.completedUnitCount, progress.totalUnitCount);
-            })
-
+            });
           }
         : null;
     let task: NSURLSessionDataTask;
@@ -463,13 +468,13 @@ export function createRequest(opts: HttpsRequestOptions, useLegacy: boolean = tr
                 }
             } else if (opts.method === 'PUT'){
                 if (opts.body instanceof File) {
-                    const request = NSMutableURLRequest.alloc().initWithURL(NSURL.URLWithString(opts.url));
+                    const request = createNSRequest(opts.url);
                     request.HTTPMethod = opts.method;
-                    Object.keys(heads).forEach(k=>{
+                    Object.keys(heads).forEach(k => {
                         request.setValueForHTTPHeaderField(heads[k], k);
                     });
                     task = manager.uploadTaskWithRequestFromFileProgressCompletionHandler(request, NSURL.fileURLWithPath(opts.body.path), progress, (response: NSURLResponse, responseObject: any, error: NSError)=>{
-                        if (error){
+                        if (error) {
                             failure(task, error);
                         } else {
                             success(task, responseObject);
@@ -486,13 +491,13 @@ export function createRequest(opts: HttpsRequestOptions, useLegacy: boolean = tr
                     } else {
                         data = NSString.stringWithString(JSON.stringify(opts.body)).dataUsingEncoding(NSUTF8StringEncoding);
                     }
-                    const request = NSMutableURLRequest.alloc().initWithURL(NSURL.URLWithString(opts.url));
+                    const request = createNSRequest(opts.url);
                     request.HTTPMethod = opts.method;
-                    Object.keys(heads).forEach(k=>{
+                    Object.keys(heads).forEach(k => {
                         request.setValueForHTTPHeaderField(heads[k], k);
                     });
-                    task = manager.uploadTaskWithRequestFromDataProgressCompletionHandler(request, data, progress, (response: NSURLResponse, responseObject: any, error: NSError)=>{
-                        if (error){
+                    task = manager.uploadTaskWithRequestFromDataProgressCompletionHandler(request, data, progress, (response: NSURLResponse, responseObject: any, error: NSError) => {
+                        if (error) {
                             failure(task, error);
                         } else {
                             success(task, responseObject);

src/https/typings/android.d.ts

@@ -7,6 +7,9 @@ declare namespace com {
             export class CacheInterceptor {
                 public static INTERCEPTOR: okhttp3.Interceptor;
             }
+            export class CacheUtils {
+                static removeCachedResponse(url: string, cache: okhttp3.Cache): void;
+            }
             export class OkHttpResponse {
                 progressCallback: OkHttpResponse.OkHttpResponseProgressCallback;
                 closeCallback: OkHttpResponse.OkHttpResponseCloseCallback;