@enbox/dwn-server 0.0.3 → 0.0.5

package/dist/esm/tests/http-api.spec.js

@@ -1,782 +0,0 @@
-import { Convert } from '@enbox/common';
-import { expect } from 'chai';
-import log from 'loglevel';
-import { v4 as uuidv4 } from 'uuid';
-import { webcrypto } from 'node:crypto';
-import { DataStream, DwnErrorCode, ProtocolsConfigure, RecordsQuery, TestDataGenerator, Time, } from '@enbox/dwn-sdk-js';
-import sinon, { useFakeTimers } from 'sinon';
-import CommonScenarioValidator from './common-scenario-validator.js';
-import { config } from '../src/config.js';
-import { getTestDwn } from './test-dwn.js';
-import { HttpApi } from '../src/http-api.js';
-import { RegistrationManager } from '../src/registration/registration-manager.js';
-import { createJsonRpcRequest, JsonRpcErrorCodes, } from '../src/lib/json-rpc.js';
-import { createRecordsWriteMessage, getDwnResponse, getFileAsReadStream, } from './utils.js';
-if (!globalThis.crypto) {
-    // @ts-ignore
-    globalThis.crypto = webcrypto;
-}
-describe('http api', function () {
-    let httpApi;
-    let alice;
-    let registrationManager;
-    let dwn;
-    let clock;
-    let baseUrl;
-    before(async function () {
-        clock = useFakeTimers({ shouldAdvanceTime: true });
-        // TODO: Remove direct use of default config to avoid changes bleed/pollute between tests - https://github.com/enboxorg/enbox/issues/144
-        config.packageJsonPath = './package.json'; // default is Docker path; override for local tests
-        config.registrationStoreUrl = 'sqlite://';
-        config.registrationProofOfWorkEnabled = true;
-        config.termsOfServiceFilePath = './tests/fixtures/terms-of-service.txt';
-        config.registrationProofOfWorkInitialMaxHash = '0FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF'; // 1 in 16 chance of solving
-        // RegistrationManager creation
-        const registrationStoreUrl = config.registrationStoreUrl;
-        const termsOfServiceFilePath = config.termsOfServiceFilePath;
-        const proofOfWorkInitialMaximumAllowedHash = config.registrationProofOfWorkInitialMaxHash;
-        registrationManager = await RegistrationManager.create({ registrationStoreUrl, termsOfServiceFilePath, proofOfWorkInitialMaximumAllowedHash });
-        dwn = await getTestDwn({ tenantGate: registrationManager });
-        httpApi = await HttpApi.create(config, dwn, registrationManager);
-    });
-    beforeEach(async function () {
-        sinon.restore();
-        await httpApi.start(0);
-        baseUrl = `http://localhost:${httpApi.server.port}`;
-        // generate a new persona for each test to avoid state pollution
-        alice = await TestDataGenerator.generateDidKeyPersona();
-        await registrationManager.recordTenantRegistration({ did: alice.did, termsOfServiceHash: registrationManager.getTermsOfServiceHash() });
-    });
-    afterEach(async function () {
-        await httpApi.close();
-    });
-    after(function () {
-        sinon.restore();
-        clock.restore();
-    });
-    describe('/ (rpc)', function () {
-        it('responds with a 400 if no dwn-request header is provided', async function () {
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-            });
-            expect(response.status).to.equal(400);
-            const body = (await response.json());
-            expect(body.error.code).to.equal(JsonRpcErrorCodes.BadRequest);
-            expect(body.error.message).to.equal('request payload required.');
-        });
-        it('responds with a 400 if parsing dwn request fails', async function () {
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: { 'dwn-request': ';;;;@!#@!$$#!@%' },
-            });
-            expect(response.status).to.equal(400);
-            const body = (await response.json());
-            expect(body.error.code).to.equal(JsonRpcErrorCodes.BadRequest);
-            expect(body.error.message).to.include('JSON');
-        });
-        it('responds with a 2XX HTTP status if JSON RPC handler returns 4XX/5XX DWN status code', async function () {
-            const { recordsWrite, dataStream } = await createRecordsWriteMessage(alice);
-            // Intentionally delete a required property to produce an invalid RecordsWrite message.
-            const message = recordsWrite.toJSON();
-            delete message['descriptor']['interface'];
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: message,
-                target: alice.did,
-            });
-            const dataBytes = await DataStream.toBytes(dataStream);
-            // Attempt an initial RecordsWrite with the invalid message to ensure the DWN returns an error.
-            const responseInitialWrite = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: new Blob([dataBytes]),
-            });
-            expect(responseInitialWrite.status).to.equal(200);
-            const body = (await responseInitialWrite.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(400);
-            expect(reply.status.detail).to.include('Both interface and method must be present');
-        });
-        it('exposes dwn-response header', async function () {
-            // This test verifies that the Express web server includes `dwn-response` in the list of
-            // `access-control-expose-headers` returned in each HTTP response. This is necessary to enable applications
-            // that have CORS enabled to read and parse DWeb Messages that are returned as Response headers, particularly
-            // in the case of RecordsRead messages.
-            // TODO: github.com/enboxorg/enbox/issues/50
-            // Consider replacing this test with a more robust method of testing, such as writing Playwright tests
-            // that run in a browser to verify that the `dwn-response` header can be read from the `fetch()` response
-            // when CORS mode is enabled.
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-            });
-            // Check if the 'access-control-expose-headers' header is present
-            expect(response.headers.has('access-control-expose-headers')).to.be.true;
-            // Check if the 'dwn-response' header is listed in 'access-control-expose-headers'
-            const exposedHeaders = response.headers.get('access-control-expose-headers');
-            expect(exposedHeaders).to.include('dwn-response');
-        });
-        it('works fine when no request body is provided', async function () {
-            const recordsQuery = await RecordsQuery.create({
-                filter: {
-                    schema: 'woosa',
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsQuery.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: { 'dwn-request': JSON.stringify(dwnRequest) },
-            });
-            expect(response.status).to.equal(200);
-            const body = await response.json();
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            expect(body.result.reply.status.code).to.equal(200);
-        });
-    });
-    describe('P0 Scenarios', function () {
-        it('should be able to read and write a protocol record', async function () {
-            await CommonScenarioValidator.sanityTestDwnReadWrite(baseUrl, alice);
-        });
-    });
-    describe('RecordsWrite', function () {
-        it('handles RecordsWrite overwrite that does not mutate data', async function () {
-            // First RecordsWrite that creates the record.
-            const { recordsWrite: initialWrite, dataStream } = await createRecordsWriteMessage(alice);
-            const dataBytes = await DataStream.toBytes(dataStream);
-            let requestId = uuidv4();
-            let dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: initialWrite.toJSON(),
-                target: alice.did,
-            });
-            const responseInitialWrite = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: new Blob([dataBytes]),
-            });
-            expect(responseInitialWrite.status).to.equal(200);
-            // Waiting for minimal time to make sure subsequent RecordsWrite has a later timestamp.
-            await Time.minimalSleep();
-            // Subsequent RecordsWrite that mutates the published property of the record.
-            const { recordsWrite: overWrite } = await createRecordsWriteMessage(alice, {
-                recordId: initialWrite.message.recordId,
-                dataCid: initialWrite.message.descriptor.dataCid,
-                dataSize: initialWrite.message.descriptor.dataSize,
-                dateCreated: initialWrite.message.descriptor.dateCreated,
-                published: true,
-            });
-            requestId = uuidv4();
-            dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: overWrite.toJSON(),
-                target: alice.did,
-            });
-            const responseOverwrite = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(responseOverwrite.status).to.equal(200);
-            const body = (await responseOverwrite.json());
-            expect(body.error).to.not.exist;
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-        });
-        it('handles a RecordsWrite tombstone', async function () {
-            const { recordsWrite: tombstone } = await createRecordsWriteMessage(alice);
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: tombstone.toJSON(),
-                target: alice.did,
-            });
-            const responeTombstone = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(responeTombstone.status).to.equal(200);
-        });
-    });
-    describe('health check', function () {
-        it('returns a health check', async function () {
-            const response = await fetch(`${baseUrl}/health`, {
-                method: 'GET',
-            });
-            expect(response.status).to.equal(200);
-        });
-    });
-    describe('default http get response', function () {
-        it('returns returns a default message', async function () {
-            const response = await fetch(`${baseUrl}/`, {
-                method: 'GET',
-            });
-            expect(response.status).to.equal(200);
-        });
-    });
-    describe('/:did/records/:id', function () {
-        it('returns record data if record is published', async function () {
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-                published: true,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            let response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: stream,
-            });
-            expect(response.status).to.equal(200);
-            const body = (await response.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-            response = await fetch(`${baseUrl}/${alice.did}/records/${recordsWrite.message.recordId}`);
-            const blob = await response.blob();
-            expect(blob.size).to.equal(size);
-        });
-        it('returns a 404 if an unpublished record is requested', async function () {
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            let response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: stream,
-            });
-            expect(response.status).to.equal(200);
-            const body = (await response.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-            response = await fetch(`${baseUrl}/${alice.did}/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 if record does not exist', async function () {
-            const { recordsWrite } = await createRecordsWriteMessage(alice);
-            const response = await fetch(`${baseUrl}/${alice.did}/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 for invalid or unauthorized did', async function () {
-            const unauthorized = await TestDataGenerator.generateDidKeyPersona();
-            const { recordsWrite } = await createRecordsWriteMessage(unauthorized);
-            const response = await fetch(`${baseUrl}/${unauthorized.did}/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 for invalid record id', async function () {
-            const response = await fetch(`${baseUrl}/${alice.did}/records/kaka`);
-            expect(response.status).to.equal(404);
-        });
-    });
-    describe('/:did/read/records/:id', function () {
-        it('returns record data if record is published', async function () {
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-                published: true,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            let response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: stream,
-            });
-            expect(response.status).to.equal(200);
-            const body = (await response.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-            response = await fetch(`${baseUrl}/${alice.did}/read/records/${recordsWrite.message.recordId}`);
-            const blob = await response.blob();
-            expect(blob.size).to.equal(size);
-        });
-        it('returns a 404 if an unpublished record is requested', async function () {
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            let response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: stream,
-            });
-            expect(response.status).to.equal(200);
-            const body = (await response.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-            response = await fetch(`${baseUrl}/${alice.did}/read/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 if record does not exist', async function () {
-            const { recordsWrite } = await createRecordsWriteMessage(alice);
-            const response = await fetch(`${baseUrl}/${alice.did}/read/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 for invalid or unauthorized did', async function () {
-            const unauthorized = await TestDataGenerator.generateDidKeyPersona();
-            const { recordsWrite } = await createRecordsWriteMessage(unauthorized);
-            const response = await fetch(`${baseUrl}/${unauthorized.did}/read/records/${recordsWrite.message.recordId}`);
-            expect(response.status).to.equal(404);
-        });
-        it('returns a 404 for invalid record id', async function () {
-            const response = await fetch(`${baseUrl}/${alice.did}/read/records/kaka`);
-            expect(response.status).to.equal(404);
-        });
-    });
-    describe('/:did/read/protocols/:protocol', function () {
-        it('returns protocol definition if protocol is published', async function () {
-            // Create and publish a protocol
-            const protocolConfigure = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol',
-                    published: true,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: protocolConfigure.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(response.status).to.equal(200);
-            // Fetch the protocol definition using the HTTP API
-            const base64urlEncodedProtocol = Convert.string(protocolConfigure.message.descriptor.definition.protocol).toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}`;
-            const protocolQueryResponse = await fetch(protocolUrl);
-            expect(protocolQueryResponse.status).to.equal(200);
-            // get the JSON response
-            const protocolConfigureReply = await protocolQueryResponse.json();
-            expect(protocolConfigureReply.descriptor).to.deep.equal(protocolConfigure.message.descriptor);
-        });
-        it('returns a 404 if protocol is not published', async function () {
-            // Create a not-published protocol
-            const protocolConfigure = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol',
-                    published: false,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: protocolConfigure.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(response.status).to.equal(200);
-            // Fetch the protocol definition using the HTTP API
-            const base64urlEncodedProtocol = Convert.string(protocolConfigure.message.descriptor.definition.protocol).toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}`;
-            const protocolQueryResponse = await fetch(protocolUrl);
-            expect(protocolQueryResponse.status).to.equal(404);
-        });
-        it('returns a 400 if protocol is not base64url encoded', async function () {
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/invalid-protocol`;
-            const protocolQueryResponse = await fetch(protocolUrl);
-            expect(protocolQueryResponse.status).to.equal(400);
-            expect(await protocolQueryResponse.text()).to.equal('Bad Request');
-        });
-    });
-    describe('/:did/query/protocols', function () {
-        it('returns protocol definition if protocol is published', async function () {
-            // create two protocol definitions, one published and one not
-            const protocolConfigurePublished = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol',
-                    published: true,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: protocolConfigurePublished.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(response.status).to.equal(200);
-            const protocolConfigureNotPublished = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol2',
-                    published: false,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId2 = uuidv4();
-            const dwnRequest2 = createJsonRpcRequest(requestId2, 'dwn.processMessage', {
-                message: protocolConfigureNotPublished.toJSON(),
-                target: alice.did,
-            });
-            const response2 = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest2),
-                },
-            });
-            expect(response2.status).to.equal(200);
-            // now query for a list of protocols
-            const protocolQueryUrl = `${baseUrl}/${alice.did}/query/protocols`;
-            const protocolQueryResponse = await fetch(protocolQueryUrl);
-            expect(protocolQueryResponse.status).to.equal(200);
-            // get the JSON response
-            const protocolQueryReply = await protocolQueryResponse.json();
-            expect(protocolQueryReply).to.have.lengthOf(1);
-            // check that the published protocol is returned
-            expect(protocolQueryReply[0].descriptor).to.deep.equal(protocolConfigurePublished.message.descriptor);
-        });
-    });
-    describe('/:did/read/protocols/:protocol/*', function () {
-        it('returns record for a given protocol and protocolPath that is published', async function () {
-            // Create and publish a protocol
-            const protocolConfigure = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol',
-                    published: true,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: protocolConfigure.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(response.status).to.equal(200);
-            // Create a foo record
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-                published: true,
-                protocol: protocolConfigure.message.descriptor.definition.protocol,
-                protocolPath: 'foo',
-            });
-            const recordsWriteRequestId = uuidv4();
-            const recordsWriteDwnRequest = createJsonRpcRequest(recordsWriteRequestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            const recordsWriteResponse = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(recordsWriteDwnRequest),
-                },
-                body: stream,
-            });
-            expect(recordsWriteResponse.status).to.equal(200);
-            const responseJson = await recordsWriteResponse.json();
-            expect(responseJson.result.reply.status.code).to.equal(202);
-            // Fetch the record using the HTTP API
-            const base64urlEncodedProtocol = Convert.string(protocolConfigure.message.descriptor.definition.protocol).toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}/foo`;
-            const recordReadResponse = await fetch(protocolUrl);
-            expect(recordReadResponse.status).to.equal(200);
-            // get the data response
-            const blob = await recordReadResponse.blob();
-            expect(blob.size).to.equal(size);
-            // get dwn message response
-            const { status, entry } = getDwnResponse(recordReadResponse);
-            expect(status.code).to.equal(200);
-            expect(entry).to.exist;
-            expect(entry.recordsWrite.recordId).to.equal(recordsWrite.message.recordId);
-        });
-        it('removes the trailing slash from the protocol path', async function () {
-            const recordsQueryCreateSpy = sinon.spy(RecordsQuery, 'create');
-            const base64urlEncodedProtocol = Convert.string('http://example.com/protocol').toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}/foo/`; // trailing slash
-            const recordReadResponse = await fetch(protocolUrl);
-            expect(recordReadResponse.status).to.equal(404);
-            expect(recordsQueryCreateSpy.calledOnce).to.be.true;
-            const recordsQueryFilter = recordsQueryCreateSpy.getCall(0).args[0].filter;
-            expect(recordsQueryFilter.protocolPath).to.equal('foo');
-        });
-        it('returns a 404 if record for a given protocol and protocolPath is not published', async function () {
-            // Create and publish a protocol
-            const protocolConfigure = await ProtocolsConfigure.create({
-                definition: {
-                    protocol: 'http://example.com/protocol',
-                    published: true,
-                    types: {
-                        foo: {},
-                    },
-                    structure: {
-                        foo: {}
-                    }
-                },
-                signer: alice.signer,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: protocolConfigure.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-            });
-            expect(response.status).to.equal(200);
-            // Create a foo record
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-                published: false, // not published
-                protocol: protocolConfigure.message.descriptor.definition.protocol,
-                protocolPath: 'foo',
-            });
-            const recordsWriteRequestId = uuidv4();
-            const recordsWriteDwnRequest = createJsonRpcRequest(recordsWriteRequestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            const recordsWriteResponse = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(recordsWriteDwnRequest),
-                },
-                body: stream,
-            });
-            expect(recordsWriteResponse.status).to.equal(200);
-            const responseJson = await recordsWriteResponse.json();
-            expect(responseJson.result.reply.status.code).to.equal(202);
-            // Fetch the record using the HTTP API
-            const base64urlEncodedProtocol = Convert.string(protocolConfigure.message.descriptor.definition.protocol).toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}/foo`;
-            const recordReadResponse = await fetch(protocolUrl);
-            expect(recordReadResponse.status).to.equal(404);
-        });
-        it('returns a 400 if protocol path is not provided', async function () {
-            // Fetch a protocol record without providing a protocol path
-            const base64urlEncodedProtocol = Convert.string('http://example.com/protocol').toBase64Url();
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/${base64urlEncodedProtocol}/`; // missing protocol path
-            const recordReadResponse = await fetch(protocolUrl);
-            expect(recordReadResponse.status).to.equal(400);
-            expect(await recordReadResponse.text()).to.equal('protocol path is required');
-        });
-        it('returns a 400 error if protocol cannot be base64url encoded', async function () {
-            const protocolUrl = `${baseUrl}/${alice.did}/read/protocols/invalid-protocol/foo`;
-            const recordReadResponse = await fetch(protocolUrl);
-            expect(recordReadResponse.status).to.equal(400);
-            expect(await recordReadResponse.text()).to.equal('Bad Request');
-        });
-    });
-    describe('/:did/query', function () {
-        it('returns record data if record is published', async function () {
-            const filePath = './fixtures/test.jpeg';
-            const { cid: expectedCid, size, stream, } = await getFileAsReadStream(filePath);
-            const { recordsWrite } = await createRecordsWriteMessage(alice, {
-                dataCid: expectedCid,
-                dataSize: size,
-                published: true,
-            });
-            const requestId = uuidv4();
-            const dwnRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-                message: recordsWrite.toJSON(),
-                target: alice.did,
-            });
-            const response = await fetch(baseUrl, {
-                method: 'POST',
-                headers: {
-                    'dwn-request': JSON.stringify(dwnRequest),
-                },
-                body: stream,
-            });
-            expect(response.status).to.equal(200);
-            const body = (await response.json());
-            expect(body.id).to.equal(requestId);
-            expect(body.error).to.not.exist;
-            const { reply } = body.result;
-            expect(reply.status.code).to.equal(202);
-            const { entries } = await fetch(`${baseUrl}/${alice.did}/query?filter.recordId=${recordsWrite.message.recordId}&other.random.param=unused-value`).then(response => response.json());
-            expect(entries?.length).to.equal(1);
-        });
-        it('should return 400 if user provide invalid query', async function () {
-            const response = await fetch(`${baseUrl}/${alice.did}/query?filter=invalid-filter`);
-            expect(response.status).to.equal(400);
-            const responseBody = await response.json();
-            expect(responseBody.code).to.equal(DwnErrorCode.SchemaValidatorAdditionalPropertyNotAllowed);
-        });
-    });
-    describe('/info', function () {
-        it('verify /info has some of the fields it is supposed to have', async function () {
-            const resp = await fetch(`${baseUrl}/info`);
-            expect(resp.status).to.equal(200);
-            const info = await resp.json();
-            expect(info['url']).to.equal('http://localhost:3000');
-            expect(info['server']).to.equal('@enbox/dwn-server');
-            expect(info['registrationRequirements']).to.include('terms-of-service');
-            expect(info['registrationRequirements']).to.include('proof-of-work-sha256-v0');
-        });
-        it('verify /info signals websocket support', async function () {
-            let resp = await fetch(`${baseUrl}/info`);
-            expect(resp.status).to.equal(200);
-            let info = await resp.json();
-            expect(info['server']).to.equal('@enbox/dwn-server');
-            expect(info['webSocketSupport']).to.equal(true);
-            // start server without websocket support enabled
-            await httpApi.close();
-            config.webSocketSupport = false;
-            httpApi = await HttpApi.create(config, dwn, registrationManager);
-            await httpApi.start(0);
-            baseUrl = `http://localhost:${httpApi.server.port}`;
-            resp = await fetch(`${baseUrl}/info`);
-            expect(resp.status).to.equal(200);
-            info = await resp.json();
-            expect(info['server']).to.equal('@enbox/dwn-server');
-            expect(info['webSocketSupport']).to.equal(false);
-            // restore old config value
-            config.webSocketSupport = true;
-        });
-        it('verify /info still returns when package.json file does not exist', async function () {
-            await httpApi.close();
-            // set up spy to check for an info log by the server
-            const logSpy = sinon.spy(log, 'info');
-            // set the config to an invalid file path
-            const packageJsonConfig = config.packageJsonPath;
-            config.packageJsonPath = '/some/invalid/file.json';
-            httpApi = await HttpApi.create(config, dwn, registrationManager);
-            await httpApi.start(0);
-            baseUrl = `http://localhost:${httpApi.server.port}`;
-            const resp = await fetch(`${baseUrl}/info`);
-            const info = await resp.json();
-            expect(resp.status).to.equal(200);
-            // check that server name exists in the info object
-            expect(info['server']).to.equal('@enbox/dwn-server');
-            // check that `sdkVersion` and `version` are undefined as they were not abel to be retrieved from the invalid file.
-            expect(info['sdkVersion']).to.be.undefined;
-            expect(info['version']).to.be.undefined;
-            // check the logSpy was called
-            expect(logSpy.callCount).to.be.gt(0);
-            expect(logSpy.calledWith(sinon.match('could not read `package.json` for version info'))).to.be.true;
-            // restore old config path
-            config.packageJsonPath = packageJsonConfig;
-        });
-        it('verify /info returns server name from config', async function () {
-            await httpApi.close();
-            // set a custom name for the `serverName`
-            const serverName = config.serverName;
-            config.serverName = '@enbox/dwn-server-2';
-            httpApi = await HttpApi.create(config, dwn, registrationManager);
-            await httpApi.start(0);
-            baseUrl = `http://localhost:${httpApi.server.port}`;
-            const resp = await fetch(`${baseUrl}/info`);
-            const info = await resp.json();
-            expect(resp.status).to.equal(200);
-            // verify that the custom server name was passed to the info endpoint
-            expect(info['server']).to.equal('@enbox/dwn-server-2');
-            // verify that `sdkVersion` and `version` exist.
-            expect(info['sdkVersion']).to.not.be.undefined;
-            expect(info['version']).to.not.be.undefined;
-            // restore server name config
-            config.serverName = serverName;
-        });
-    });
-});
-//# sourceMappingURL=http-api.spec.js.map