Enable queries to use caching policies

[aliasad106]

New Feature / Enhancement Checklist

• I am not disclosing a vulnerability.
• I am not just asking a question.
• I have searched through existing issues.

Current Limitation

The query does not allow me to add cachePolicy cacheThenNetwork as it was implemented there in the Parse iOS/macOS SDK.

Feature / Enhancement Description

When given the .cacheThenNetwork. It will first check from cache and respond and then it will load from network.

Example Use Case

Example use case is. When I load my feeds it first shows from cache and simultaneously fetches from network and respond and it also updates the cache with new data.

Alternatives / Workarounds

No

3rd Party References

Parse

[parse-github-assistant]

Thanks for opening this issue!

• 🎉 We are excited about your ideas for improvement!

[cbaker6]

Please complete the issue template in it's entirety by adding information under each header.

Caching was added in #196. You can change the default cache policy the SDK uses for your app when you initialize the SDK using requestCachePolicy, cacheMemoryCapacity, and cacheDiskCapacity as stated in the documentation. Details can be found by looking at Apple's documentation. The SDK defaults to Apple's default, useProtocolCachePolicy

If you want to choose a different caching policy for an individual query, simply pass the caching policy option you want to your query:

let options: API.Options = [.cachepolicy(returnCacheDataDontLoad)]
let query = GameScore.query("points" > 50)
let results = try await query.find(options: options)
...

[aliasad106]

@cbaker6
The apple documentation doesn't really guide how can we achieve cacheThenNetwork. And how can we update our cache with the updated response of query.
P.S. How do we use useProtocolCachePolicy with combination to Parse query ?

[cbaker6]

P.S. How do we use useProtocolCachePolicy with combination to Parse query?

I’ve answered this in the previous comment, it’s automatically used for every query:

The SDK defaults to Apple's default, useProtocolCachePolicy

[aliasad106]

@cbaker6 But I don't see the cached response, It always fetched from network when we use useProtocolCachePolicy

[cbaker6]

This is probably because the SDK uses .POST instead of .GET for queries:

Parse-Swift/Sources/ParseSwift/Types/Query.swift

Lines 1271 to 1447 in b0bd351

	func findCommand() -> API.NonParseBodyCommand<Query<ResultType>, [ResultType]> {
	let query = self
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0).results
	}
	}
	func firstCommand() -> API.NonParseBodyCommand<Query<ResultType>, ResultType> {
	var query = self
	query.limit = 1
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	if let decoded = try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0).results.first {
	return decoded
	}
	throw ParseError(code: .objectNotFound,
	message: "Object not found on the server.")
	}
	}
	func countCommand() -> API.NonParseBodyCommand<Query<ResultType>, Int> {
	var query = self
	query.limit = 1
	query.isCount = true
	return API.NonParseBodyCommand(method: .POST,
	path: query.endpoint,
	body: query) {
	try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0).count ?? 0
	}
	}
	func withCountCommand() -> API.NonParseBodyCommand<Query<ResultType>, ([ResultType], Int)> {
	var query = self
	query.isCount = true
	return API.NonParseBodyCommand(method: .POST,
	path: query.endpoint,
	body: query) {
	let decoded = try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0)
	return (decoded.results, decoded.count ?? 0)
	}
	}
	func aggregateCommand() -> API.NonParseBodyCommand<AggregateBody<ResultType>, [ResultType]> {
	let query = self
	let body = AggregateBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0).results
	}
	}
	func distinctCommand(key: String) -> API.NonParseBodyCommand<DistinctBody<ResultType>, [ResultType]> {
	var query = self
	query.distinct = key
	let body = DistinctBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try ParseCoding.jsonDecoder().decode(QueryResponse<T>.self, from: $0).results
	}
	}
	func findExplainCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results
	}
	}
	func firstExplainCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, U> {
	var query = self
	query.limit = 1
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	if let decoded = try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results.first {
	return decoded
	}
	throw ParseError(code: .objectNotFound,
	message: "Object not found on the server.")
	}
	}
	func countExplainCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.limit = 1
	query.isCount = true
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results
	}
	}
	func withCountExplainCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.isCount = true
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results
	}
	}
	func aggregateExplainCommand<U: Decodable>() -> API.NonParseBodyCommand<AggregateBody<ResultType>, [U]> {
	var query = self
	query.explain = true
	let body = AggregateBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results
	}
	}
	func distinctExplainCommand<U: Decodable>(key: String) -> API.NonParseBodyCommand<DistinctBody<ResultType>, [U]> {
	var query = self
	query.explain = true
	query.distinct = key
	let body = DistinctBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try ParseCoding.jsonDecoder().decode(AnyResultsResponse<U>.self, from: $0).results
	}
	}
	func findExplainMongoCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try [ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results]
	}
	}
	func firstExplainMongoCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, U> {
	var query = self
	query.limit = 1
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	do {
	return try ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results
	} catch {
	throw ParseError(code: .objectNotFound,
	message: "Object not found on the server. Error: \(error)")
	}
	}
	}
	func countExplainMongoCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.limit = 1
	query.isCount = true
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try [ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results]
	}
	}
	func withCountExplainMongoCommand<U: Decodable>() -> API.NonParseBodyCommand<Query<ResultType>, [U]> {
	var query = self
	query.isCount = true
	query.explain = true
	return API.NonParseBodyCommand(method: .POST, path: query.endpoint, body: query) {
	try [ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results]
	}
	}
	func aggregateExplainMongoCommand<U: Decodable>() -> API.NonParseBodyCommand<AggregateBody<ResultType>, [U]> {
	var query = self
	query.explain = true
	let body = AggregateBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try [ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results]
	}
	}
	// swiftlint:disable:next line_length
	func distinctExplainMongoCommand<U: Decodable>(key: String) -> API.NonParseBodyCommand<DistinctBody<ResultType>, [U]> {
	var query = self
	query.explain = true
	query.distinct = key
	let body = DistinctBody(query: query)
	return API.NonParseBodyCommand(method: .POST, path: .aggregate(className: T.className), body: body) {
	try [ParseCoding.jsonDecoder().decode(AnyResultsMongoResponse<U>.self, from: $0).results]
	}
	}

[aliasad106]

@cbaker6 I have updated to 4.9.3 and it still doesn't show me cacheThenNetwork. And by default it always fetches from network.