Skip to content

Commit b66d36a

Browse files
Udit-takkarjoeauyeung
Udit-takkar
and
joeauyeung
authored
feat: generate transcription from recording and API endpoint (#15358)
* feat: generate transcription from recording * fix: api * chore: undo * tests: add unit tests * chore: refactor move zod type * fix: add more security check * chore: update test * chore: type err * chore: test * chore: fix tyoe * fix: build err * chore: add try .. catch * chore: update desc --------- Co-authored-by: Joe Au-Yeung <65426560+joeauyeung@users.noreply.github.com>
1 parent 68ce952 commit b66d36a

File tree

9 files changed

+451
-2
lines changed

9 files changed

+451
-2
lines changed

‎apps/api/v1/lib/validations/shared/queryIdTransformParseInt.ts

+4
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,7 @@ export const withValidQueryIdTransformParseInt = withValidation({
1414
type: "Zod",
1515
mode: "query",
1616
});
17+
18+
export const getTranscriptFromRecordingId = schemaQueryIdParseInt.extend({
19+
recordingId: z.string(),
20+
});

‎apps/api/v1/pages/api/bookings/[id]/transcripts/[recordingId]/_get.ts

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import type { NextApiRequest } from "next";
2+
3+
import {
4+
getTranscriptsAccessLinkFromRecordingId,
5+
checkIfRoomNameMatchesInRecording,
6+
} from "@calcom/core/videoClient";
7+
import { HttpError } from "@calcom/lib/http-error";
8+
import { defaultResponder } from "@calcom/lib/server";
9+
import prisma from "@calcom/prisma";
10+
import type { PartialReference } from "@calcom/types/EventManager";
11+
12+
import { getTranscriptFromRecordingId } from "~/lib/validations/shared/queryIdTransformParseInt";
13+
14+
/**
15+
* @swagger
16+
* /bookings/{id}/transcripts/{recordingId}:
17+
* get:
18+
* summary: Find all Cal video transcripts of that recording
19+
* operationId: getTranscriptsByRecordingId
20+
* parameters:
21+
* - in: path
22+
* name: id
23+
* schema:
24+
* type: integer
25+
* required: true
26+
* description: ID of the booking for which transcripts need to be fetched.
27+
* - in: path
28+
* name: recordingId
29+
* schema:
30+
* type: string
31+
* required: true
32+
* description: ID of the recording(daily.co recording id) for which transcripts need to be fetched.
33+
* - in: query
34+
* name: apiKey
35+
* required: true
36+
* schema:
37+
* type: string
38+
* description: Your API key
39+
* tags:
40+
* - bookings
41+
* responses:
42+
* 200:
43+
* description: OK
44+
* content:
45+
* application/json:
46+
* 401:
47+
* description: Authorization information is missing or invalid.
48+
* 404:
49+
* description: Booking was not found
50+
*/
51+
52+
export async function getHandler(req: NextApiRequest) {
53+
const { query } = req;
54+
const { id, recordingId } = getTranscriptFromRecordingId.parse(query);
55+
56+
await checkIfRecordingBelongsToBooking(id, recordingId);
57+
58+
const transcriptsAccessLinks = await getTranscriptsAccessLinkFromRecordingId(recordingId);
59+
60+
return transcriptsAccessLinks;
61+
}
62+
63+
const checkIfRecordingBelongsToBooking = async (bookingId: number, recordingId: string) => {
64+
const booking = await prisma.booking.findUnique({
65+
where: { id: bookingId },
66+
include: { references: true },
67+
});
68+
69+
if (!booking)
70+
throw new HttpError({
71+
statusCode: 404,
72+
message: `No Booking found with booking id ${bookingId}`,
73+
});
74+
75+
const roomName =
76+
booking?.references?.find((reference: PartialReference) => reference.type === "daily_video")?.meetingId ??
77+
undefined;
78+
79+
if (!roomName)
80+
throw new HttpError({
81+
statusCode: 404,
82+
message: `No Booking Reference with Daily Video found with booking id ${bookingId}`,
83+
});
84+
85+
const canUserAccessRecordingId = await checkIfRoomNameMatchesInRecording(roomName, recordingId);
86+
if (!canUserAccessRecordingId) {
87+
throw new HttpError({
88+
statusCode: 403,
89+
message: `This Recording Id ${recordingId} does not belong to booking ${bookingId}`,
90+
});
91+
}
92+
};
93+
94+
export default defaultResponder(getHandler);

‎apps/api/v1/pages/api/bookings/[id]/transcripts/[recordingId]/index.ts

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import type { NextApiRequest, NextApiResponse } from "next";
2+
3+
import { defaultHandler, defaultResponder } from "@calcom/lib/server";
4+
5+
import { withMiddleware } from "~/lib/helpers/withMiddleware";
6+
7+
import authMiddleware from "../../_auth-middleware";
8+
9+
export default withMiddleware()(
10+
defaultResponder(async (req: NextApiRequest, res: NextApiResponse) => {
11+
await authMiddleware(req);
12+
return defaultHandler({
13+
GET: import("./_get"),
14+
})(req, res);
15+
})
16+
);

‎apps/api/v1/test/lib/bookings/[id]/transcripts/[recordingId]/_get.test.ts

+129
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
import prismaMock from "../../../../../../../../../tests/libs/__mocks__/prismaMock";
2+
3+
import type { Request, Response } from "express";
4+
import type { NextApiRequest, NextApiResponse } from "next";
5+
import { createMocks } from "node-mocks-http";
6+
import { describe, expect, test, vi, afterEach } from "vitest";
7+
8+
import {
9+
getTranscriptsAccessLinkFromRecordingId,
10+
checkIfRoomNameMatchesInRecording,
11+
} from "@calcom/core/videoClient";
12+
import { buildBooking } from "@calcom/lib/test/builder";
13+
14+
import { getAccessibleUsers } from "~/lib/utils/retrieveScopedAccessibleUsers";
15+
16+
import authMiddleware from "../../../../../../pages/api/bookings/[id]/_auth-middleware";
17+
import handler from "../../../../../../pages/api/bookings/[id]/transcripts/[recordingId]/_get";
18+
19+
type CustomNextApiRequest = NextApiRequest & Request;
20+
type CustomNextApiResponse = NextApiResponse & Response;
21+
22+
vi.mock("@calcom/core/videoClient", () => {
23+
return {
24+
getTranscriptsAccessLinkFromRecordingId: vi.fn(),
25+
checkIfRoomNameMatchesInRecording: vi.fn(),
26+
};
27+
});
28+
29+
vi.mock("~/lib/utils/retrieveScopedAccessibleUsers", () => {
30+
return {
31+
getAccessibleUsers: vi.fn(),
32+
};
33+
});
34+
35+
afterEach(() => {
36+
vi.resetAllMocks();
37+
});
38+
39+
const mockGetTranscripts = () => {
40+
const downloadLinks = [{ format: "json", link: "https://URL1" }];
41+
42+
vi.mocked(getTranscriptsAccessLinkFromRecordingId).mockResolvedValue(downloadLinks);
43+
vi.mocked(checkIfRoomNameMatchesInRecording).mockResolvedValue(true);
44+
45+
return downloadLinks;
46+
};
47+
48+
const recordingId = "abc-xyz";
49+
50+
describe("GET /api/bookings/[id]/transcripts/[recordingId]", () => {
51+
test("Returns transcripts if user is system-wide admin", async () => {
52+
const adminUserId = 1;
53+
const userId = 2;
54+
55+
const bookingId = 1111;
56+
57+
prismaMock.booking.findUnique.mockResolvedValue(
58+
buildBooking({
59+
id: bookingId,
60+
userId,
61+
references: [
62+
{
63+
id: 1,
64+
type: "daily_video",
65+
uid: "17OHkCH53pBa03FhxMbw",
66+
meetingId: "17OHkCH53pBa03FhxMbw",
67+
meetingPassword: "password",
68+
meetingUrl: "https://URL",
69+
},
70+
],
71+
})
72+
);
73+
74+
const mockedTranscripts = mockGetTranscripts();
75+
const { req, res } = createMocks<CustomNextApiRequest, CustomNextApiResponse>({
76+
method: "GET",
77+
body: {},
78+
query: {
79+
id: bookingId,
80+
recordingId,
81+
},
82+
});
83+
84+
req.isSystemWideAdmin = true;
85+
req.userId = adminUserId;
86+
87+
await authMiddleware(req);
88+
await handler(req, res);
89+
90+
expect(res.statusCode).toBe(200);
91+
expect(JSON.parse(res._getData())).toEqual(mockedTranscripts);
92+
});
93+
94+
test("Allows GET transcripts when user is org-wide admin", async () => {
95+
const adminUserId = 1;
96+
const memberUserId = 10;
97+
const bookingId = 3333;
98+
99+
prismaMock.booking.findUnique.mockResolvedValue(
100+
buildBooking({
101+
id: bookingId,
102+
userId: memberUserId,
103+
references: [
104+
{ id: 1, type: "daily_video", uid: "17OHkCH53pBa03FhxMbw", meetingId: "17OHkCH53pBa03FhxMbw" },
105+
],
106+
})
107+
);
108+
109+
const { req, res } = createMocks<CustomNextApiRequest, CustomNextApiResponse>({
110+
method: "GET",
111+
body: {},
112+
query: {
113+
id: bookingId,
114+
recordingId,
115+
},
116+
});
117+
118+
req.userId = adminUserId;
119+
req.isOrganizationOwnerOrAdmin = true;
120+
mockGetTranscripts();
121+
122+
vi.mocked(getAccessibleUsers).mockResolvedValue([memberUserId]);
123+
124+
await authMiddleware(req);
125+
await handler(req, res);
126+
127+
expect(res.statusCode).toBe(200);
128+
});
129+
});

‎apps/web/pages/api/recorded-daily-video.ts

+11-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@ import { createHmac } from "crypto";
33
import type { NextApiRequest, NextApiResponse } from "next";
44
import { z } from "zod";
55

6-
import { getDownloadLinkOfCalVideoByRecordingId } from "@calcom/core/videoClient";
6+
import {
7+
getDownloadLinkOfCalVideoByRecordingId,
8+
submitBatchProcessorTranscriptionJob,
9+
} from "@calcom/core/videoClient";
710
import { sendDailyVideoRecordingEmails } from "@calcom/emails";
811
import getWebhooks from "@calcom/features/webhooks/lib/getWebhooks";
912
import sendPayload from "@calcom/features/webhooks/lib/sendOrSchedulePayload";
@@ -268,6 +271,13 @@ async function handler(req: NextApiRequest, res: NextApiResponse) {
268271
},
269272
});
270273

