937698 - Add :offline to potatosearch

Status: VERIFIED FIXED

(Marketplace Graveyard :: Search, enhancement, P2)

Description

[Wil Clouser [:clouserw]]

A request from the mailing list (https://groups.google.com/forum/#!msg/mozilla.dev.marketplace/BRrCZtgjeZY/FsmfsBS5A7UJ ) to add :offline support to PotatoSearch.  Is this a simple addition?

Comment 1

[Christopher Van Wiemeersch [:cvan]]

I swear there's another bug for this. But sure.

If we do this based on presence of `appcache_path` in the manifest OR if the app is a packaged app, this is easy. If we're doing it based on presence of appcache in the HTML, valid appcache manifest, presence of serviceworkers, etc. then that's a bit complicated and we'll need some Basta love up in here.

Comment 3

[Fred Wenzel [:wenzel]]

(In reply to Christopher Van Wiemeersch [:cvan] from comment #1)
> I swear there's another bug for this. But sure.
> 
> If we do this based on presence of `appcache_path` in the manifest OR if the
> app is a packaged app, this is easy. If we're doing it based on presence of
> appcache in the HTML, valid appcache manifest, presence of serviceworkers,
> etc. then that's a bit complicated and we'll need some Basta love up in here.

An app without appcache in its manifest is not an "offline capable" app in the strict sense of the word (the platform will not precache on install), so let's not treat it as such. If the devs add it to the HTML but not the manifest, that's a bug.

Comment 4

[Christopher Van Wiemeersch [:cvan]]

(In reply to Fred Wenzel [:wenzel] from comment #3)
> (In reply to Christopher Van Wiemeersch [:cvan] from comment #1)
> > I swear there's another bug for this. But sure.
> > 
> > If we do this based on presence of `appcache_path` in the manifest OR if the
> > app is a packaged app, this is easy. If we're doing it based on presence of
> > appcache in the HTML, valid appcache manifest, presence of serviceworkers,
> > etc. then that's a bit complicated and we'll need some Basta love up in here.
> 
> An app without appcache in its manifest is not an "offline capable" app in
> the strict sense of the word (the platform will not precache on install), so
> let's not treat it as such. If the devs add it to the HTML but not the
> manifest, that's a bug.

Just to clarify: are you suggesting that a packaged app is not an offline app or an app that uses serviceworkers? Also, just because an app has an `appcache_path` and manifest doesn't mean that it degrades gracefully offline (but that an attempt was made and at least some resources are available offline).

Comment 5

[Fred Wenzel [:wenzel]]

(In reply to Christopher Van Wiemeersch [:cvan] from comment #4)
> Just to clarify: are you suggesting that a packaged app is not an offline
> app or an app that uses serviceworkers? Also, just because an app has an
> `appcache_path` and manifest doesn't mean that it degrades gracefully
> offline (but that an attempt was made and at least some resources are
> available offline).

Good points. Sorry for being ambiguous. I was talking about hosted apps whose manifest does not define an appcache path. In that case, it should not be treated as offline-capable.

For now, I'm suggesting "If we do this based on presence of `appcache_path` in the manifest OR if the app is a packaged app, this is easy." is the right approach, while keeping in mind this is not a perfect representation of a good offline experience.

Comment 6

[Christopher Van Wiemeersch [:cvan]]

Agree 100%. We just ought to be clear that we don't falsely advertise "works 100% offline." But this will be good :)

Comment 7

[Christopher Van Wiemeersch [:cvan]]

https://github.com/mozilla/zamboni/commit/469b381
https://github.com/mozilla/zamboni/commit/90f9e55
https://github.com/mozilla/fireplace/commit/323686a


PotatoSearch™ Usage
-------------------
:offline
Return all apps offering graceful offline support (i.e., packaged apps and apps that have defined an `appcache_path` in their manifests)
https://marketplace-dev.allizom.org/search?q=%3Aoffline
https://marketplace-dev.allizom.org/api/v1/apps/search/?offline=True

:online
Return all apps requiring an online network connection
https://marketplace-dev.allizom.org/search?q=%3Aonline
https://marketplace-dev.allizom.org/api/v1/apps/search/?offline=False


Docs
----
Updated ":help" document:
https://github.com/mozilla/fireplace/wiki/QuickSearch-(PotatoSearch%E2%84%A2)

Updated API search docs:
http://firefox-marketplace-api.readthedocs.org/en/latest/topics/search.html#search-api

Comment 8

[Victor Carciu]

Verified as fixed.