feat(core): Add endpoint to create free AI credits (#12362)

packages/cli/test/integration/ai/ai.api.test.ts

@@ -0,0 +1,99 @@
+import { randomUUID } from 'crypto';
+import { mock } from 'jest-mock-extended';
+import { Container } from 'typedi';
+
+import { FREE_AI_CREDITS_CREDENTIAL_NAME, OPEN_AI_API_CREDENTIAL_TYPE } from '@/constants';
+import type { Project } from '@/databases/entities/project';
+import type { User } from '@/databases/entities/user';
+import { CredentialsRepository } from '@/databases/repositories/credentials.repository';
+import { ProjectRepository } from '@/databases/repositories/project.repository';
+import { SharedCredentialsRepository } from '@/databases/repositories/shared-credentials.repository';
+import { UserRepository } from '@/databases/repositories/user.repository';
+import { AiService } from '@/services/ai.service';
+
+import { createOwner } from '../shared/db/users';
+import * as testDb from '../shared/test-db';
+import type { SuperAgentTest } from '../shared/types';
+import { setupTestServer } from '../shared/utils';
+
+const createAiCreditsResponse = {
+	apiKey: randomUUID(),
+	url: 'https://api.openai.com',
+};
+
+Container.set(
+	AiService,
+	mock<AiService>({
+		createFreeAiCredits: async () => createAiCreditsResponse,
+	}),
+);
+
+const testServer = setupTestServer({ endpointGroups: ['ai'] });
+
+let owner: User;
+let ownerPersonalProject: Project;
+
+let authOwnerAgent: SuperAgentTest;
+
+beforeEach(async () => {
+	await testDb.truncate(['SharedCredentials', 'Credentials']);
+
+	owner = await createOwner();
+
+	ownerPersonalProject = await Container.get(ProjectRepository).getPersonalProjectForUserOrFail(
+		owner.id,
+	);
+
+	authOwnerAgent = testServer.authAgentFor(owner);
+});
+
+describe('POST /ai/free-credits', () => {
+	test('should create OpenAI managed credential', async () => {
+		// Act
+		const response = await authOwnerAgent.post('/ai/free-credits').send({
+			projectId: ownerPersonalProject.id,
+		});
+
+		// Assert
+
+		expect(response.statusCode).toBe(200);
+
+		const { id, name, type, data: encryptedData, scopes } = response.body.data;
+
+		expect(name).toBe(FREE_AI_CREDITS_CREDENTIAL_NAME);
+		expect(type).toBe(OPEN_AI_API_CREDENTIAL_TYPE);
+		expect(encryptedData).not.toBe(createAiCreditsResponse);
+
+		expect(scopes).toEqual(
+			[
+				'credential:create',
+				'credential:delete',
+				'credential:list',
+				'credential:move',
+				'credential:read',
+				'credential:share',
+				'credential:update',
+			].sort(),
+		);
+
+		const credential = await Container.get(CredentialsRepository).findOneByOrFail({ id });
+
+		expect(credential.name).toBe(FREE_AI_CREDITS_CREDENTIAL_NAME);
+		expect(credential.type).toBe(OPEN_AI_API_CREDENTIAL_TYPE);
+		expect(credential.data).not.toBe(createAiCreditsResponse);
+		expect(credential.isManaged).toBe(true);
+
+		const sharedCredential = await Container.get(SharedCredentialsRepository).findOneOrFail({
+			relations: { project: true, credentials: true },
+			where: { credentialsId: credential.id },
+		});
+
+		expect(sharedCredential.project.id).toBe(ownerPersonalProject.id);
+		expect(sharedCredential.credentials.name).toBe(FREE_AI_CREDITS_CREDENTIAL_NAME);
+		expect(sharedCredential.credentials.isManaged).toBe(true);
+
+		const user = await Container.get(UserRepository).findOneOrFail({ where: { id: owner.id } });
+
+		expect(user.settings?.userClaimedAiCredits).toBe(true);
+	});
+});