274+
try {
275+
// Submit Transcription Batch Processor Job
276+
await submitBatchProcessorTranscriptionJob(recording_id);
277+
} catch (err) {
278+
log.error("Failed to Submit Transcription Batch Processor Job:", safeStringify(err));
279+
}
280+
271281
// send emails to all attendees only when user has team plan
272282
await sendDailyVideoRecordingEmails(evt, downloadLink);
273283
return res.status(200).json({ message: "Success" });

‎packages/app-store/dailyvideo/lib/VideoApiAdapter.ts

+65-1
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,18 @@ import { z } from "zod";
33
import { handleErrorsJson } from "@calcom/lib/errors";
44
import { prisma } from "@calcom/prisma";
55
import type { GetRecordingsResponseSchema, GetAccessLinkResponseSchema } from "@calcom/prisma/zod-utils";
6-
import { getRecordingsResponseSchema, getAccessLinkResponseSchema } from "@calcom/prisma/zod-utils";
6+
import {
7+
getRecordingsResponseSchema,
8+
getAccessLinkResponseSchema,
9+
recordingItemSchema,
10+
} from "@calcom/prisma/zod-utils";
711
import type { CalendarEvent } from "@calcom/types/Calendar";
812
import type { CredentialPayload } from "@calcom/types/Credential";
913
import type { PartialReference } from "@calcom/types/EventManager";
1014
import type { VideoApiAdapter, VideoCallData } from "@calcom/types/VideoApiAdapter";
1115

