feat: add extendBody option for CallContent (#979)

* feat: add extendBody option for CallContent

* feat: adding snapshot tests

Author: renefloor

.gitignore

@@ -137,3 +137,8 @@ env.g.dart
 /.fvm/version
 /.fvm/versions/3.16.0
 /.fvmrc
+
+# Non-CI golden files and failures
+**/test/**/goldens/**/*.*
+**/test/**/failures/**/*.*
+!**/test/**/goldens/ci/*.*

melos.yaml

@@ -121,6 +121,10 @@ scripts:
       flutter: true
       dirExists: test
 
+  update:goldens:
+    run: melos exec -c 1 --depends-on="alchemist" -- "flutter test --tags golden --update-goldens"
+    description: Update golden files for all packages in this project.
+
   clean:flutter:
     run: melos exec -c 4 --fail-fast -- "flutter clean"
     description: Run Flutter clean for a specific package in this project.

packages/stream_video_flutter/lib/src/call_screen/call_content/call_content.dart

@@ -41,6 +41,7 @@ class StreamCallContent extends StatefulWidget {
     this.callParticipantsBuilder,
     this.callControlsBuilder,
     this.layoutMode = ParticipantLayoutMode.grid,
+    this.extendBody = false,
     this.pictureInPictureConfiguration = const PictureInPictureConfiguration(),
   });
 
@@ -68,6 +69,12 @@ class StreamCallContent extends StatefulWidget {
   /// The layout mode used to display the participants.
   final ParticipantLayoutMode layoutMode;
 
+  /// If true participants view will be shown all the way to the bottom of the scaffold,
+  /// meaning that the call controls for the local participants will be on top of the camera view.
+  ///
+  /// See also [Scaffold.extendBody].
+  final bool extendBody;
+
   /// Configuration for picture-in-picture mode.
   final PictureInPictureConfiguration pictureInPictureConfiguration;
 
@@ -256,6 +263,7 @@ class _StreamCallContentState extends State<StreamCallContent>
             ),
         ],
       ),
+      extendBody: widget.extendBody,
       bottomNavigationBar: localParticipant != null
           ? widget.callControlsBuilder?.call(context, call, callState) ??
               StreamCallControls.withDefaultOptions(

packages/stream_video_flutter/pubspec.yaml

@@ -27,6 +27,7 @@ dependencies:
   visibility_detector: ^0.4.0+2
 
 dev_dependencies:
+  alchemist: '>=0.11.0 <0.13.0'
   flutter_test:
     sdk: flutter
   mocktail: ^1.0.0

packages/stream_video_flutter/test/flutter_test_config.dart

@@ -0,0 +1,18 @@
+import 'dart:async';
+import 'dart:io';
+
+import 'package:alchemist/alchemist.dart';
+
+Future<void> testExecutable(FutureOr<void> Function() testMain) async {
+  final isRunningInCi = Platform.environment.containsKey('CI') ||
+      Platform.environment.containsKey('GITHUB_ACTIONS');
+
+  return AlchemistConfig.runWithConfig(
+    config: AlchemistConfig(
+      platformGoldensConfig: PlatformGoldensConfig(
+        enabled: !isRunningInCi,
+      ),
+    ),
+    run: testMain,
+  );
+}

packages/stream_video_flutter/test/src/call_screen/call_content/call_content_test.dart

@@ -0,0 +1,112 @@
+// ignore_for_file: avoid_redundant_argument_values
+
+import 'package:alchemist/alchemist.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:stream_video_flutter/stream_video_flutter.dart';
+
+import '../../../test_utils/test_wrapper.dart';
+
+void main() {
+  group('StreamCallContent', () {
+    late MockCall mockCall;
+    late MockCallState mockCallState;
+    late MockCallParticipantState mockLocalParticipant;
+
+    setUp(() {
+      mockCall = MockCall();
+      mockCallState = MockCallState();
+      mockLocalParticipant = MockCallParticipantState();
+
+      when(() => mockCallState.localParticipant)
+          .thenReturn(mockLocalParticipant);
+      when(() => mockCallState.status).thenReturn(CallStatus.connected());
+      when(() => mockCallState.callParticipants).thenReturn([]);
+    });
+
+    goldenTest(
+      'renders correctly with extendBody true',
+      fileName: 'stream_call_content_extend_body_true',
+      builder: () => GoldenTestGroup(
+        children: [
+          GoldenTestScenario(
+            name: 'default',
+            child: _CallContentExample(
+              mockCall,
+              mockCallState,
+              extendBody: true,
+            ),
+          ),
+        ],
+      ),
+    );
+
+    goldenTest(
+      'renders correctly with extendBody false',
+      fileName: 'stream_call_content_extend_body_false',
+      builder: () => GoldenTestGroup(
+        children: [
+          GoldenTestScenario(
+            name: 'default',
+            child: _CallContentExample(
+              mockCall,
+              mockCallState,
+              extendBody: false,
+            ),
+          ),
+        ],
+      ),
+    );
+  });
+}
+
+class _CallContentExample extends StatelessWidget {
+  const _CallContentExample(this.mockCall, this.mockCallState,
+      {this.extendBody = false});
+
+  final MockCall mockCall;
+  final MockCallState mockCallState;
+  final bool extendBody;
+
+  @override
+  Widget build(BuildContext context) {
+    return SizedBox(
+      width: 300,
+      height: 300,
+      child: TestWrapper(
+        child: StreamCallContent(
+          call: mockCall,
+          callState: mockCallState,
+          extendBody: extendBody,
+          callAppBarBuilder: (context, call, callState) => AppBar(
+            title: const Text('Custom App Bar'),
+          ),
+          callParticipantsBuilder: (context, call, callState) =>
+              const ColoredBox(
+            color: Colors.green,
+            child: Center(
+              child: Text('Custom Participants View'),
+            ),
+          ),
+          callControlsBuilder: (context, call, callState) => Row(
+            mainAxisAlignment: MainAxisAlignment.center,
+            children: [
+              IconButton(
+                onPressed: () {},
+                icon: const Icon(Icons.call),
+              ),
+              IconButton(onPressed: () {}, icon: const Icon(Icons.mic)),
+            ],
+          ),
+        ),
+      ),
+    );
+  }
+}
+
+class MockCall extends Mock implements Call {}
+
+class MockCallState extends Mock implements CallState {}
+
+class MockCallParticipantState extends Mock implements CallParticipantState {}