feat(database): add initial firebase database

[daeyeon]

See this link for the message channel protocol.

Signed-off-by: Daeyeon Jeong [email protected]

[daeyeon]

cc @JSUYA

[JSUYA]

I left a few reviews. Please check.

+)
Most TRACE() rules are ambiguous. There are a tag, an error or warning, simple call checks.
At least I think it can be cleaned up just by adding the appropriate tags.

[JSUYA]

There are already other PR prefixes using [!] but I think it would be better if these were words that meant something.
It is recommended to replace it with [WARN] or [WARNING].

[daeyeon]

Most TRACE() rules are ambiguous. There are a tag, an error or warning, simple call checks. At least I think it can be cleaned up just by adding the appropriate tags.

Make sense. However, since formatting the logs is trivial, why don't we apply the rules to all plugins in another PR? By the way, please note that all the TRACEs are removed in the release build and will never be shown to users, even in debug mode. This already resolves our main concerns about verbose logs for users.

[daeyeon]

Applied suggestions from code review. @JSUYA PTAL when you have a moment.

[JSUYA]

This is result of dart analyze.
Please run and check dart analyze

Analyzing firebase_database...

   info - example/integration_test/firebase_database/database_e2e.dart:8:8 - Can't use a relative path to import a library in 'lib'. Try fixing the relative path or changing the import to a 'package:' import. - avoid_relative_lib_imports
   info - example/integration_test/firebase_database/database_e2e.dart:63:10 - Unnecessary braces in a string interpolation. Try removing the braces. - unnecessary_brace_in_string_interps
   info - example/integration_test/firebase_database/database_e2e.dart:70:10 - Unnecessary braces in a string interpolation. Try removing the braces. - unnecessary_brace_in_string_interps
   info - example/integration_test/firebase_database/database_e2e.dart:75:10 - Unnecessary braces in a string interpolation. Try removing the braces. - unnecessary_brace_in_string_interps
   info - example/integration_test/firebase_database/database_reference_e2e.dart:141:46 - Missing a required trailing comma. - require_trailing_commas
   info - example/integration_test/firebase_database/extra_e2e.dart:22:7 - Missing an 'await' for the 'Future' computed by this expression. Try adding an 'await' or wrapping the expression un 'unawaited'. - unawaited_futures
   info - example/integration_test/firebase_database/extra_e2e.dart:37:7 - Missing an 'await' for the 'Future' computed by this expression. Try adding an 'await' or wrapping the expression un 'unawaited'. - unawaited_futures
   info - example/integration_test/firebase_database/query_e2e.dart:81:55 - Missing a required trailing comma. - require_trailing_commas
   info - example/integration_test/firebase_database/query_e2e.dart:155:54 - Missing a required trailing comma. - require_trailing_commas
   info - example/lib/main.dart:128:50 - 'headline4' is deprecated and shouldn't be used. Use headlineMedium instead. This feature was deprecated after v3.1.0-0.0.pre. Try replacing the use of the deprecated member with the replacement. - deprecated_member_use
   info - pubspec.yaml:25:3 - Unsorted dependencies. Try sorting the dependencies. - sort_pub_dependencies

11 issues found.

[daeyeon]

@JSUYA Regarding the dart analyze result, we don't plan to improve the tests and the example ourselves.

[JSUYA]

@JSUYA Regarding the dart analyze result, we don't plan to improve the tests and the example ourselves.

It is not a matter of improving the example and test code.
Since this project is based on firebase_database 10.0.9. analyze_options and more files should be changed.
(We have to make sure that no errors are found in dart analyze.)

This is firebase/firebase_database/example/analysis_options.yaml (ver 10.0.9)

include: ../../../../analysis_options.yaml
linter:
  rules:
    avoid_print: false
    depend_on_referenced_packages: false
    library_private_types_in_public_api: false

[daeyeon]