16+
import { ZSubmitBatchProcessorJobRes, ZGetTranscriptAccessLink } from "../zod";
17+
import type { TSubmitBatchProcessorJobRes, TGetTranscriptAccessLink, batchProcessorBody } from "../zod";
1218
import { getDailyAppKeys } from "./getDailyAppKeys";
1319

1420
/** @link https://docs.daily.co/reference/rest-api/rooms/create-room */
@@ -48,6 +54,17 @@ const getTranscripts = z.object({
4854
),
4955
});
5056

57+
const getBatchProcessJobs = z.object({
58+
total_count: z.number(),
59+
data: z.array(
60+
z.object({
61+
id: z.string(),
62+
preset: z.string(),
63+
status: z.string(),
64+
})
65+
),
66+
});
67+
5168
const getRooms = z
5269
.object({
5370
id: z.string(),
@@ -272,6 +289,53 @@ const DailyVideoApiAdapter = (): VideoApiAdapter => {
272289
throw new Error("Something went wrong! Unable to get transcription access link");
273290
}
274291
},
292+
submitBatchProcessorJob: async (body: batchProcessorBody): Promise<TSubmitBatchProcessorJobRes> => {
293+
try {
294+
const batchProcessorJob = await postToDailyAPI("/batch-processor", body).then(
295+
ZSubmitBatchProcessorJobRes.parse
296+
);
297+
return batchProcessorJob;
298+
} catch (err) {
299+
console.log("err", err);
300+
throw new Error("Something went wrong! Unable to submit batch processor job");
301+
}
302+
},
303+
getTranscriptsAccessLinkFromRecordingId: async (
304+
recordingId: string
305+
): Promise<TGetTranscriptAccessLink["transcription"] | { message: string }> => {
306+
try {
307+
const batchProcessorJobs = await fetcher(`/batch-processor?recordingId=${recordingId}`).then(
308+
getBatchProcessJobs.parse
309+
);
310+
if (!batchProcessorJobs.data.length) {
311+
return { message: `No Batch processor jobs found for recording id ${recordingId}` };
312+
}
313+
314+
const transcriptJobId = batchProcessorJobs.data.filter(
315+
(job) => job.preset === "transcript" && job.status === "finished"
316+
)?.[0]?.id;
317+
318+
if (!transcriptJobId) return [];
319+
320+
const accessLinkRes = await fetcher(`/batch-processor/${transcriptJobId}/access-link`).then(
321+
ZGetTranscriptAccessLink.parse
322+
);
323+
324+
return accessLinkRes.transcription;
325+
} catch (err) {
326+
console.log("err", err);
327+
throw new Error("Something went wrong! can't get transcripts");
328+
}
329+
},
330+
checkIfRoomNameMatchesInRecording: async (roomName: string, recordingId: string): Promise<boolean> => {
331+
try {
332+
const recording = await fetcher(`/recordings/${recordingId}`).then(recordingItemSchema.parse);
333+
return recording.room_name === roomName;
334+
} catch (err) {
335+
console.error("err", err);
336+
throw new Error(`Something went wrong! Unable to checkIfRoomNameMatchesInRecording. ${err}`);
337+
}
338+
},
275339
};
276340
};
277341

0 commit comments

Comments
 (0)