From 7a7f7eff8070bf88d4c90d107c8f942c34afa3f1 Mon Sep 17 00:00:00 2001 From: Guillaume Bernos Date: Tue, 11 Aug 2026 14:26:12 +0200 Subject: [PATCH 1/2] fix(database,windows): fix transaction threwing and native error codes dropped --- .github/workflows/e2e_tests_database.yaml | 10 + .../lib/src/exception.dart | 22 +- .../test/exception_test.dart | 162 ++++++++++ .../database/FirebaseDatabasePlugin.kt | 31 +- .../database_reference_e2e.dart | 84 +++++- .../example/windows/.gitignore | 17 ++ .../example/windows/CMakeLists.txt | 108 +++++++ .../example/windows/flutter/CMakeLists.txt | 109 +++++++ .../example/windows/runner/CMakeLists.txt | 40 +++ .../example/windows/runner/Runner.rc | 121 ++++++++ .../example/windows/runner/flutter_window.cpp | 73 +++++ .../example/windows/runner/flutter_window.h | 39 +++ .../example/windows/runner/main.cpp | 46 +++ .../example/windows/runner/resource.h | 22 ++ .../windows/runner/resources/app_icon.ico | Bin 0 -> 33772 bytes .../windows/runner/runner.exe.manifest | 14 + .../example/windows/runner/utils.cpp | 75 +++++ .../example/windows/runner/utils.h | 25 ++ .../example/windows/runner/win32_window.cpp | 284 ++++++++++++++++++ .../example/windows/runner/win32_window.h | 106 +++++++ .../FLTFirebaseDatabasePlugin.swift | 21 +- .../windows/firebase_database_plugin.cpp | 168 +++++++++-- .../windows/firebase_database_plugin.h | 2 + 23 files changed, 1538 insertions(+), 41 deletions(-) create mode 100644 packages/_flutterfire_internals/test/exception_test.dart create mode 100644 packages/firebase_database/firebase_database/example/windows/.gitignore create mode 100644 packages/firebase_database/firebase_database/example/windows/CMakeLists.txt create mode 100644 packages/firebase_database/firebase_database/example/windows/flutter/CMakeLists.txt create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/CMakeLists.txt create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/Runner.rc create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/flutter_window.cpp create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/flutter_window.h create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/main.cpp create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/resource.h create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/resources/app_icon.ico create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/runner.exe.manifest create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/utils.cpp create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/utils.h create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/win32_window.cpp create mode 100644 packages/firebase_database/firebase_database/example/windows/runner/win32_window.h diff --git a/.github/workflows/e2e_tests_database.yaml b/.github/workflows/e2e_tests_database.yaml index fd100936a7c4..5e801fbd82fa 100644 --- a/.github/workflows/e2e_tests_database.yaml +++ b/.github/workflows/e2e_tests_database.yaml @@ -89,3 +89,13 @@ jobs: package-scope: 'firebase_database*' native-config-args: '--database-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/firebase_database/firebase_database' + package-scope: 'firebase_database*' + native-config-args: '--database-native' + nightly_test_mode: ${{ inputs.nightly_test_mode == true }} diff --git a/packages/_flutterfire_internals/lib/src/exception.dart b/packages/_flutterfire_internals/lib/src/exception.dart index f6fa5039fc06..534d9c2cf7d9 100644 --- a/packages/_flutterfire_internals/lib/src/exception.dart +++ b/packages/_flutterfire_internals/lib/src/exception.dart @@ -31,9 +31,11 @@ Never convertPlatformExceptionToFirebaseException( /// Converts a [PlatformException] into a [FirebaseException]. /// -/// A [PlatformException] can only be converted to a [FirebaseException] if the -/// `details` of the exception exist. Firebase returns specific codes and messages -/// which can be converted into user friendly exceptions. +/// Firebase returns specific codes and messages which can be converted into +/// user friendly exceptions. Most native implementations carry them in the +/// `details` of the exception, but a code sent as [PlatformException.code] is +/// honoured as well: the Windows plugins report native Firebase codes that way, +/// with no `details` payload at all. FirebaseException platformExceptionToFirebaseException( PlatformException platformException, { required String plugin, @@ -54,6 +56,20 @@ FirebaseException platformExceptionToFirebaseException( message = details['message'] as String? ?? message; } else if (rawDetails != null) { message = rawDetails.toString(); + } else if (platformException.code.isNotEmpty && + platformException.code != plugin) { + // With no `details` payload at all, honour a code sent in the standard + // `PlatformException.code` field: the Windows plugins report native + // Firebase codes that way, because the Pigeon C++ + // `FlutterError(code, message)` and `EventSink::Error(code, message)` + // overloads both send null details. Without this the code is lost and every + // such error surfaces as `unknown`. + // + // The plugin name itself is not a code - the Android and Windows Pigeon + // APIs send it in that field as a channel-level marker and carry the real + // code in `details` - so it is treated as absent rather than reported as + // `FirebaseException(code: 'firebase_database')`. + code = platformException.code; } return FirebaseException( diff --git a/packages/_flutterfire_internals/test/exception_test.dart b/packages/_flutterfire_internals/test/exception_test.dart new file mode 100644 index 000000000000..5bca5596edf5 --- /dev/null +++ b/packages/_flutterfire_internals/test/exception_test.dart @@ -0,0 +1,162 @@ +// 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. + +import 'package:_flutterfire_internals/_flutterfire_internals.dart'; +import 'package:firebase_core/firebase_core.dart'; +import 'package:flutter/services.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + group('platformExceptionToFirebaseException', () { + test('reads the code and message from a details map', () { + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'firebase_database', + message: 'a channel level message', + details: { + 'code': 'permission-denied', + 'message': "Client doesn't have permission to access the desired " + 'data.', + }, + ), + plugin: 'firebase_database', + ); + + expect(exception.plugin, 'firebase_database'); + expect(exception.code, 'permission-denied'); + expect( + exception.message, + "Client doesn't have permission to access the desired data.", + ); + }); + + test('keeps the platform message when details omit one', () { + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'firebase_database', + message: 'a channel level message', + details: {'code': 'permission-denied'}, + ), + plugin: 'firebase_database', + ); + + expect(exception.code, 'permission-denied'); + expect(exception.message, 'a channel level message'); + }); + + // Regression test for https://github.com/firebase/flutterfire/issues/18550: + // the Windows plugins send the native code as `PlatformException.code` with + // no details payload, and it used to be dropped in favour of `unknown`. + test('falls back to PlatformException.code when there are no details', () { + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'permission-denied', + message: "Client doesn't have permission to access the desired data.", + ), + plugin: 'firebase_database', + ); + + expect(exception.code, 'permission-denied'); + expect( + exception.message, + "Client doesn't have permission to access the desired data.", + ); + }); + + test('ignores PlatformException.code when a details payload is present', () { + // Pigeon's generic error path sends the exception class name as the code + // and a stack trace as the details, so a details payload without a code + // means there is no Firebase code to report. + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'DatabaseException', + message: 'Firebase Database error: Permission denied', + details: 'a stack trace', + ), + plugin: 'firebase_database', + ); + + expect(exception.code, 'unknown'); + expect(exception.message, 'a stack trace'); + }); + + test('prefers the details code over PlatformException.code', () { + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'firebase_database', + details: {'code': 'permission-denied'}, + ), + plugin: 'firebase_database', + ); + + expect(exception.code, 'permission-denied'); + }); + + test('does not report the plugin name as a code', () { + // The Android and Windows Pigeon APIs put the plugin name in + // `PlatformException.code` as a channel-level marker. + final exception = platformExceptionToFirebaseException( + PlatformException( + code: 'firebase_database', + message: 'Firebase Database error: Permission denied', + ), + plugin: 'firebase_database', + ); + + expect(exception.code, 'unknown'); + expect(exception.message, 'Firebase Database error: Permission denied'); + }); + + test('falls back to unknown when no code is available at all', () { + final exception = platformExceptionToFirebaseException( + PlatformException(code: '', message: 'no code anywhere'), + plugin: 'firebase_database', + ); + + expect(exception.code, 'unknown'); + expect(exception.message, 'no code anywhere'); + }); + + test('stringifies non-map details into the message', () { + final exception = platformExceptionToFirebaseException( + PlatformException(code: 'unavailable', details: 'a string detail'), + plugin: 'firebase_database', + ); + + expect(exception.code, 'unknown'); + expect(exception.message, 'a string detail'); + }); + }); + + group('convertPlatformExceptionToFirebaseException', () { + test('converts a PlatformException and preserves the stack trace', () { + final stackTrace = StackTrace.current; + + try { + convertPlatformExceptionToFirebaseException( + PlatformException(code: 'permission-denied', message: 'denied'), + stackTrace, + plugin: 'firebase_database', + ); + } on FirebaseException catch (error, stack) { + expect(error.code, 'permission-denied'); + expect(error.message, 'denied'); + expect(stack, stackTrace); + } + }); + + test('rethrows exceptions that are not PlatformExceptions', () { + final error = StateError('not a platform exception'); + + expect( + () => convertPlatformExceptionToFirebaseException( + error, + StackTrace.current, + plugin: 'firebase_database', + ), + throwsA(same(error)), + ); + }); + }); +} diff --git a/packages/firebase_database/firebase_database/android/src/main/kotlin/io/flutter/plugins/firebase/database/FirebaseDatabasePlugin.kt b/packages/firebase_database/firebase_database/android/src/main/kotlin/io/flutter/plugins/firebase/database/FirebaseDatabasePlugin.kt index 0654954d2c81..ee6a1cf8a381 100644 --- a/packages/firebase_database/firebase_database/android/src/main/kotlin/io/flutter/plugins/firebase/database/FirebaseDatabasePlugin.kt +++ b/packages/firebase_database/firebase_database/android/src/main/kotlin/io/flutter/plugins/firebase/database/FirebaseDatabasePlugin.kt @@ -607,6 +607,25 @@ class FirebaseDatabasePlugin : FlutterFirebasePlugin, FlutterPlugin, FirebaseDat } } + /** + * Wraps a failed write in a [FlutterError] that carries the Realtime Database code in its + * details, the way the transaction path already does. + * + * `FlutterError("firebase_database", message, null)` drops the code: the Dart converter reads it + * out of the details map, so every failure used to reach Dart as `unknown`. + */ + private fun writeFlutterError(exception: Exception?): FlutterError { + val databaseException = + when (exception) { + null -> FlutterFirebaseDatabaseException.unknown() + is FlutterFirebaseDatabaseException -> exception + is DatabaseException -> FlutterFirebaseDatabaseException.fromDatabaseException(exception) + else -> FlutterFirebaseDatabaseException.fromException(exception) + } + return FlutterError( + "firebase_database", databaseException.message, databaseException.additionalData) + } + override fun databaseReferenceSet( app: DatabasePigeonFirebaseApp, request: DatabaseReferenceRequest, @@ -623,9 +642,7 @@ class FirebaseDatabasePlugin : FlutterFirebasePlugin, FlutterPlugin, FirebaseDat if (completedTask.isSuccessful) { callback(KotlinResult.success(Unit)) } else { - val exception = completedTask.exception ?: Exception("Unknown error setting value") - callback( - KotlinResult.failure(FlutterError("firebase_database", exception.message, null))) + callback(KotlinResult.failure(writeFlutterError(completedTask.exception))) } } } @@ -665,10 +682,7 @@ class FirebaseDatabasePlugin : FlutterFirebasePlugin, FlutterPlugin, FirebaseDat if (completedTask.isSuccessful) { callback(KotlinResult.success(Unit)) } else { - val exception = - completedTask.exception ?: Exception("Unknown error setting value with priority") - callback( - KotlinResult.failure(FlutterError("firebase_database", exception.message, null))) + callback(KotlinResult.failure(writeFlutterError(completedTask.exception))) } } } @@ -691,8 +705,7 @@ class FirebaseDatabasePlugin : FlutterFirebasePlugin, FlutterPlugin, FirebaseDat if (task.isSuccessful) { callback(KotlinResult.success(Unit)) } else { - val exception = task.exception - callback(KotlinResult.failure(FlutterError("firebase_database", exception?.message, null))) + callback(KotlinResult.failure(writeFlutterError(task.exception))) } } } diff --git a/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart b/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart index d3e33c703f75..f3639640829b 100644 --- a/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart +++ b/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart @@ -7,6 +7,7 @@ import 'dart:math'; import 'package:firebase_core/firebase_core.dart'; import 'package:firebase_database/firebase_database.dart'; +import 'package:flutter/foundation.dart'; import 'package:flutter_test/flutter_test.dart'; import 'e2e_test.dart'; @@ -42,6 +43,26 @@ void setupDatabaseReferenceTests() { expect(after.value, isNull); expect(after.exists, isFalse); }); + + // Regression test for + // https://github.com/firebase/flutterfire/issues/18550: the Windows + // plugin computed a mapped code but sent it without a Pigeon `details` + // payload, so every native error reached Dart as `unknown` with the code + // dropped. + test('a rejected write keeps its native error code and message', + () async { + // `denied_read` denies reads and writes in database.rules.json. + final ref = database.ref('denied_read/rejected-write'); + + await expectLater( + ref.set('probe'), + throwsA( + isA() + .having((e) => e.code, 'code', 'permission-denied') + .having((e) => e.message, 'message', isNotEmpty), + ), + ); + }); }); group('setPriority()', () { @@ -106,6 +127,57 @@ void setupDatabaseReferenceTests() { expect(result.snapshot.value, 5); }); + // Regression test for + // https://github.com/firebase/flutterfire/issues/18549: on Windows an + // abort decided on the handler's *first* invocation threw a + // FirebaseException instead of resolving with `committed: false`. The + // desktop C++ SDK completes that path with `kErrorWriteCanceled` and no + // message, never with the `kErrorTransactionAbortedByUser` the mobile + // SDKs use. + test('aborts on the first handler invocation without throwing', () async { + final ref = _uniqueRef('transaction-abort-first-invocation'); + await ref.set('unchanged'); + + var invocations = 0; + Object? seenValue; + final result = await ref.runTransaction((value) { + invocations++; + seenValue = value; + return Transaction.abort(); + }); + + // Aborting ends the transaction, so the handler runs exactly once and + // the result reports the data that invocation saw (which is the local + // cache, not necessarily the stored value). + expect(invocations, 1); + expect(result.committed, false); + expect(result.snapshot.value, seenValue); + + // An aborted transaction must not touch the stored value. + final snapshot = await ref.get(); + expect(snapshot.value, 'unchanged'); + }); + + test( + 'rethrows an error thrown by the handler and does not commit', + () async { + final ref = _uniqueRef('transaction-handler-throws'); + await ref.set('unchanged'); + await ref.get(); + + await expectLater( + ref.runTransaction((value) => throw StateError('handler failed')), + throwsA(isA()), + ); + + final snapshot = await ref.get(); + expect(snapshot.value, 'unchanged'); + }, + // On web the handler runs inside a JS callback, so a Dart error thrown + // from it does not come back as the original Dart error. + skip: kIsWeb, + ); + test('does not emit local transaction events when disabled', () async { final ref = _uniqueRef('transaction-apply-locally-false'); await ref.set({'count': 0}); @@ -186,7 +258,17 @@ void setupDatabaseReferenceTests() { final streamError = await errorReceived.future.timeout(const Duration(seconds: 30)); expect(streamError, isA()); - expect(streamError.code, 'permission-denied'); + if (defaultTargetPlatform == TargetPlatform.windows) { + // The desktop C++ SDK replaces any non-`datastale` server error on a + // *sent* transaction with `kErrorUnknownError` and an empty message + // before the plugin can see it, so the real code cannot reach Dart on + // this path: https://github.com/firebase/firebase-cpp-sdk/issues/1904 + // Plain writes are unaffected - see the `set()` test above, which + // asserts `permission-denied` on every platform. + expect(streamError.code, 'unknown'); + } else { + expect(streamError.code, 'permission-denied'); + } }); test('Server.increment', () async { diff --git a/packages/firebase_database/firebase_database/example/windows/.gitignore b/packages/firebase_database/firebase_database/example/windows/.gitignore new file mode 100644 index 000000000000..d492d0d98c8f --- /dev/null +++ b/packages/firebase_database/firebase_database/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/firebase_database/firebase_database/example/windows/CMakeLists.txt b/packages/firebase_database/firebase_database/example/windows/CMakeLists.txt new file mode 100644 index 000000000000..ef3500dad4fe --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/CMakeLists.txt @@ -0,0 +1,108 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(firebase_database_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 "firebase_database_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/firebase_database/firebase_database/example/windows/flutter/CMakeLists.txt b/packages/firebase_database/firebase_database/example/windows/flutter/CMakeLists.txt new file mode 100644 index 000000000000..903f4899d6fc --- /dev/null +++ b/packages/firebase_database/firebase_database/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/firebase_database/firebase_database/example/windows/runner/CMakeLists.txt b/packages/firebase_database/firebase_database/example/windows/runner/CMakeLists.txt new file mode 100644 index 000000000000..394917c053a0 --- /dev/null +++ b/packages/firebase_database/firebase_database/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/firebase_database/firebase_database/example/windows/runner/Runner.rc b/packages/firebase_database/firebase_database/example/windows/runner/Runner.rc new file mode 100644 index 000000000000..c59fd9d9616e --- /dev/null +++ b/packages/firebase_database/firebase_database/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.database" "\0" + VALUE "FileDescription", "firebase_database_example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "firebase_database_example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2026 io.flutter.plugins.firebase.database. All rights reserved." "\0" + VALUE "OriginalFilename", "firebase_database_example.exe" "\0" + VALUE "ProductName", "firebase_database_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/firebase_database/firebase_database/example/windows/runner/flutter_window.cpp b/packages/firebase_database/firebase_database/example/windows/runner/flutter_window.cpp new file mode 100644 index 000000000000..5ebed39dfc68 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/flutter_window.cpp @@ -0,0 +1,73 @@ +// 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 "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/firebase_database/firebase_database/example/windows/runner/flutter_window.h b/packages/firebase_database/firebase_database/example/windows/runner/flutter_window.h new file mode 100644 index 000000000000..e2cf68443060 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/flutter_window.h @@ -0,0 +1,39 @@ +/* + * 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 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/firebase_database/firebase_database/example/windows/runner/main.cpp b/packages/firebase_database/firebase_database/example/windows/runner/main.cpp new file mode 100644 index 000000000000..72d841a98e77 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/main.cpp @@ -0,0 +1,46 @@ +// 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 +#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"firebase_database_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/firebase_database/firebase_database/example/windows/runner/resource.h b/packages/firebase_database/firebase_database/example/windows/runner/resource.h new file mode 100644 index 000000000000..89f26a9b61c3 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/resource.h @@ -0,0 +1,22 @@ +/* + * 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. + */ + +//{{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/firebase_database/firebase_database/example/windows/runner/resources/app_icon.ico b/packages/firebase_database/firebase_database/example/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000000000000000000000000000000000000..c04e20caf6370ebb9253ad831cc31de4a9c965f6 GIT binary patch literal 33772 zcmeHQc|26z|35SKE&G-*mXah&B~fFkXr)DEO&hIfqby^T&>|8^_Ub8Vp#`BLl3lbZ zvPO!8k!2X>cg~Elr=IVxo~J*a`+9wR=A83c-k-DFd(XM&UI1VKCqM@V;DDtJ09WB} zRaHKiW(GT00brH|0EeTeKVbpbGZg?nK6-j827q-+NFM34gXjqWxJ*a#{b_apGN<-L_m3#8Z26atkEn& ze87Bvv^6vVmM+p+cQ~{u%=NJF>#(d;8{7Q{^rWKWNtf14H}>#&y7$lqmY6xmZryI& z($uy?c5-+cPnt2%)R&(KIWEXww>Cnz{OUpT>W$CbO$h1= z#4BPMkFG1Y)x}Ui+WXr?Z!w!t_hjRq8qTaWpu}FH{MsHlU{>;08goVLm{V<&`itk~ zE_Ys=D(hjiy+5=?=$HGii=Y5)jMe9|wWoD_K07(}edAxh`~LBorOJ!Cf@f{_gNCC| z%{*04ViE!#>@hc1t5bb+NO>ncf@@Dv01K!NxH$3Eg1%)|wLyMDF8^d44lV!_Sr}iEWefOaL z8f?ud3Q%Sen39u|%00W<#!E=-RpGa+H8}{ulxVl4mwpjaU+%2pzmi{3HM)%8vb*~-M9rPUAfGCSos8GUXp02|o~0BTV2l#`>>aFV&_P$ejS;nGwSVP8 zMbOaG7<7eKD>c12VdGH;?2@q7535sa7MN*L@&!m?L`ASG%boY7(&L5imY#EQ$KrBB z4@_tfP5m50(T--qv1BJcD&aiH#b-QC>8#7Fx@3yXlonJI#aEIi=8&ChiVpc#N=5le zM*?rDIdcpawoc5kizv$GEjnveyrp3sY>+5_R5;>`>erS%JolimF=A^EIsAK zsPoVyyUHCgf0aYr&alx`<)eb6Be$m&`JYSuBu=p8j%QlNNp$-5C{b4#RubPb|CAIS zGE=9OFLP7?Hgc{?k45)84biT0k&-C6C%Q}aI~q<(7BL`C#<6HyxaR%!dFx7*o^laG z=!GBF^cwK$IA(sn9y6>60Rw{mYRYkp%$jH z*xQM~+bp)G$_RhtFPYx2HTsWk80+p(uqv9@I9)y{b$7NK53rYL$ezbmRjdXS?V}fj zWxX_feWoLFNm3MG7pMUuFPs$qrQWO9!l2B(SIuy2}S|lHNbHzoE+M2|Zxhjq9+Ws8c{*}x^VAib7SbxJ*Q3EnY5lgI9 z=U^f3IW6T=TWaVj+2N%K3<%Un;CF(wUp`TC&Y|ZjyFu6co^uqDDB#EP?DV5v_dw~E zIRK*BoY9y-G_ToU2V_XCX4nJ32~`czdjT!zwme zGgJ0nOk3U4@IE5JwtM}pwimLjk{ln^*4HMU%Fl4~n(cnsLB}Ja-jUM>xIB%aY;Nq8 z)Fp8dv1tkqKanv<68o@cN|%thj$+f;zGSO7H#b+eMAV8xH$hLggtt?O?;oYEgbq@= zV(u9bbd12^%;?nyk6&$GPI%|+<_mEpJGNfl*`!KV;VfmZWw{n{rnZ51?}FDh8we_L z8OI9nE31skDqJ5Oa_ybn7|5@ui>aC`s34p4ZEu6-s!%{uU45$Zd1=p$^^dZBh zu<*pDDPLW+c>iWO$&Z_*{VSQKg7=YEpS3PssPn1U!lSm6eZIho*{@&20e4Y_lRklKDTUCKI%o4Pc<|G^Xgu$J^Q|B87U;`c1zGwf^-zH*VQ^x+i^OUWE0yd z;{FJq)2w!%`x7yg@>uGFFf-XJl4H`YtUG%0slGKOlXV`q?RP>AEWg#x!b{0RicxGhS!3$p7 zij;{gm!_u@D4$Ox%>>bPtLJ> zwKtYz?T_DR1jN>DkkfGU^<#6sGz|~p*I{y`aZ>^Di#TC|Z!7j_O1=Wo8thuit?WxR zh9_S>kw^{V^|g}HRUF=dcq>?q(pHxw!8rx4dC6vbQVmIhmICF#zU!HkHpQ>9S%Uo( zMw{eC+`&pb=GZRou|3;Po1}m46H6NGd$t<2mQh}kaK-WFfmj_66_17BX0|j-E2fe3Jat}ijpc53 zJV$$;PC<5aW`{*^Z6e5##^`Ed#a0nwJDT#Qq~^e8^JTA=z^Kl>La|(UQ!bI@#ge{Dzz@61p-I)kc2?ZxFt^QQ}f%ldLjO*GPj(5)V9IyuUakJX=~GnTgZ4$5!3E=V#t`yOG4U z(gphZB6u2zsj=qNFLYShhg$}lNpO`P9xOSnO*$@@UdMYES*{jJVj|9z-}F^riksLK zbsU+4-{281P9e2UjY6tse^&a)WM1MFw;p#_dHhWI7p&U*9TR0zKdVuQed%6{otTsq z$f~S!;wg#Bd9kez=Br{m|66Wv z#g1xMup<0)H;c2ZO6su_ii&m8j&+jJz4iKnGZ&wxoQX|5a>v&_e#6WA!MB_4asTxLRGQCC5cI(em z%$ZfeqP>!*q5kU>a+BO&ln=4Jm>Ef(QE8o&RgLkk%2}4Tf}U%IFP&uS7}&|Q-)`5< z+e>;s#4cJ-z%&-^&!xsYx777Wt(wZY9(3(avmr|gRe4cD+a8&!LY`1^T?7x{E<=kdY9NYw>A;FtTvQ=Y&1M%lyZPl$ss1oY^Sl8we}n}Aob#6 zl4jERwnt9BlSoWb@3HxYgga(752Vu6Y)k4yk9u~Kw>cA5&LHcrvn1Y-HoIuFWg~}4 zEw4bR`mXZQIyOAzo)FYqg?$5W<;^+XX%Uz61{-L6@eP|lLH%|w?g=rFc;OvEW;^qh z&iYXGhVt(G-q<+_j}CTbPS_=K>RKN0&;dubh0NxJyDOHFF;<1k!{k#7b{|Qok9hac z;gHz}6>H6C6RnB`Tt#oaSrX0p-j-oRJ;_WvS-qS--P*8}V943RT6kou-G=A+7QPGQ z!ze^UGxtW3FC0$|(lY9^L!Lx^?Q8cny(rR`es5U;-xBhphF%_WNu|aO<+e9%6LuZq zt(0PoagJG<%hyuf;te}n+qIl_Ej;czWdc{LX^pS>77s9t*2b4s5dvP_!L^3cwlc)E!(!kGrg~FescVT zZCLeua3f4;d;Tk4iXzt}g}O@nlK3?_o91_~@UMIl?@77Qc$IAlLE95#Z=TES>2E%z zxUKpK{_HvGF;5%Q7n&vA?`{%8ohlYT_?(3A$cZSi)MvIJygXD}TS-3UwyUxGLGiJP znblO~G|*uA^|ac8E-w#}uBtg|s_~s&t>-g0X%zIZ@;o_wNMr_;{KDg^O=rg`fhDZu zFp(VKd1Edj%F zWHPl+)FGj%J1BO3bOHVfH^3d1F{)*PL&sRX`~(-Zy3&9UQX)Z;c51tvaI2E*E7!)q zcz|{vpK7bjxix(k&6=OEIBJC!9lTkUbgg?4-yE{9+pFS)$Ar@vrIf`D0Bnsed(Cf? zObt2CJ>BKOl>q8PyFO6w)+6Iz`LW%T5^R`U_NIW0r1dWv6OY=TVF?N=EfA(k(~7VBW(S;Tu5m4Lg8emDG-(mOSSs=M9Q&N8jc^Y4&9RqIsk(yO_P(mcCr}rCs%1MW1VBrn=0-oQN(Xj!k%iKV zb%ricBF3G4S1;+8lzg5PbZ|$Se$)I=PwiK=cDpHYdov2QO1_a-*dL4KUi|g&oh>(* zq$<`dQ^fat`+VW?m)?_KLn&mp^-@d=&7yGDt<=XwZZC=1scwxO2^RRI7n@g-1o8ps z)&+et_~)vr8aIF1VY1Qrq~Xe``KJrQSnAZ{CSq3yP;V*JC;mmCT6oRLSs7=GA?@6g zUooM}@tKtx(^|aKK8vbaHlUQqwE0}>j&~YlN3H#vKGm@u)xxS?n9XrOWUfCRa< z`20Fld2f&;gg7zpo{Adh+mqNntMc-D$N^yWZAZRI+u1T1zWHPxk{+?vcS1D>08>@6 zLhE@`gt1Y9mAK6Z4p|u(5I%EkfU7rKFSM=E4?VG9tI;a*@?6!ey{lzN5=Y-!$WFSe z&2dtO>^0@V4WRc#L&P%R(?@KfSblMS+N+?xUN$u3K4Ys%OmEh+tq}fnU}i>6YHM?< zlnL2gl~sF!j!Y4E;j3eIU-lfa`RsOL*Tt<%EFC0gPzoHfNWAfKFIKZN8}w~(Yi~=q z>=VNLO2|CjkxP}RkutxjV#4fWYR1KNrPYq5ha9Wl+u>ipsk*I(HS@iLnmGH9MFlTU zaFZ*KSR0px>o+pL7BbhB2EC1%PJ{67_ z#kY&#O4@P=OV#-79y_W>Gv2dxL*@G7%LksNSqgId9v;2xJ zrh8uR!F-eU$NMx@S*+sk=C~Dxr9Qn7TfWnTupuHKuQ$;gGiBcU>GF5sWx(~4IP3`f zWE;YFO*?jGwYh%C3X<>RKHC-DZ!*r;cIr}GLOno^3U4tFSSoJp%oHPiSa%nh=Zgn% z14+8v@ygy0>UgEN1bczD6wK45%M>psM)y^)IfG*>3ItX|TzV*0i%@>L(VN!zdKb8S?Qf7BhjNpziA zR}?={-eu>9JDcl*R=OP9B8N$IcCETXah9SUDhr{yrld{G;PnCWRsPD7!eOOFBTWUQ=LrA_~)mFf&!zJX!Oc-_=kT<}m|K52 z)M=G#;p;Rdb@~h5D{q^K;^fX-m5V}L%!wVC2iZ1uu401Ll}#rocTeK|7FAeBRhNdQ zCc2d^aQnQp=MpOmak60N$OgS}a;p(l9CL`o4r(e-nN}mQ?M&isv-P&d$!8|1D1I(3-z!wi zTgoo)*Mv`gC?~bm?S|@}I|m-E2yqPEvYybiD5azInexpK8?9q*$9Yy9-t%5jU8~ym zgZDx>!@ujQ=|HJnwp^wv-FdD{RtzO9SnyfB{mH_(c!jHL*$>0o-(h(eqe*ZwF6Lvu z{7rkk%PEqaA>o+f{H02tzZ@TWy&su?VNw43! z-X+rN`6llvpUms3ZiSt)JMeztB~>9{J8SPmYs&qohxdYFi!ra8KR$35Zp9oR)eFC4 zE;P31#3V)n`w$fZ|4X-|%MX`xZDM~gJyl2W;O$H25*=+1S#%|53>|LyH za@yh+;325%Gq3;J&a)?%7X%t@WXcWL*BaaR*7UEZad4I8iDt7^R_Fd`XeUo256;sAo2F!HcIQKk;h})QxEsPE5BcKc7WyerTchgKmrfRX z!x#H_%cL#B9TWAqkA4I$R^8{%do3Y*&(;WFmJ zU7Dih{t1<{($VtJRl9|&EB?|cJ)xse!;}>6mSO$o5XIx@V|AA8ZcoD88ZM?C*;{|f zZVmf94_l1OmaICt`2sTyG!$^UeTHx9YuUP!omj(r|7zpm5475|yXI=rR>>fteLI+| z)MoiGho0oEt=*J(;?VY0QzwCqw@cVm?d7Y!z0A@u#H?sCJ*ecvyhj& z-F77lO;SH^dmf?L>3i>?Z*U}Em4ZYV_CjgfvzYsRZ+1B!Uo6H6mbS<-FFL`ytqvb& zE7+)2ahv-~dz(Hs+f})z{*4|{)b=2!RZK;PWwOnO=hG7xG`JU5>bAvUbdYd_CjvtHBHgtGdlO+s^9ca^Bv3`t@VRX2_AD$Ckg36OcQRF zXD6QtGfHdw*hx~V(MV-;;ZZF#dJ-piEF+s27z4X1qi5$!o~xBnvf=uopcn7ftfsZc zy@(PuOk`4GL_n(H9(E2)VUjqRCk9kR?w)v@xO6Jm_Mx})&WGEl=GS0#)0FAq^J*o! zAClhvoTsNP*-b~rN{8Yym3g{01}Ep^^Omf=SKqvN?{Q*C4HNNAcrowIa^mf+3PRy! z*_G-|3i8a;+q;iP@~Of_$(vtFkB8yOyWt2*K)vAn9El>=D;A$CEx6b*XF@4y_6M+2 zpeW`RHoI_p(B{%(&jTHI->hmNmZjHUj<@;7w0mx3&koy!2$@cfX{sN19Y}euYJFn& z1?)+?HCkD0MRI$~uB2UWri})0bru_B;klFdwsLc!ne4YUE;t41JqfG# zZJq6%vbsdx!wYeE<~?>o4V`A3?lN%MnKQ`z=uUivQN^vzJ|C;sdQ37Qn?;lpzg})y z)_2~rUdH}zNwX;Tp0tJ78+&I=IwOQ-fl30R79O8@?Ub8IIA(6I`yHn%lARVL`%b8+ z4$8D-|MZZWxc_)vu6@VZN!HsI$*2NOV&uMxBNzIbRgy%ob_ zhwEH{J9r$!dEix9XM7n&c{S(h>nGm?el;gaX0@|QnzFD@bne`el^CO$yXC?BDJ|Qg z+y$GRoR`?ST1z^e*>;!IS@5Ovb7*RlN>BV_UC!7E_F;N#ky%1J{+iixp(dUJj93aK zzHNN>R-oN7>kykHClPnoPTIj7zc6KM(Pnlb(|s??)SMb)4!sMHU^-ntJwY5Big7xv zb1Ew`Xj;|D2kzGja*C$eS44(d&RMU~c_Y14V9_TLTz0J#uHlsx`S6{nhsA0dWZ#cG zJ?`fO50E>*X4TQLv#nl%3GOk*UkAgt=IY+u0LNXqeln3Z zv$~&Li`ZJOKkFuS)dJRA>)b_Da%Q~axwA_8zNK{BH{#}#m}zGcuckz}riDE-z_Ms> zR8-EqAMcfyGJCtvTpaUVQtajhUS%c@Yj}&6Zz;-M7MZzqv3kA7{SuW$oW#=0az2wQ zg-WG@Vb4|D`pl~Il54N7Hmsauc_ne-a!o5#j3WaBBh@Wuefb!QJIOn5;d)%A#s+5% zuD$H=VNux9bE-}1&bcYGZ+>1Fo;3Z@e&zX^n!?JK*adSbONm$XW9z;Q^L>9U!}Toj2WdafJ%oL#h|yWWwyAGxzfrAWdDTtaKl zK4`5tDpPg5>z$MNv=X0LZ0d6l%D{(D8oT@+w0?ce$DZ6pv>{1&Ok67Ix1 zH}3=IEhPJEhItCC8E=`T`N5(k?G=B4+xzZ?<4!~ ze~z6Wk9!CHTI(0rLJ4{JU?E-puc;xusR?>G?;4vt;q~iI9=kDL=z0Rr%O$vU`30X$ zDZRFyZ`(omOy@u|i6h;wtJlP;+}$|Ak|k2dea7n?U1*$T!sXqqOjq^NxLPMmk~&qI zYg0W?yK8T(6+Ea+$YyspKK?kP$+B`~t3^Pib_`!6xCs32!i@pqXfFV6PmBIR<-QW= zN8L{pt0Vap0x`Gzn#E@zh@H)0FfVfA_Iu4fjYZ+umO1LXIbVc$pY+E234u)ttcrl$ z>s92z4vT%n6cMb>=XT6;l0+9e(|CZG)$@C7t7Z7Ez@a)h)!hyuV&B5K%%)P5?Lk|C zZZSVzdXp{@OXSP0hoU-gF8s8Um(#xzjP2Vem zec#-^JqTa&Y#QJ>-FBxd7tf`XB6e^JPUgagB8iBSEps;92KG`!#mvVcPQ5yNC-GEG zTiHEDYfH+0O15}r^+ z#jxj=@x8iNHWALe!P3R67TwmhItn**0JwnzSV2O&KE8KcT+0hWH^OPD1pwiuyx=b@ zNf5Jh0{9X)8;~Es)$t@%(3!OnbY+`@?i{mGX7Yy}8T_*0a6g;kaFPq;*=px5EhO{Cp%1kI<0?*|h8v!6WnO3cCJRF2-CRrU3JiLJnj@6;L)!0kWYAc_}F{2P))3HmCrz zQ&N&gE70;`!6*eJ4^1IR{f6j4(-l&X!tjHxkbHA^Zhrnhr9g{exN|xrS`5Pq=#Xf& zG%P=#ra-TyVFfgW%cZo5OSIwFL9WtXAlFOa+ubmI5t*3=g#Y zF%;70p5;{ZeFL}&}yOY1N1*Q;*<(kTB!7vM$QokF)yr2FlIU@$Ph58$Bz z0J?xQG=MlS4L6jA22eS42g|9*9pX@$#*sUeM(z+t?hr@r5J&D1rx}2pW&m*_`VDCW zUYY@v-;bAO0HqoAgbbiGGC<=ryf96}3pouhy3XJrX+!!u*O_>Si38V{uJmQ&USptX zKp#l(?>%^7;2%h(q@YWS#9;a!JhKlkR#Vd)ERILlgu!Hr@jA@V;sk4BJ-H#p*4EqC zDGjC*tl=@3Oi6)Bn^QwFpul18fpkbpg0+peH$xyPBqb%`$OUhPKyWb32o7clB*9Z< zN=i~NLjavrLtwgJ01bufP+>p-jR2I95|TpmKpQL2!oV>g(4RvS2pK4*ou%m(h6r3A zX#s&`9LU1ZG&;{CkOK!4fLDTnBys`M!vuz>Q&9OZ0hGQl!~!jSDg|~s*w52opC{sB ze|Cf2luD(*G13LcOAGA!s2FjSK8&IE5#W%J25w!vM0^VyQM!t)inj&RTiJ!wXzFgz z3^IqzB7I0L$llljsGq})thBy9UOyjtFO_*hYM_sgcMk>44jeH0V1FDyELc{S1F-;A zS;T^k^~4biG&V*Irq}O;e}j$$+E_#G?HKIn05iP3j|87TkGK~SqG!-KBg5+mN(aLm z8ybhIM`%C19UX$H$KY6JgXbY$0AT%rEpHC;u`rQ$Y=rxUdsc5*Kvc8jaYaO$^)cI6){P6K0r)I6DY4Wr4&B zLQUBraey#0HV|&c4v7PVo3n$zHj99(TZO^3?Ly%C4nYvJTL9eLBLHsM3WKKD>5!B` zQ=BsR3aR6PD(Fa>327E2HAu5TM~Wusc!)>~(gM)+3~m;92Jd;FnSib=M5d6;;5{%R zb4V7DEJ0V!CP-F*oU?gkc>ksUtAYP&V4ND5J>J2^jt*vcFflQWCrB&fLdT%O59PVJ zhid#toR=FNgD!q3&r8#wEBr`!wzvQu5zX?Q>nlSJ4i@WC*CN*-xU66F^V5crWevQ9gsq$I@z1o(a=k7LL~ z7m_~`o;_Ozha1$8Q}{WBehvAlO4EL60y5}8GDrZ< zXh&F}71JbW2A~8KfEWj&UWV#4+Z4p`b{uAj4&WC zha`}X@3~+Iz^WRlOHU&KngK>#j}+_o@LdBC1H-`gT+krWX3-;!)6?{FBp~%20a}FL zFP9%Emqcwa#(`=G>BBZ0qZDQhmZKJg_g8<=bBFKWr!dyg(YkpE+|R*SGpDVU!+VlU zFC54^DLv}`qa%49T>nNiA9Q7Ips#!Xx90tCU2gvK`(F+GPcL=J^>No{)~we#o@&mUb6c$ zCc*<|NJBk-#+{j9xkQ&ujB zI~`#kN~7W!f*-}wkG~Ld!JqZ@tK}eeSnsS5J1fMFXm|`LJx&}5`@dK3W^7#Wnm+_P zBZkp&j1fa2Y=eIjJ0}gh85jt43kaIXXv?xmo@eHrka!Z|vQv12HN#+!I5E z`(fbuW>gFiJL|uXJ!vKt#z3e3HlVdboH7;e#i3(2<)Fg-I@BR!qY#eof3MFZ&*Y@l zI|KJf&ge@p2Dq09Vu$$Qxb7!}{m-iRk@!)%KL)txi3;~Z4Pb}u@GsW;ELiWeG9V51 znX#}B&4Y2E7-H=OpNE@q{%hFLxwIpBF2t{vPREa8_{linXT;#1vMRWjOzLOP$-hf( z>=?$0;~~PnkqY;~K{EM6Vo-T(0K{A0}VUGmu*hR z{tw3hvBN%N3G3Yw`X5Te+F{J`(3w1s3-+1EbnFQKcrgrX1Jqvs@ADGe%M0s$EbK$$ zK)=y=upBc6SjGYAACCcI=Y*6Fi8_jgwZlLxD26fnQfJmb8^gHRN5(TemhX@0e=vr> zg`W}6U>x6VhoA3DqsGGD9uL1DhB3!OXO=k}59TqD@(0Nb{)Ut_luTioK_>7wjc!5C zIr@w}b`Fez3)0wQfKl&bae7;PcTA7%?f2xucM0G)wt_KO!Ewx>F~;=BI0j=Fb4>pp zv}0R^xM4eti~+^+gE$6b81p(kwzuDti(-K9bc|?+pJEl@H+jSYuxZQV8rl8 zjp@M{#%qItIUFN~KcO9Hed*`$5A-2~pAo~K&<-Q+`9`$CK>rzqAI4w~$F%vs9s{~x zg4BP%Gy*@m?;D6=SRX?888Q6peF@_4Z->8wAH~Cn!R$|Hhq2cIzFYqT_+cDourHbY z0qroxJnrZ4Gh+Ay+F`_c%+KRT>y3qw{)89?=hJ@=KO=@ep)aBJ$c!JHfBMJpsP*3G za7|)VJJ8B;4?n{~ldJF7%jmb`-ftIvNd~ekoufG(`K(3=LNc;HBY& z(lp#q8XAD#cIf}k49zX_i`*fO+#!zKA&%T3j@%)R+#yag067CU%yUEe47>wzGU8^` z1EXFT^@I!{J!F8!X?S6ph8J=gUi5tl93*W>7}_uR<2N2~e}FaG?}KPyugQ=-OGEZs z!GBoyYY+H*ANn4?Z)X4l+7H%`17i5~zRlRIX?t)6_eu=g2Q`3WBhxSUeea+M-S?RL zX9oBGKn%a!H+*hx4d2(I!gsi+@SQK%<{X22M~2tMulJoa)0*+z9=-YO+;DFEm5eE1U9b^B(Z}2^9!Qk`!A$wUE z7$Ar5?NRg2&G!AZqnmE64eh^Anss3i!{}%6@Et+4rr!=}!SBF8eZ2*J3ujCWbl;3; z48H~goPSv(8X61fKKdpP!Z7$88NL^Z?j`!^*I?-P4X^pMxyWz~@$(UeAcTSDd(`vO z{~rc;9|GfMJcApU3k}22a!&)k4{CU!e_ny^Y3cO;tOvOMKEyWz!vG(Kp*;hB?d|R3`2X~=5a6#^o5@qn?J-bI8Ppip{-yG z!k|VcGsq!jF~}7DMr49Wap-s&>o=U^T0!Lcy}!(bhtYsPQy z4|EJe{12QL#=c(suQ89Mhw9<`bui%nx7Nep`C&*M3~vMEACmcRYYRGtANq$F%zh&V zc)cEVeHz*Z1N)L7k-(k3np#{GcDh2Q@ya0YHl*n7fl*ZPAsbU-a94MYYtA#&!c`xGIaV;yzsmrjfieTEtqB_WgZp2*NplHx=$O{M~2#i_vJ{ps-NgK zQsxKK_CBM2PP_je+Xft`(vYfXXgIUr{=PA=7a8`2EHk)Ym2QKIforz# tySWtj{oF3N9@_;i*Fv5S)9x^z=nlWP>jpp-9)52ZmLVA=i*%6g{{fxOO~wEK literal 0 HcmV?d00001 diff --git a/packages/firebase_database/firebase_database/example/windows/runner/runner.exe.manifest b/packages/firebase_database/firebase_database/example/windows/runner/runner.exe.manifest new file mode 100644 index 000000000000..153653e8d67f --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/runner.exe.manifest @@ -0,0 +1,14 @@ + + + + + PerMonitorV2 + + + + + + + + + diff --git a/packages/firebase_database/firebase_database/example/windows/runner/utils.cpp b/packages/firebase_database/firebase_database/example/windows/runner/utils.cpp new file mode 100644 index 000000000000..082b64f40604 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/utils.cpp @@ -0,0 +1,75 @@ +// 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 "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/firebase_database/firebase_database/example/windows/runner/utils.h b/packages/firebase_database/firebase_database/example/windows/runner/utils.h new file mode 100644 index 000000000000..d9ba18aa0e99 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/utils.h @@ -0,0 +1,25 @@ +/* + * 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 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/firebase_database/firebase_database/example/windows/runner/win32_window.cpp b/packages/firebase_database/firebase_database/example/windows/runner/win32_window.cpp new file mode 100644 index 000000000000..e25d13f9d076 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/win32_window.cpp @@ -0,0 +1,284 @@ +// 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 "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/firebase_database/firebase_database/example/windows/runner/win32_window.h b/packages/firebase_database/firebase_database/example/windows/runner/win32_window.h new file mode 100644 index 000000000000..702c769afe93 --- /dev/null +++ b/packages/firebase_database/firebase_database/example/windows/runner/win32_window.h @@ -0,0 +1,106 @@ +/* + * 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 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/firebase_database/firebase_database/ios/firebase_database/Sources/firebase_database/FLTFirebaseDatabasePlugin.swift b/packages/firebase_database/firebase_database/ios/firebase_database/Sources/firebase_database/FLTFirebaseDatabasePlugin.swift index 469164b0256f..cbcb5a120822 100644 --- a/packages/firebase_database/firebase_database/ios/firebase_database/Sources/firebase_database/FLTFirebaseDatabasePlugin.swift +++ b/packages/firebase_database/firebase_database/ios/firebase_database/Sources/firebase_database/FLTFirebaseDatabasePlugin.swift @@ -32,6 +32,11 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug private var listenerCount: Int = 0 private var transactionResults: [Int64: [String: Any?]] = [:] + /// Wraps a native error so that its Realtime Database code reaches Dart. + /// + /// Forwarding the raw `NSError` instead lets Pigeon fall back to its generic + /// shape - the error's description as the code and its type name as the + /// message - and the Dart converter then reports `unknown`. private func createFlutterError(_ error: Error) -> PigeonError { let parts = FLTFirebaseDatabaseUtils.codeAndMessage(from: error) let code = parts[0] @@ -220,7 +225,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.setValue(request.value) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -237,7 +242,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.setValue(request.value, andPriority: request.priority) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -255,7 +260,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.updateChildValues(values) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -272,7 +277,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.setPriority(request.priority) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -376,7 +381,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.onDisconnectSetValue(request.value) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -393,7 +398,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.onDisconnectSetValue(request.value, andPriority: request.priority) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -411,7 +416,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.onDisconnectUpdateChildValues(values) { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } @@ -427,7 +432,7 @@ public class FLTFirebaseDatabasePlugin: NSObject, FlutterPlugin, FLTFirebasePlug reference.cancelDisconnectOperations { error, _ in if let error { - completion(.failure(error)) + completion(.failure(self.createFlutterError(error))) } else { completion(.success(())) } diff --git a/packages/firebase_database/firebase_database/windows/firebase_database_plugin.cpp b/packages/firebase_database/firebase_database/windows/firebase_database_plugin.cpp index f523a86ffe59..7f139d6fc6f1 100644 --- a/packages/firebase_database/firebase_database/windows/firebase_database_plugin.cpp +++ b/packages/firebase_database/firebase_database/windows/firebase_database_plugin.cpp @@ -206,8 +206,12 @@ std::string FirebaseDatabasePlugin::GetDatabaseErrorCode(Error error) { return "max-retries"; case Error::kErrorNetworkError: return "network-error"; + // `failure` and `write-cancelled` rather than the C++ enum's own wording: + // these are the codes the Android, Apple and web implementations report for + // the same conditions, and until #18550 no Windows code reached Dart at all + // for anything to depend on. case Error::kErrorOperationFailed: - return "operation-failed"; + return "failure"; case Error::kErrorOverriddenBySet: return "overridden-by-set"; case Error::kErrorPermissionDenied: @@ -215,7 +219,7 @@ std::string FirebaseDatabasePlugin::GetDatabaseErrorCode(Error error) { case Error::kErrorUnavailable: return "unavailable"; case Error::kErrorWriteCanceled: - return "write-canceled"; + return "write-cancelled"; case Error::kErrorInvalidVariantType: return "invalid-variant-type"; case Error::kErrorConflictingOperationInProgress: @@ -232,13 +236,33 @@ std::string FirebaseDatabasePlugin::GetDatabaseErrorMessage(Error error) { return msg ? std::string(msg) : "Unknown error"; } +// --- Helper: `details` payload carrying the code and message to Dart --- +// +// `_flutterfire_internals` reads the Firebase code out of this map, keyed the +// same way the Android plugin keys its `additionalData`. Sending only the +// two-argument `FlutterError(code, message)` leaves Pigeon's `details` null, +// which used to cost every native error its code on Windows. +// See https://github.com/firebase/flutterfire/issues/18550. +flutter::EncodableValue FirebaseDatabasePlugin::BuildErrorDetails( + const std::string& code, const std::string& message) { + return EncodableValue(EncodableMap{ + {EncodableValue("code"), EncodableValue(code)}, + {EncodableValue("message"), EncodableValue(message)}, + }); +} + FlutterError FirebaseDatabasePlugin::ParseError( const firebase::FutureBase& future) { Error error = static_cast(future.error()); std::string code = GetDatabaseErrorCode(error); - std::string message = - future.error_message() ? future.error_message() : "Unknown error"; - return FlutterError(code, message); + // An empty C string is non-null, and the desktop SDK completes some futures + // with one (a deliberate transaction abort, for instance), so test for + // emptiness rather than just for null before falling back. + const char* error_message = future.error_message(); + std::string message = (error_message && *error_message) + ? std::string(error_message) + : GetDatabaseErrorMessage(error); + return FlutterError(code, message, BuildErrorDetails(code, message)); } // --- Helper: Convert DataSnapshot to EncodableMap --- @@ -671,6 +695,19 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( int64_t transaction_key; std::map* transaction_results; std::function reply)> result; + // Whether the Dart handler asked to abort. The desktop SDK does not report + // a deliberate abort the way the mobile SDKs do (see the completion handler + // below), so the handler's own decision is what we key the + // `committed: false` contract off. Written from the transaction handler, + // which the SDK always runs to completion before completing the future. + bool handler_aborted = false; + // The data as of the aborting invocation, shaped like + // `DataSnapshotToEncodableMap` so that an aborted transaction reports the + // same snapshot on Windows as it does on the other platforms. + EncodableMap aborted_snapshot; + // Whether the handler could not be called at all (a channel failure rather + // than a decision made by Dart code). + bool handler_failed = false; }; auto* ctx = new TransactionContext{messenger_, transaction_key, @@ -690,6 +727,7 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( std::mutex mtx; std::condition_variable cv; bool handler_complete = false; + bool handler_failed = false; TransactionHandlerResult* handler_result = nullptr; auto flutter_api = @@ -711,6 +749,7 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( }, [&](const FlutterError& error) { handler_result = new TransactionHandlerResult(true, true); + handler_failed = true; std::lock_guard lock(mtx); handler_complete = true; cv.notify_one(); @@ -722,8 +761,42 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( cv.wait(lock, [&] { return handler_complete; }); } + if (handler_failed) { + // The handler never ran, so there is no Dart-side decision (nor a + // stored Dart error) to report: surface this as a genuine failure. + ctx->handler_failed = true; + delete handler_result; + return firebase::database::kTransactionResultAbort; + } + if (!handler_result || handler_result->aborted() || handler_result->exception()) { + // Dart returned `Transaction.abort()`, or the handler threw - the + // Dart side stores its own error and rethrows it, so both are an + // abort as far as the native result goes. Record the decision and the + // data it saw: the completion handler cannot recover it from the + // future, because the desktop SDK reports a deliberate abort as + // `kErrorWriteCanceled` on the initial invocation and as + // `kErrorNone` on a rerun. + ctx->handler_aborted = true; + ctx->aborted_snapshot.clear(); + ctx->aborted_snapshot[EncodableValue("key")] = + data->key() ? EncodableValue(std::string(data->key())) + : EncodableValue(); + ctx->aborted_snapshot[EncodableValue("value")] = snapshot_value; + ctx->aborted_snapshot[EncodableValue("priority")] = + FirebaseDatabasePlugin::VariantToEncodableValue(data->priority()); + EncodableList aborted_child_keys; + std::vector children = data->children(); + for (auto& child : children) { + if (child.key()) { + aborted_child_keys.push_back( + EncodableValue(std::string(child.key()))); + } + } + ctx->aborted_snapshot[EncodableValue("childKeys")] = + EncodableValue(aborted_child_keys); + delete handler_result; return firebase::database::kTransactionResultAbort; } @@ -745,7 +818,31 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( // Wait for the transaction to complete ref.RunTransactionLastResult().OnCompletion( [ctx](const Future& future) { - if (future.error() == Error::kErrorNone) { + Error error = static_cast(future.error()); + + // A deliberate abort is not an error condition: `runTransaction` has to + // resolve with `committed: false`, as it does on Android, iOS and web. + // + // The handler's own decision - not the native error code - is what + // decides this. The desktop SDK reports a deliberate abort as + // `kErrorWriteCanceled` when the handler aborts on its initial + // invocation and as `kErrorNone` when it aborts on a rerun, and it + // never reports the `kErrorTransactionAbortedByUser` that the mobile + // SDKs use (that code is only ever emitted by the Android and iOS + // implementations). Neither native code can be trusted on its own here: + // `kErrorWriteCanceled` also means "cancelled by + // PurgeOutstandingWrites()", which must stay an error, and `kErrorNone` + // otherwise means the transaction committed. + // See https://github.com/firebase/flutterfire/issues/18549, + // https://github.com/firebase/firebase-cpp-sdk/issues/1905. + bool aborted_by_handler = + ctx->handler_aborted || + error == Error::kErrorTransactionAbortedByUser; + // Either way the handler, not the server, ended this transaction, so it + // did not commit - whatever the native error code says. + bool ended_by_handler = aborted_by_handler || ctx->handler_failed; + + if (error == Error::kErrorNone && !ended_by_handler) { const DataSnapshot* snapshot = future.result(); EncodableMap result_map; result_map[EncodableValue("committed")] = EncodableValue(true); @@ -758,20 +855,32 @@ void FirebaseDatabasePlugin::DatabaseReferenceRunTransaction( (*ctx->transaction_results)[ctx->transaction_key] = result_map; ctx->result(std::nullopt); } else { - // Transaction failed but may have been aborted EncodableMap result_map; result_map[EncodableValue("committed")] = EncodableValue(false); - result_map[EncodableValue("snapshot")] = EncodableValue(EncodableMap{ - {EncodableValue("key"), EncodableValue()}, - {EncodableValue("value"), EncodableValue()}, - {EncodableValue("priority"), EncodableValue()}, - {EncodableValue("childKeys"), EncodableValue(EncodableList{})}, - }); + if (aborted_by_handler && !ctx->aborted_snapshot.empty()) { + // Report the data the handler saw, like the other platforms do. + result_map[EncodableValue("snapshot")] = + EncodableValue(ctx->aborted_snapshot); + } else { + result_map[EncodableValue("snapshot")] = + EncodableValue(EncodableMap{ + {EncodableValue("key"), EncodableValue()}, + {EncodableValue("value"), EncodableValue()}, + {EncodableValue("priority"), EncodableValue()}, + {EncodableValue("childKeys"), + EncodableValue(EncodableList{})}, + }); + } (*ctx->transaction_results)[ctx->transaction_key] = result_map; - if (static_cast(future.error()) == - Error::kErrorTransactionAbortedByUser) { - // Aborted by user is not an error condition + if (ctx->handler_failed) { + std::string message = + "The transaction handler could not be called. The transaction " + "was aborted."; + ctx->result(FlutterError( + "unknown", message, + FirebaseDatabasePlugin::BuildErrorDetails("unknown", message))); + } else if (aborted_by_handler) { ctx->result(std::nullopt); } else { ctx->result(FirebaseDatabasePlugin::ParseError(future)); @@ -901,6 +1010,27 @@ void FirebaseDatabasePlugin::OnDisconnectCancel( // ===== Query methods ===== +namespace { + +// Forwards a listener cancellation to Dart with a `details` payload, so the +// mapped code survives the conversion to `FirebaseException` the same way it +// does for the Pigeon host-API errors built by `ParseError()`. The two-argument +// `EventSink::Error()` overload sends null details, which loses the code. +// See https://github.com/firebase/flutterfire/issues/18550. +void SendListenerError(flutter::EventSink* events, + const Error& error, const char* error_message) { + if (!events) return; + std::string code = FirebaseDatabasePlugin::GetDatabaseErrorCode(error); + std::string message = + (error_message && *error_message) + ? std::string(error_message) + : FirebaseDatabasePlugin::GetDatabaseErrorMessage(error); + events->Error(code, message, + FirebaseDatabasePlugin::BuildErrorDetails(code, message)); +} + +} // namespace + void FirebaseDatabasePlugin::QueryObserve( const DatabasePigeonFirebaseApp& app, const QueryRequest& request, std::function reply)> result) { @@ -980,8 +1110,7 @@ void FirebaseDatabasePlugin::QueryObserve( } void OnCancelled(const Error& error, const char* error_message) override { - events_->Error(FirebaseDatabasePlugin::GetDatabaseErrorCode(error), - error_message ? error_message : "Unknown error"); + SendListenerError(events_, error, error_message); } private: @@ -1015,8 +1144,7 @@ void FirebaseDatabasePlugin::QueryObserve( } void OnCancelled(const Error& error, const char* error_message) override { - events_->Error(FirebaseDatabasePlugin::GetDatabaseErrorCode(error), - error_message ? error_message : "Unknown error"); + SendListenerError(events_, error, error_message); } private: diff --git a/packages/firebase_database/firebase_database/windows/firebase_database_plugin.h b/packages/firebase_database/firebase_database/windows/firebase_database_plugin.h index 6a6fa145f6e0..8081d267f4ab 100644 --- a/packages/firebase_database/firebase_database/windows/firebase_database_plugin.h +++ b/packages/firebase_database/firebase_database/windows/firebase_database_plugin.h @@ -40,6 +40,8 @@ class FirebaseDatabasePlugin : public flutter::Plugin, const flutter::EncodableValue& value); static std::string GetDatabaseErrorCode(firebase::database::Error error); static std::string GetDatabaseErrorMessage(firebase::database::Error error); + static flutter::EncodableValue BuildErrorDetails(const std::string& code, + const std::string& message); static FlutterError ParseError(const firebase::FutureBase& future); static flutter::EncodableMap DataSnapshotToEncodableMap( const firebase::database::DataSnapshot& snapshot); From 63b82d32d2f148b52d669032528802f1c9e6920d Mon Sep 17 00:00:00 2001 From: Guillaume Bernos Date: Tue, 11 Aug 2026 14:49:03 +0200 Subject: [PATCH 2/2] fix(database,windows): normalise the code fallback, skip known Windows gaps `platformExceptionToFirebaseException` now lower-cases and dashes a code it takes from `PlatformException.code`, the same normalisation the auth converter applies to that field, so a native `UNKNOWN` keeps reporting as `unknown`. Skips three tests on Windows for pre-existing plugin gaps that the new e2e job exposed, unrelated to this PR: `startAfter` and `endBefore` are mapped onto the C++ SDK's inclusive `StartAt`/`EndAt` (it has no exclusive cursor), and the desktop SDK does not resolve `ServerValue.increment` sentinels. Also wraps a test name that pushed a line past the formatter's limit. --- .../lib/src/exception.dart | 7 +- .../test/exception_test.dart | 21 +++++- .../database_reference_e2e.dart | 33 +++++---- .../example/integration_test/query_e2e.dart | 71 +++++++++++-------- 4 files changed, 88 insertions(+), 44 deletions(-) diff --git a/packages/_flutterfire_internals/lib/src/exception.dart b/packages/_flutterfire_internals/lib/src/exception.dart index 534d9c2cf7d9..54c3c00d8cc7 100644 --- a/packages/_flutterfire_internals/lib/src/exception.dart +++ b/packages/_flutterfire_internals/lib/src/exception.dart @@ -65,11 +65,16 @@ FirebaseException platformExceptionToFirebaseException( // overloads both send null details. Without this the code is lost and every // such error surfaces as `unknown`. // + // Normalised to the casing Firebase codes use, as + // `platformExceptionToFirebaseAuthException` already does for the same + // field, so that a native `UNKNOWN` or `PERMISSION_DENIED` does not leak + // through in a shape no caller can compare against. + // // The plugin name itself is not a code - the Android and Windows Pigeon // APIs send it in that field as a channel-level marker and carry the real // code in `details` - so it is treated as absent rather than reported as // `FirebaseException(code: 'firebase_database')`. - code = platformException.code; + code = platformException.code.toLowerCase().replaceAll('_', '-'); } return FirebaseException( diff --git a/packages/_flutterfire_internals/test/exception_test.dart b/packages/_flutterfire_internals/test/exception_test.dart index 5bca5596edf5..4cd37d650bc2 100644 --- a/packages/_flutterfire_internals/test/exception_test.dart +++ b/packages/_flutterfire_internals/test/exception_test.dart @@ -64,7 +64,26 @@ void main() { ); }); - test('ignores PlatformException.code when a details payload is present', () { + test('normalises the casing of a PlatformException.code fallback', () { + // Keeps a native `UNKNOWN` reporting as the documented `unknown`, the + // same normalisation the auth converter applies to this field. + final exception = platformExceptionToFirebaseException( + PlatformException(code: 'PERMISSION_DENIED', message: 'denied'), + plugin: 'firebase_database', + ); + + expect(exception.code, 'permission-denied'); + + expect( + platformExceptionToFirebaseException( + PlatformException(code: 'UNKNOWN'), + plugin: 'firebase_crashlytics', + ).code, + 'unknown', + ); + }); + + test('ignores PlatformException.code when details are present', () { // Pigeon's generic error path sends the exception class name as the code // and a stack trace as the details, so a details payload without a code // means there is no Firebase code to report. diff --git a/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart b/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart index f3639640829b..deddc05b6e32 100644 --- a/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart +++ b/packages/firebase_database/firebase_database/example/integration_test/database_reference_e2e.dart @@ -271,19 +271,26 @@ void setupDatabaseReferenceTests() { } }); - test('Server.increment', () async { - final DatabaseReference ref = _uniqueRef('server-increment'); - await ref.set(ServerValue.increment(1.5)); - - final snap = await ref.get(); - var value = snap.value; - expect(value, 1.5); - - await ref.set(ServerValue.increment(1)); - final snap2 = await ref.get(); - var value2 = snap2.value; - expect(value2, 2.5); - }); + test( + 'Server.increment', + () async { + final DatabaseReference ref = _uniqueRef('server-increment'); + await ref.set(ServerValue.increment(1.5)); + + final snap = await ref.get(); + var value = snap.value; + expect(value, 1.5); + + await ref.set(ServerValue.increment(1)); + final snap2 = await ref.get(); + var value2 = snap2.value; + expect(value2, 2.5); + }, + // The desktop C++ SDK does not resolve `increment` server-value + // sentinels, so the client reads back the raw `{'.sv': ...}` map. + // Pre-existing gap, tracked separately. + skip: defaultTargetPlatform == TargetPlatform.windows, + ); }); }); } diff --git a/packages/firebase_database/firebase_database/example/integration_test/query_e2e.dart b/packages/firebase_database/firebase_database/example/integration_test/query_e2e.dart index 6d41c4e4bc8c..2b7d8a2ac2d5 100644 --- a/packages/firebase_database/firebase_database/example/integration_test/query_e2e.dart +++ b/packages/firebase_database/firebase_database/example/integration_test/query_e2e.dart @@ -100,24 +100,31 @@ void setupQueryTests() { expect(snapshot.value, isNull); }); - test('starts after the correct value', () async { - await ref.set({ - 'a': 1, - 'b': 2, - 'c': 3, - 'd': 4, - }); + test( + 'starts after the correct value', + () async { + await ref.set({ + 'a': 1, + 'b': 2, + 'c': 3, + 'd': 4, + }); - // TODO(ehesp): Using `get` returns the wrong results. Have flagged with SDK team. - final e = await ref.orderByValue().startAfter(2).once(); + // TODO(ehesp): Using `get` returns the wrong results. Have flagged with SDK team. + final e = await ref.orderByValue().startAfter(2).once(); - final expected = ['c', 'd']; + final expected = ['c', 'd']; - expect(e.snapshot.children.length, expected.length); - e.snapshot.children.toList().forEachIndexed((i, childSnapshot) { - expect(childSnapshot.key, expected[i]); - }); - }); + expect(e.snapshot.children.length, expected.length); + e.snapshot.children.toList().forEachIndexed((i, childSnapshot) { + expect(childSnapshot.key, expected[i]); + }); + }, + // The C++ SDK has no exclusive cursor, so the Windows plugin maps + // `startAfter` onto the inclusive `StartAt` and still returns the + // boundary value. Pre-existing gap, tracked separately. + skip: defaultTargetPlatform == TargetPlatform.windows, + ); }); group('endAt', () { @@ -175,23 +182,29 @@ void setupQueryTests() { }); }); - test('ends before the correct value', () async { - await ref.set({ - 'a': 1, - 'b': 2, - 'c': 3, - 'd': 4, - }); + test( + 'ends before the correct value', + () async { + await ref.set({ + 'a': 1, + 'b': 2, + 'c': 3, + 'd': 4, + }); - final snapshot = await ref.orderByValue().endBefore(2).get(); + final snapshot = await ref.orderByValue().endBefore(2).get(); - final expected = ['a']; + final expected = ['a']; - expect(snapshot.children.length, expected.length); - snapshot.children.toList().forEachIndexed((i, childSnapshot) { - expect(childSnapshot.key, expected[i]); - }); - }); + expect(snapshot.children.length, expected.length); + snapshot.children.toList().forEachIndexed((i, childSnapshot) { + expect(childSnapshot.key, expected[i]); + }); + }, + // Same exclusive-cursor gap as `startAfter` above: the Windows plugin + // maps `endBefore` onto the inclusive `EndAt`. + skip: defaultTargetPlatform == TargetPlatform.windows, + ); }); group('equalTo', () {