├── .gitattributes ├── .gitignore ├── LICENSE ├── README.md ├── build.sbt ├── deploy.sh ├── images ├── caches.png ├── controller.png ├── network.png ├── neworkerinstalled.png ├── offline.JPG ├── oldworkerkilled.png └── swactivated.png ├── index.html ├── offline.js ├── project ├── build.properties └── plugins.sbt └── src └── main └── scala └── chandu0101 └── scalajs └── offline ├── ReactApp.scala ├── components ├── ScalaJSRepos.scala └── TodoApp.scala ├── model └── TodoItem.scala ├── pages └── HomePage.scala ├── routes └── AppRouter.scala ├── services ├── BaseService.scala └── TodoService.scala └── util └── PouchDBChangesListener.scala /.gitattributes: -------------------------------------------------------------------------------- 1 | examples/styles/* linguist-vendored 2 | examples/src/main/resources/* linguist-vendored -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | 4 | # sbt specific 5 | .cache/ 6 | .history/ 7 | .lib/ 8 | dist/* 9 | target/ 10 | lib_managed/ 11 | src_managed/ 12 | project/boot/ 13 | project/plugins/project/ 14 | 15 | # Scala-IDE specific 16 | .scala_dependencies 17 | .worksheet 18 | 19 | #Intellij 20 | .idea 21 | 22 | #mac 23 | .DS_Store 24 | 25 | #project 26 | examples/js/ 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # scalajs-offline 2 | 3 | ####why offline apps ? 4 | 5 | Internet - The World of **Uncertainty!** , don't believe me ? 6 | 7 | ![](http://www.slate.com/content/dam/slate/blogs/future_tense/2014/08/15/shark.jpg.CROP.promo-mediumlarge.jpg) 8 | 9 | ![](https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcQUl1H91-e3djS3dON4qeXtGebMMIz36dWcpxP8SNlLri6QUWwh) 10 | 11 | [The Uncertain Future of the Internet](http://energycommerce.house.gov/hearing/the-uncertain-future-of-the-internet) 12 | 13 | Mobile Internet. 14 | 15 | I was interested in offline apps for none of the reasons mentioned above, 16 | this is where i'm coding these days :) 17 | 18 | ![offline coding](images/offline.JPG) 19 | 20 | 21 | enough stories? ,ok back to business .. 22 | 23 | ###What is a ServiceWorker : 24 | 25 | ServiceWorker is a background worker, it gives us a JavaScript context to add features such as push messaging, background sync, geofencing and network control. 26 | 27 | In terms of network control, it acts like a proxy server sitting on the client, you get to decide what to do on a request-by-request basis. You can use this to make stuff work faster, offline, or build new features. 28 | 29 | [Introduction to Service Worker](http://www.html5rocks.com/en/tutorials/service-worker/introduction/) 30 | 31 | [Using ServiceWorker in Chrome today](http://jakearchibald.com/2014/using-serviceworker-today/) 32 | 33 | [A simple ServiceWorker app](http://blog.lamplightdev.com/2015/01/06/A-Simple-ServiceWorker-App/) 34 | 35 | [The ServiceWorker: The network layer is yours to own](https://www.youtube.com/watch?v=4uQMl7mFB6g) 36 | 37 | [Google I/O 2014 - Bridging the gap between the web and apps](https://www.youtube.com/watch?v=_yy0CDLnhMA) 38 | 39 | enough theory ? , ok back to real business .. 40 | 41 | ###Registration 42 | 43 | ```scala 44 | 45 | @JSExport 46 | override def main(): Unit = { 47 | React.render(AppRouter.C(), dom.document.getElementById("container")) 48 | if(!js.isUndefined(dom.navigator.serviceWorker)){ 49 | dom.navigator.serviceWorker.register("/scalajs-offline/offline.js").andThen((resp: ServiceWorkerRegistration) => { 50 | println(s" ServiceWorker registered successfully : ${JSON.stringify(resp)}") 51 | } 52 | ).catchErr((err: Any) => println(s"service worker failed ${err}")) 53 | } else { 54 | println("ServiceWorker not there yet!") 55 | } 56 | } 57 | 58 | ``` 59 | 60 | On first load of our page, it'll render normally .But in background serviceWorker will be registered! 61 | 62 | 1) First we check if browser support serviceWorker or not 63 | 64 | 2) If serviceWorker Supported then we'll register using ServiceWorkerContainer register method 65 | 66 | ```scala 67 | def register(scriptURL : String,options : js.UndefOr[js.Object] = js.undefined) : Promise[ServiceWorkerRegistration] = js.native 68 | 69 | ``` 70 | the method will take two args 71 | - scriptURL - the URL for service script (this is where all magic happens) 72 | - options (optional settings) 73 | - scope - A unique identifier for a service worker registration; this is usually a relative URL. Defaults to '/' when not present. 74 | example = { scope : "/scalajs-offline/" } - now our script only captures requests that bound to path scalajs-offline instead whole domain. 75 | 76 | 3) If registration successfull ,serviceWorker enters next life cycle **install** 77 | ###Install 78 | From now onwards we'll be looking code from offine.js 79 | 80 | ```javascript 81 | var projectDir = "/scalajs-offline" 82 | // Include SW cache polyfill this script will be downloaded and cached by default 83 | importScripts(projectDir+"/js/serviceworker-cache-polyfill.js"); 84 | //version 85 | var version = "0.0.8" 86 | // Cache name definitions 87 | var cacheNameStatic = "scalajs-offline-"+version; 88 | var cacheNameGithub = "scalajs-offline-github"; 89 | var currentCacheNames = [ 90 | cacheNameStatic, 91 | cacheNameGithub 92 | ]; 93 | // A new ServiceWorker has been registered 94 | self.addEventListener("install", function (event) { 95 | event.waitUntil( 96 | caches.open(cacheNameStatic) 97 | .then(function (cache) { 98 | return cache.addAll([ 99 | projectDir+"/", 100 | projectDir+"/js/scalajs-offline-opt.js", 101 | projectDir+"/js/scalajs-offline-jsdeps.js" 102 | ]); 103 | }) 104 | ); 105 | }); 106 | 107 | ``` 108 | ServiceWorker comes with its own cache API , but its not implemented in browsers yet . Thanks to polyfills! 109 | 110 | In this stage we'll cache all our static assets that are needed to make our app work offline.Please note that this operation is **atomic** , meaning it'll be successfull only if all resources downloaded and cached otherwise it will fail silently.If installation successfull then serviceWorker enters next life cycle **activate** 111 | 112 | ###Activate 113 | 114 | ```js 115 | // New service worker installed ( now you can safely perform deleting/migrating old cache) 116 | self.addEventListener("activate", function (event) { 117 | event.waitUntil( 118 | caches.keys() 119 | .then(function (cacheNames) { 120 | return Promise.all( 121 | cacheNames.map(function (cacheName) { 122 | if (currentCacheNames.indexOf(cacheName) === -1) { 123 | return caches.delete(cacheName); 124 | } 125 | }) 126 | ); 127 | }) 128 | ); 129 | }); 130 | ``` 131 | In this stage we'll perform cleanup of old caches(if any) . after this our serviceWorker finally activated!. 132 | 133 | You can check this in chrome using 134 | ``chrome://serviceworker-internals/`` 135 | 136 | ![service worker activated](images/swactivated.png) 137 | 138 | Ok now you're happy man!,want to shut this computer and enjoy cool breeze outisde!.Well it's not over yet bud, keep follow along with me .. 139 | 140 | At this point serviceWorker activated but it's not controlling our page yet, meaning all network requests from our app still not in control of serviceWorker they directly hitting the world of uncertainty(The Internet). 141 | 142 | To check whether our page is controlled by serviceworker or not type this in Dev Tools console 143 | ``navigator.serviceWorker.controller`` It retuns *null* if SW not controlling our page (which is true in our case) 144 | 145 | The page won't be controlled by this worker until the next navigate(or refresh). Now refresh our page and check ``navigator.serviceWorker.controller`` again 146 | 147 | ![controller value](images/controller.png) 148 | 149 | hola , now our app is controlled by SW. to make sure check out network tab 150 | 151 | ![network tab](images/network.png) 152 | 153 | all our assets are downloaded from serviceworker not internet! 154 | 155 | to take control of network requests we can use serviceWorker **fetch** life cycle. 156 | 157 | ###Fetch 158 | 159 | ```js 160 | // when a network request made from app 161 | self.addEventListener("fetch", function (event) { 162 | var requestURL = new URL(event.request.url); 163 | if (requestURL.hostname.indexOf(".github.com") > -1) { 164 | event.respondWith(githubAPIResponse(event.request)) 165 | } else { 166 | event.respondWith( 167 | caches.match(event.request) 168 | .then(function (response) { 169 | if (response) { // if we cached already just send that response back 170 | return response; 171 | } 172 | var fetchRequest = event.request.clone(); 173 | return fetch(fetchRequest).then( // if not cached get from network return it and then cache it 174 | function (response) { 175 | var shouldCache = false; 176 | if (response.type === "basic" && response.status === 200) { 177 | shouldCache = cacheNameStatic; 178 | } 179 | if (shouldCache) { 180 | var responseToCache = response.clone(); 181 | caches.open(shouldCache) 182 | .then(function (cache) { 183 | var cacheRequest = event.request.clone(); 184 | cache.put(cacheRequest, responseToCache); 185 | }); 186 | } 187 | return response; 188 | } 189 | ); 190 | }) 191 | ); 192 | } 193 | }); 194 | ``` 195 | 196 | ServiceWorker comes with the new shiny **[fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)** to fetch resources across network. 197 | Our scalajs-offline app makes only two type of network request 1) static resources from our domain 2) github api call to get scalajs repos. 198 | 199 | Static Resource Network Requests : 200 | When app requested for a new static resource ,it'll hit service worker fetch event.Here we first check if its in cache or not. If its in cache then we'll send response directly from cache , if not then we request that resource using new **fetch api** once its finished we'll cache it and return the response. 201 | 202 | Github API call : 203 | 204 | ```js 205 | function githubAPIResponse(request) { 206 | if (request.headers.get('Accept') == 'x-cache/only') { 207 | return caches.match(request).then(function(response) { 208 | return response; 209 | }); 210 | } else { 211 | return fetch(request.clone()).then(function(response) { 212 | if(response.type === 200 ) { // only cache successful responses , as github supports CORS we can check status of response for non supported cors origins we'll get opaque response 213 | return caches.open(cacheNameGithub).then(function(cache) { 214 | cache.put(request,response.clone()) 215 | return response; 216 | }); 217 | } else { 218 | return response; 219 | } 220 | 221 | }); 222 | } 223 | } 224 | ``` 225 | 226 | We'll repeat the same process as above , but this time we'll store cache in ``cacheNameGithub``. 227 | 228 | to check caches info open a new tab then type ``chrome://serviceworker-internals/`` now click on inspect a new DevTools window will be open! go to resouces tab and then expand Servie Worker Cache 229 | 230 | ![Service Worker Cache](images/caches.png) 231 | 232 | Feth API Response types 233 | 234 | 235 | >**Basic** - a response from a resource hosted on our domain. We have access to all of the response including full headers. For example our index page, CSS and JavaScript. 236 | 237 | >**CORS** - a response from an external domain that supports CORS. Again full access to the response is available. 238 | 239 | >**Opaque** - a response from any other source. In this case we use this for both the wikipedia api calls and the typekit calls that don’t support CORS, and the wikipedia images. The issue with opaque responses is that we don’t get access to the full response so we can’t tell the status of it. Successful responses (status 200) and error responses (statuses in the 400s and 500s) can’t be distinguished between so we might cache an error response. There’s not much that can be done in this case apart from wait for wider support for CORS. 240 | 241 | 242 | 243 | **Thats it , you successfully created first offline App!. Sorry for stopping you before , now go out enjoy cool breeze :).Take your app with you if you want ,its offline app afterall!.** 244 | 245 | ###Updating App : 246 | 247 | Enjoyed nature out there ha! , To update our app we must change offline.js file. 248 | 249 | Let say if we updated our app code(some core logic!) then incremented version number in offline.js and deployed our code. Now when user navigated to our app 250 | 251 | 1) New offline.js file will be downloaded and it'll byte compared with old file , check will return true and serviceWorker try to installs new version. 252 | 253 | ![new worker installed](images/neworkerinstalled.png) 254 | 255 | 2) New worker will not be activated until current tab closed(or hard refreshed shift+refresh), meaning all network requests handled by old service worker. 256 | 257 | 3) Once we close our existing tab and navigate to our app the new service worker will be activated and old one will be killed. 258 | 259 | ![old worker killed](images/oldworkerkilled.png) 260 | 261 | 4) In new worker activate phase we'll clean up all old caches. 262 | 263 | 264 | 265 | 266 | 267 | 268 | -------------------------------------------------------------------------------- /build.sbt: -------------------------------------------------------------------------------- 1 | 2 | name := "scalajs-offline" 3 | 4 | version := "1.0" 5 | 6 | scalaVersion := "2.11.7" 7 | 8 | lazy val root = project.in(file(".")). 9 | enablePlugins(ScalaJSPlugin) 10 | 11 | //scala 12 | val scalajsReactVersion = "0.8.2" 13 | val scalajsPouchDBVersion = "0.1.0" 14 | val scalajsDomVersion = "0.8.1" 15 | 16 | //js 17 | val reactVersion = "0.12.1" 18 | val pouchDBVersion = "3.3.0" 19 | 20 | // scalajs deps 21 | libraryDependencies ++= Seq( 22 | "com.github.chandu0101.scalajs" %%% "pouchdb" % scalajsPouchDBVersion, 23 | "org.scala-js" %%% "scalajs-dom" % scalajsDomVersion, 24 | "com.github.japgolly.scalajs-react" %%% "extra" % scalajsReactVersion, 25 | "com.github.japgolly.scalajs-react" %%% "core" % scalajsReactVersion 26 | ) 27 | 28 | resolvers += "bintray/non" at "http://dl.bintray.com/non/maven" 29 | 30 | // js deps 31 | jsDependencies ++= Seq( 32 | "org.webjars" % "react" % reactVersion / "react-with-addons.js" commonJSName "React", 33 | "org.webjars" % "pouchdb" % pouchDBVersion / "pouchdb.min.js") 34 | 35 | // creates single jsdeps resource file for easy integration in html page 36 | skip in packageJSDependencies := false 37 | 38 | // uTest settings 39 | //utest.jsrunner.Plugin.utestJsSettings 40 | 41 | 42 | persistLauncher := true 43 | 44 | persistLauncher in Test := false 45 | 46 | 47 | // copy javascript files to js folder,that are generated using fastOptJS/fullOptJS 48 | 49 | crossTarget in(Compile, fullOptJS) := file("js") 50 | 51 | crossTarget in(Compile, fastOptJS) := file("js") 52 | 53 | crossTarget in(Compile, packageJSDependencies) := file("js") 54 | 55 | 56 | //crossTarget in (Compile, packageScalaJSLauncher) := file("js") 57 | 58 | artifactPath in(Compile, fastOptJS) := ((crossTarget in(Compile, fastOptJS)).value / 59 | ((moduleName in fastOptJS).value + "-opt.js")) 60 | 61 | scalacOptions += "-feature" 62 | 63 | 64 | 65 | -------------------------------------------------------------------------------- /deploy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | 4 | 5 | # get comment 6 | comment="$1" 7 | 8 | sbt fullOptJS 9 | 10 | if [ "$comment" == "" ]; then 11 | comment="push form CI" 12 | echo "no comment specified to deploy, using default : $comment" 13 | fi 14 | 15 | projectName="scalajs-offline" 16 | 17 | ghPagesPath="/Users/chandrasekharkode/Desktop/Kode/Programming/scalaprojects/chandu0101.github.io" 18 | 19 | projectPath=${ghPagesPath}/${projectName} 20 | 21 | mkdir -p ${projectPath}/js 22 | 23 | cp index.html ${projectPath} 24 | 25 | cp offline.js ${projectPath} 26 | 27 | cp js/scalajs-offline-opt.js ${projectPath}/js/ 28 | 29 | cp js/scalajs-offline-jsdeps.js ${projectPath}/js/ 30 | 31 | cp js/serviceworker-cache-polyfill.js ${projectPath}/js/ 32 | 33 | cd ${ghPagesPath} 34 | 35 | git add ${projectName} 36 | 37 | git commit -m "$comment" 38 | 39 | git push -------------------------------------------------------------------------------- /images/caches.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/caches.png -------------------------------------------------------------------------------- /images/controller.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/controller.png -------------------------------------------------------------------------------- /images/network.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/network.png -------------------------------------------------------------------------------- /images/neworkerinstalled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/neworkerinstalled.png -------------------------------------------------------------------------------- /images/offline.JPG: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/offline.JPG -------------------------------------------------------------------------------- /images/oldworkerkilled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/oldworkerkilled.png -------------------------------------------------------------------------------- /images/swactivated.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/chandu0101/scalajs-offline/4f2cd140dd01a4eb50cd8d00db2a0521c8365948/images/swactivated.png -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | ScalaJS Offline example 6 | 93 | 94 | 95 | 96 | 97 | 98 |
99 | 100 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | -------------------------------------------------------------------------------- /offline.js: -------------------------------------------------------------------------------- 1 | (function () { 2 | "use strict"; 3 | /* global importScripts */ 4 | /* global self */ 5 | /* global caches */ 6 | /* global fetch */ 7 | /* global URL */ 8 | 9 | 10 | var projectDir = "/scalajs-offline" 11 | 12 | // Include SW cache polyfill this script will be downloaded and cached by default 13 | importScripts(projectDir+"/js/serviceworker-cache-polyfill.js"); 14 | 15 | //version 16 | 17 | var version = "0.0.9" 18 | 19 | // Cache name definitions 20 | var cacheNameStatic = "scalajs-offline-"+version; 21 | var cacheNameGithub = "scalajs-offline-github"; 22 | 23 | var currentCacheNames = [ 24 | cacheNameStatic, 25 | cacheNameGithub 26 | ]; 27 | 28 | 29 | // A new ServiceWorker has been registered 30 | //self.addEventListener("install", function (event) { 31 | // console.log("Installing SW .. " + new Date()) 32 | // event.waitUntil( 33 | // caches.open(cacheNameStatic) 34 | // .then(function (cache) { 35 | // return cache.addAll([ 36 | // projectDir+"/index.html", 37 | // projectDir+"/js/scalajs-offline-opt.js", 38 | // projectDir+"/js/scalajs-offline-jsdeps.js" 39 | // ]); 40 | // }) 41 | // ); 42 | //}); 43 | 44 | self.addEventListener("install", hola(event)) 45 | 46 | // New service worker is activated at this point ( now you can safely perform deleting/migrating old cache) 47 | self.addEventListener("activate", function (event) { 48 | event.waitUntil( 49 | caches.keys() 50 | .then(function (cacheNames) { 51 | return Promise.all( 52 | cacheNames.map(function (cacheName) { 53 | if (currentCacheNames.indexOf(cacheName) === -1) { 54 | return caches.delete(cacheName); 55 | } 56 | }) 57 | ); 58 | }) 59 | ); 60 | }); 61 | 62 | // when a network request made from app 63 | self.addEventListener("fetch", function (event) { 64 | var requestURL = new URL(event.request.url); 65 | if (requestURL.hostname.indexOf(".github.com") > -1) { 66 | event.respondWith(githubAPIResponse(event.request)) 67 | } else { 68 | event.respondWith( 69 | caches.match(event.request) 70 | .then(function (response) { 71 | if (response) { // if we cached already just send that response back 72 | return response; 73 | } 74 | var fetchRequest = event.request.clone(); 75 | return fetch(fetchRequest).then( // if not cached get from network return it and then cache it 76 | function (response) { 77 | var shouldCache = false; 78 | if (response.type === "basic" && response.status === 200) { 79 | shouldCache = cacheNameStatic; 80 | } 81 | if (shouldCache) { 82 | var responseToCache = response.clone(); 83 | caches.open(shouldCache) 84 | .then(function (cache) { 85 | var cacheRequest = event.request.clone(); 86 | cache.put(cacheRequest, responseToCache); 87 | }); 88 | } 89 | return response; 90 | } 91 | ); 92 | }) 93 | ); 94 | } 95 | }); 96 | 97 | /** 98 | * get scalajs github repos. 99 | * @param request 100 | * @returns {*} 101 | */ 102 | function githubAPIResponse(request) { 103 | if (request.headers.get('Accept') == 'x-cache/only') { 104 | return caches.match(request).then(function(response) { 105 | return response; 106 | }); 107 | } else { 108 | return fetch(request.clone()).then(function(response) { 109 | if(response.status === 200 ) { // only cache successful responses , as github supports CORS we can check status of response for non supported cors origins we'll get opaque response 110 | return caches.open(cacheNameGithub).then(function(cache) { 111 | cache.put(request,response.clone()) 112 | return response; 113 | }); 114 | } else { 115 | return response; 116 | } 117 | 118 | }); 119 | } 120 | } 121 | 122 | })(); -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=0.13.7 2 | -------------------------------------------------------------------------------- /project/plugins.sbt: -------------------------------------------------------------------------------- 1 | 2 | addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.5") 3 | 4 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/ReactApp.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline 2 | 3 | import chandu0101.scalajs.offline.routes.AppRouter 4 | import japgolly.scalajs.react.React 5 | import org.scalajs.dom 6 | import org.scalajs.dom.raw.ServiceWorkerRegistration 7 | 8 | import scala.scalajs.js 9 | import scala.scalajs.js.Dynamic.{global => g, literal => json} 10 | import scala.scalajs.js.annotation.JSExport 11 | import scala.scalajs.js.{Date, JSApp, JSON} 12 | 13 | /** 14 | * Created by chandrasekharkode on 2/25/15. 15 | */ 16 | object ReactApp extends JSApp { 17 | @JSExport 18 | override def main(): Unit = { 19 | React.render(AppRouter.C(), dom.document.getElementById("container")) 20 | if (!js.isUndefined(dom.navigator.serviceWorker)) { 21 | // check if serviceWorker supported or not 22 | dom.navigator.serviceWorker.register("/scalajs-offline/offline.js").andThen((resp: ServiceWorkerRegistration) => { 23 | println(s" ServiceWorker registered ${new Date()} successfully : ${JSON.stringify(resp)} ") 24 | } 25 | ).recover((err: Any) => println(s"service worker failed ${err}")) 26 | } else { 27 | println("ServiceWorker not there yet!") 28 | 29 | } 30 | } 31 | 32 | } 33 | 34 | 35 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/components/ScalaJSRepos.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.components 2 | 3 | 4 | import japgolly.scalajs.react._ 5 | import japgolly.scalajs.react.vdom.all._ 6 | import org.scalajs.dom 7 | import org.scalajs.dom.ext.Ajax 8 | 9 | import scala.concurrent.ExecutionContext.Implicits.global 10 | import scala.scalajs.js 11 | import scala.scalajs.js.JSON 12 | import scala.util.{Failure, Success} 13 | 14 | /** 15 | * Created by chandrasekharkode on 3/10/15. 16 | */ 17 | object ScalaJSRepos { 18 | 19 | case class State(repos: js.Array[js.Dynamic] = js.Array() ,err : String = "") 20 | 21 | class Backend(t: BackendScope[_, State]) { 22 | def getRepos(headers : Map[String,String] = Map.empty) = { 23 | Ajax.get("https://api.github.com/search/repositories?q=scalajs&sort=stars&order=desc",headers = headers) 24 | .onComplete { 25 | case Success(xhr) => { 26 | val result = JSON.parse(xhr.responseText) 27 | if(js.isUndefined(result) || js.isUndefined(result.total_count)) { 28 | if(headers.isEmpty && t.state.repos.isEmpty) t.modState(_.copy(err = "Network error!")) 29 | } else { 30 | val repos = result.items.asInstanceOf[js.Array[js.Dynamic]] 31 | if(repos.length != t.state.repos.length) t.modState(_.copy(repos = repos)) 32 | } 33 | } 34 | case Failure(ex) => { 35 | println(s"failed getting repos ${ex.getMessage} and headers $headers") 36 | if(headers.isEmpty && t.state.repos.isEmpty) t.modState(_.copy(err = "Network error!")) 37 | } 38 | } 39 | 40 | } 41 | } 42 | 43 | val component = ReactComponentB[Unit]("ScalaJSRepos") 44 | .initialState(State()) 45 | .backend(new Backend(_)) 46 | .render((P, S, B) => { 47 | div( cls := "repos", 48 | if(S.err.nonEmpty) strong(S.err) 49 | else ul( 50 | S.repos.map(repo => li(key := repo.full_name.toString, a(target := "_blank", href := repo.html_url.toString , repo.full_name.toString),br(),span(repo.description.toString.concat(s" Stars : ${repo.stargazers_count.toString} ")))) 51 | ) 52 | 53 | ) 54 | }) 55 | .componentWillMount(scope => { 56 | if(!js.isUndefined(dom.navigator.serviceWorker) && dom.navigator.serviceWorker.controller != null) { // means service worker controlling this page 57 | scope.backend.getRepos(Map("Accept" -> "x-cache/only")) 58 | } 59 | }) 60 | .componentDidMount(scope => { 61 | scope.backend.getRepos() 62 | }) 63 | .buildU 64 | 65 | def apply() = component() 66 | 67 | 68 | } 69 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/components/TodoApp.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.components 2 | 3 | import chandu0101.scalajs.offline.model.TodoItem 4 | import chandu0101.scalajs.offline.services.TodoService 5 | import chandu0101.scalajs.offline.util.PouchDBChangesListener 6 | import japgolly.scalajs.react._ 7 | import japgolly.scalajs.react.vdom.all._ 8 | import org.scalajs.dom.ext.KeyCode 9 | import org.scalajs.dom.raw.KeyboardEvent 10 | 11 | /** 12 | * Created by chandrasekharkode on 2/25/15. 13 | */ 14 | object TodoApp { 15 | 16 | 17 | case class State(list: List[TodoItem] = List()) 18 | 19 | class Backend(t: BackendScope[_, State]) extends PouchDBChangesListener[TodoItem](TodoService) { 20 | 21 | def handleItemUpdate(item: TodoItem) = TodoService.save(item) 22 | 23 | def handleItemDelete(item: TodoItem) = TodoService.remove(item) 24 | 25 | def handleItemSave(e: ReactEventI): Unit = { 26 | val text = e.target.value 27 | if (e.asInstanceOf[KeyboardEvent].keyCode == KeyCode.enter && text.nonEmpty) { 28 | e.target.value = "" 29 | TodoService.save(TodoItem(title = text)) 30 | } 31 | } 32 | 33 | override def updateNewData(data: List[TodoItem]): Unit = t.modState(_.copy(list = data)) 34 | 35 | 36 | } 37 | 38 | val todoList = ReactComponentB[(State, Backend)]("TodoList") 39 | .render(P => { 40 | val (s, b) = P 41 | ul( 42 | s.list.map(item => li(paddingBottom := "6px", 43 | input(tpe := "checkbox", checked := item.completed, onChange --> b.handleItemUpdate(item.copy(completed = !item.completed))), 44 | span(paddingLeft := "10px", item.title), 45 | button(marginLeft := "10px", onClick --> b.handleItemDelete(item))("X") 46 | )) 47 | ) 48 | }) 49 | .build 50 | 51 | 52 | val component = ReactComponentB[Unit]("TodoApp") 53 | .initialState(State()) 54 | .backend(new Backend(_)) 55 | .render((P, S, B) => { 56 | div(cls := "todoapp", 57 | input(marginLeft := "60px", tpe := "text", onKeyUp ==> B.handleItemSave,placeholder := "type a todo here .."), 58 | todoList((S, B)) 59 | ) 60 | }) 61 | .componentDidMount(scope => scope.backend.startListening) 62 | .buildU 63 | 64 | def apply() = component() 65 | } 66 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/model/TodoItem.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.model 2 | 3 | import scala.scalajs.js 4 | import scala.scalajs.js.Date 5 | import scala.scalajs.js.Dynamic.{literal => json} 6 | 7 | /** 8 | * Created by chandrasekharkode on 2/25/15. 9 | */ 10 | case class TodoItem(_id : String = new Date().toISOString(),_rev : String = "",title : String,completed : Boolean = false) { 11 | 12 | def toJson = json("_id" -> _id ,"_rev" -> _rev,"title" -> title ,"completed" -> completed) 13 | } 14 | 15 | object TodoItem { 16 | 17 | def fromJson(obj : js.Dynamic) : TodoItem = TodoItem(obj._id.toString, 18 | obj._rev.toString, 19 | obj.title.toString, 20 | obj.completed.asInstanceOf[Boolean]) 21 | 22 | } -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/pages/HomePage.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.pages 2 | 3 | import chandu0101.scalajs.offline.components.{ScalaJSRepos, TodoApp} 4 | import japgolly.scalajs.react._ 5 | import japgolly.scalajs.react.vdom.all._ 6 | 7 | 8 | /** 9 | * Created by chandrasekharkode on 2/25/15. 10 | */ 11 | object HomePage { 12 | 13 | val component = ReactComponentB[Unit]("HomePage") 14 | .render(P => { 15 | div(cls := "homePage")( 16 | div(cls := "todoWrapper", 17 | h3("Todo App"), 18 | TodoApp()), 19 | div(cls := "reposWrapper", 20 | h3("ScalaJS Top Repos!"), 21 | ScalaJSRepos()) 22 | ) 23 | }).buildU 24 | 25 | def apply() = component() 26 | 27 | } 28 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/routes/AppRouter.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.routes 2 | 3 | import chandu0101.scalajs.offline.components.TodoApp 4 | import chandu0101.scalajs.offline.pages.HomePage 5 | import japgolly.scalajs.react._ 6 | import japgolly.scalajs.react.extra.router.{AbsUrl, BaseUrl, Redirect, RoutingRules} 7 | import japgolly.scalajs.react.vdom.all._ 8 | 9 | 10 | 11 | /** 12 | * Created by chandrasekharkode on 2/25/15. 13 | */ 14 | object AppRouter { 15 | 16 | 17 | object AppPage extends RoutingRules { 18 | 19 | val root = register(rootLocation(HomePage())) 20 | 21 | register(removeTrailingSlashes) 22 | 23 | override protected val notFound = redirect(root, Redirect.Replace) 24 | 25 | 26 | override protected def interceptRender(i: InterceptionR): ReactElement = 27 | i.element 28 | 29 | } 30 | 31 | val baseUrl = BaseUrl.fromWindowOrigin / "scalajs-offline/" 32 | // val baseUrl = BaseUrl("https://chandu0101.github.io/scalajs-offline/") 33 | 34 | val C = AppPage.router(baseUrl) 35 | } 36 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/services/BaseService.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.services 2 | 3 | import chandu0101.pouchdb.PouchDB 4 | 5 | import scala.concurrent.Future 6 | 7 | /** 8 | * Created by chandrasekharkode on 2/26/15. 9 | */ 10 | trait BaseService[T] { 11 | 12 | val store: PouchDB 13 | 14 | val sync = false 15 | 16 | val retrySync = false 17 | 18 | val remoteStore = "" 19 | 20 | def save(item: T) 21 | 22 | def remove(item: T) 23 | 24 | def getAll: Future[List[T]] 25 | } 26 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/services/TodoService.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.services 2 | 3 | import chandu0101.pouchdb.{AllDocsOptions, PouchDB} 4 | import chandu0101.scalajs.offline.model.TodoItem 5 | 6 | import scala.concurrent.ExecutionContext.Implicits.global 7 | import scala.concurrent.Future 8 | import scala.scalajs.js 9 | 10 | /** 11 | * Created by chandrasekharkode on 2/26/15. 12 | */ 13 | object TodoService extends BaseService[TodoItem] { 14 | 15 | val DB_NAME = "scalajs-todos" 16 | val store: PouchDB = PouchDB.create(DB_NAME) 17 | override val sync = false 18 | override val remoteStore = s"http://localhost:5984/$DB_NAME" 19 | 20 | def save(item: TodoItem) = store.put(item.toJson) 21 | 22 | def remove(item: TodoItem) = store.remove(item.toJson) 23 | 24 | def getAll: Future[List[TodoItem]] = { 25 | store.allDocs(AllDocsOptions.include_docs(true).descending(true).result).map(resp => resp.rows.asInstanceOf[js.Array[js.Dynamic]] 26 | .map(item => TodoItem.fromJson(item.doc) 27 | ).toList 28 | ) 29 | } 30 | 31 | } 32 | -------------------------------------------------------------------------------- /src/main/scala/chandu0101/scalajs/offline/util/PouchDBChangesListener.scala: -------------------------------------------------------------------------------- 1 | package chandu0101.scalajs.offline.util 2 | 3 | import chandu0101.pouchdb.{ChangesEventEmitter, ChangesOptions, ReplicateOptions} 4 | import chandu0101.scalajs.offline.services.BaseService 5 | import japgolly.scalajs.react.extra.OnUnmount 6 | import org.scalajs.dom 7 | 8 | import scala.concurrent.ExecutionContext.Implicits.global 9 | import scala.scalajs.js 10 | import scala.scalajs.js.JSON 11 | 12 | /** 13 | * Created by chandrasekharkode on 2/26/15. 14 | */ 15 | abstract class PouchDBChangesListener[T](service: BaseService[T]) extends OnUnmount { 16 | 17 | var changes: ChangesEventEmitter = null 18 | 19 | var synChanges: ChangesEventEmitter = null 20 | 21 | /** 22 | * implement this method to update react component 23 | * @param data 24 | */ 25 | def updateNewData(data: List[T]) 26 | 27 | def startListening = { 28 | changes = service.store.changes(ChangesOptions.since("now").live(true).result).onChange((resp: js.Dynamic) => { 29 | getNewData 30 | }).onError((err: js.Dynamic) => println(s"Error occurred while performing db operations on ${service.store.name} : ${JSON.stringify(err)}")) 31 | getNewData // call explicitly for the first time 32 | if (service.retrySync) retrySync 33 | else if (service.sync) sync 34 | } 35 | 36 | 37 | def sync = { 38 | synChanges = service.store.sync(service.remoteStore, ReplicateOptions.live(true).result) 39 | .onError((err: js.Dynamic) => // oops network error 40 | println(s"Error occurred while syncing db's : $err}")) 41 | } 42 | 43 | /** 44 | * Useful when user have on/off internet connectivity (example : mobile internet) 45 | */ 46 | def retrySync: Unit = { 47 | var timeout = 10000 // 10secs 48 | var increment = 2 49 | synChanges = service.store.sync(service.remoteStore, ReplicateOptions.live(true).result) 50 | .onChange((resp: js.Dynamic) => timeout = 10000) // reset retry timer when user came back on 51 | .onError((err: js.Dynamic) => 52 | dom.setTimeout(() => { 53 | timeout *= increment 54 | retrySync 55 | }, timeout) 56 | ) 57 | } 58 | 59 | def getNewData = { 60 | service.getAll.onSuccess { 61 | case (data: List[T]) => { 62 | updateNewData(data) 63 | } 64 | } 65 | } 66 | 67 | 68 | /** 69 | * clean up 70 | */ 71 | onUnmount(() => { 72 | if (changes != null) changes.cancel() 73 | if (synChanges != null) synChanges.cancel() 74 | }) 75 | 76 | } 77 | --------------------------------------------------------------------------------