feat: add BigBlueButton video integration#29483
Conversation
|
Welcome to Cal.diy, @rjnevins! Thanks for opening this pull request. A few things to keep in mind:
A maintainer will review your PR soon. Thanks for contributing! |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis pull request adds BigBlueButton as a native video conferencing integration to Cal.com. The change includes Zod schemas for credential validation, app metadata with display and configuration properties, an installation API route to add the app as a team or user credential, a VideoApiAdapter implementation handling the complete BigBlueButton meeting lifecycle (create, delete, update), and registration within the app store infrastructure through generated files and seed scripts. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/app-store/bigbluebutton/_metadata.ts`:
- Around line 17-22: Update the user-facing label in
packages/app-store/bigbluebutton/_metadata.ts to use a translation key instead
of the hardcoded string: replace appData.location.label = "BigBlueButton" with a
lookup of the i18n key (e.g., t('apps.bigbluebutton.label')) and add that
key/value to packages/i18n/locales/en/common.json (for example "apps": {
"bigbluebutton": { "label": "BigBlueButton" }}) so the string flows through the
app i18n system.
In `@packages/app-store/bigbluebutton/api/add.ts`:
- Around line 42-109: The handler in default export (handler) currently performs
credential creation for any HTTP method; add an early guard that only allows
POST: check req.method === "POST" at the top of handler and return
res.status(405).json({ message: "Method Not Allowed" }) (or similar) for other
methods to avoid side effects on GET; keep this check before any authentication,
teamId parsing, or calls to throwIfNotHaveAdminAccessToTeam, getTeamId,
prisma.credential.findFirst, and prisma.credential.create so mutations only
occur on POST.
In `@packages/app-store/bigbluebutton/lib/VideoApiAdapter.ts`:
- Around line 106-117: The persisted join URL currently hardcodes
fullName="Guest" (see joinParams and the url built by buildApiUrl in
VideoApiAdapter.ts) which causes all attendees to appear as "Guest"; remove
fullName from the stored/signed join URL and instead generate/signed the final
join URL per-user using their real display name. Concretely: stop saving a
fully-signed URL that includes fullName in the return payload, change the stored
value to either a join URL template (no fullName) or store only
meetingID/password and the ability to call buildApiUrl on demand, and update
updateMeeting() to regenerate the join URL by calling buildApiUrl(apiUrl,
"join", joinParamsWithProvidedFullName, sharedSecret) when producing a
user-facing link so each attendee’s fullName is injected at join time rather
than reusing the original signed URL.
- Around line 54-57: getBigBlueButtonConfig currently fetches keys by
metadata.slug which ignores the credential this adapter instance was created
for; change it to read keys from the installed credential instead. Replace the
getAppKeysFromSlug(metadata.slug) call in getBigBlueButtonConfig with the call
that fetches keys for the adapter's installed credential (use the credential
identifier available on the adapter instance, e.g., installedCredential.id or
credential.id) and keep the result typed as BigBlueButtonKeys; make the same
replacement for the second occurrence mentioned (lines 71-77) so each adapter
uses its own credential's keys rather than the shared slug-based config.
In `@scripts/seed-app-store.ts`:
- Around line 167-170: Seed the BigBlueButton app only when both
BIGBLUEBUTTON_SERVER_URL and BIGBLUEBUTTON_SHARED_SECRET are set: wrap the
createApp("bigbluebutton", ...) call in a conditional that checks
process.env.BIGBLUEBUTTON_SERVER_URL and process.env.BIGBLUEBUTTON_SHARED_SECRET
are truthy, and skip creation (or log a message) otherwise; update the code
around the createApp invocation so the BigBlueButton entry is only created when
both environment variables exist.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 18fb82d0-f7f8-4ffb-8bb3-c8b0ae7ef3ba
⛔ Files ignored due to path filters (1)
packages/app-store/bigbluebutton/static/icon.svgis excluded by!**/*.svg
📒 Files selected for processing (16)
packages/app-store/apps.keys-schemas.generated.tspackages/app-store/apps.metadata.generated.tspackages/app-store/apps.schemas.generated.tspackages/app-store/apps.server.generated.tspackages/app-store/bigbluebutton/DESCRIPTION.mdpackages/app-store/bigbluebutton/_metadata.tspackages/app-store/bigbluebutton/api/add.tspackages/app-store/bigbluebutton/api/index.tspackages/app-store/bigbluebutton/index.tspackages/app-store/bigbluebutton/lib/VideoApiAdapter.tspackages/app-store/bigbluebutton/lib/index.tspackages/app-store/bigbluebutton/package.jsonpackages/app-store/bigbluebutton/zod.tspackages/app-store/bookerApps.metadata.generated.tspackages/app-store/video.adapters.generated.tsscripts/seed-app-store.ts
| appData: { | ||
| location: { | ||
| linkType: "dynamic", | ||
| type: "integrations:bigbluebutton", | ||
| label: "BigBlueButton", | ||
| }, |
There was a problem hiding this comment.
Localize the location label.
appData.location.label is a user-facing string, so hardcoding "BigBlueButton" here skips the app’s i18n flow. Please add it to packages/i18n/locales/en/common.json and reference the translated value instead.
As per coding guidelines, "**/*.{ts,tsx,jsx}: Add translations to packages/i18n/locales/en/common.json for all UI strings".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/app-store/bigbluebutton/_metadata.ts` around lines 17 - 22, Update
the user-facing label in packages/app-store/bigbluebutton/_metadata.ts to use a
translation key instead of the hardcoded string: replace appData.location.label
= "BigBlueButton" with a lookup of the i18n key (e.g.,
t('apps.bigbluebutton.label')) and add that key/value to
packages/i18n/locales/en/common.json (for example "apps": { "bigbluebutton": {
"label": "BigBlueButton" }}) so the string flows through the app i18n system.
| const getBigBlueButtonConfig = async () => { | ||
| const appKeys = (await getAppKeysFromSlug( | ||
| metadata.slug, | ||
| )) as BigBlueButtonKeys; |
There was a problem hiding this comment.
Read BigBlueButton keys from the installed credential, not from the app slug.
This adapter is created per credential, but getBigBlueButtonConfig() ignores that input and resolves keys by metadata.slug instead. For a non-global app, that collapses every install onto one shared config and can create/end meetings against the wrong BBB server or secret.
Also applies to: 71-77
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/app-store/bigbluebutton/lib/VideoApiAdapter.ts` around lines 54 -
57, getBigBlueButtonConfig currently fetches keys by metadata.slug which ignores
the credential this adapter instance was created for; change it to read keys
from the installed credential instead. Replace the
getAppKeysFromSlug(metadata.slug) call in getBigBlueButtonConfig with the call
that fetches keys for the adapter's installed credential (use the credential
identifier available on the adapter instance, e.g., installedCredential.id or
credential.id) and keep the result typed as BigBlueButtonKeys; make the same
replacement for the second occurrence mentioned (lines 71-77) so each adapter
uses its own credential's keys rather than the shared slug-based config.
- Add POST-only method guard to add.ts handler (405 for other methods) - Remove hardcoded fullName=Guest from stored join URL; updateMeeting now generates a per-attendee signed join URL using the real attendee name - Guard bigbluebutton seed behind BIGBLUEBUTTON_SERVER_URL + BIGBLUEBUTTON_SHARED_SECRET env check
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/app-store/bigbluebutton/lib/VideoApiAdapter.ts`:
- Around line 143-146: Replace the plain Error throw in VideoApiAdapter (the
branch checking meetingID and attendeePassword) with an ErrorWithCode so
structured error handling is preserved: import ErrorWithCode into
VideoApiAdapter.ts and change the throw to something like throw new
ErrorWithCode("BigBlueButton booking reference is missing meeting data",
"BAD_REQUEST") (or another appropriate error code), ensuring the same message is
used; update any surrounding code that expects Error to handle ErrorWithCode if
necessary.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b58e4317-063e-4e16-a838-92d56d2a7971
📒 Files selected for processing (3)
packages/app-store/bigbluebutton/api/add.tspackages/app-store/bigbluebutton/lib/VideoApiAdapter.tsscripts/seed-app-store.ts
🚧 Files skipped from review as they are similar to previous changes (2)
- scripts/seed-app-store.ts
- packages/app-store/bigbluebutton/api/add.ts
|
please attach a working demo in the description. making it draft til then. |
2 participants
Summary
/claim #1985
Adds a BigBlueButton conferencing app integration for Cal.diy.
This implementation:
bigbluebuttonapp-store package and generated app mapscreate,join, andendAPI URLsteamId, sanitizingreturnTo, selecting only credential IDs, and returning typed HTTP errorsNotes
BigBlueButton is stateless, so this creates meetings at booking time using the signed BBB API instead of trying to pre-schedule rooms inside BBB itself.
Validation
git diff --check origin/main..HEADnpx --yes prettier --check packages/app-store/bigbluebutton/api/add.ts packages/app-store/bigbluebutton/lib/VideoApiAdapter.tsI attempted a full
corepack yarn installto run broader checks, but the local runner ran out of disk space during package fetch (ENOSPC).