initialize remaining tests, update firebase config (#11)

ericwindmill · web-flow · commit 77d3b81dd364 · 2022-04-21T13:47:58.000-04:00
Co-authored-by: Eric Windmill &lt;ewindmill@google.com&gt;
diff --git a/.github/workflows/scripts/.firebaserc b/.github/workflows/scripts/.firebaserc
@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "flutter-fire-snippets"
+  }
+}
diff --git a/.github/workflows/scripts/database.rules.json b/.github/workflows/scripts/database.rules.json
@@ -0,0 +1,14 @@
+{
+  "rules": {
+    ".read": "false",
+    ".write": "false",
+    "posts": {
+      ".read": "true",
+      ".write": "true"
+    },
+    "users": {
+      ".read": "true",
+      ".write": "true"
+    }
+  }
+}
diff --git a/.github/workflows/scripts/firebase.json b/.github/workflows/scripts/firebase.json
@@ -0,0 +1,46 @@
+{
+  "database": {
+    "rules": "database.rules.json"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  },
+  "hosting": {
+    "public": "web",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ]
+  },
+  "storage": {
+    "rules": "storage.rules"
+  },
+  "emulators": {
+    "auth": {
+      "port": 9099
+    },
+    "firestore": {
+      "port": 8080
+    },
+    "database": {
+      "port": 9000
+    },
+    "hosting": {
+      "port": 3030
+    },
+    "pubsub": {
+      "port": 8085
+    },
+    "storage": {
+      "port": 9199
+    },
+    "ui": {
+      "enabled": true
+    }
+  },
+  "remoteconfig": {
+    "template": "remoteconfig.template.json"
+  }
+}
diff --git a/.github/workflows/scripts/firestore.indexes.json b/.github/workflows/scripts/firestore.indexes.json
@@ -0,0 +1,4 @@
+{
+  "indexes": [],
+  "fieldOverrides": []
+}
diff --git a/.github/workflows/scripts/firestore.rules b/.github/workflows/scripts/firestore.rules
@@ -0,0 +1,20 @@
+rules_version = '2';
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /{document=**} {
+      allow read, write: if false;
+    }
+
+    match /users/{document=**} {
+      allow read, write;
+    }
+
+    match /cities/{document=**} {
+      allow read, write;
+    }
+
+    match /restaurants/{document=**} {
+      allow read, write;
+    }
+  }
+}
diff --git a/.github/workflows/scripts/remoteconfig.template.json b/.github/workflows/scripts/remoteconfig.template.json
@@ -0,0 +1 @@
+{}
diff --git a/.github/workflows/scripts/storage.rules b/.github/workflows/scripts/storage.rules
@@ -0,0 +1,8 @@
+rules_version = '2';
+service firebase.storage {
+  match /b/{bucket}/o {
+    match /{allPaths=**} {
+      allow read, write: if true;
+    }
+  }
+}
diff --git a/packages/firebase_snippets_app/android/build.gradle b/packages/firebase_snippets_app/android/build.gradle
@@ -9,6 +9,8 @@ buildscript {
         classpath 'com.android.tools.build:gradle:4.1.0'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath 'com.google.gms:google-services:4.3.10'
+        classpath 'com.google.firebase:firebase-crashlytics-gradle:2.7.1'
+
     }
 }
 
diff --git a/packages/firebase_snippets_app/database.rules.json b/packages/firebase_snippets_app/database.rules.json
@@ -1,6 +1,14 @@
 {
   "rules": {
-    ".read": "auth != null",
-    ".write": "auth != null"
+    ".read": "false",
+    ".write": "false",
+    "posts": {
+      ".read": "true",
+      ".write": "true"
+    },
+    "users": {
+      ".read": "true",
+      ".write": "true"
+    }
   }
 }
