Skip to content

Fix Empty post capabilities array #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DanielleMaor wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix Empty post capabilities array #163

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24e0d01
Empty post capabilities array
DanielleMaor Jul 7, 2025
f693f41
use skipIf condition
DanielleMaor Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 53 additions & 50 deletions v2/api-validator/tests/server-tests/bad-request-body.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,58 +21,61 @@ describe('Test request bodies missing one required property', () => {

let accountId: string;

describe.each(postEndpoints)('$method $url', ({ operationId, url, schema }: EndpointSchema) => {
const [component] = schema.tags;
accountId = getCapableAccountId(component as keyof ApiComponents);

// Test multiple times due to the randomness of the generated payloads
describe.each([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])('Attempt %d', () => {
const goodBody = JSONSchemaFaker.generate(schema.body as Schema);
if (!goodBody || typeof goodBody !== 'object') throw new Error('Unexpected body type');

const sendRequest = async (requestBody: JsonValue) => {
const operationFunction = client[schema.tags[0]]?.[operationId].bind(client);

try {
await operationFunction({ requestBody, accountId });
} catch (err) {
if (err instanceof ApiError) {
return err;
}
throw err;
}
throw new Error('Expected to throw');
};

for (const propertyPath of getPropertyPaths(goodBody)) {
describe(`Body without ${propertyPath.join('.')}`, () => {
let apiError: ApiError;

beforeAll(async () => {
const badBody = _.cloneDeep(goodBody);
deleteDeepProperty(badBody, propertyPath);

if (Object.hasOwn(badBody, 'idempotencyKey')) {
badBody['idempotencyKey'] = randomUUID();
describe.skipIf(postEndpoints.length === 0).each(postEndpoints)(
'$method $url',
({ operationId, url, schema }: EndpointSchema) => {
const [component] = schema.tags;
accountId = getCapableAccountId(component as keyof ApiComponents);

// Test multiple times due to the randomness of the generated payloads
describe.each([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])('Attempt %d', () => {
const goodBody = JSONSchemaFaker.generate(schema.body as Schema);
if (!goodBody || typeof goodBody !== 'object') throw new Error('Unexpected body type');

const sendRequest = async (requestBody: JsonValue) => {
const operationFunction = client[schema.tags[0]]?.[operationId].bind(client);

try {
await operationFunction({ requestBody, accountId });
} catch (err) {
if (err instanceof ApiError) {
return err;
}

apiError = await sendRequest(badBody);
});

it('should respond with HTTP response code 400 (Bad Request)', () => {
expect(apiError.status).toEqual(400);
});
it('should properly describe the error in the response body', () => {
expect(apiError.body.requestPart).toEqual(RequestPart.BODY);
expect(getExpectedVariants(url, propertyPath)).toContain(apiError.body.propertyName);
expect(apiError.body.errorType).toEqual(
BadRequestError.errorType.SCHEMA_PROPERTY_ERROR
);
throw err;
}
throw new Error('Expected to throw');
};

for (const propertyPath of getPropertyPaths(goodBody)) {
describe(`Body without ${propertyPath.join('.')}`, () => {
let apiError: ApiError;

beforeAll(async () => {
const badBody = _.cloneDeep(goodBody);
deleteDeepProperty(badBody, propertyPath);

if (Object.hasOwn(badBody, 'idempotencyKey')) {
badBody['idempotencyKey'] = randomUUID();
}

apiError = await sendRequest(badBody);
});

it('should respond with HTTP response code 400 (Bad Request)', () => {
expect(apiError.status).toEqual(400);
});
it('should properly describe the error in the response body', () => {
expect(apiError.body.requestPart).toEqual(RequestPart.BODY);
expect(getExpectedVariants(url, propertyPath)).toContain(apiError.body.propertyName);
expect(apiError.body.errorType).toEqual(
BadRequestError.errorType.SCHEMA_PROPERTY_ERROR
);
});
});
});
}
});
});
}
});
}
);
});

// When missing a properties appearing in oneOf, the server might report as if
Expand Down