[Obs AI Assistant] Prefer observabilityAIAssistantAPIClient over supertest

[sorenlouv]

For api and e2e tests we should use observabilityAIAssistantAPIClient when calling any of the Obs AI Assistants endpoints (internal and public). supertest should only be used for calling apis for the platform and other plugins.

observabilityAIAssistantAPIClient is type safety so errors caused by invalid urls/params will be surfaces at compile time. With supertest these errors are not visible before running the test.

Places where supertest is used for calling own endpoints:

kibana/x-pack/test/observability_ai_assistant_api_integration/tests/chat/chat.spec.ts

Lines 56 to 65 in 4eb9006

	await supertest
	.post(CHAT_API_URL)
	.set('kbn-xsrf', 'foo')
	.send({
	name: 'my_api_call',
	messages,
	connectorId: 'does not exist',
	functions: [],
	scopes: ['all'],
	})

kibana/x-pack/test/observability_ai_assistant_api_integration/tests/complete/complete.spec.ts

Lines 80 to 89 in 4eb9006

	supertest
	.post(COMPLETE_API_URL)
	.set('kbn-xsrf', 'foo')
	.send({
	messages,
	connectorId,
	persist: true,
	screenContexts: params.screenContexts || [],
	scopes: ['all'],
	})

kibana/x-pack/test_serverless/api_integration/test_suites/observability/ai_assistant/tests/chat/chat.spec.ts

Lines 92 to 100 in 4eb9006

	await supertestEditorWithCookieCredentials
	.post(CHAT_API_URL)
	.send({
	name: 'my_api_call',
	messages,
	connectorId: 'does not exist',
	functions: [],
	scopes: ['all'],
	})

kibana/x-pack/test_serverless/api_integration/test_suites/observability/ai_assistant/tests/complete/complete.spec.ts

Lines 89 to 97 in 4eb9006

	supertestEditorWithCookieCredentials
	.post(COMPLETE_API_URL)
	.send({
	messages,
	connectorId,
	persist: true,
	screenContexts: params.screenContexts || [],
	scopes: ['all'],
	})

[elasticmachine]

Pinging @elastic/obs-ai-assistant (Team:Obs AI Assistant)

[dgieselaar]

fwiw, I'm abstracting this in https://github.com/elastic/kibana/pull/204309/files#diff-cb59199a241f60514e9ba52c57b587929f6be6bcedb24c5a138d5ba72184fe85

[sorenlouv]

fwiw, I'm abstracting this in https://github.com/elastic/kibana/pull/204309/files#diff-cb59199a241f60514e9ba52c57b587929f6be6bcedb24c5a138d5ba72184fe85

Nice! Meaning we can get rid of these api clients:

• https://github.com/elastic/kibana/blob/main/x-pack/test/observability_ai_assistant_api_integration/common/observability_ai_assistant_api_client.ts
• https://github.com/elastic/kibana/blob/main/x-pack/test_serverless/api_integration/test_suites/observability/ai_assistant/common/observability_ai_assistant_api_client.ts

We'd still need to migrate the above-mentioned occurrences from supertest.