Merge pull request #1 from firebase/remote-config

Adds Remote Config initial files and classes

Author: ericwindmill

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+_Description of what this PR is changing or adding, and why:_
+
+_Issues fixed by this PR (if any):_
+
+## Pre-submit checklist
+- [ ] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style)
+- [ ] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks)

.gitignore

@@ -0,0 +1,47 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+*.g.dart
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release

apps/firestore_snippets/lib/app.dart

@@ -13,27 +13,33 @@
 // limitations under the License.
 
 import 'package:cloud_firestore/cloud_firestore.dart';
+import 'package:firebase_remote_config/firebase_remote_config.dart';
 import 'package:firestore_snippets/snippets/firestore.dart';
+import 'package:firestore_snippets/snippets/remote_config.dart';
 import 'package:flutter/material.dart';
 
 class MyApp extends StatefulWidget {
   const MyApp({
     Key? key,
     required this.firestore,
+    required this.firebaseRemoteConfig,
   }) : super(key: key);
 
   final FirebaseFirestore firestore;
+  final FirebaseRemoteConfig firebaseRemoteConfig;
 
   @override
   State<MyApp> createState() => _MyAppState();
 }
 
 class _MyAppState extends State<MyApp> {
   late final FirestoreSnippets _firestoreSnippets;
+  late final RemoteConfigSnippets _remoteConfigSnippets;
 
   @override
   void initState() {
     _firestoreSnippets = FirestoreSnippets(widget.firestore);
+    _remoteConfigSnippets = RemoteConfigSnippets(widget.firebaseRemoteConfig);
 
     _firestoreSnippets.runAll();
     super.initState();

apps/firestore_snippets/lib/main.dart

@@ -15,6 +15,7 @@
 // [START set_up_environment]
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_remote_config/firebase_remote_config.dart';
 // [END set_up_environment]
 
 import 'package:firestore_snippets/app.dart';
@@ -61,9 +62,16 @@ void main() async {
   db.settings = settings;
   // [END access_data_offline_configure_offline_persistence]
 
+  // [START get_started_get_singleton_object]
+  FirebaseRemoteConfig firebaseRemoteConfig = FirebaseRemoteConfig.instance;
+  // [END get_started_get_singleton_object]
+
   if (!kReleaseMode) db.useFirestoreEmulator('localhost', 8080);
 
   runApp(
-    MyApp(firestore: db),
+    MyApp(
+      firestore: db,
+      firebaseRemoteConfig: firebaseRemoteConfig,
+    ),
   );
 }

apps/firestore_snippets/lib/snippets/firestore.dart

@@ -21,7 +21,7 @@ import 'package:firestore_snippets/snippets/custom_snippets/firestore_add_data_c
 import 'package:firestore_snippets/snippets/custom_snippets/restaurant.dart';
 import 'package:firestore_snippets/snippets/snippet.dart';
 
-class FirestoreSnippets extends DocSnippet implements Firestore {
+class FirestoreSnippets extends DocSnippet {
   @override
   final FirebaseFirestore db;
 

apps/firestore_snippets/lib/snippets/remote_config.dart

@@ -0,0 +1,59 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// ignore_for_file: non_constant_identifier_names, avoid_print
+
+import 'package:firebase_remote_config/firebase_remote_config.dart';
+import 'package:firestore_snippets/snippets/snippet.dart';
+
+class RemoteConfigSnippets extends DocSnippet {
+  final FirebaseRemoteConfig firebaseRemoteConfig;
+
+  RemoteConfigSnippets(this.firebaseRemoteConfig);
+
+  @override
+  void runAll() {}
+
+  void getStarted_setMinimumIntervalFetch() {
+    // [START get_started_set_minimum_interval_fetch]
+    firebaseRemoteConfig.settings.minimumFetchInterval =
+        const Duration(milliseconds: 3600000);
+    // [END get_started_set_minimum_interval_fetch]
+  }
+
+  void getStarted_setDefaultValues() {
+    // [START get_started_set_default_values]
+    firebaseRemoteConfig.setDefaults(<String, dynamic>{
+      'welcome_message': 'this is the default welcome message',
+    });
+    // [END get_started_set_default_values]
+  }
+
+  void getStarted_getDefaultValues() {
+    // [START get_started_get_default_values]
+    final val = firebaseRemoteConfig.getValue("welcome_messsage");
+    // [END get_started_get_default_values]
+  }
+
+  void getStarted_fetchAndActivateValues() {
+    // [START get_started_fetch_and_activate_values]
+    firebaseRemoteConfig.fetchAndActivate().then((bool success) {
+      if (success) {
+        final updatedConfig = firebaseRemoteConfig.getAll();
+        print("Config params updated: $updatedConfig");
+      }
+    });
+    // [END get_started_fetch_and_activate_values]
+  }
+}

apps/firestore_snippets/lib/snippets/snippet.dart

@@ -12,17 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/*
-Base class for all Snippets
- */
-import 'package:cloud_firestore/cloud_firestore.dart';
-
 abstract class DocSnippet {
   void runAll();
 }
-
-class Firestore {
-  final FirebaseFirestore db;
-
-  Firestore(this.db);
-}

apps/firestore_snippets/pubspec.lock

@@ -84,14 +84,35 @@ packages:
       name: firebase_core_platform_interface
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "4.2.4"
+    version: "4.2.5"
   firebase_core_web:
     dependency: transitive
     description:
       name: firebase_core_web
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.5.4"
+    version: "1.6.1"
+  firebase_remote_config:
+    dependency: "direct main"
+    description:
+      name: firebase_remote_config
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "2.0.2"
+  firebase_remote_config_platform_interface:
+    dependency: transitive
+    description:
+      name: firebase_remote_config_platform_interface
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.1.1"
+  firebase_remote_config_web:
+    dependency: transitive
+    description:
+      name: firebase_remote_config_web
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.7"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -226,4 +247,4 @@ packages:
     version: "2.1.1"
 sdks:
   dart: ">=2.16.1 <3.0.0"
-  flutter: ">=1.12.13+hotfix.5"
+  flutter: ">=1.20.0"

apps/firestore_snippets/pubspec.yaml

@@ -25,6 +25,7 @@ dependencies:
     sdk: flutter
   firebase_core: ^1.12.0
   cloud_firestore: ^3.1.8
+  firebase_remote_config: ^2.0.2
 
 dev_dependencies:
   flutter_test: