aboutsummaryrefslogtreecommitdiff
path: root/internal/api/plc_compatibility_test.go
blob: 8787902cae0fc513e0d20a248a45b9ebdfbb9f86 (plain) (blame)
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
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
package api

import (
	"context"
	"crypto/ed25519"
	"crypto/rand"
	"encoding/base64"
	"encoding/json"
	"github.com/Fuwn/plutia/internal/checkpoint"
	"github.com/Fuwn/plutia/internal/config"
	"github.com/Fuwn/plutia/internal/ingest"
	"github.com/Fuwn/plutia/internal/storage"
	"github.com/Fuwn/plutia/internal/types"
	"io"
	"net/http"
	"net/http/httptest"
	"os"
	"path/filepath"
	"strings"
	"testing"
	"time"
)

func TestPLCCompatibilityGetDIDShape(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did:plc:alice")

	if err != nil {
		t.Fatalf("get did: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		t.Fatalf("status: got %d want 200", resp.StatusCode)
	}

	if got := resp.Header.Get("Content-Type"); !strings.Contains(got, "application/did+ld+json") {
		t.Fatalf("content-type mismatch: %s", got)
	}

	var body map[string]any

	if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
		t.Fatalf("decode body: %v", err)
	}

	if _, ok := body["@context"].([]any); !ok {
		t.Fatalf("missing or invalid @context: %#v", body["@context"])
	}

	if got, _ := body["id"].(string); got != "did:plc:alice" {
		t.Fatalf("id mismatch: got %q want %q", got, "did:plc:alice")
	}

	if _, ok := body["authentication"]; ok {
		t.Fatalf("unexpected authentication field in compatibility did document")
	}
}

func TestPLCCompatibilityGetDataShape(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did:plc:alice/data")

	if err != nil {
		t.Fatalf("get data: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		t.Fatalf("status: got %d want 200", resp.StatusCode)
	}

	if got := resp.Header.Get("Content-Type"); got != "application/json; charset=utf-8" {
		t.Fatalf("content-type mismatch: got %q want %q", got, "application/json; charset=utf-8")
	}

	var body map[string]any

	if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
		t.Fatalf("decode body: %v", err)
	}

	required := []string{"did", "verificationMethods", "rotationKeys", "alsoKnownAs", "services"}

	for _, key := range required {
		if _, ok := body[key]; !ok {
			t.Fatalf("missing key %q in /data response", key)
		}
	}

	if _, ok := body["verificationMethods"].(map[string]any); !ok {
		t.Fatalf("verificationMethods has wrong type: %#v", body["verificationMethods"])
	}

	if _, ok := body["rotationKeys"].([]any); !ok {
		t.Fatalf("rotationKeys has wrong type: %#v", body["rotationKeys"])
	}

	if _, ok := body["alsoKnownAs"].([]any); !ok {
		t.Fatalf("alsoKnownAs has wrong type: %#v", body["alsoKnownAs"])
	}

	if _, ok := body["services"].(map[string]any); !ok {
		t.Fatalf("services has wrong type: %#v", body["services"])
	}
}