diff --git a/packages/firebase_snippets_app/firebase.json b/packages/firebase_snippets_app/firebase.json
@@ -38,6 +38,9 @@
     },
     "ui": {
       "enabled": true
+    },
+    "functions": {
+      "port": 5001
     }
   },
   "remoteconfig": {
diff --git a/packages/firebase_snippets_app/firestore.rules b/packages/firebase_snippets_app/firestore.rules
@@ -2,7 +2,19 @@ rules_version = '2';
 service cloud.firestore {
   match /databases/{database}/documents {
     match /{document=**} {
-      allow read, write: if true;
+      allow read, write: if false;
+    }
+
+    match /users/{document=**} {
+      allow read, write;
+    }
+
+    match /cities/{document=**} {
+      allow read, write;
+    }
+
+    match /restaurants/{document=**} {
+      allow read, write;
     }
   }
 }
diff --git a/packages/firebase_snippets_app/lib/app.dart b/packages/firebase_snippets_app/lib/app.dart
@@ -15,8 +15,19 @@
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:firebase_dynamic_links/firebase_dynamic_links.dart';
 import 'package:firebase_remote_config/firebase_remote_config.dart';
+import 'package:firebase_snippets_app/snippets/analytics.dart';
+import 'package:firebase_snippets_app/snippets/auth.dart';
+import 'package:firebase_snippets_app/snippets/cloud_functions.dart';
+import 'package:firebase_snippets_app/snippets/cloud_messaging.dart';
+import 'package:firebase_snippets_app/snippets/cloud_storage.dart';
+import 'package:firebase_snippets_app/snippets/crashlytics.dart';
+import 'package:firebase_snippets_app/snippets/database.dart';
+import 'package:firebase_snippets_app/snippets/dynamic_links.dart';
+import 'package:firebase_snippets_app/snippets/firebase_performance.dart';
 import 'package:firebase_snippets_app/snippets/firestore.dart';
+import 'package:firebase_snippets_app/snippets/ml_model_downloader.dart';
 import 'package:firebase_snippets_app/snippets/remote_config.dart';
+import 'package:firebase_snippets_app/snippets/snippet_base.dart';
 import 'package:flutter/material.dart';
 
 class MyApp extends StatefulWidget {
@@ -36,16 +47,32 @@ class MyApp extends StatefulWidget {
 }
 
 class _MyAppState extends State<MyApp> {
-  late final FirestoreSnippets _firestoreSnippets;
-  late final RemoteConfigSnippets _remoteConfigSnippets;
-
   @override
   void initState() {
-    _firestoreSnippets = FirestoreSnippets(widget.firestore);
-    _remoteConfigSnippets = RemoteConfigSnippets(widget.firebaseRemoteConfig);
+    final List<DocSnippet> _allSnippets = [
+      // Build Products
+      AuthenticationSnippets(),
+      RealtimeDatabaseSnippets(),
+      FirestoreSnippets(widget.firestore),
+      CloudStorageSnippets(),
+      MLModelDownloaderSnippets(),
+      CloudFunctionsSnippets(),
+
+      // Release and Monitor Products
+      CrashlyticsSnippets(),
+      FirebasePerformanceMonitoringSnippets(),
+
+      // Engage Products
+      AnalyticsSnippets(),
+      RemoteConfigSnippets(widget.firebaseRemoteConfig),
+      CloudMessagingSnippets(),
+      DynamicLinkSnippets(),
+    ];
+
+    for (var snippet in _allSnippets) {
+      snippet.runAll();
+    }
 
-    _firestoreSnippets.runAll();
-    _remoteConfigSnippets.runAll();
     super.initState();
   }
 
diff --git a/packages/firebase_snippets_app/lib/firebase_options.dart b/packages/firebase_snippets_app/lib/firebase_options.dart
@@ -1,17 +1,3 @@
-// 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.
-
 // File generated by FlutterFire CLI.
 // ignore_for_file: lines_longer_than_80_chars
 import 'package:firebase_core/firebase_core.dart' show FirebaseOptions;
@@ -31,55 +17,38 @@ import 'package:flutter/foundation.dart'
 class DefaultFirebaseOptions {
   static FirebaseOptions get currentPlatform {
     if (kIsWeb) {
-      return web;
+      throw UnsupportedError(
+        'DefaultFirebaseOptions have not been configured for web - '
+        'you can reconfigure this by running the FlutterFire CLI again.',
+      );
     }
     // ignore: missing_enum_constant_in_switch
     switch (defaultTargetPlatform) {
       case TargetPlatform.android:
         return android;
       case TargetPlatform.iOS:
-        return ios;
+        throw UnsupportedError(
+          'DefaultFirebaseOptions have not been configured for ios - '
+          'you can reconfigure this by running the FlutterFire CLI again.',
+        );
       case TargetPlatform.macOS:
         throw UnsupportedError(
           'DefaultFirebaseOptions have not been configured for macos - '
           'you can reconfigure this by running the FlutterFire CLI again.',
         );
     }
+
     throw UnsupportedError(
       'DefaultFirebaseOptions are not supported for this platform.',
     );
   }
 
-  /// Per this SO answer by Puf@, it is okay to put this info in GitHub,
-  /// as its not really 'secret' https://stackoverflow.com/a/37484053
-  ///
-  /// Instead of hiding this information, security should be handled
-  /// with access rules to individual products.
-  static const FirebaseOptions web = FirebaseOptions(
-    apiKey: 'AIzaSyDu2FRBnv0pV01dHHOQuk26pR1oYcZpGTE',
-    appId: '1:220375889386:web:bc468dd9e586597b6bae93',
-    messagingSenderId: '220375889386',
-    projectId: 'flutter-fire-snippets',
-    authDomain: 'flutter-fire-snippets.firebaseapp.com',
-    storageBucket: 'flutter-fire-snippets.appspot.com',
-  );
-
   static const FirebaseOptions android = FirebaseOptions(
     apiKey: 'AIzaSyC2bbpFcMWgGpKKEmqNw57Al2vdV4QnNP0',
     appId: '1:220375889386:android:1a16e85eeab0d5896bae93',
     messagingSenderId: '220375889386',
     projectId: 'flutter-fire-snippets',
+    databaseURL: 'https://flutter-fire-snippets-default-rtdb.firebaseio.com',
     storageBucket: 'flutter-fire-snippets.appspot.com',
   );
-
-  static const FirebaseOptions ios = FirebaseOptions(
-    apiKey: 'AIzaSyDNp5_kQjIgyS_UMtv9oRKcbCjOfYB1LNc',
-    appId: '1:220375889386:ios:0fec9df2e96f0db36bae93',
-    messagingSenderId: '220375889386',
-    projectId: 'flutter-fire-snippets',
-    storageBucket: 'flutter-fire-snippets.appspot.com',
-    iosClientId:
-        '220375889386-8v73sv2lia3e7c12h0btp2tfbj0um4it.apps.googleusercontent.com',
-    iosBundleId: 'com.fluttersnippets.app',
-  );
 }
diff --git a/packages/firebase_snippets_app/lib/main.dart b/packages/firebase_snippets_app/lib/main.dart
@@ -16,11 +16,13 @@
 import 'package:cloud_firestore/cloud_firestore.dart';
 import 'package:firebase_auth/firebase_auth.dart';
 import 'package:firebase_core/firebase_core.dart';
+import 'package:firebase_database/firebase_database.dart';
 import 'package:firebase_dynamic_links/firebase_dynamic_links.dart';
 import 'package:firebase_remote_config/firebase_remote_config.dart';
 // [END set_up_environment]
 
 import 'package:firebase_snippets_app/app.dart';
+import 'package:firebase_storage/firebase_storage.dart';
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
@@ -29,6 +31,7 @@ import 'firebase_options.dart';
 void main() async {
   WidgetsFlutterBinding.ensureInitialized();
   await Firebase.initializeApp(
+    name: 'Dev',
     options: DefaultFirebaseOptions.currentPlatform,
   );
 
@@ -59,7 +62,12 @@ void main() async {
     // [END auth_persistingAuthState]
   }
 
-  if (!kReleaseMode) db.useFirestoreEmulator('localhost', 8080);
+  if (!kReleaseMode) {
+    FirebaseAuth.instance.useAuthEmulator('localhost', 9099);
+    FirebaseFirestore.instance.useFirestoreEmulator('localhost', 8080);
+    FirebaseDatabase.instance.useDatabaseEmulator('localhost', 9000);
+    FirebaseStorage.instance.useStorageEmulator('localhost', 9199);
+  }
 
   runApp(
     MyApp(
diff --git a/packages/firebase_snippets_app/lib/snippets/crashlytics.dart b/packages/firebase_snippets_app/lib/snippets/crashlytics.dart
@@ -0,0 +1,10 @@
+import 'package:firebase_snippets_app/snippets/snippet_base.dart';
+
+class CrashlyticsSnippets implements DocSnippet {
+  @override
+  void runAll() {
+    // Crashlytics testing isn't yet supported,
+    // since it requires crashing the app to set up
+    // and this will require additional CI work
+  }
+}
diff --git a/packages/firebase_snippets_app/lib/snippets/firestore.dart b/packages/firebase_snippets_app/lib/snippets/firestore.dart
@@ -188,23 +188,23 @@ class FirestoreSnippets extends DocSnippet {
   }
 
   void addData_addADocument() {
-    // [START add_data_add_a_document ]
+    // [START add_data_add_a_document]
     db.collection("cities").doc("new-city-id").set({"name": "Chicago"});
-    // [END add_data_add_a_document ]
+    // [END add_data_add_a_document]
   }
 
   void addData_addADocument2() {
-    // [START add_data_add_a_document_2 ]
+    // [START add_data_add_a_document_2]
     // Add a new document with a generated id.
     final data = {"name": "Tokyo", "country": "Japan"};
 
     db.collection("cities").add(data).then((documentSnapshot) =>
         print("Added Data with ID: ${documentSnapshot.id}"));
-    // [END add_data_add_a_document_2 ]
+    // [END add_data_add_a_document_2]
   }
 
   void addData_addADocument3() {
-    // [START add_data_add_a_document_3 ]
+    // [START add_data_add_a_document_3]
     // Add a new document with a generated id.
     final data = <String, dynamic>{};
 
@@ -213,7 +213,7 @@ class FirestoreSnippets extends DocSnippet {
     // Later...
     newCityRef.set(data);
 
-    // [END add_data_add_a_document_3 ]
+    // [END add_data_add_a_document_3]
   }
 
   void addData_updateADocument() {
diff --git a/packages/firebase_snippets_app/lib/snippets/firestore_odm.dart b/packages/firebase_snippets_app/lib/snippets/firestore_odm.dart
diff --git a/packages/firebase_snippets_app/lib/snippets/remote_config.dart b/packages/firebase_snippets_app/lib/snippets/remote_config.dart
diff --git a/packages/firebase_snippets_app/lib/widgets/user.dart b/packages/firebase_snippets_app/lib/widgets/user.dart
diff --git a/packages/firebase_snippets_app/pubspec.lock b/packages/firebase_snippets_app/pubspec.lock
diff --git a/packages/firebase_snippets_app/pubspec.yaml b/packages/firebase_snippets_app/pubspec.yaml
diff --git a/packages/firebase_snippets_app/storage.rules b/packages/firebase_snippets_app/storage.rules

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "projects": {
 +    "default": "flutter-fire-snippets"
 +  }
 +}
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ buildscript {`
`9`	`9`	`classpath 'com.android.tools.build:gradle:4.1.0'`
`10`	`10`	`classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"`
`11`	`11`	`classpath 'com.google.gms:google-services:4.3.10'`
	`12`	`+ classpath 'com.google.firebase:firebase-crashlytics-gradle:2.7.1'`
	`13`	`+`
`12`	`14`	`}`
`13`	`15`	`}`
`14`	`16`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,14 @@`
`1`	`1`	`{`
`2`	`2`	`"rules": {`
`3`		`- ".read": "auth != null",`
`4`		`- ".write": "auth != null"`
	`3`	`+ ".read": "false",`
	`4`	`+ ".write": "false",`
	`5`	`+ "posts": {`
	`6`	`+ ".read": "true",`
	`7`	`+ ".write": "true"`
	`8`	`+ },`
	`9`	`+ "users": {`
	`10`	`+ ".read": "true",`
	`11`	`+ ".write": "true"`
	`12`	`+ }`
`5`	`13`	`}`
`6`	`14`	`}`