idb-cache-expiration.js 4.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  1. /*
  2. Copyright 2015 Google Inc. All Rights Reserved.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. 'use strict';
  14. var DB_PREFIX = 'sw-toolbox-';
  15. var DB_VERSION = 1;
  16. var STORE_NAME = 'store';
  17. var URL_PROPERTY = 'url';
  18. var TIMESTAMP_PROPERTY = 'timestamp';
  19. var cacheNameToDbPromise = {};
  20. function openDb(cacheName) {
  21. return new Promise(function(resolve, reject) {
  22. var request = indexedDB.open(DB_PREFIX + cacheName, DB_VERSION);
  23. request.onupgradeneeded = function() {
  24. var objectStore = request.result.createObjectStore(STORE_NAME,
  25. {keyPath: URL_PROPERTY});
  26. objectStore.createIndex(TIMESTAMP_PROPERTY, TIMESTAMP_PROPERTY,
  27. {unique: false});
  28. };
  29. request.onsuccess = function() {
  30. resolve(request.result);
  31. };
  32. request.onerror = function() {
  33. reject(request.error);
  34. };
  35. });
  36. }
  37. function getDb(cacheName) {
  38. if (!(cacheName in cacheNameToDbPromise)) {
  39. cacheNameToDbPromise[cacheName] = openDb(cacheName);
  40. }
  41. return cacheNameToDbPromise[cacheName];
  42. }
  43. function setTimestampForUrl(db, url, now) {
  44. return new Promise(function(resolve, reject) {
  45. var transaction = db.transaction(STORE_NAME, 'readwrite');
  46. var objectStore = transaction.objectStore(STORE_NAME);
  47. objectStore.put({url: url, timestamp: now});
  48. transaction.oncomplete = function() {
  49. resolve(db);
  50. };
  51. transaction.onabort = function() {
  52. reject(transaction.error);
  53. };
  54. });
  55. }
  56. function expireOldEntries(db, maxAgeSeconds, now) {
  57. // Bail out early by resolving with an empty array if we're not using
  58. // maxAgeSeconds.
  59. if (!maxAgeSeconds) {
  60. return Promise.resolve([]);
  61. }
  62. return new Promise(function(resolve, reject) {
  63. var maxAgeMillis = maxAgeSeconds * 1000;
  64. var urls = [];
  65. var transaction = db.transaction(STORE_NAME, 'readwrite');
  66. var objectStore = transaction.objectStore(STORE_NAME);
  67. var index = objectStore.index(TIMESTAMP_PROPERTY);
  68. index.openCursor().onsuccess = function(cursorEvent) {
  69. var cursor = cursorEvent.target.result;
  70. if (cursor) {
  71. if (now - maxAgeMillis > cursor.value[TIMESTAMP_PROPERTY]) {
  72. var url = cursor.value[URL_PROPERTY];
  73. urls.push(url);
  74. objectStore.delete(url);
  75. cursor.continue();
  76. }
  77. }
  78. };
  79. transaction.oncomplete = function() {
  80. resolve(urls);
  81. };
  82. transaction.onabort = reject;
  83. });
  84. }
  85. function expireExtraEntries(db, maxEntries) {
  86. // Bail out early by resolving with an empty array if we're not using
  87. // maxEntries.
  88. if (!maxEntries) {
  89. return Promise.resolve([]);
  90. }
  91. return new Promise(function(resolve, reject) {
  92. var urls = [];
  93. var transaction = db.transaction(STORE_NAME, 'readwrite');
  94. var objectStore = transaction.objectStore(STORE_NAME);
  95. var index = objectStore.index(TIMESTAMP_PROPERTY);
  96. var countRequest = index.count();
  97. index.count().onsuccess = function() {
  98. var initialCount = countRequest.result;
  99. if (initialCount > maxEntries) {
  100. index.openCursor().onsuccess = function(cursorEvent) {
  101. var cursor = cursorEvent.target.result;
  102. if (cursor) {
  103. var url = cursor.value[URL_PROPERTY];
  104. urls.push(url);
  105. objectStore.delete(url);
  106. if (initialCount - urls.length > maxEntries) {
  107. cursor.continue();
  108. }
  109. }
  110. };
  111. }
  112. };
  113. transaction.oncomplete = function() {
  114. resolve(urls);
  115. };
  116. transaction.onabort = reject;
  117. });
  118. }
  119. function expireEntries(db, maxEntries, maxAgeSeconds, now) {
  120. return expireOldEntries(db, maxAgeSeconds, now).then(function(oldUrls) {
  121. return expireExtraEntries(db, maxEntries).then(function(extraUrls) {
  122. return oldUrls.concat(extraUrls);
  123. });
  124. });
  125. }
  126. module.exports = {
  127. getDb: getDb,
  128. setTimestampForUrl: setTimestampForUrl,
  129. expireEntries: expireEntries
  130. };