func TestPLCCompatibilityGetLogOrdered(t *testing.T) {
	ts, _, recs, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did:plc:alice/log")

	if err != nil {
		t.Fatalf("get log: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		t.Fatalf("status: got %d want 200", resp.StatusCode)
	}

	if got := resp.Header.Get("Content-Type"); got != "application/json; charset=utf-8" {
		t.Fatalf("content-type mismatch: got %q want %q", got, "application/json; charset=utf-8")
	}

	var ops []map[string]any

	if err := json.NewDecoder(resp.Body).Decode(&ops); err != nil {
		t.Fatalf("decode log: %v", err)
	}

	if len(ops) != 2 {
		t.Fatalf("log length mismatch: got %d want 2", len(ops))
	}

	if _, ok := ops[0]["prev"]; ok {
		t.Fatalf("first op should be genesis without prev")
	}

	if prev, _ := ops[1]["prev"].(string); prev != recs[0].CID {
		t.Fatalf("second op prev mismatch: got %q want %q", prev, recs[0].CID)
	}
}

func TestPLCCompatibilityExportCount(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/export?count=2")

	if err != nil {
		t.Fatalf("get export: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		t.Fatalf("status: got %d want 200", resp.StatusCode)
	}

	if got := resp.Header.Get("Content-Type"); !strings.Contains(got, "application/jsonlines") {
		t.Fatalf("content-type mismatch: %s", got)
	}

	body, _ := io.ReadAll(resp.Body)
	lines := strings.Split(strings.TrimSpace(string(body)), "\n")

	if len(lines) != 2 {
		t.Fatalf("line count mismatch: got %d want 2", len(lines))
	}

	for _, line := range lines {
		var entry map[string]any

		if err := json.Unmarshal([]byte(line), &entry); err != nil {
			t.Fatalf("decode export line: %v", err)
		}

		for _, key := range []string{"did", "operation", "cid", "nullified", "createdAt"} {
			if _, ok := entry[key]; !ok {
				t.Fatalf("missing export key %q in %v", key, entry)
			}
		}
	}
}

func TestPLCCompatibilityPostIsMethodNotAllowed(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	req, err := http.NewRequest(http.MethodPost, ts.URL+"/did:plc:alice", strings.NewReader(`{}`))

	if err != nil {
		t.Fatalf("new request: %v", err)
	}

	resp, err := http.DefaultClient.Do(req)

	if err != nil {
		t.Fatalf("post did: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusMethodNotAllowed {
		t.Fatalf("status: got %d want 405", resp.StatusCode)
	}

	if allow := resp.Header.Get("Allow"); allow != http.MethodGet {
		t.Fatalf("allow header mismatch: got %q want %q", allow, http.MethodGet)
	}

	var body map[string]any

	if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
		t.Fatalf("decode body: %v", err)
	}

	if _, ok := body["message"].(string); !ok {
		t.Fatalf("expected PLC-style message field, got: %v", body)
	}

	if _, ok := body["error"]; ok {
		t.Fatalf("unexpected internal error field in compatibility response: %v", body)
	}
}

func TestPLCCompatibilityNoVerificationMetadataLeak(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did:plc:alice")

	if err != nil {
		t.Fatalf("get did: %v", err)
	}

	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)

	if strings.Contains(string(body), "checkpoint_reference") {
		t.Fatalf("compatibility endpoint leaked verification metadata: %s", string(body))
	}
}

func TestPLCCompatibilityProofEndpointStillWorks(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did/did:plc:alice/proof")

	if err != nil {
		t.Fatalf("get proof: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusOK {
		body, _ := io.ReadAll(resp.Body)

		t.Fatalf("proof status: got %d want 200 body=%s", resp.StatusCode, string(body))
	}
}

func TestPLCCompatibilityNotFoundUsesPLCErrorShape(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)

	defer cleanup()

	resp, err := http.Get(ts.URL + "/did:plc:not-registered")

	if err != nil {
		t.Fatalf("get missing did: %v", err)
	}

	defer resp.Body.Close()

	if resp.StatusCode != http.StatusNotFound {
		t.Fatalf("status: got %d want 404", resp.StatusCode)
	}

	var body map[string]any

	if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
		t.Fatalf("decode body: %v", err)
	}

	if _, ok := body["message"].(string); !ok {
		t.Fatalf("expected message field for 404, got: %v", body)
	}

	if _, ok := body["error"]; ok {
		t.Fatalf("unexpected error field in compatibility 404 body: %v", body)
	}
}

func TestPLCCompatibilityTombstonedDIDReturnsNotAvailable404(t *testing.T) {
	ts, store, _, cleanup := newCompatibilityServer(t)
	defer cleanup()

	const tombDID = "did:plc:tombstone-test"

	if err := store.PutState(types.StateV1{
		DID:          tombDID,
		ChainTipHash: "bafy-tomb-tip",
		DIDDocument:  []byte(`{"id":"did:plc:tombstone-test","deactivated":true}`),
	}); err != nil {
		t.Fatalf("put tombstoned state: %v", err)
	}

	check := func(path string) {
		t.Helper()

		resp, err := http.Get(ts.URL + path)
		if err != nil {
			t.Fatalf("get %s: %v", path, err)
		}
		defer resp.Body.Close()

		if resp.StatusCode != http.StatusNotFound {
			t.Fatalf("%s status: got %d want 404", path, resp.StatusCode)
		}

		if got := resp.Header.Get("Content-Type"); got != "application/json; charset=utf-8" {
			t.Fatalf("%s content-type mismatch: got %q want %q", path, got, "application/json; charset=utf-8")
		}

		var body map[string]any
		if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
			t.Fatalf("%s decode body: %v", path, err)
		}

		if len(body) != 1 {
			t.Fatalf("%s expected single message field, got: %v", path, body)
		}

		want := "DID not available: " + tombDID
		if got, _ := body["message"].(string); got != want {
			t.Fatalf("%s message mismatch: got %q want %q", path, got, want)
		}
	}

	check("/" + tombDID)
	check("/" + tombDID + "/data")
}

