⭐️⭐️⭐️ Open-source, self-hosted alternative to Linear and Plane. Project management and issue tracking where teams and AI agents work side by side to plan and ship products.
TypeScript agenticagileai-agentsbug-reportingbug-trackerganttissue-trackerjirajira-alternativekanbanlinearlinear-alternativeopen-sourceproduct-managementproject-managementroadmapself-hostedsprint-planningteam-collaborationtrello-alternative
import { describe, expect, it } from 'bun:test';
import pkg from '../../../../../package.json';
import { app } from '../helpers/app';
type Operation = {
description?: string;
security?: Array<Record<string, string[]>>;
tags?: string[];
requestBody?: { content?: Record<string, unknown> };
responses?: Record<string, { content?: Record<string, unknown> }>;
};
type Document = {
info: { version: string; description?: string };
servers?: Array<{ url: string }>;
paths: Record<string, Record<string, Operation>>;
};
async function document(): Promise<Document> {
const response = await app.handle(new Request('http://localhost/docs/json'));
expect(response.status).toBe(200);
return (await response.json()) as Document;
}
describe('OpenAPI document', () => {
it('uses the configured public origin and current product version', async () => {
const doc = await document();
expect(doc.servers?.[0]?.url).toBe(process.env.API_URL);
expect(doc.info.version).toBe(pkg.version);
expect(doc.info.description).toContain('/account/api-keys');
expect(doc.info.description).toContain('/mcp');
});
it('documents each authentication surface accurately', async () => {
const doc = await document();
expect(doc.paths['/projects']!.get!.security).toBeUndefined();
expect(doc.paths['/']!.get!.security).toEqual([]);
expect(doc.paths['/me']!.get!.security).toEqual([{}, { apiKey: [] }]);
expect(doc.paths['/share/issue/{token}']!.get!.security).toEqual([]);
expect(doc.paths['/scim/v2/Users']!.post!.security).toEqual([{ scimBearer: [] }]);
expect(doc.paths['/webhooks/git/{webhookId}']!.post!.security).toContainEqual({
gitLabToken: [],
});
});
it('documents only the media types each surface accepts', async () => {
const doc = await document();
const genericMediaTypes = ['application/json', 'multipart/form-data', 'text/plain'];
expect(Object.keys(doc.paths['/teams/{teamId}/projects']!.post!.requestBody!.content!)).toEqual(
['application/json'],
);
expect(
Object.keys(doc.paths['/issues/{issueId}/attachments']!.post!.requestBody!.content!),
).toEqual(['multipart/form-data']);
expect(
Object.keys(doc.paths['/webhooks/git/{webhookId}']!.post!.requestBody!.content!),
).toEqual(['application/json']);
expect(Object.keys(doc.paths['/scim/v2/Users']!.post!.requestBody!.content!)).toEqual([
'application/scim+json',
]);
expect(Object.keys(doc.paths['/scim/v2/Users']!.post!.responses!['201']!.content!)).toEqual([
'application/scim+json',
]);
for (const path of Object.values(doc.paths)) {
for (const operation of Object.values(path)) {
if (!operation || typeof operation !== 'object' || !('responses' in operation)) continue;
const requestTypes = Object.keys(operation.requestBody?.content ?? {}).filter((mediaType) =>
genericMediaTypes.includes(mediaType),
);
expect(requestTypes.length).toBeLessThanOrEqual(1);
for (const response of Object.values(operation.responses ?? {})) {
const responseTypes = Object.keys(response.content ?? {}).filter((mediaType) =>
genericMediaTypes.includes(mediaType),
);
expect(responseTypes.length).toBeLessThanOrEqual(1);
}
}
}
});
it('groups SCIM and gives every operation a description', async () => {
const doc = await document();
const operations = Object.values(doc.paths).flatMap((path) =>
Object.values(path).filter((operation): operation is Operation =>
Boolean(operation && typeof operation === 'object' && 'responses' in operation),
),
);
expect(doc.paths['/scim/v2/Users']!.post!.tags).toEqual(['SCIM']);
expect(operations.length).toBeGreaterThan(300);
expect(operations.every((operation) => Boolean(operation.description))).toBe(true);
});
});
describe('API CORS', () => {
it('allows personal API keys from the web app', async () => {
const origin = process.env.APP_URL?.split(',')[0]?.trim();
if (!origin) throw new Error('APP_URL is required for the CORS test');
const response = await app.handle(
new Request('http://localhost/projects', {
method: 'OPTIONS',
headers: {
origin,
'access-control-request-method': 'GET',
'access-control-request-headers': 'x-api-key',
},
}),
);
expect(response.status).toBe(204);
const allowed = response.headers.get('access-control-allow-headers')?.toLowerCase();
expect(allowed).toContain('x-api-key');
});
});