@JSUYA As you may know, the integration_test sources have been merged into the example directory, so we can't simply get the errors passed using the lint option above. And, as discussed already, the integration_test sources will be moved to a different path in the future, making it easier to fix the lint errors. So, it dosen't seem worth improving the test sources or any options in this PR right now. What do you think?

[JSUYA]

~/dev/os/f-project/flutterfire/packages/firebase_database (dev/db) 17:27:27 $ git diff
diff --git a/all_lint_rules.yaml b/all_lint_rules.yaml
index 0375a83..7f933bb 100644
--- a/all_lint_rules.yaml
+++ b/all_lint_rules.yaml
@@ -193,4 +193,4 @@ linter:
     - use_test_throws_matchers
     - use_to_and_as_if_applicable
     - valid_regexps
-    - void_checks
+    - void_checks
\ No newline at end of file
diff --git a/analysis_options.yaml b/analysis_options.yaml
index 2156d38..79a2ff5 100644
--- a/analysis_options.yaml
+++ b/analysis_options.yaml
@@ -74,6 +74,10 @@ linter:
     # and `@required Widget child` last.
     always_put_required_named_parameters_first: false

+    # `as` is not that bad (especially with the upcoming non-nullable types).
+    # Explicit exceptions is better than implicit exceptions.
+    avoid_as: false
+
     # This project doesn't use Flutter-style todos
     flutter_style_todos: false

diff --git a/packages/firebase_database/example/analysis_options.yaml b/packages/firebase_database/example/analysis_options.yaml
index a1fbb31..6b3fb09 100644
--- a/packages/firebase_database/example/analysis_options.yaml
+++ b/packages/firebase_database/example/analysis_options.yaml
@@ -2,4 +2,9 @@
 # Use of this source code is governed by a BSD-style license that can be
 # in the LICENSE file.

-include: ../analysis_options.yaml
+include: ../../../analysis_options.yaml
+linter:
+  rules:
+    avoid_print: false
+    depend_on_referenced_packages: false
+    library_private_types_in_public_api: false
\ No newline at end of file

[JSUYA]

~/dev/os/f-project/flutterfire/packages/firebase_database (dev/db) 17:27:32 $ dart analyze
Analyzing firebase_database...         0.7s

   info • example/integration_test/firebase_database/database_e2e.dart:8:8 • Can't use a relative path to import a library in 'lib'. Try fixing the relative path
          or changing the import to a 'package:' import. • avoid_relative_lib_imports
   info • example/integration_test/firebase_database/database_e2e.dart:63:10 • Unnecessary braces in a string interpolation. Try removing the braces. •
          unnecessary_brace_in_string_interps
   info • example/integration_test/firebase_database/database_e2e.dart:70:10 • Unnecessary braces in a string interpolation. Try removing the braces. •
          unnecessary_brace_in_string_interps
   info • example/integration_test/firebase_database/database_e2e.dart:75:10 • Unnecessary braces in a string interpolation. Try removing the braces. •
          unnecessary_brace_in_string_interps
   info • example/integration_test/firebase_database/database_reference_e2e.dart:141:46 • Missing a required trailing comma. • require_trailing_commas
   info • example/integration_test/firebase_database/extra_e2e.dart:22:7 • Missing an 'await' for the 'Future' computed by this expression. Try adding an 'await'
          or wrapping the expression un 'unawaited'. • unawaited_futures
   info • example/integration_test/firebase_database/extra_e2e.dart:37:7 • Missing an 'await' for the 'Future' computed by this expression. Try adding an 'await'
          or wrapping the expression un 'unawaited'. • unawaited_futures
   info • example/integration_test/firebase_database/query_e2e.dart:81:55 • Missing a required trailing comma. • require_trailing_commas
   info • example/integration_test/firebase_database/query_e2e.dart:155:54 • Missing a required trailing comma. • require_trailing_commas
   info • example/lib/main.dart:225:59 • The expression has no effect and can be removed. Try removing the expression. • noop_primitive_operations

10 issues found.

[daeyeon]

10 issues found.