func TestPLCCompatibilitySuccessContentTypesMatchUpstreamStyle(t *testing.T) {
	ts, _, _, cleanup := newCompatibilityServer(t)
	defer cleanup()

	tests := []struct {
		path string
		want string
	}{
		{path: "/did:plc:alice", want: "application/did+ld+json; charset=utf-8"},
		{path: "/did:plc:alice/data", want: "application/json; charset=utf-8"},
		{path: "/did:plc:alice/log", want: "application/json; charset=utf-8"},
		{path: "/did:plc:alice/log/last", want: "application/json; charset=utf-8"},
		{path: "/did:plc:alice/log/audit", want: "application/json; charset=utf-8"},
	}

	for _, tc := range tests {
		resp, err := http.Get(ts.URL + tc.path)
		if err != nil {
			t.Fatalf("get %s: %v", tc.path, err)
		}

		if resp.StatusCode != http.StatusOK {
			_ = resp.Body.Close()
			t.Fatalf("%s status: got %d want 200", tc.path, resp.StatusCode)
		}

		got := resp.Header.Get("Content-Type")
		_ = resp.Body.Close()

		if got != tc.want {
			t.Fatalf("%s content-type mismatch: got %q want %q", tc.path, got, tc.want)
		}
	}
}

func newCompatibilityServer(t *testing.T) (*httptest.Server, *storage.PebbleStore, []types.ExportRecord, func()) {
	t.Helper()

	tmp := t.TempDir()
	dataDir := filepath.Join(tmp, "data")

	if err := os.MkdirAll(dataDir, 0o755); err != nil {
		t.Fatalf("mkdir data: %v", err)
	}

	seed := make([]byte, ed25519.SeedSize)

	if _, err := rand.Read(seed); err != nil {
		t.Fatalf("seed: %v", err)
	}

	keyPath := filepath.Join(tmp, "mirror.key")

	if err := os.WriteFile(keyPath, []byte(base64.RawURLEncoding.EncodeToString(seed)), 0o600); err != nil {
		t.Fatalf("write key: %v", err)
	}

	recs := buildCheckpointScenarioRecords(t)
	sourcePath := filepath.Join(tmp, "records.ndjson")

	writeRecordsFile(t, sourcePath, recs)

	store, err := storage.OpenPebble(dataDir)

	if err != nil {
		t.Fatalf("open pebble: %v", err)
	}

	if err := store.SetMode(config.ModeMirror); err != nil {
		t.Fatalf("set mode: %v", err)
	}

	bl, err := storage.OpenBlockLog(dataDir, 3, 4)

	if err != nil {
		t.Fatalf("open block log: %v", err)
	}

	cfg := config.Config{
		Mode:                 config.ModeMirror,
		DataDir:              dataDir,
		PLCSource:            sourcePath,
		VerifyPolicy:         config.VerifyFull,
		ZstdLevel:            3,
		BlockSizeMB:          4,
		CheckpointInterval:   2,
		CommitBatchSize:      2,
		VerifyWorkers:        2,
		ListenAddr:           ":0",
		MirrorPrivateKeyPath: keyPath,
		PollInterval:         5 * time.Second,
		RequestTimeout:       10 * time.Second,
	}
	cpMgr := checkpoint.NewManager(store, dataDir, keyPath)
	svc := ingest.NewService(cfg, store, ingest.NewClient(sourcePath), bl, cpMgr)

	if err := svc.Replay(context.Background()); err != nil {
		t.Fatalf("replay: %v", err)
	}

	if err := svc.Flush(context.Background()); err != nil {
		t.Fatalf("flush: %v", err)
	}

	if _, err := svc.Snapshot(context.Background()); err != nil {
		t.Fatalf("snapshot: %v", err)
	}

	ts := httptest.NewServer(NewServer(cfg, store, svc, cpMgr).Handler())
	cleanup := func() {
		ts.Close()
		svc.Close()

		_ = store.Close()
	}

	return ts, store, recs, cleanup
}