feat(functions): add leaderboard cleanup function (#376)

.firebaserc

@@ -0,0 +1,5 @@
+{
+  "projects": {
+    "default": "pinball-dev"
+  }
+}

firebase.json

@@ -5,7 +5,11 @@
   "hosting": {
     "public": "build/web",
     "site": "ashehwkdkdjruejdnensjsjdne",
-    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ],
     "headers": [
       {
         "source": "**/*.@(jpg|jpeg|gif|png)",

firestore.rules

@@ -17,7 +17,7 @@ service cloud.firestore {
       }
    
       // Leaderboard can be read if it doesn't contain any prohibited initials
-      allow read: if !prohibited(resource.data.playerInitials);
+      allow read: if isAuthedUser(request.auth);
       
       // A leaderboard entry can be created if the user is authenticated,
       // it's 3 characters long, and not a prohibited combination.

functions/.gitignore

@@ -0,0 +1 @@
+node_modules/

functions/index.js

@@ -0,0 +1,28 @@
+const functions = require("firebase-functions");
+const admin = require("firebase-admin");
+admin.initializeApp();
+
+const db = admin.firestore();
+
+exports.timedLeaderboardCleanup = functions.firestore
+  .document("leaderboard/{leaderboardEntry}")
+  .onCreate(async (_, __) => {
+    functions.logger.info(
+      "Document created, getting all leaderboard documents"
+    );
+    const snapshot = await db
+      .collection("leaderboard")
+      .orderBy("score", "desc")
+      .offset(10)
+      .get();
+
+    functions.logger.info(
+      `Preparing to delete ${snapshot.docs.length} documents.`
+    );
+    try {
+      await Promise.all(snapshot.docs.map((doc) => doc.ref.delete()));
+      functions.logger.info("Success");
+    } catch (error) {
+      functions.logger.error(`Failed to delete documents ${error}`);
+    }
+  });

functions/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "functions",
+  "description": "Cloud Functions for Firebase",
+  "scripts": {
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "main": "index.js",
+  "dependencies": {
+    "firebase-admin": "^10.0.2",
+    "firebase-functions": "^3.18.0"
+  },
+  "devDependencies": {
+    "firebase-functions-test": "^0.2.0"
+  },
+  "private": true
+}

packages/leaderboard_repository/lib/src/leaderboard_repository.dart

@@ -44,7 +44,6 @@ class LeaderboardRepository {
       final tenthPositionScore = leaderboard[9].score;
       if (entry.score > tenthPositionScore) {
         await _saveScore(entry);
-        await _deleteScoresUnder(tenthPositionScore);
       }
     }
   }
@@ -71,23 +70,6 @@ class LeaderboardRepository {
       throw AddLeaderboardEntryException(error, stackTrace);
     }
   }
-
-  Future<void> _deleteScoresUnder(int score) async {
-    try {
-      final querySnapshot = await _firebaseFirestore
-          .collection(_leaderboardCollectionName)
-          .where(_scoreFieldName, isLessThanOrEqualTo: score)
-          .get();
-      final documents = querySnapshot.docs;
-      for (final document in documents) {
-        await document.reference.delete();
-      }
-    } on LeaderboardDeserializationException {
-      rethrow;
-    } on Exception catch (error, stackTrace) {
-      throw DeleteLeaderboardException(error, stackTrace);
-    }
-  }
 }
 
 extension on List<QueryDocumentSnapshot> {

packages/leaderboard_repository/lib/src/models/exceptions.dart

@@ -40,16 +40,6 @@ class FetchLeaderboardException extends LeaderboardException {
       : super(error, stackTrace);
 }
 
-/// {@template delete_leaderboard_exception}
-/// Exception thrown when failure occurs while deleting the leaderboard under
-/// the tenth position.
-/// {@endtemplate}
-class DeleteLeaderboardException extends LeaderboardException {
-  /// {@macro fetch_top_10_leaderboard_exception}
-  const DeleteLeaderboardException(Object error, StackTrace stackTrace)
-      : super(error, stackTrace);
-}
-
 /// {@template add_leaderboard_entry_exception}
 /// Exception thrown when failure occurs while adding entry to leaderboard.
 /// {@endtemplate}

packages/leaderboard_repository/test/src/leaderboard_repository_test.dart

@@ -242,73 +242,10 @@ void main() {
         );
       });
 
