summaryrefslogtreecommitdiffstats
path: root/dom/localstorage/test/unit/test_originInit.js
blob: 48afdf971bd9f1429aab90a2dcadd81bc9426ca7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/**
 * Any copyright is dedicated to the Public Domain.
 * http://creativecommons.org/publicdomain/zero/1.0/
 */

add_task(async function testSteps() {
  const storageDirName = "storage";
  const persistenceTypeDefaultDirName = "default";
  const persistenceTypePersistentDirName = "permanent";

  const principal = getPrincipal("http://example.com");

  const originDirName = "http+++example.com";

  const clientLSDirName = "ls";

  const dataFile = getRelativeFile(
    `${storageDirName}/${persistenceTypeDefaultDirName}/${originDirName}/` +
      `${clientLSDirName}/data.sqlite`
  );

  const usageJournalFile = getRelativeFile(
    `${storageDirName}/${persistenceTypeDefaultDirName}/${originDirName}/` +
      `${clientLSDirName}/usage-journal`
  );

  const usageFile = getRelativeFile(
    `${storageDirName}/${persistenceTypeDefaultDirName}/${originDirName}/` +
      `${clientLSDirName}/usage`
  );

  const persistentLSDir = getRelativeFile(
    `${storageDirName}/${persistenceTypePersistentDirName}/${originDirName}/` +
      `${clientLSDirName}`
  );

  const data = {};
  data.key = "key1";
  data.value = "value1";
  data.usage = data.key.length + data.value.length;

  const usageFileCookie = 0x420a420a;

  async function createTestOrigin() {
    let storage = getLocalStorage(principal);

    storage.setItem(data.key, data.value);

    let request = reset();
    await requestFinished(request);
  }

  async function createPersistentTestOrigin() {
    let database = getSimpleDatabase(principal, "persistent");

    let request = database.open("data");
    await requestFinished(request);

    request = reset();
    await requestFinished(request);
  }

  function removeFile(file) {
    file.remove(false);
  }

  function createEmptyFile(file) {
    file.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0o0644);
  }

  function createEmptyDirectory(dir) {
    dir.create(Ci.nsIFile.DIRECTORY_TYPE, 0o0755);
  }

  function getBinaryOutputStream(file) {
    var ostream = Cc[
      "@mozilla.org/network/file-output-stream;1"
    ].createInstance(Ci.nsIFileOutputStream);
    ostream.init(file, -1, parseInt("0644", 8), 0);

    let bstream = Cc["@mozilla.org/binaryoutputstream;1"].createInstance(
      Ci.nsIBinaryOutputStream
    );
    bstream.setOutputStream(ostream);

    return bstream;
  }

  async function initTestOrigin() {
    let request = initStorage();
    await requestFinished(request);

    request = initTemporaryStorage();
    await requestFinished(request);

    request = initTemporaryOrigin("default", principal);
    await requestFinished(request);
  }

  async function initPersistentTestOrigin() {
    let request = initStorage();
    await requestFinished(request);

    request = initPersistentOrigin(principal);
    await requestFinished(request);
  }

  async function checkFiles(wantData, wantUsage) {
    let exists = dataFile.exists();
    if (wantData) {
      ok(exists, "Data file does exist");
    } else {
      ok(!exists, "Data file doesn't exist");
    }

    exists = usageJournalFile.exists();
    ok(!exists, "Usage journal file doesn't exist");

    exists = usageFile.exists();
    if (wantUsage) {
      ok(exists, "Usage file does exist");
    } else {
      ok(!exists, "Usage file doesn't exist");
      return;
    }

    let usage = await readUsageFromUsageFile(usageFile);
    ok(usage == data.usage, "Correct usage");
  }

  async function clearTestOrigin() {
    let request = clearOrigin(principal, "default");
    await requestFinished(request);
  }

  async function clearPersistentTestOrigin() {
    let request = clearOrigin(principal, "persistent");
    await requestFinished(request);
  }

  info("Setting prefs");

  Services.prefs.setBoolPref(
    "dom.storage.enable_unsupported_legacy_implementation",
    false
  );

  info(
    "Stage 1 - " +
      "data.sqlite file doesn't exist, " +
      "usage-journal file doesn't exist, " +
      "any usage file exists"
  );

  await createTestOrigin();

  removeFile(dataFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ false, /* wantUsage */ false);

  await clearTestOrigin();

  info(
    "Stage 2 - " +
      "data.sqlite file doesn't exist, " +
      "any usage-journal file exists, " +
      "any usage file exists"
  );

  await createTestOrigin();

  removeFile(dataFile);
  createEmptyFile(usageJournalFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ false, /* wantUsage */ false);

  await clearTestOrigin();

  info(
    "Stage 3 - " +
      "valid data.sqlite file exists, " +
      "usage-journal file doesn't exist, " +
      "usage file doesn't exist"
  );

  await createTestOrigin();

  removeFile(usageFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 4 - " +
      "valid data.sqlite file exists, " +
      "usage-journal file doesn't exist, " +
      "invalid (wrong file size) usage file exists"
  );

  await createTestOrigin();

  removeFile(usageFile);
  createEmptyFile(usageFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 5 - " +
      "valid data.sqlite file exists, " +
      "usage-journal file doesn't exist, " +
      "invalid (wrong cookie) usage file exists"
  );

  await createTestOrigin();

  let stream = getBinaryOutputStream(usageFile);
  stream.write32(usageFileCookie - 1);
  stream.write64(data.usage);
  stream.close();

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 6 - " +
      "valid data.sqlite file exists, " +
      "usage-journal file doesn't exist, " +
      "valid usage file exists"
  );

  await createTestOrigin();

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 7 - " +
      "valid data.sqlite file exists, " +
      "any usage-journal exists, " +
      "usage file doesn't exist"
  );

  await createTestOrigin();

  createEmptyFile(usageJournalFile);
  removeFile(usageFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 8 - " +
      "valid data.sqlite file exists, " +
      "any usage-journal exists, " +
      "invalid (wrong file size) usage file exists"
  );

  await createTestOrigin();

  createEmptyFile(usageJournalFile);
  removeFile(usageFile);
  createEmptyFile(usageFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 9 - " +
      "valid data.sqlite file exists, " +
      "any usage-journal exists, " +
      "invalid (wrong cookie) usage file exists"
  );

  await createTestOrigin();

  createEmptyFile(usageJournalFile);
  stream = getBinaryOutputStream(usageFile);
  stream.write32(usageFileCookie - 1);
  stream.write64(data.usage);
  stream.close();

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 10 - " +
      "valid data.sqlite file exists, " +
      "any usage-journal exists, " +
      "invalid (wrong usage) usage file exists"
  );

  await createTestOrigin();

  createEmptyFile(usageJournalFile);
  stream = getBinaryOutputStream(usageFile);
  stream.write32(usageFileCookie);
  stream.write64(data.usage - 1);
  stream.close();

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  info(
    "Stage 11 - " +
      "valid data.sqlite file exists, " +
      "any usage-journal exists, " +
      "valid usage file exists"
  );

  await createTestOrigin();

  createEmptyFile(usageJournalFile);

  await initTestOrigin();

  await checkFiles(/* wantData */ true, /* wantUsage */ true);

  await clearTestOrigin();

  // Verify that InitializeOrigin doesn't fail when a
  // storage/permanent/${origin}/ls exists.
  info(
    "Stage 12 - Testing initialization of ls directory placed in permanent " +
      "origin directory"
  );

  await createPersistentTestOrigin();

  createEmptyDirectory(persistentLSDir);

  try {
    await initPersistentTestOrigin();

    ok(true, "Should not have thrown");
  } catch (ex) {
    ok(false, "Should not have thrown");
  }

  let exists = persistentLSDir.exists();
  ok(exists, "ls directory in permanent origin directory does exist");

  await clearPersistentTestOrigin();
});