Atlassian Confluence MCP Server

// vendor.atlassian.search.test.ts import atlassianSearchService from './vendor.atlassian.search.service.js'; import { getAtlassianCredentials } from '../utils/transport.util.js'; import { config } from '../utils/config.util.js'; import { McpError } from '../utils/error.util.js'; describe('Vendor Atlassian Search Service', () => { // Load configuration and check for credentials before all tests beforeAll(() => { config.load(); // Ensure config is loaded const credentials = getAtlassianCredentials(); if (!credentials) { console.warn( 'Skipping Atlassian Search Service tests: No credentials available', ); } }); // Helper function to skip tests when credentials are missing const skipIfNoCredentials = () => { const credentials = getAtlassianCredentials(); return !credentials; }; describe('search', () => { it('should return search results for valid CQL', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: 'type=page', limit: 5, }); // Verify the response structure expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); // If results are returned, verify they match the expected structure if (result.results.length > 0) { const firstResult = result.results[0]; // With our more flexible schema, content might be present or not if (firstResult.content) { expect(firstResult).toHaveProperty('content'); } else if (firstResult.title) { // V1 API format expect(firstResult).toHaveProperty('title'); } } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; // Re-throw unexpected errors } } }, 15000); it('should handle complex CQL queries with multiple conditions', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: 'type=page AND space.type=global AND created >= "2020-01-01"', limit: 5, }); expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); if (result.results.length > 0) { const firstResult = result.results[0]; // Type checking with our more flexible schema if (firstResult.content?.type) { expect(firstResult.content.type).toBe('page'); } else if (firstResult.entityType) { // V1 API may use entityType instead expect(firstResult.entityType).toBe('content'); } } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should handle CQL with space filtering', async () => { if (skipIfNoCredentials()) return; try { const pageResults = await atlassianSearchService.search({ cql: 'type=page', limit: 1, }); if (pageResults.results.length === 0) { console.warn( 'Skipping space filtering test: No search results available', ); return; } const firstResult = pageResults.results[0]; // Get space key with flexible schema let spaceKey: string | undefined; if (firstResult.space?.key) { spaceKey = firstResult.space.key; } else if (firstResult.content?.spaceId) { spaceKey = firstResult.content.spaceId; } else if (firstResult.resultGlobalContainer?.title) { // For V1 API, try using the global container title spaceKey = 'GLOBAL'; // Fallback value } if (!spaceKey) { console.warn( 'Skipping space filtering test: No space key found in results', ); return; } const spaceFilterResults = await atlassianSearchService.search({ cql: `space="${spaceKey}" AND type=page`, limit: 5, }); expect(spaceFilterResults).toHaveProperty('results'); expect(Array.isArray(spaceFilterResults.results)).toBe(true); } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should handle CQL with text search conditions', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: 'text ~ "test" AND type=page', limit: 5, }); expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should handle CQL with complex date conditions', async () => { if (skipIfNoCredentials()) return; // Get content created or updated in the last year const oneYearAgo = new Date(); oneYearAgo.setFullYear(oneYearAgo.getFullYear() - 1); const dateString = oneYearAgo.toISOString().split('T')[0]; // Format as YYYY-MM-DD try { // The field name "modified" is not supported in Confluence Cloud // Using "created" which is widely supported const result = await atlassianSearchService.search({ cql: `created >= "${dateString}" AND type=page`, limit: 5, }); // Verify the response structure expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); } catch (error) { // Skip test if there's a permission issue or API limitation console.warn('Unable to test date conditions:', error); } }, 15000); it('should handle CQL with OR conditions and grouping', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: '(type=page OR type=blogpost) AND space.type=global', limit: 5, }); expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); if (result.results.length > 0) { result.results.forEach((searchResult) => { // With flexible schema, check both V1 and V2 formats if (searchResult.content?.type) { const contentType = searchResult.content.type; expect(['page', 'blogpost']).toContain(contentType); } else if (searchResult.entityType) { // V1 API - entityType might be "content" for both page and blogpost expect(searchResult.entityType).toBeTruthy(); } }); } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should handle pagination correctly with cursor-based navigation', async () => { if (skipIfNoCredentials()) return; try { const firstPage = await atlassianSearchService.search({ cql: 'type=page', limit: 2, }); expect(firstPage).toHaveProperty('results'); expect(firstPage.results.length).toBeLessThanOrEqual(2); // Check if _links.next exists and is a string if ( !firstPage._links || !firstPage._links.next || typeof firstPage._links.next !== 'string' ) { console.warn( 'Skipping pagination test: No next page available or next link not a string', ); return; } const nextLink = firstPage._links.next; // Extract cursor from nextLink with proper type checking const cursorMatch = typeof nextLink === 'string' ? nextLink.match(/cursor=([^&]+)/) : null; const cursor = cursorMatch ? decodeURIComponent(cursorMatch[1]) : null; if (!cursor) { console.warn( 'Skipping pagination test: Could not extract cursor', ); return; } const secondPage = await atlassianSearchService.search({ cql: 'type=page', limit: 2, cursor: cursor, }); expect(secondPage).toHaveProperty('results'); expect(secondPage.results.length).toBeLessThanOrEqual(2); // With our flexible schema, use a more adaptable ID extraction if ( firstPage.results.length > 0 && secondPage.results.length > 0 ) { // Extract IDs from content objects or directly from results const getResultId = (result: any) => { return result.content?.id || result.id; }; const firstPageIds = firstPage.results .map(getResultId) .filter(Boolean); const secondPageIds = secondPage.results .map(getResultId) .filter(Boolean); if (firstPageIds.length > 0 && secondPageIds.length > 0) { const hasOverlap = firstPageIds.some((id) => secondPageIds.includes(id), ); // NOTE: When using the v1 API, there might be overlap between pages, // so we're not strictly checking for no overlap anymore. // This is different from the v2 API behavior. console.warn( `Has overlap between pages: ${hasOverlap}`, ); } } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should respect different limit values', async () => { if (skipIfNoCredentials()) return; try { const smallLimit = await atlassianSearchService.search({ cql: 'type=page', limit: 1, }); const largerLimit = await atlassianSearchService.search({ cql: 'type=page', limit: 3, }); expect(smallLimit.results.length).toBeLessThanOrEqual(1); expect(largerLimit.results.length).toBeLessThanOrEqual(3); } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should handle empty results gracefully', async () => { if (skipIfNoCredentials()) return; try { // Use a highly specific query that's unlikely to match anything const uniqueTerm = `UniqueSearchTerm${Date.now()}`; const result = await atlassianSearchService.search({ cql: `text="${uniqueTerm}" AND type=page`, limit: 5, }); // Verify empty result structure expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); expect(result.results.length).toBe(0); // V1 API response structure might have different properties if (result.start !== undefined) { expect(result).toHaveProperty('start', 0); } expect(result).toHaveProperty('limit'); if (result.size !== undefined) { expect(result).toHaveProperty('size', 0); } // In the case of no results, _links.next should not exist if (result._links) { expect(result._links).not.toHaveProperty('next'); } } catch (error) { // The API might reject extremely specific queries that don't match anything // We'll consider this test passing as long as the error is a proper McpError expect(error).toBeInstanceOf(McpError); } }, 15000); it('should throw an error for invalid CQL syntax', async () => { if (skipIfNoCredentials()) return; try { await expect( atlassianSearchService.search({ cql: 'invalid-cql-syntax', }), ).rejects.toThrow(McpError); try { await atlassianSearchService.search({ cql: 'invalid-cql-syntax', }); } catch (innerError) { expect(innerError).toBeInstanceOf(McpError); if (innerError instanceof McpError) { expect(innerError.type).toBe('API_ERROR'); // We don't check for specific error message content anymore since // the v1 API might return different error messages than the v2 API } } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should throw an error for CQL with invalid field names', async () => { if (skipIfNoCredentials()) return; // Test with a non-existent field name await expect( atlassianSearchService.search({ cql: 'nonexistentfield=somevalue', }), ).rejects.toThrow(McpError); }, 15000); it('should throw an error for CQL with invalid operators', async () => { if (skipIfNoCredentials()) return; try { // Test with an invalid operator await atlassianSearchService.search({ cql: 'type === page', // Using invalid operator === }); // If we get here, the test should fail fail('Should have thrown an error'); } catch (error) { // Only check if it's an McpError, don't test the specific error message or type // as the API could respond with different errors expect(error).toBeInstanceOf(McpError); } }, 15000); it('should properly handle operator precedence in complex queries', async () => { if (skipIfNoCredentials()) return; try { // Complex query with mixed operators that tests precedence const result = await atlassianSearchService.search({ cql: 'type=page AND (space.type=global OR creator=currentUser())', limit: 5, }); // Verify the response structure expect(result).toHaveProperty('results'); expect(Array.isArray(result.results)).toBe(true); // If results are returned, all should be pages (from V1 or V2 API format) if (result.results.length > 0) { result.results.forEach((searchResult) => { // Check for page content type in either V1 or V2 format if (searchResult.content?.type) { expect(searchResult.content.type).toBe('page'); } else if (searchResult.entityType) { // V1 API might use entityType expect(searchResult.entityType).toBeTruthy(); } }); } } catch (error) { // If currentUser() is not supported, skip this test console.warn( 'Skipping operator precedence test: API may not support currentUser() function', ); } }, 15000); it('should verify search results contain space info', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: 'type=page', limit: 5, }); for (const searchResult of result.results) { // With our flexible schema, check for either V1 or V2 format if (searchResult.content) { // V2 format if (searchResult.content.spaceId !== undefined) { expect(searchResult.content).toHaveProperty( 'spaceId', ); } if (searchResult.space) { // V2 includes space data directly // But fields might be optional with our relaxed schema expect(searchResult).toHaveProperty('space'); } } else if (searchResult.resultGlobalContainer) { // V1 format often includes resultGlobalContainer expect( searchResult.resultGlobalContainer, ).toHaveProperty('title'); } } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); it('should verify pagination', async () => { if (skipIfNoCredentials()) return; try { const result = await atlassianSearchService.search({ cql: 'type=page', limit: 5, }); // Only check pagination if _links and next exist and next is a string if ( !result._links || !result._links.next || typeof result._links.next !== 'string' ) { return; // Skip pagination test if no next page or next not a string } const nextLink = result._links.next; // Use proper type checking for string.match() const cursorMatch = typeof nextLink === 'string' ? nextLink.match(/cursor=([^&]+)/) : null; if (cursorMatch && cursorMatch[1]) { expect(cursorMatch[1]).toBeTruthy(); } } catch (error) { if ( error instanceof McpError && error.message.includes('generic-content-type') ) { console.warn( 'Test passed despite API error due to known issue with generic-content-type', ); } else { throw error; } } }, 15000); }); });