-      test(
-          'throws DeleteLeaderboardException '
-          'when deleting scores outside the top 10 fails', () async {
-        final deleteQuery = _MockQuery();
-        final deleteQuerySnapshot = _MockQuerySnapshot();
-        final newScore = LeaderboardEntryData(
-          playerInitials: 'ABC',
-          score: 15000,
-          character: CharacterType.android,
-        );
-        final leaderboardScores = [
-          10000,
-          9500,
-          9000,
-          8500,
-          8000,
-          7500,
-          7000,
-          6500,
-          6000,
-          5500,
-          5000,
-        ];
-        final deleteDocumentSnapshots = [5500, 5000].map((score) {
-          final queryDocumentSnapshot = _MockQueryDocumentSnapshot();
-          when(queryDocumentSnapshot.data).thenReturn(<String, dynamic>{
-            'character': 'dash',
-            'playerInitials': 'AAA',
-            'score': score
-          });
-          when(() => queryDocumentSnapshot.id).thenReturn('id$score');
-          when(() => queryDocumentSnapshot.reference)
-              .thenReturn(documentReference);
-          return queryDocumentSnapshot;
-        }).toList();
-        when(deleteQuery.get).thenAnswer((_) async => deleteQuerySnapshot);
-        when(() => deleteQuerySnapshot.docs)
-            .thenReturn(deleteDocumentSnapshots);
-        final queryDocumentSnapshots = leaderboardScores.map((score) {
-          final queryDocumentSnapshot = _MockQueryDocumentSnapshot();
-          when(queryDocumentSnapshot.data).thenReturn(<String, dynamic>{
-            'character': 'dash',
-            'playerInitials': 'AAA',
-            'score': score
-          });
-          when(() => queryDocumentSnapshot.id).thenReturn('id$score');
-          when(() => queryDocumentSnapshot.reference)
-              .thenReturn(documentReference);
-          return queryDocumentSnapshot;
-        }).toList();
-        when(
-          () => collectionReference.where('score', isLessThanOrEqualTo: 5500),
-        ).thenAnswer((_) => deleteQuery);
-        when(() => documentReference.delete()).thenThrow(Exception('oops'));
-        when(() => querySnapshot.docs).thenReturn(queryDocumentSnapshots);
-        expect(
-          () => leaderboardRepository.addLeaderboardEntry(newScore),
-          throwsA(isA<DeleteLeaderboardException>()),
-        );
-      });
-
       test(
           'saves the new score when there are more than 10 scores in the '
-          'leaderboard and the new score is higher than the lowest top 10, and '
-          'deletes the scores that are not in the top 10 anymore', () async {
-        final deleteQuery = _MockQuery();
-        final deleteQuerySnapshot = _MockQuerySnapshot();
+          'leaderboard and the new score is higher than the lowest top 10',
+          () async {
         final newScore = LeaderboardEntryData(
           playerInitials: 'ABC',
           score: 15000,
@@ -327,21 +264,6 @@ void main() {
           5500,
           5000,
         ];
-        final deleteDocumentSnapshots = [5500, 5000].map((score) {
-          final queryDocumentSnapshot = _MockQueryDocumentSnapshot();
-          when(queryDocumentSnapshot.data).thenReturn(<String, dynamic>{
-            'character': 'dash',
-            'playerInitials': 'AAA',
-            'score': score
-          });
-          when(() => queryDocumentSnapshot.id).thenReturn('id$score');
-          when(() => queryDocumentSnapshot.reference)
-              .thenReturn(documentReference);
-          return queryDocumentSnapshot;
-        }).toList();
-        when(deleteQuery.get).thenAnswer((_) async => deleteQuerySnapshot);
-        when(() => deleteQuerySnapshot.docs)
-            .thenReturn(deleteDocumentSnapshots);
         final queryDocumentSnapshots = leaderboardScores.map((score) {
           final queryDocumentSnapshot = _MockQueryDocumentSnapshot();
           when(queryDocumentSnapshot.data).thenReturn(<String, dynamic>{
@@ -354,15 +276,10 @@ void main() {
               .thenReturn(documentReference);
           return queryDocumentSnapshot;
         }).toList();
-        when(
-          () => collectionReference.where('score', isLessThanOrEqualTo: 5500),
-        ).thenAnswer((_) => deleteQuery);
-        when(() => documentReference.delete())
-            .thenAnswer((_) async => Future.value());
+
         when(() => querySnapshot.docs).thenReturn(queryDocumentSnapshots);
         await leaderboardRepository.addLeaderboardEntry(newScore);
         verify(() => collectionReference.add(newScore.toJson())).called(1);
-        verify(() => documentReference.delete()).called(2);
       });
     });
   });