diff --git a/.github/workflows/e2e_tests_functions.yaml b/.github/workflows/e2e_tests_functions.yaml index 701cabe3923b..6b15008d26af 100644 --- a/.github/workflows/e2e_tests_functions.yaml +++ b/.github/workflows/e2e_tests_functions.yaml @@ -97,3 +97,13 @@ jobs: package-scope: 'cloud_functions*' native-config-args: '--functions-native' nightly_test_mode: ${{ inputs.nightly_test_mode == true }} + + windows: + needs: changes + if: needs.changes.outputs.windows == 'true' + uses: ./.github/workflows/reusable_e2e_windows.yaml + with: + package-path: 'packages/cloud_functions/cloud_functions' + package-scope: 'cloud_functions*' + native-config-args: '--functions-native' + nightly_test_mode: ${{ inputs.nightly_test_mode == true }} diff --git a/README.md b/README.md index 5e57d89b4ab9..b0b48f624e72 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ and open source. | App Check | [![App Check pub.dev badge](https://img.shields.io/pub/v/firebase_app_check.svg)](https://pub.dev/packages/firebase_app_check) | [🔗](https://firebase.google.com/docs/app-check) | [📖](https://firebase.google.com/docs/app-check/flutter/default-providers) | [`firebase_app_check`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/firebase_app_check) | ✔ | ✔ | ✔ | β | N/A | | Authentication | [![Authentication pub.dev badge](https://img.shields.io/pub/v/firebase_auth.svg)](https://pub.dev/packages/firebase_auth) | [🔗](https://firebase.google.com/products/auth) | [📖](https://firebase.google.com/docs/auth/flutter/start) | [`firebase_auth`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/firebase_auth) | ✔ | ✔ | ✔ | β | (*) | | Cloud Firestore | [![Cloud Firestore pub.dev badge](https://img.shields.io/pub/v/cloud_firestore.svg)](https://pub.dev/packages/cloud_firestore) | [🔗](https://firebase.google.com/products/firestore) | [📖](https://firebase.google.com/docs/firestore/quickstart) | [`cloud_firestore`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/cloud_firestore) | ✔ | ✔ | ✔ | β | (*) | -| Cloud Functions | [![Cloud Functions pub.dev badge](https://img.shields.io/pub/v/cloud_functions.svg)](https://pub.dev/packages/cloud_functions) | [🔗](https://firebase.google.com/products/functions) | [📖](https://firebase.google.com/docs/functions/get-started?gen=2nd) | [`cloud_functions`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/cloud_functions) | ✔ | ✔ | ✔ | β | N/A | +| Cloud Functions | [![Cloud Functions pub.dev badge](https://img.shields.io/pub/v/cloud_functions.svg)](https://pub.dev/packages/cloud_functions) | [🔗](https://firebase.google.com/products/functions) | [📖](https://firebase.google.com/docs/functions/get-started?gen=2nd) | [`cloud_functions`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/cloud_functions) | ✔ | ✔ | ✔ | β | (*) | | Cloud Messaging | [![Cloud Messaging pub.dev badge](https://img.shields.io/pub/v/firebase_messaging.svg)](https://pub.dev/packages/firebase_messaging) | [🔗](https://firebase.google.com/products/cloud-messaging) | [📖](https://firebase.google.com/docs/cloud-messaging/flutter/client) | [`firebase_messaging`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/firebase_messaging) | ✔ | ✔ | ✔ | β | N/A | | Cloud Storage | [![Cloud Storage pub.dev badge](https://img.shields.io/pub/v/firebase_storage.svg)](https://pub.dev/packages/firebase_storage) | [🔗](https://firebase.google.com/products/storage) | [📖](https://firebase.google.com/docs/storage/flutter/start) | [`firebase_storage`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/firebase_storage) | ✔ | ✔ | ✔ | β | (*) | | Core | [![Core pub.dev badge](https://img.shields.io/pub/v/firebase_core.svg)](https://pub.dev/packages/firebase_core) | [🔗](https://firebase.google.com) | [📖](https://firebase.google.com) | [`firebase_core`](https://github.com/FirebaseExtended/flutterfire/tree/main/packages/firebase_core) | ✔ | ✔ | ✔ | β | (*) | diff --git a/packages/cloud_functions/cloud_functions/example/.metadata b/packages/cloud_functions/cloud_functions/example/.metadata index 784ce1298249..7503c86136e5 100644 --- a/packages/cloud_functions/cloud_functions/example/.metadata +++ b/packages/cloud_functions/cloud_functions/example/.metadata @@ -18,6 +18,9 @@ migration: - platform: web create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + - platform: windows + create_revision: 4cf24164269a5ebf0c16a028a00727d0e77bbb05 + base_revision: 4cf24164269a5ebf0c16a028a00727d0e77bbb05 # User provided section diff --git a/packages/cloud_functions/cloud_functions/example/integration_test/e2e_test.dart b/packages/cloud_functions/cloud_functions/example/integration_test/e2e_test.dart index b2f088f9cd01..1f9fad150a1d 100644 --- a/packages/cloud_functions/cloud_functions/example/integration_test/e2e_test.dart +++ b/packages/cloud_functions/cloud_functions/example/integration_test/e2e_test.dart @@ -25,6 +25,17 @@ String kTestStreamResponse = 'testStreamResponse'; /// event fails the test instead of burning the job timeout. const _completerTimeout = Duration(seconds: 30); +/// Whether the tests are running against the desktop implementations backed by +/// the Firebase C++ SDK (Windows and Linux). Both platforms share the same +/// C++ SDK, so they have identical feature limitations in this suite. +/// +/// The `!kIsWeb` check matters because web e2e tests run on Linux CI runners, +/// where `defaultTargetPlatform` reports [TargetPlatform.linux]. +bool get _isDesktopCppSdk => + !kIsWeb && + (defaultTargetPlatform == TargetPlatform.windows || + defaultTargetPlatform == TargetPlatform.linux); + void main() { final binding = IntegrationTestWidgetsFlutterBinding.ensureInitialized(); reportTestResultsToDriver(binding); @@ -208,27 +219,33 @@ void main() { } }); - test('it returns "details" value as part of the exception', () async { - try { - await callable({ - 'type': 'deepMap', - 'inputData': data.deepMap, - 'asError': true, - }); - fail('Should have thrown'); - } on FirebaseFunctionsException catch (e) { - expect(e.code, equals('cancelled')); - expect( - e.message, - equals( - 'Response data was requested to be sent as part of an Error payload, so here we are!', - ), - ); - expect(e.details, equals(data.deepMap)); - } catch (e) { - fail('$e'); - } - }); + test( + 'it returns "details" value as part of the exception', + () async { + try { + await callable({ + 'type': 'deepMap', + 'inputData': data.deepMap, + 'asError': true, + }); + fail('Should have thrown'); + } on FirebaseFunctionsException catch (e) { + expect(e.code, equals('cancelled')); + expect( + e.message, + equals( + 'Response data was requested to be sent as part of an Error payload, so here we are!', + ), + ); + expect(e.details, equals(data.deepMap)); + } catch (e) { + fail('$e'); + } + }, + // Desktop C++ SDK skip: exception `details` payloads are not + // propagated by the firebase-cpp-sdk. + skip: _isDesktopCppSdk, + ); }); group('instanceFor', () { @@ -263,6 +280,12 @@ void main() { } catch (e) { fail('$e'); } + if (_isDesktopCppSdk) { + // The C++ SDK cannot cancel the timed-out request; it keeps + // running on the transport and delays subsequent calls. Wait for + // it to drain so the next test is not queued behind it. + await Future.delayed(const Duration(seconds: 4)); + } }, // Android skip because it's flaky. See: // https://github.com/firebase/flutterfire/issues/9652 @@ -288,248 +311,270 @@ void main() { ); }); - group('HttpsCallable Stream', () { - test('returns a [StreamResponse]', () { - final streamResponseCallable = - FirebaseFunctions.instance.httpsCallable(kTestStreamResponse); - final stream = streamResponseCallable.stream(); - expect(stream, emits(isA())); - }); - - test('accepts a string value', () async { - final stream = callable.stream('foo').where((event) => event is Chunk); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('string')), - ), - ); - }); - - test('accepts a number value', () async { - final stream = callable - .stream(123) - .where((event) => event is Chunk) - .asBroadcastStream(); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('number')), - ), - ); - }); - - test('accepts no arguments', () async { - final stream = callable - .stream() - .where((event) => event is Chunk) - .asBroadcastStream(); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('null')), - ), - ); - }); + group( + 'HttpsCallable Stream', + () { + test('returns a [StreamResponse]', () { + final streamResponseCallable = + FirebaseFunctions.instance.httpsCallable(kTestStreamResponse); + final stream = streamResponseCallable.stream(); + expect(stream, emits(isA())); + }); - test('accepts a false boolean value', () async { - final stream = callable.stream(false).where((event) => event is Chunk); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('boolean')), - ), - ); - }); + test('accepts a string value', () async { + final stream = + callable.stream('foo').where((event) => event is Chunk); + await expectLater( + stream, + emits( + isA().having( + (e) => e.partialData, + 'partialData', + equals('string'), + ), + ), + ); + }); - test('accepts a true boolean value', () async { - final stream = callable.stream(true).where((event) => event is Chunk); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('boolean')), - ), - ); - }); + test('accepts a number value', () async { + final stream = callable + .stream(123) + .where((event) => event is Chunk) + .asBroadcastStream(); + await expectLater( + stream, + emits( + isA().having( + (e) => e.partialData, + 'partialData', + equals('number'), + ), + ), + ); + }); - test('can be called using an String url', () async { - final localhostMapped = - kIsWeb || !Platform.isAndroid ? 'localhost' : '10.0.2.2'; + test('accepts no arguments', () async { + final stream = callable + .stream() + .where((event) => event is Chunk) + .asBroadcastStream(); + await expectLater( + stream, + emits( + isA() + .having((e) => e.partialData, 'partialData', equals('null')), + ), + ); + }); - HttpsCallable callable = - FirebaseFunctions.instance.httpsCallableFromUrl( - 'http://$localhostMapped:5001/flutterfire-e2e-tests/us-central1/listfruits2ndgen', - ); + test('accepts a false boolean value', () async { + final stream = + callable.stream(false).where((event) => event is Chunk); + await expectLater( + stream, + emits( + isA().having( + (e) => e.partialData, + 'partialData', + equals('boolean'), + ), + ), + ); + }); - final stream = callable.stream(); - await expectLater(stream, emits(isA())); - }); + test('accepts a true boolean value', () async { + final stream = callable.stream(true).where((event) => event is Chunk); + await expectLater( + stream, + emits( + isA().having( + (e) => e.partialData, + 'partialData', + equals('boolean'), + ), + ), + ); + }); - test('can be called using an Uri url', () async { - final localhostMapped = - kIsWeb || !Platform.isAndroid ? 'localhost' : '10.0.2.2'; + test('can be called using an String url', () async { + final localhostMapped = + kIsWeb || !Platform.isAndroid ? 'localhost' : '10.0.2.2'; - HttpsCallable callable = - FirebaseFunctions.instance.httpsCallableFromUri( - Uri.parse( + HttpsCallable callable = + FirebaseFunctions.instance.httpsCallableFromUrl( 'http://$localhostMapped:5001/flutterfire-e2e-tests/us-central1/listfruits2ndgen', - ), - ); + ); - final stream = callable.stream(); - await expectLater(stream, emits(isA())); - }); + final stream = callable.stream(); + await expectLater(stream, emits(isA())); + }); - test( - 'concurrent streams on the same callable do not collide', - () async { - // Regression test for https://github.com/firebase/flutterfire/issues/18036 - final stream1 = callable - .stream('foo') - .where((event) => event is Chunk) - .map((event) => (event as Chunk).partialData) - .first; - final stream2 = callable - .stream(123) - .where((event) => event is Chunk) - .map((event) => (event as Chunk).partialData) - .first; + test('can be called using an Uri url', () async { + final localhostMapped = + kIsWeb || !Platform.isAndroid ? 'localhost' : '10.0.2.2'; - final results = await Future.wait([stream1, stream2]); - expect(results[0], equals('string')); - expect(results[1], equals('number')); - }, - ); + HttpsCallable callable = + FirebaseFunctions.instance.httpsCallableFromUri( + Uri.parse( + 'http://$localhostMapped:5001/flutterfire-e2e-tests/us-central1/listfruits2ndgen', + ), + ); + + final stream = callable.stream(); + await expectLater(stream, emits(isA())); + }); - test('should emit a [Result] as last value', () async { - final stream = await callable.stream().last; - expect( - stream, - isA(), + test( + 'concurrent streams on the same callable do not collide', + () async { + // Regression test for https://github.com/firebase/flutterfire/issues/18036 + final stream1 = callable + .stream('foo') + .where((event) => event is Chunk) + .map((event) => (event as Chunk).partialData) + .first; + final stream2 = callable + .stream(123) + .where((event) => event is Chunk) + .map((event) => (event as Chunk).partialData) + .first; + + final results = await Future.wait([stream1, stream2]); + expect(results[0], equals('string')); + expect(results[1], equals('number')); + }, ); - }); - test( - 'Result.data is Map for object-shaped JSON', - () async { - final stream = callable.stream({ - 'type': 'deepMap', - 'inputData': data.deepMap, - }); - final terminalEvent = await stream.where((e) => e is Result).last; - expect(terminalEvent, isA()); - final result = (terminalEvent as Result).result; + test('should emit a [Result] as last value', () async { + final stream = await callable.stream().last; expect( - result.data, - isA>(), + stream, + isA(), ); - }, - skip: !kIsWeb, - ); + }); - test('accepts a [List]', () async { - final stream = - callable.stream(data.list).where((event) => event is Chunk); - await expectLater( - stream, - emits( - isA() - .having((e) => e.partialData, 'partialData', equals('array')), - ), + test( + 'Result.data is Map for object-shaped JSON', + () async { + final stream = callable.stream({ + 'type': 'deepMap', + 'inputData': data.deepMap, + }); + final terminalEvent = await stream.where((e) => e is Result).last; + expect(terminalEvent, isA()); + final result = (terminalEvent as Result).result; + expect( + result.data, + isA>(), + ); + }, + skip: !kIsWeb, ); - }); - test('accepts a deeply nested [Map]', () async { - final stream = callable.stream({ - 'type': 'deepMap', - 'inputData': data.deepMap, - }).where((event) => event is Chunk); - await expectLater( - stream, - emits( - isA().having( - (e) => e.partialData, - 'partialData', - equals(data.deepMap), + test('accepts a [List]', () async { + final stream = + callable.stream(data.list).where((event) => event is Chunk); + await expectLater( + stream, + emits( + isA() + .having((e) => e.partialData, 'partialData', equals('array')), ), - ), - ); - }); - - test( - 'throws error when aborted with TimeLimit signal', - () async { - final instance = FirebaseFunctions.instance; - instance.useFunctionsEmulator('localhost', 5001); - - final completer = Completer(); + ); + }); - final timeoutCallable = FirebaseFunctions.instance.httpsCallable( - kTestFunctionTimeout, - options: HttpsCallableOptions( - webAbortSignal: TimeLimit(const Duration(seconds: 3)), + test('accepts a deeply nested [Map]', () async { + final stream = callable.stream({ + 'type': 'deepMap', + 'inputData': data.deepMap, + }).where((event) => event is Chunk); + await expectLater( + stream, + emits( + isA().having( + (e) => e.partialData, + 'partialData', + equals(data.deepMap), + ), ), ); + }); - timeoutCallable.stream({ - 'testTimeout': const Duration(seconds: 6).inMilliseconds.toString(), - }).listen( - (data) { - completer.completeError('Should have thrown'); - }, - onError: (error) { - if (error is FirebaseFunctionsException) { - expect(error.code, equals('internal')); - completer.complete(); - } else { - completer.completeError('Unexpected error type: $error'); - } - }, - ); - await completer.future.timeout(_completerTimeout); - }, - skip: !kIsWeb, - ); + test( + 'throws error when aborted with TimeLimit signal', + () async { + final instance = FirebaseFunctions.instance; + instance.useFunctionsEmulator('localhost', 5001); - test( - 'throws error when aborted with Abort signal', - () async { - final instance = FirebaseFunctions.instance; - instance.useFunctionsEmulator('localhost', 5001); + final completer = Completer(); - final completer = Completer(); + final timeoutCallable = FirebaseFunctions.instance.httpsCallable( + kTestFunctionTimeout, + options: HttpsCallableOptions( + webAbortSignal: TimeLimit(const Duration(seconds: 3)), + ), + ); - final timeoutCallable = FirebaseFunctions.instance.httpsCallable( - kTestFunctionTimeout, - options: HttpsCallableOptions( - webAbortSignal: Abort('aborted'), - ), - ); + timeoutCallable.stream({ + 'testTimeout': + const Duration(seconds: 6).inMilliseconds.toString(), + }).listen( + (data) { + completer.completeError('Should have thrown'); + }, + onError: (error) { + if (error is FirebaseFunctionsException) { + expect(error.code, equals('internal')); + completer.complete(); + } else { + completer.completeError('Unexpected error type: $error'); + } + }, + ); + await completer.future.timeout(_completerTimeout); + }, + skip: !kIsWeb, + ); - timeoutCallable.stream({ - 'testTimeout': const Duration(seconds: 6).inMilliseconds.toString(), - }).listen( - (data) { - completer.completeError('Should have thrown'); - }, - onError: (error) { - if (error is FirebaseFunctionsException) { - expect(error.code, equals('internal')); - completer.complete(); - } else { - completer.completeError('Unexpected error type: $error'); - } - }, - ); - await completer.future.timeout(_completerTimeout); - }, - skip: !kIsWeb, - ); - }); + test( + 'throws error when aborted with Abort signal', + () async { + final instance = FirebaseFunctions.instance; + instance.useFunctionsEmulator('localhost', 5001); + + final completer = Completer(); + + final timeoutCallable = FirebaseFunctions.instance.httpsCallable( + kTestFunctionTimeout, + options: HttpsCallableOptions( + webAbortSignal: Abort('aborted'), + ), + ); + + timeoutCallable.stream({ + 'testTimeout': + const Duration(seconds: 6).inMilliseconds.toString(), + }).listen( + (data) { + completer.completeError('Should have thrown'); + }, + onError: (error) { + if (error is FirebaseFunctionsException) { + expect(error.code, equals('internal')); + completer.complete(); + } else { + completer.completeError('Unexpected error type: $error'); + } + }, + ); + await completer.future.timeout(_completerTimeout); + }, + skip: !kIsWeb, + ); + }, + // Desktop C++ SDK skip: streaming callables are not supported by the + // firebase-cpp-sdk. + skip: _isDesktopCppSdk, + ); }); } diff --git a/packages/cloud_functions/cloud_functions/example/windows/.gitignore b/packages/cloud_functions/cloud_functions/example/windows/.gitignore new file mode 100644 index 000000000000..d492d0d98c8f --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/packages/cloud_functions/cloud_functions/example/windows/CMakeLists.txt b/packages/cloud_functions/cloud_functions/example/windows/CMakeLists.txt new file mode 100644 index 000000000000..b0765840141c --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(cloud_functions_example LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "cloud_functions_example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(VERSION 3.14...3.25) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Copy the native assets provided by the build.dart from all packages. +set(NATIVE_ASSETS_DIR "${PROJECT_BUILD_DIR}native_assets/windows/") +install(DIRECTORY "${NATIVE_ASSETS_DIR}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/packages/cloud_functions/cloud_functions/example/windows/flutter/CMakeLists.txt b/packages/cloud_functions/cloud_functions/example/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000000..903f4899d6fc --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,109 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# Set fallback configurations for older versions of the flutter tool. +if (NOT DEFINED FLUTTER_TARGET_PLATFORM) + set(FLUTTER_TARGET_PLATFORM "windows-x64") +endif() + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + ${FLUTTER_TARGET_PLATFORM} $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/CMakeLists.txt b/packages/cloud_functions/cloud_functions/example/windows/runner/CMakeLists.txt new file mode 100644 index 000000000000..394917c053a0 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/CMakeLists.txt @@ -0,0 +1,40 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add preprocessor definitions for the build version. +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION=\"${FLUTTER_VERSION}\"") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MAJOR=${FLUTTER_VERSION_MAJOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_MINOR=${FLUTTER_VERSION_MINOR}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_PATCH=${FLUTTER_VERSION_PATCH}") +target_compile_definitions(${BINARY_NAME} PRIVATE "FLUTTER_VERSION_BUILD=${FLUTTER_VERSION_BUILD}") + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_link_libraries(${BINARY_NAME} PRIVATE "dwmapi.lib") +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/Runner.rc b/packages/cloud_functions/cloud_functions/example/windows/runner/Runner.rc new file mode 100644 index 000000000000..ed2683ea285f --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#if defined(FLUTTER_VERSION_MAJOR) && defined(FLUTTER_VERSION_MINOR) && defined(FLUTTER_VERSION_PATCH) && defined(FLUTTER_VERSION_BUILD) +#define VERSION_AS_NUMBER FLUTTER_VERSION_MAJOR,FLUTTER_VERSION_MINOR,FLUTTER_VERSION_PATCH,FLUTTER_VERSION_BUILD +#else +#define VERSION_AS_NUMBER 1,0,0,0 +#endif + +#if defined(FLUTTER_VERSION) +#define VERSION_AS_STRING FLUTTER_VERSION +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "io.flutter.plugins.firebase.functions" "\0" + VALUE "FileDescription", "cloud_functions_example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "cloud_functions_example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 io.flutter.plugins.firebase.functions. All rights reserved." "\0" + VALUE "OriginalFilename", "cloud_functions_example.exe" "\0" + VALUE "ProductName", "cloud_functions_example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.cpp b/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.cpp new file mode 100644 index 000000000000..955ee3038f98 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.cpp @@ -0,0 +1,71 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + + flutter_controller_->engine()->SetNextFrameCallback([&]() { + this->Show(); + }); + + // Flutter can complete the first frame before the "show window" callback is + // registered. The following call ensures a frame is pending to ensure the + // window is shown. It is a no-op if the first frame hasn't completed yet. + flutter_controller_->ForceRedraw(); + + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.h b/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.h new file mode 100644 index 000000000000..6da0652f05f2 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/main.cpp b/packages/cloud_functions/cloud_functions/example/windows/runner/main.cpp new file mode 100644 index 000000000000..fc3d784b9f37 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.Create(L"cloud_functions_example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/resource.h b/packages/cloud_functions/cloud_functions/example/windows/runner/resource.h new file mode 100644 index 000000000000..66a65d1e4a79 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/resources/app_icon.ico b/packages/cloud_functions/cloud_functions/example/windows/runner/resources/app_icon.ico new file mode 100644 index 000000000000..c04e20caf637 Binary files /dev/null and b/packages/cloud_functions/cloud_functions/example/windows/runner/resources/app_icon.ico differ diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/runner.exe.manifest b/packages/cloud_functions/cloud_functions/example/windows/runner/runner.exe.manifest new file mode 100644 index 000000000000..153653e8d67f --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/utils.cpp b/packages/cloud_functions/cloud_functions/example/windows/runner/utils.cpp new file mode 100644 index 000000000000..3cb71466549c --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/utils.cpp @@ -0,0 +1,69 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + // First, find the length of the string with a safe upper bound (CWE-126). + // UNICODE_STRING_MAX_CHARS (32767) is the maximum length of a UNICODE_STRING. + int input_length = static_cast(wcsnlen(utf16_string, UNICODE_STRING_MAX_CHARS)); + // Now use that bounded length to determine the required buffer size. + // When an explicit length is passed, WideCharToMultiByte does not include + // the null terminator in its returned size. + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, nullptr, 0, nullptr, nullptr); + std::string utf8_string; + if (target_length == 0 || static_cast(target_length) > utf8_string.max_size()) { + return utf8_string; + } + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + input_length, utf8_string.data(), target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/utils.h b/packages/cloud_functions/cloud_functions/example/windows/runner/utils.h new file mode 100644 index 000000000000..3879d5475579 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.cpp b/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.cpp new file mode 100644 index 000000000000..60608d0fe5bf --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.cpp @@ -0,0 +1,288 @@ +#include "win32_window.h" + +#include +#include + +#include "resource.h" + +namespace { + +/// Window attribute that enables dark mode window decorations. +/// +/// Redefined in case the developer's machine has a Windows SDK older than +/// version 10.0.22000.0. +/// See: https://docs.microsoft.com/windows/win32/api/dwmapi/ne-dwmapi-dwmwindowattribute +#ifndef DWMWA_USE_IMMERSIVE_DARK_MODE +#define DWMWA_USE_IMMERSIVE_DARK_MODE 20 +#endif + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +/// Registry key for app theme preference. +/// +/// A value of 0 indicates apps should use dark mode. A non-zero or missing +/// value indicates apps should use light mode. +constexpr const wchar_t kGetPreferredBrightnessRegKey[] = + L"Software\\Microsoft\\Windows\\CurrentVersion\\Themes\\Personalize"; +constexpr const wchar_t kGetPreferredBrightnessRegValue[] = L"AppsUseLightTheme"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + } + FreeLibrary(user32_module); +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registrar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::Create(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + UpdateTheme(window); + + return OnCreate(); +} + +bool Win32Window::Show() { + return ShowWindow(window_handle_, SW_SHOWNORMAL); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + + case WM_DWMCOLORIZATIONCOLORCHANGED: + UpdateTheme(hwnd); + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} + +void Win32Window::UpdateTheme(HWND const window) { + DWORD light_mode; + DWORD light_mode_size = sizeof(light_mode); + LSTATUS result = RegGetValue(HKEY_CURRENT_USER, kGetPreferredBrightnessRegKey, + kGetPreferredBrightnessRegValue, + RRF_RT_REG_DWORD, nullptr, &light_mode, + &light_mode_size); + + if (result == ERROR_SUCCESS) { + BOOL enable_dark_mode = light_mode == 0; + DwmSetWindowAttribute(window, DWMWA_USE_IMMERSIVE_DARK_MODE, + &enable_dark_mode, sizeof(enable_dark_mode)); + } +} diff --git a/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.h b/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.h new file mode 100644 index 000000000000..e901dde684ea --- /dev/null +++ b/packages/cloud_functions/cloud_functions/example/windows/runner/win32_window.h @@ -0,0 +1,102 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates a win32 window with |title| that is positioned and sized using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size this function will scale the inputted width and height as + // as appropriate for the default monitor. The window is invisible until + // |Show| is called. Returns true if the window was created successfully. + bool Create(const std::wstring& title, const Point& origin, const Size& size); + + // Show the current window. Returns true if the window was successfully shown. + bool Show(); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + // Update the window frame's theme to match the system theme. + static void UpdateTheme(HWND const window); + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/packages/cloud_functions/cloud_functions/pubspec.yaml b/packages/cloud_functions/cloud_functions/pubspec.yaml index b02a8dfc15df..37222a807119 100644 --- a/packages/cloud_functions/cloud_functions/pubspec.yaml +++ b/packages/cloud_functions/cloud_functions/pubspec.yaml @@ -42,3 +42,5 @@ flutter: pluginClass: FirebaseFunctionsPlugin web: default_package: cloud_functions_web + windows: + pluginClass: CloudFunctionsPluginCApi diff --git a/packages/cloud_functions/cloud_functions/windows/CMakeLists.txt b/packages/cloud_functions/cloud_functions/windows/CMakeLists.txt new file mode 100644 index 000000000000..f435f47c6634 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/CMakeLists.txt @@ -0,0 +1,80 @@ +# The Flutter tooling requires that developers have a version of Visual Studio +# installed that includes CMake 3.14 or later. You should not increase this +# version, as doing so will cause the plugin to fail to compile for some +# customers of the plugin. +cmake_minimum_required(VERSION 3.14) + +# Project-level configuration. +set(PROJECT_NAME "cloud_functions") +project(${PROJECT_NAME} LANGUAGES CXX) + +# This value is used when generating builds using this plugin, so it must +# not be changed +set(PLUGIN_NAME "cloud_functions_plugin") + +# Any new source files that you add to the plugin should be added here. +list(APPEND PLUGIN_SOURCES + "cloud_functions_plugin.cpp" + "cloud_functions_plugin.h" + "messages.g.cpp" + "messages.g.h" +) + +# Read version from pubspec.yaml +file(STRINGS "../pubspec.yaml" pubspec_content) +foreach(line ${pubspec_content}) + string(FIND ${line} "version: " has_version) + + if("${has_version}" STREQUAL "0") + string(FIND ${line} ": " version_start_pos) + math(EXPR version_start_pos "${version_start_pos} + 2") + string(LENGTH ${line} version_end_pos) + math(EXPR len "${version_end_pos} - ${version_start_pos}") + string(SUBSTRING ${line} ${version_start_pos} ${len} PLUGIN_VERSION) + break() + endif() +endforeach(line) + +configure_file(plugin_version.h.in ${CMAKE_BINARY_DIR}/generated/cloud_functions/plugin_version.h) +include_directories(${CMAKE_BINARY_DIR}/generated/) + +# Define the plugin library target. Its name must not be changed (see comment +# on PLUGIN_NAME above). +add_library(${PLUGIN_NAME} STATIC + "include/cloud_functions/cloud_functions_plugin_c_api.h" + "cloud_functions_plugin_c_api.cpp" + ${PLUGIN_SOURCES} + ${CMAKE_BINARY_DIR}/generated/cloud_functions/plugin_version.h +) + +# Apply a standard set of build settings that are configured in the +# application-level CMakeLists.txt. This can be removed for plugins that want +# full control over build settings. +apply_standard_settings(${PLUGIN_NAME}) + +# Symbols are hidden by default to reduce the chance of accidental conflicts +# between plugins. This should not be removed; any symbols that should be +# exported should be explicitly exported with the FLUTTER_PLUGIN_EXPORT macro. +set_target_properties(${PLUGIN_NAME} PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_compile_definitions(${PLUGIN_NAME} PUBLIC FLUTTER_PLUGIN_IMPL) +# Enable firebase-cpp-sdk's platform logging api. +target_compile_definitions(${PLUGIN_NAME} PRIVATE -DINTERNAL_EXPERIMENTAL=1) + +# Source include directories and library dependencies. Add any plugin-specific +# dependencies here. +set(MSVC_RUNTIME_MODE MD) +set(firebase_libs firebase_core_plugin firebase_functions) +target_link_libraries(${PLUGIN_NAME} PRIVATE "${firebase_libs}") + +target_include_directories(${PLUGIN_NAME} INTERFACE + "${CMAKE_CURRENT_SOURCE_DIR}/include") +target_link_libraries(${PLUGIN_NAME} PUBLIC flutter flutter_wrapper_plugin) + +# List of absolute paths to libraries that should be bundled with the plugin. +# This list could contain prebuilt libraries, or libraries created by an +# external build triggered from this build file. +set(cloud_functions_bundled_libraries + "" + PARENT_SCOPE +) diff --git a/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.cpp b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.cpp new file mode 100644 index 000000000000..c6b21b577fcc --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.cpp @@ -0,0 +1,396 @@ +// Copyright 2026, the Chromium project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +#include "cloud_functions_plugin.h" + +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "cloud_functions/plugin_version.h" +#include "firebase/app.h" +#include "firebase/functions.h" +#include "firebase/functions/callable_reference.h" +#include "firebase/functions/callable_result.h" +#include "firebase/functions/common.h" +#include "firebase/future.h" +#include "firebase/variant.h" +#include "messages.g.h" + +using ::firebase::App; +using ::firebase::Future; +using ::firebase::Variant; +using ::firebase::functions::Error; +using ::firebase::functions::Functions; +using ::firebase::functions::HttpsCallableReference; +using ::firebase::functions::HttpsCallableResult; + +namespace cloud_functions_windows { + +static std::string kLibraryName = "flutter-fire-fn"; + +// --- Helper: Convert firebase::Variant to EncodableValue --- +static flutter::EncodableValue VariantToEncodableValue(const Variant& variant) { + switch (variant.type()) { + case Variant::kTypeNull: + return flutter::EncodableValue(); + case Variant::kTypeInt64: + return flutter::EncodableValue(variant.int64_value()); + case Variant::kTypeDouble: + return flutter::EncodableValue(variant.double_value()); + case Variant::kTypeBool: + return flutter::EncodableValue(variant.bool_value()); + case Variant::kTypeStaticString: + return flutter::EncodableValue(std::string(variant.string_value())); + case Variant::kTypeMutableString: + return flutter::EncodableValue(variant.mutable_string()); + case Variant::kTypeVector: { + flutter::EncodableList list; + for (const auto& item : variant.vector()) { + list.push_back(VariantToEncodableValue(item)); + } + return flutter::EncodableValue(list); + } + case Variant::kTypeMap: { + flutter::EncodableMap map; + for (const auto& kv : variant.map()) { + map[VariantToEncodableValue(kv.first)] = + VariantToEncodableValue(kv.second); + } + return flutter::EncodableValue(map); + } + case Variant::kTypeStaticBlob: + case Variant::kTypeMutableBlob: { + const uint8_t* data = static_cast(variant.blob_data()); + if (data == nullptr || variant.blob_size() == 0) { + return flutter::EncodableValue(std::vector()); + } + return flutter::EncodableValue( + std::vector(data, data + variant.blob_size())); + } + default: + return flutter::EncodableValue(); + } +} + +// --- Helper: Convert EncodableValue to firebase::Variant --- +static Variant EncodableValueToVariant(const flutter::EncodableValue& value) { + if (std::holds_alternative(value)) { + return Variant::Null(); + } else if (std::holds_alternative(value)) { + return Variant(std::get(value)); + } else if (std::holds_alternative(value)) { + return Variant(static_cast(std::get(value))); + } else if (std::holds_alternative(value)) { + return Variant(std::get(value)); + } else if (std::holds_alternative(value)) { + return Variant(std::get(value)); + } else if (std::holds_alternative(value)) { + return Variant(std::get(value)); + } else if (std::holds_alternative>(value)) { + const auto& bytes = std::get>(value); + // bytes.data() may be null for an empty vector; give the SDK a valid + // pointer regardless. + return bytes.empty() ? Variant::FromMutableBlob("", 0) + : Variant::FromMutableBlob(bytes.data(), bytes.size()); + } else if (std::holds_alternative>(value)) { + std::vector vec; + for (int32_t item : std::get>(value)) { + vec.push_back(Variant(static_cast(item))); + } + return Variant(vec); + } else if (std::holds_alternative>(value)) { + std::vector vec; + for (int64_t item : std::get>(value)) { + vec.push_back(Variant(item)); + } + return Variant(vec); + } else if (std::holds_alternative>(value)) { + std::vector vec; + for (float item : std::get>(value)) { + vec.push_back(Variant(static_cast(item))); + } + return Variant(vec); + } else if (std::holds_alternative>(value)) { + std::vector vec; + for (double item : std::get>(value)) { + vec.push_back(Variant(item)); + } + return Variant(vec); + } else if (std::holds_alternative(value)) { + std::vector vec; + for (const auto& item : std::get(value)) { + vec.push_back(EncodableValueToVariant(item)); + } + return Variant(vec); + } else if (std::holds_alternative(value)) { + std::map variant_map; + for (const auto& kv : std::get(value)) { + variant_map[EncodableValueToVariant(kv.first)] = + EncodableValueToVariant(kv.second); + } + return Variant(variant_map); + } + return Variant::Null(); +} + +// --- Helper: map a Cloud Functions error enum to its canonical string code --- +static std::string GetFunctionsErrorCode(Error error) { + switch (error) { + case Error::kErrorNone: + return "none"; + case Error::kErrorCancelled: + return "cancelled"; + case Error::kErrorInvalidArgument: + return "invalid-argument"; + case Error::kErrorDeadlineExceeded: + return "deadline-exceeded"; + case Error::kErrorNotFound: + return "not-found"; + case Error::kErrorAlreadyExists: + return "already-exists"; + case Error::kErrorPermissionDenied: + return "permission-denied"; + case Error::kErrorResourceExhausted: + return "resource-exhausted"; + case Error::kErrorFailedPrecondition: + return "failed-precondition"; + case Error::kErrorAborted: + return "aborted"; + case Error::kErrorOutOfRange: + return "out-of-range"; + case Error::kErrorUnimplemented: + return "unimplemented"; + case Error::kErrorInternal: + return "internal"; + case Error::kErrorUnavailable: + return "unavailable"; + case Error::kErrorDataLoss: + return "data-loss"; + case Error::kErrorUnauthenticated: + return "unauthenticated"; + case Error::kErrorUnknown: + default: + return "unknown"; + } +} + +// --- Helper: read a string entry from an EncodableMap (or empty) --- +static std::string GetStringArg(const flutter::EncodableMap& map, + const char* key) { + auto it = map.find(flutter::EncodableValue(key)); + if (it == map.end() || !std::holds_alternative(it->second)) { + return std::string(); + } + return std::get(it->second); +} + +// --- Helper: resolve a Functions instance for app + region --- +// The C++ SDK caches instances internally per (app, region), so no local +// cache is kept; a local raw-pointer cache would dangle if an app were +// deleted and recreated. +static Functions* GetFunctionsInstance(const std::string& app_name, + const std::string& region) { + App* app = App::GetInstance(app_name.c_str()); + if (app == nullptr) { + return nullptr; + } + return region.empty() ? Functions::GetInstance(app) + : Functions::GetInstance(app, region.c_str()); +} + +// Per-call bookkeeping shared by the deadline thread and the SDK completion. +// +// The C++ SDK has no per-call deadline API, so the plugin enforces the +// Dart-provided timeout itself. Whichever of the deadline thread and the SDK +// completion runs first delivers the response; the loser only cleans up. +// +// `ref` is heap-allocated because its internals own the transport that runs +// the request on an SDK background thread: a stack local would be destroyed +// when the handler returns, mid-request. It is only released once the SDK +// completion has fired -- but not *on* the completion thread either, since +// OnCompletion runs inside the reference's own Future/transport machinery and +// destroying the reference from there crashes on Windows. The delete is +// therefore handed to a short-lived thread. +struct CallState { + std::mutex mutex; + std::condition_variable cv; + bool responded = false; + HttpsCallableReference* ref = nullptr; +}; + +// Marks the call as responded. Returns true for exactly one caller. +static bool ClaimResponse(CallState& state) { + std::lock_guard lock(state.mutex); + if (state.responded) { + return false; + } + state.responded = true; + return true; +} + +static void ReleaseReference(CallState& state) { + HttpsCallableReference* ref = nullptr; + { + std::lock_guard lock(state.mutex); + ref = state.ref; + state.ref = nullptr; + } + std::thread([ref]() { delete ref; }).detach(); +} + +// Reads the "timeout" argument (milliseconds); 0 when absent or non-integer. +static int64_t GetTimeoutMsArg(const flutter::EncodableMap& arguments) { + auto it = arguments.find(flutter::EncodableValue("timeout")); + if (it == arguments.end()) { + return 0; + } + if (std::holds_alternative(it->second)) { + return std::get(it->second); + } + if (std::holds_alternative(it->second)) { + return std::get(it->second); + } + return 0; +} + +static FlutterError MakeFunctionsError(const std::string& code, + const std::string& message) { + // Dart's platformExceptionToFirebaseFunctionsException reads the canonical + // code/message out of the error details map. + flutter::EncodableMap details; + details[flutter::EncodableValue("code")] = flutter::EncodableValue(code); + details[flutter::EncodableValue("message")] = + flutter::EncodableValue(message); + return FlutterError(code, message, flutter::EncodableValue(details)); +} + +// static +void CloudFunctionsPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarWindows* registrar) { + auto plugin = std::make_unique(); + + CloudFunctionsHostApi::SetUp(registrar->messenger(), plugin.get()); + + registrar->AddPlugin(std::move(plugin)); + + App::RegisterLibrary(kLibraryName.c_str(), getPluginVersion().c_str(), + nullptr); +} + +CloudFunctionsPlugin::CloudFunctionsPlugin() {} + +CloudFunctionsPlugin::~CloudFunctionsPlugin() = default; + +void CloudFunctionsPlugin::Call( + const flutter::EncodableMap& arguments, + std::function> reply)> + result) { + std::string app_name = GetStringArg(arguments, "appName"); + std::string region = GetStringArg(arguments, "region"); + std::string function_name = GetStringArg(arguments, "functionName"); + std::string function_uri = GetStringArg(arguments, "functionUri"); + std::string origin = GetStringArg(arguments, "origin"); + + if (app_name.empty()) { + result(MakeFunctionsError("invalid-argument", "Missing appName")); + return; + } + + Functions* functions = GetFunctionsInstance(app_name, region); + if (functions == nullptr) { + result(MakeFunctionsError("internal", "Functions instance not found")); + return; + } + + if (!origin.empty()) { + functions->UseFunctionsEmulator(origin.c_str()); + } + + auto state = std::make_shared(); + if (!function_name.empty()) { + state->ref = new HttpsCallableReference( + functions->GetHttpsCallable(function_name.c_str())); + } else if (!function_uri.empty()) { + state->ref = new HttpsCallableReference( + functions->GetHttpsCallableFromURL(function_uri.c_str())); + } else { + result(MakeFunctionsError( + "invalid-argument", + "Either functionName or functionUri must be provided")); + return; + } + + Variant parameters = Variant::Null(); + auto parameters_it = arguments.find(flutter::EncodableValue("parameters")); + if (parameters_it != arguments.end()) { + parameters = EncodableValueToVariant(parameters_it->second); + } + + int64_t timeout_ms = GetTimeoutMsArg(arguments); + if (timeout_ms > 0) { + std::thread([state, result, timeout_ms]() { + std::unique_lock lock(state->mutex); + // wait_for returns false only on timeout; a completed request notifies + // the condition variable so this thread exits (and releases its + // captures) immediately instead of sleeping out the full deadline. + bool completed = + state->cv.wait_for(lock, std::chrono::milliseconds(timeout_ms), + [state] { return state->responded; }); + if (completed) { + return; + } + state->responded = true; + lock.unlock(); + result( + MakeFunctionsError("deadline-exceeded", "The operation timed out.")); + }).detach(); + } + + state->ref->Call(parameters) + .OnCompletion([state, result](const Future& future) { + ErrorOr> reply = + std::optional(); + if (future.error() == Error::kErrorNone) { + const HttpsCallableResult* callable_result = future.result(); + if (callable_result != nullptr) { + reply = std::optional( + VariantToEncodableValue(callable_result->data())); + } + } else { + std::string code = + GetFunctionsErrorCode(static_cast(future.error())); + std::string message = + future.error_message() ? future.error_message() : "Unknown error"; + reply = MakeFunctionsError(code, message); + } + + bool deliver = ClaimResponse(*state); + state->cv.notify_all(); + if (deliver) { + result(std::move(reply)); + } + ReleaseReference(*state); + }); +} + +// Streaming callable functions (httpsCallable().stream()) are not supported +// by the Firebase C++ SDK. Fail explicitly rather than silently hanging. +void CloudFunctionsPlugin::RegisterEventChannel( + const flutter::EncodableMap& arguments, + std::function reply)> result) { + result(MakeFunctionsError( + "unimplemented", + "Streaming callable functions are not supported on Windows.")); +} + +} // namespace cloud_functions_windows diff --git a/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.h b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.h new file mode 100644 index 000000000000..139daf3319d1 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin.h @@ -0,0 +1,42 @@ +// Copyright 2026, the Chromium project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +#ifndef FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_H_ +#define FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_H_ + +#include +#include + +#include + +#include "messages.g.h" + +namespace cloud_functions_windows { + +class CloudFunctionsPlugin : public flutter::Plugin, + public CloudFunctionsHostApi { + public: + static void RegisterWithRegistrar(flutter::PluginRegistrarWindows* registrar); + + CloudFunctionsPlugin(); + + virtual ~CloudFunctionsPlugin(); + + // Disallow copy and assign. + CloudFunctionsPlugin(const CloudFunctionsPlugin&) = delete; + CloudFunctionsPlugin& operator=(const CloudFunctionsPlugin&) = delete; + + // CloudFunctionsHostApi + void Call( + const flutter::EncodableMap& arguments, + std::function> reply)> + result) override; + void RegisterEventChannel( + const flutter::EncodableMap& arguments, + std::function reply)> result) override; +}; + +} // namespace cloud_functions_windows + +#endif // FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_H_ diff --git a/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin_c_api.cpp b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin_c_api.cpp new file mode 100644 index 000000000000..6f3ddba63318 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/cloud_functions_plugin_c_api.cpp @@ -0,0 +1,16 @@ +// Copyright 2026, the Chromium project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +#include "include/cloud_functions/cloud_functions_plugin_c_api.h" + +#include + +#include "cloud_functions_plugin.h" + +void CloudFunctionsPluginCApiRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar) { + cloud_functions_windows::CloudFunctionsPlugin::RegisterWithRegistrar( + flutter::PluginRegistrarManager::GetInstance() + ->GetRegistrar(registrar)); +} diff --git a/packages/cloud_functions/cloud_functions/windows/include/cloud_functions/cloud_functions_plugin_c_api.h b/packages/cloud_functions/cloud_functions/windows/include/cloud_functions/cloud_functions_plugin_c_api.h new file mode 100644 index 000000000000..e8c185de54f8 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/include/cloud_functions/cloud_functions_plugin_c_api.h @@ -0,0 +1,27 @@ +// Copyright 2026, the Chromium project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +#ifndef FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_C_API_H_ +#define FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_C_API_H_ + +#include + +#ifdef FLUTTER_PLUGIN_IMPL +#define FLUTTER_PLUGIN_EXPORT __declspec(dllexport) +#else +#define FLUTTER_PLUGIN_EXPORT __declspec(dllimport) +#endif + +#if defined(__cplusplus) +extern "C" { +#endif + +FLUTTER_PLUGIN_EXPORT void CloudFunctionsPluginCApiRegisterWithRegistrar( + FlutterDesktopPluginRegistrarRef registrar); + +#if defined(__cplusplus) +} // extern "C" +#endif + +#endif // FLUTTER_PLUGIN_CLOUD_FUNCTIONS_PLUGIN_C_API_H_ diff --git a/packages/cloud_functions/cloud_functions/windows/plugin_version.h.in b/packages/cloud_functions/cloud_functions/windows/plugin_version.h.in new file mode 100644 index 000000000000..78aea8c9c299 --- /dev/null +++ b/packages/cloud_functions/cloud_functions/windows/plugin_version.h.in @@ -0,0 +1,13 @@ +// Copyright 2026, the Chromium project authors. Please see the AUTHORS file +// for details. All rights reserved. Use of this source code is governed by a +// BSD-style license that can be found in the LICENSE file. + +#ifndef PLUGIN_VERSION_CONFIG_H +#define PLUGIN_VERSION_CONFIG_H + +namespace cloud_functions_windows { + +std::string getPluginVersion() { return "@PLUGIN_VERSION@"; } +} // namespace cloud_functions_windows + +#endif // PLUGIN_VERSION_CONFIG_H diff --git a/packages/firebase_core/firebase_core/windows/CMakeLists.txt b/packages/firebase_core/firebase_core/windows/CMakeLists.txt index d95b97353e9c..06252b4eb766 100644 --- a/packages/firebase_core/firebase_core/windows/CMakeLists.txt +++ b/packages/firebase_core/firebase_core/windows/CMakeLists.txt @@ -122,7 +122,7 @@ add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL) target_include_directories(${PLUGIN_NAME} INTERFACE "${FIREBASE_CPP_SDK_DIR}/include") -set(FIREBASE_RELEASE_PATH_LIBS firebase_app firebase_auth firebase_remote_config firebase_storage firebase_firestore firebase_database firebase_app_check) +set(FIREBASE_RELEASE_PATH_LIBS firebase_app firebase_auth firebase_remote_config firebase_storage firebase_firestore firebase_database firebase_app_check firebase_functions) foreach(firebase_lib IN ITEMS ${FIREBASE_RELEASE_PATH_LIBS}) get_target_property(firebase_lib_path ${firebase_lib} IMPORTED_LOCATION) string(REPLACE "Debug" "Release" firebase_lib_release_path ${firebase_lib_path}) diff --git a/tests/windows/flutter/generated_plugin_registrant.cc b/tests/windows/flutter/generated_plugin_registrant.cc index b6d55c18d245..886783e3107b 100644 --- a/tests/windows/flutter/generated_plugin_registrant.cc +++ b/tests/windows/flutter/generated_plugin_registrant.cc @@ -6,6 +6,7 @@ #include "generated_plugin_registrant.h" +#include #include #include #include @@ -14,6 +15,8 @@ #include void RegisterPlugins(flutter::PluginRegistry* registry) { + CloudFunctionsPluginCApiRegisterWithRegistrar( + registry->GetRegistrarForPlugin("CloudFunctionsPluginCApi")); FirebaseAppCheckPluginCApiRegisterWithRegistrar( registry->GetRegistrarForPlugin("FirebaseAppCheckPluginCApi")); FirebaseAuthPluginCApiRegisterWithRegistrar( diff --git a/tests/windows/flutter/generated_plugins.cmake b/tests/windows/flutter/generated_plugins.cmake index 89f9a20f171a..98f446b80d56 100644 --- a/tests/windows/flutter/generated_plugins.cmake +++ b/tests/windows/flutter/generated_plugins.cmake @@ -3,6 +3,7 @@ # list(APPEND FLUTTER_PLUGIN_LIST + cloud_functions firebase_app_check firebase_auth firebase_core