chore: remove checkPreMediaCallCreated from the handler interface

Author: d-gubert

apps/meteor/tests/data/apps/app-packages/README.md

@@ -705,9 +705,6 @@ An app implementing every method of `IMediaCallHandler`. It records what each ha
 logs, which is how `tests/e2e/apps/media-call-events.spec.ts` asserts the events actually arrived, and it
 answers the pre-create event according to a mode the test sets beforehand.
 
-`checkPreMediaCallCreated` is deliberately **not** implemented, so installing this app also covers the
-listener manager's `JSONRPC_METHOD_NOT_FOUND` fallback for that optional method.
-
 **Mode endpoint:**
 
 - `POST /api/apps/public/:appId/mode` with `{ "mode": "pass" | "prevent" | "drop-screen-share" }`

apps/meteor/tests/data/apps/app-packages/src/media-call-events-test/MediaCallEventsTestApp.ts

@@ -20,10 +20,6 @@ import { readMode } from './lib/mode';
 /**
  * Exercises every method of `IMediaCallHandler` and records what it saw in the app
  * logs, which is how the e2e spec asserts the events actually arrived.
- *
- * `checkPreMediaCallCreated` is deliberately NOT implemented, so installing this app
- * also covers the listener manager's `JSONRPC_METHOD_NOT_FOUND` fallback for the
- * optional check method.
  */
 export class MediaCallEventsTestApp extends App implements IMediaCallHandler {
 	constructor(info: IAppInfo, logger: ILogger, accessors: IAppAccessors) {

packages/apps-engine/src/definition/mediaCalls/IMediaCallHandler.ts

@@ -18,12 +18,6 @@ import { AppMethod } from '../metadata';
  * that shapes the join event.
  */
 export interface IMediaCallHandler {
-	/**
-	 * Enables the handler to signal to the Apps framework whether this handler
-	 * should actually run for the media call about to be created.
-	 */
-	[AppMethod.CHECK_PRE_MEDIA_CALL_CREATED]?(context: IPreMediaCallCreatedContext, read: IRead, http: IHttp): Promise<boolean>;
-
 	/**
 	 * Called before a media call is created, and awaited: a slow handler delays
 	 * the call from ringing. May `pass`, `patch` the call's requested features, or

packages/apps-engine/src/definition/metadata/AppMethod.ts

@@ -108,7 +108,6 @@ export enum AppMethod {
 	EXECUTE_POST_USER_LOGGED_OUT = 'executePostUserLoggedOut',
 	EXECUTE_POST_USER_STATUS_CHANGED = 'executePostUserStatusChanged',
 	// Media calls
-	CHECK_PRE_MEDIA_CALL_CREATED = 'checkPreMediaCallCreated',
 	EXECUTE_PRE_MEDIA_CALL_CREATED = 'executePreMediaCallCreated',
 	EXECUTE_POST_MEDIA_CALL_STARTED = 'executePostMediaCallStarted',
 	EXECUTE_POST_MEDIA_CALL_PARTICIPANT_JOINED = 'executePostMediaCallParticipantJoined',

packages/apps/src/server/managers/AppListenerManager.ts

@@ -1314,19 +1314,6 @@ export class AppListenerManager {
 		for (const appId of this.listeners.get(AppInterface.IMediaCallHandler)) {
 			const app = this.manager.getOneById(appId);
 
-			const continueOn = (await app.call(AppMethod.CHECK_PRE_MEDIA_CALL_CREATED, context).catch((error) => {
-				// This method is optional, so if it doesn't exist, we should continue
-				if (error?.code === JSONRPC_METHOD_NOT_FOUND) {
-					return true;
-				}
-
-				throw error;
-			})) as boolean;
-
-			if (!continueOn) {
-				continue;
-			}
-
 			const result = await app.call(AppMethod.EXECUTE_PRE_MEDIA_CALL_CREATED, context).catch((error) => {
 				// Every method of IMediaCallHandler is optional: an app may implement the
 				// interface for the post events alone

packages/apps/tests/server/managers/AppListenerManager.mediaCalls.test.ts

@@ -175,37 +175,6 @@ describe('AppListenerManager media call events', () => {
 			assert.deepStrictEqual(outcome, { prevented: false, context: { ...context, features: ['audio', 'hold'] } });
 		});
 
-		it('does not run the handler of an app whose check opted out', async () => {
-			let executed = false;
-			const outcome = await runPreCallCreated([
-				mockApp('opting-out', {
-					[AppMethod.CHECK_PRE_MEDIA_CALL_CREATED]: () => false,
-					[AppMethod.EXECUTE_PRE_MEDIA_CALL_CREATED]: () => {
-						executed = true;
-						return EventResult.prevent({ reason: 'should never run' });
-					},
-				}),
-			]);
-
-			assert.strictEqual(executed, false);
-			assert.deepStrictEqual(outcome, { prevented: false, context });
-		});
-
-		it('runs the handler of an app whose check opted in', async () => {
-			const outcome = await runPreCallCreated([
-				mockApp('opting-in', {
-					[AppMethod.CHECK_PRE_MEDIA_CALL_CREATED]: () => true,
-					[AppMethod.EXECUTE_PRE_MEDIA_CALL_CREATED]: () => EventResult.prevent({ reason: 'callee is on a do-not-disturb list' }),
-				}),
-			]);
-
-			assert.deepStrictEqual(outcome, {
-				prevented: true,
-				appId: 'opting-in',
-				reason: 'callee is on a do-not-disturb list',
-			});
-		});
-
 		it('drops a patch whose features are not a list', async () => {
 			const { result: outcome, warnings } = await capturingWarnings(() =>
 				runPreCallCreated([
@@ -260,27 +229,6 @@ describe('AppListenerManager media call events', () => {
 				/app blew up/,
 			);
 		});
-
-		it('fails closed when an app check throws', async () => {
-			let executed = false;
-
-			await assert.rejects(
-				runPreCallCreated([
-					mockApp('failing', {
-						[AppMethod.CHECK_PRE_MEDIA_CALL_CREATED]: () => {
-							throw new Error('check blew up');
-						},
-						[AppMethod.EXECUTE_PRE_MEDIA_CALL_CREATED]: () => {
-							executed = true;
-							return EventResult.pass();
-						},
-					}),
-				]),
-				/check blew up/,
-			);
-
-			assert.strictEqual(executed, false);
-		});
 	});
 
 	describe('post media call events', () => {