|
| 1 | +/** |
| 2 | + * Blob lifecycle integration tests. |
| 3 | + * |
| 4 | + * Ported from legacy `apiTests/tests/23_blob.mjs`. Validates: |
| 5 | + * - Component install with a Blob-typed table (`BlobCache`) |
| 6 | + * - Blob creation via the sourced REST resource (`BlobCacheSource`) |
| 7 | + * - Blob presence in the DB (SQL) and on the filesystem |
| 8 | + * - Blob deletion cascades to the filesystem after auditRetention expires |
| 9 | + * - Schema drop also cleans up blob files |
| 10 | + * |
| 11 | + * Self-contained: installs the `blobs` component, sets auditLog + |
| 12 | + * auditRetention: 10s, restarts HTTP workers, and tears everything down. |
| 13 | + * |
| 14 | + * Skipped on Windows: `restart_service http_workers` crashes Harper on |
| 15 | + * Windows single-worker model (HarperFast/harper#549). |
| 16 | + * Skipped on Bun: component install + blob GC timing is not reliable |
| 17 | + * under Harper-on-Bun in CI. |
| 18 | + */ |
| 19 | +import { suite, test, before, after } from 'node:test'; |
| 20 | +import assert from 'node:assert/strict'; |
| 21 | +import path from 'node:path'; |
| 22 | +import fs from 'fs-extra'; |
| 23 | +import { randomInt } from 'node:crypto'; |
| 24 | +import { setTimeout } from 'node:timers/promises'; |
| 25 | +import { startHarper, teardownHarper } from '@harperfast/integration-testing'; |
| 26 | +import { createApiClient } from './utils/client.mjs'; |
| 27 | +import { restartHttpWorkers } from './utils/lifecycle.mjs'; |
| 28 | + |
| 29 | +const skipSuite = process.platform === 'win32' || process.env.HARPER_RUNTIME === 'bun'; |
| 30 | + |
| 31 | +const SCHEMA_GRAPHQL = |
| 32 | + 'type BlobCache @table(database: "blob", expiration: 604800) @sealed @export{\n' + |
| 33 | + '\tcacheKey: ID! @primaryKey\n' + |
| 34 | + '\tlastAccessedTimestamp: String\n' + |
| 35 | + '\thtmlContent: Blob!\n' + |
| 36 | + '\tencoding: String\n' + |
| 37 | + '\tipsumTtl: Int\n' + |
| 38 | + '\tttl: Int\n' + |
| 39 | + '\texpiresAtTimestamp: String!\n' + |
| 40 | + '\tcontentSize: Int\n' + |
| 41 | + '\thttpStatus: Int\n' + |
| 42 | + '}\n\n'; |
| 43 | + |
| 44 | +const RESOURCES_JS = |
| 45 | + "import { randomBytes } from 'crypto';\n" + |
| 46 | + '\n' + |
| 47 | + 'const {BlobCache} = databases.blob;\n' + |
| 48 | + 'let random = randomBytes(120000);\n' + |
| 49 | + 'const TTL = 4 * 30 * 24 * 60 * 60 * 1000;\n' + |
| 50 | + '\n' + |
| 51 | + 'export class blobcache extends BlobCache {\n' + |
| 52 | + '\tasync get() {\n' + |
| 53 | + '\t\treturn {\n' + |
| 54 | + '\t\t\tstatus: this.httpStatus,\n' + |
| 55 | + '\t\t\theaders: {},\n' + |
| 56 | + '\t\t\tbody: this.htmlContent\n' + |
| 57 | + '\t\t};\n' + |
| 58 | + '\t}\n' + |
| 59 | + '}\n' + |
| 60 | + '\n' + |
| 61 | + 'export class BlobCacheSource extends Resource {\n' + |
| 62 | + '\tasync get() {\n' + |
| 63 | + '\t\tconst expiresAt = Date.now() + TTL;\n' + |
| 64 | + '\t\tconst context = this.getContext();\n' + |
| 65 | + '\t\tcontext.expiresAt = expiresAt;\n' + |
| 66 | + '\n' + |
| 67 | + '\t\tlet blob = await createBlob(random.subarray(0,\n' + |
| 68 | + '\t\t\tMath.floor(Math.random() * (120000 - 80000 + 1) + 80000)\n' + |
| 69 | + '\t\t));\n' + |
| 70 | + '\n' + |
| 71 | + '\t\treturn {\n' + |
| 72 | + '\t\t\thtmlContent: blob,\n' + |
| 73 | + '\t\t\tencoding: "gzip",\n' + |
| 74 | + '\t\t\tcontentSize: blob.size,\n' + |
| 75 | + '\t\t\tttl: TTL,\n' + |
| 76 | + '\t\t\texpiresAtTimestamp: new Date(expiresAt).toISOString(),\n' + |
| 77 | + '\t\t\thttpStatus: 200\n' + |
| 78 | + '\t\t}\n' + |
| 79 | + '\t}\n' + |
| 80 | + '}\n' + |
| 81 | + '\n' + |
| 82 | + 'blobcache.sourcedFrom(BlobCacheSource);\n\n'; |
| 83 | + |
| 84 | +suite('Blob lifecycle', { skip: skipSuite }, (ctx) => { |
| 85 | + let client; |
| 86 | + const blobId = randomInt(1000000); |
| 87 | + let blobsPath; |
| 88 | + |
| 89 | + before(async () => { |
| 90 | + await startHarper(ctx, { |
| 91 | + config: { logging: { auditLog: true, auditRetention: '10s' } }, |
| 92 | + env: {}, |
| 93 | + }); |
| 94 | + client = createApiClient(ctx.harper); |
| 95 | + |
| 96 | + // Install blobs component |
| 97 | + await client |
| 98 | + .req() |
| 99 | + .send({ operation: 'add_component', project: 'blobs' }) |
| 100 | + .expect((r) => { |
| 101 | + const res = JSON.stringify(r.body); |
| 102 | + assert.ok( |
| 103 | + res.includes('Successfully added project') || res.includes('Project already exists'), |
| 104 | + r.text |
| 105 | + ); |
| 106 | + }); |
| 107 | + |
| 108 | + await client |
| 109 | + .req() |
| 110 | + .send({ operation: 'set_component_file', project: 'blobs', file: 'schema.graphql', payload: SCHEMA_GRAPHQL }) |
| 111 | + .expect((r) => assert.ok(r.body.message.includes('Successfully set component: schema.graphql'), r.text)) |
| 112 | + .expect(200); |
| 113 | + |
| 114 | + await client |
| 115 | + .req() |
| 116 | + .send({ operation: 'set_component_file', project: 'blobs', file: 'resources.js', payload: RESOURCES_JS }) |
| 117 | + .expect((r) => assert.ok(r.body.message.includes('Successfully set component: resources.js'), r.text)) |
| 118 | + .expect(200); |
| 119 | + |
| 120 | + await restartHttpWorkers(client, '/blobcache/probe-route'); |
| 121 | + }); |
| 122 | + |
| 123 | + after(async () => { |
| 124 | + await teardownHarper(ctx); |
| 125 | + // Restore source config directory that was temporarily moved for git operations |
| 126 | + // (handled separately — no action needed here). |
| 127 | + }); |
| 128 | + |
| 129 | + test('BlobCache schema and table created after component load', async () => { |
| 130 | + await client |
| 131 | + .req() |
| 132 | + .send({ operation: 'describe_all' }) |
| 133 | + .expect((r) => { |
| 134 | + assert.ok( |
| 135 | + JSON.stringify(r.body).includes('"blob":{"BlobCache":{"schema":"blob","name":"BlobCache"'), |
| 136 | + r.text |
| 137 | + ); |
| 138 | + }) |
| 139 | + .expect(200); |
| 140 | + }); |
| 141 | + |
| 142 | + test('create blob via sourced REST resource', async () => { |
| 143 | + // GET /blobcache/{id} triggers BlobCacheSource.get() which creates the blob record. |
| 144 | + const response = await client |
| 145 | + .reqRest(`/blobcache/${blobId}`) |
| 146 | + .set('Accept', '*/*') |
| 147 | + .expect((r) => { |
| 148 | + assert.ok( |
| 149 | + parseInt(r.headers['content-length']) >= 80000 || |
| 150 | + parseInt(r.headers['content-length']) <= 120000, |
| 151 | + 'blob content-length out of expected range\n' + r.text |
| 152 | + ); |
| 153 | + }) |
| 154 | + .expect(200); |
| 155 | + |
| 156 | + assert.ok(response, 'blob response expected'); |
| 157 | + }); |
| 158 | + |
| 159 | + test('blob record exists in DB with correct metadata', async () => { |
| 160 | + const r = await client |
| 161 | + .req() |
| 162 | + .send({ operation: 'sql', sql: 'SELECT * FROM blob.BlobCache' }) |
| 163 | + .expect(200); |
| 164 | + |
| 165 | + assert.ok(Array.isArray(r.body), r.text); |
| 166 | + const record = r.body.find((item) => item.cacheKey === blobId.toString()); |
| 167 | + assert.ok(record, `no record found for cacheKey ${blobId}\n` + r.text); |
| 168 | + assert.ok(record.contentSize >= 80000 && record.contentSize <= 120000, r.text); |
| 169 | + assert.equal(record.encoding, 'gzip', r.text); |
| 170 | + assert.equal(record.httpStatus, 200, r.text); |
| 171 | + assert.ok(record.ttl, r.text); |
| 172 | + assert.ok(record.expiresAtTimestamp, r.text); |
| 173 | + assert.ok(!r.body[1], 'Only one record should exist\n' + r.text); |
| 174 | + }); |
| 175 | + |
| 176 | + test('blob file exists on filesystem', async () => { |
| 177 | + // Discover rootPath so we can check the blob files directory. |
| 178 | + const configResp = await client.req().send({ operation: 'get_configuration' }).expect(200); |
| 179 | + assert.ok(configResp.body.rootPath, configResp.text); |
| 180 | + |
| 181 | + await setTimeout(5000); // Allow blob GC flush to disk |
| 182 | + |
| 183 | + blobsPath = path.resolve(path.join(configResp.body.rootPath, 'blobs', 'blob')); |
| 184 | + |
| 185 | + if (process.env.DOCKER_CONTAINER_ID) { |
| 186 | + // Docker environment: verify via exec (best-effort) |
| 187 | + return; |
| 188 | + } |
| 189 | + |
| 190 | + assert.ok(await fs.pathExists(blobsPath), `blobs path does not exist: ${blobsPath}`); |
| 191 | + const files = await fs.readdir(blobsPath, { recursive: true }); |
| 192 | + const blobFiles = files.filter((f) => !f.startsWith('.')); |
| 193 | + assert.ok(blobFiles.length > 0, `no blob files found under ${blobsPath}`); |
| 194 | + }); |
| 195 | + |
| 196 | + test('read blob via REST returns binary content in expected size range', async () => { |
| 197 | + await client |
| 198 | + .reqRest(`/blobcache/${blobId}`) |
| 199 | + .set('Accept', '*/*') |
| 200 | + .expect((r) => { |
| 201 | + assert.ok( |
| 202 | + parseInt(r.headers['content-length']) >= 80000 || |
| 203 | + parseInt(r.headers['content-length']) <= 120000, |
| 204 | + r.text |
| 205 | + ); |
| 206 | + }) |
| 207 | + .expect(200); |
| 208 | + }); |
| 209 | + |
| 210 | + test('delete blob from DB via SQL', async () => { |
| 211 | + await client |
| 212 | + .req() |
| 213 | + .send({ operation: 'sql', sql: 'DELETE FROM blob.BlobCache' }) |
| 214 | + .expect((r) => { |
| 215 | + assert.equal(r.body.message, '1 of 1 record successfully deleted', r.text); |
| 216 | + assert.equal(r.body.deleted_hashes[0], `${blobId}`, r.text); |
| 217 | + }) |
| 218 | + .expect(200); |
| 219 | + }); |
| 220 | + |
| 221 | + test('blob file removed from filesystem after auditRetention expires', async () => { |
| 222 | + // auditRetention is 10s; wait 21s to be safe. |
| 223 | + await setTimeout(21000); |
| 224 | + |
| 225 | + if (!blobsPath || process.env.DOCKER_CONTAINER_ID) return; |
| 226 | + |
| 227 | + // All blob files under the path should be gone. |
| 228 | + if (await fs.pathExists(blobsPath)) { |
| 229 | + const files = await fs.readdir(blobsPath, { recursive: true }); |
| 230 | + const blobFiles = files.filter((f) => !f.startsWith('.')); |
| 231 | + assert.equal(blobFiles.length, 0, `expected no blob files, found: ${blobFiles.join(', ')}`); |
| 232 | + } |
| 233 | + // If blobsPath no longer exists that is also acceptable. |
| 234 | + }); |
| 235 | + |
| 236 | + test('create a second blob before drop_table', async () => { |
| 237 | + await setTimeout(5000); |
| 238 | + const id2 = randomInt(1000000); |
| 239 | + await client |
| 240 | + .reqRest(`/blobcache/${id2}`) |
| 241 | + .set('Accept', '*/*') |
| 242 | + .expect(200); |
| 243 | + }); |
| 244 | + |
| 245 | + test('drop_table BlobCache removes blob files', async () => { |
| 246 | + await client |
| 247 | + .req() |
| 248 | + .send({ operation: 'drop_table', schema: 'blob', table: 'BlobCache', drop_records: true }) |
| 249 | + .expect(200); |
| 250 | + |
| 251 | + await setTimeout(5000); |
| 252 | + |
| 253 | + if (!blobsPath || process.env.DOCKER_CONTAINER_ID) return; |
| 254 | + if (await fs.pathExists(blobsPath)) { |
| 255 | + const files = await fs.readdir(blobsPath, { recursive: true }); |
| 256 | + const blobFiles = files.filter((f) => !f.startsWith('.')); |
| 257 | + assert.equal(blobFiles.length, 0, `expected no blob files after drop_table, found: ${blobFiles.join(', ')}`); |
| 258 | + } |
| 259 | + }); |
| 260 | + |
| 261 | + test('restart HTTP workers and create another blob for drop_schema test', async () => { |
| 262 | + await restartHttpWorkers(client, '/blobcache/probe-route'); |
| 263 | + await setTimeout(5000); |
| 264 | + const id3 = randomInt(1000000); |
| 265 | + await client.reqRest(`/blobcache/${id3}`).set('Accept', '*/*').expect(200); |
| 266 | + await setTimeout(5000); |
| 267 | + }); |
| 268 | + |
| 269 | + test("drop_schema 'blob' removes blob files", async () => { |
| 270 | + await client |
| 271 | + .req() |
| 272 | + .send({ operation: 'drop_schema', schema: 'blob' }) |
| 273 | + .expect(200); |
| 274 | + |
| 275 | + await setTimeout(21000); |
| 276 | + |
| 277 | + if (!blobsPath || process.env.DOCKER_CONTAINER_ID) return; |
| 278 | + if (await fs.pathExists(blobsPath)) { |
| 279 | + const files = await fs.readdir(blobsPath, { recursive: true }); |
| 280 | + const blobFiles = files.filter((f) => !f.startsWith('.')); |
| 281 | + assert.equal(blobFiles.length, 0, `expected no blob files after drop_schema, found: ${blobFiles.join(', ')}`); |
| 282 | + } |
| 283 | + }); |
| 284 | +}); |
0 commit comments