Merge branch 'refactor/archived-party-field' into 'master'

fmasa · fmasa · commit 5bd3371302cb · 2020-09-02T23:08:16.000Z
Migrace starých dat v databázi

See merge request fmasa/wfrp-master!109
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/domain/character/Character.kt b/app/src/main/java/cz/muni/fi/rpg/model/domain/character/Character.kt
@@ -1,6 +1,5 @@
 package cz.muni.fi.rpg.model.domain.character
 
-import com.fasterxml.jackson.annotation.JsonAlias
 import cz.muni.fi.rpg.model.domain.common.Ambitions
 import cz.muni.fi.rpg.model.domain.common.Money
 import java.lang.IllegalArgumentException
@@ -13,9 +12,8 @@ data class Character(
     private var psychology: String,
     private var motivation: String,
     private var race: Race,
-    @JsonAlias("stats") // TODO: Remove alias in 1.10
     private var characteristicsBase: Stats,
-    private var characteristicsAdvances: Stats = Stats(0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
+    private var characteristicsAdvances: Stats,
     private var points: Points,
     private var ambitions: Ambitions = Ambitions("", ""),
     private var mutation: String = "",
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/domain/character/Points.kt b/app/src/main/java/cz/muni/fi/rpg/model/domain/character/Points.kt
@@ -12,7 +12,7 @@ data class Points(
     val resolve: Int,
     val sin: Int,
     val experience: Int,
-    val hardyWoundsBonus: Int = 0
+    val hardyWoundsBonus: Int
 ) {
     init {
         require(corruption >= 0)
diff --git a/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestorePartyRepository.kt b/app/src/main/java/cz/muni/fi/rpg/model/firestore/repositories/FirestorePartyRepository.kt
@@ -59,15 +59,16 @@ internal class FirestorePartyRepository(
     }
 
     override fun forUserLive(userId: String): LiveData<List<Party>> =
-        QueryLiveData(queryForUser(userId), mapper) { !it.isArchived() }
+        QueryLiveData(queryForUser(userId), mapper)
 
     override suspend fun forUser(userId: String) =
         queryForUser(userId)
             .get()
             .await()
             .documents
             .map { mapper.fromDocumentSnapshot(it) }
-            .filter { !it.isArchived() }
 
-    private fun queryForUser(userId: String) = parties.whereArrayContains("users", userId)
+    private fun queryForUser(userId: String) = parties
+        .whereArrayContains("users", userId)
+        .whereEqualTo("archived", false)
 }
diff --git a/app/src/main/java/cz/muni/fi/rpg/ui/characterCreation/CharacterCreationFragment.kt b/app/src/main/java/cz/muni/fi/rpg/ui/characterCreation/CharacterCreationFragment.kt
@@ -119,7 +119,8 @@ class CharacterCreationFragment(
                             resilience = points.resilience,
                             resolve = points.resilience,
                             corruption = 0,
-                            sin = 0
+                            sin = 0,
+                            hardyWoundsBonus = 0
                         )
                     )
                 }
diff --git a/app/src/test/java/cz/muni/fi/rpg/model/domain/character/CharacterTest.kt b/app/src/test/java/cz/muni/fi/rpg/model/domain/character/CharacterTest.kt
@@ -16,7 +16,7 @@ class CharacterTest {
         Race.HALFLING,
         Stats(20, 40, 2, 4, 80, 5, 5, 4, 0, 10),
         Stats(20, 40, 2, 4, 80, 5, 5, 4, 0, 10),
-        Points(0, 4, 4, 5, 5, 0, 0, 0, 0)
+        Points(0, 4, 4, 5, 5, 0, 0, 0, 0, 0)
     )
 
     private fun characterWithHardy() = character().apply {
diff --git a/firebase/api.ts b/firebase/api.ts
@@ -40,8 +40,8 @@ export interface Character {
     career: string,
     socialClass: string,
     race: string,
-    stats: Stats,
-    maxStats: Stats,
+    characteristicsAdvances: Stats,
+    characteristicsBase: Stats,
     points: {
         corruption: number,
         experience: number,
@@ -52,6 +52,7 @@ export interface Character {
         resilience: number,
         resolve: number,
         sin: number,
+        hardyWoundsBonus: number
     },
     ambitions: {
         shortTerm: string,
@@ -63,6 +64,7 @@ export interface Character {
     money: {
         pennies: number,
     },
+    hardyTalent: boolean,
     note: string,
 }
 
diff --git a/firebase/firestore.rules b/firebase/firestore.rules
@@ -184,10 +184,8 @@ service cloud.firestore {
                             "socialClass",
                             "points",
                             "race",
-                            "stats",
                             "characteristicsBase",
                             "characteristicsAdvances",
-                            "maxStats",
                             "userId",
                             "money",
                             "motivation",
@@ -209,14 +207,12 @@ service cloud.firestore {
                         && character.socialClass is string && isNotBlank(character.socialClass) && character.socialClass.size() <= 50
                         && character.race is string && character.race in ["HUMAN", "HIGH_ELF", "DWARF", "HALFLING", "WOOD_ELF", "GNOME"]
                         && arePointsValid(character.points)
-                        && ("stats" in character || "characteristicsBase" in character)
-                        && (! ("stats" in character) || areStatsValid(character.stats))
-                        && (! ("characteristicsBase" in character) || areStatsValid(character.characteristicsBase))
-                        && (! ("characteristicsAdvances" in character) || areStatsValid(character.characteristicsAdvances))
+                        && areStatsValid(character.characteristicsBase)
+                        && areStatsValid(character.characteristicsAdvances)
                         && areMoneyValid(character.money)
                         && areAmbitionsValid(character.ambitions)
                         && character.note is string && character.note.size() <= 400
-                        && (! ("hardyTalent" in character) || (character.hardyTalent is bool))
+                        && character.hardyTalent is bool
                         && (! ("archived" in character) || (character.archived is bool && (!character.archived || character.userId == null)));
                 }
             }
@@ -244,7 +240,7 @@ service cloud.firestore {
                     && points.sin is int
                     && points.wounds is int
                     && points.experience is int
-                    && (! ("hardyWoundsBonus" in points) || (points.hardyWoundsBonus is int && points.hardyWoundsBonus >= 0));
+                    && points.hardyWoundsBonus is int;
             }
 
             function areStatsValid(stats) {
@@ -305,7 +301,7 @@ service cloud.firestore {
                     && party.id is string && party.id == partyId && isValidUuid(party.id)
                     && isValidPartyName(party.name)
                     && party.users == [uid]
-                    && (! ("archived" in party) || party.archived is bool)
+                    && party.archived is bool
                     && (party.gameMasterId == uid || party.gameMasterId == null)
                     && party.accessCode is string && party.accessCode != ""
                     && (! ("time" in party) || isValidImperialTime(party.time))
@@ -321,7 +317,7 @@ service cloud.firestore {
                     && isValidPartyName(party.name)
                     && party.users.toSet() == resource.data.users.toSet()
                     && (! ("time" in party) || isValidImperialTime(party.time))
-                    && (! ("archived" in party) || party.archived is bool)
+                    && party.archived is bool;
             }
 
             function isValidImperialTime(time) {
diff --git a/firebase/migrations/v0.0.2__make_party_archived_field_mandatory.ts b/firebase/migrations/v0.0.2__make_party_archived_field_mandatory.ts
@@ -0,0 +1,11 @@
+import firebase from "firebase";
+
+export async function migrate({firestore}: { firestore: firebase.firestore.Firestore }): Promise<void> {
+    const parties = await firestore.collection("parties").get();
+
+    for (const document of parties.docs) {
+        if (!("archived" in document.data())) {
+            await document.ref.set({archived: false}, {merge: true});
+        }
+    }
+}
diff --git a/firebase/migrations/v0.0.3__remove_characters_stats_alias.ts b/firebase/migrations/v0.0.3__remove_characters_stats_alias.ts
@@ -0,0 +1,32 @@
+import firebase from "firebase";
+
+export async function migrate({firestore}: { firestore: firebase.firestore.Firestore }): Promise<void> {
+    const characters = await firestore.collectionGroup("characters").get();
+
+    for (const document of characters.docs) {
+        const character = document.data();
+
+        if ("stats" in character) {
+            character["characteristicsBase"] = character["stats"];
+            delete character["stats"];
+
+            if (! ("characteristicsAdvances" in character)) {
+                character["characteristicsAdvances"] = {
+                    weaponSkill: 0,
+                    dexterity: 0,
+                    initiative: 0,
+                    ballisticSkill: 0,
+                    strength: 0,
+                    toughness: 0,
+                    agility: 0,
+                    intelligence: 0,
+                    willPower: 0,
+                    fellowship: 0,
+                }
+            }
+
+            delete character["maxStats"];
+            await document.ref.set(character);
+        }
+    }
+}
diff --git a/firebase/migrations/v0.0.4__make_hardy_character_hardy_field_mandatory.ts b/firebase/migrations/v0.0.4__make_hardy_character_hardy_field_mandatory.ts
@@ -0,0 +1,16 @@
+import firebase from "firebase";
+
+export async function migrate({firestore}: { firestore: firebase.firestore.Firestore }): Promise<void> {
+    const characters = await firestore.collectionGroup("characters").get();
+
+    for (const document of characters.docs) {
+        const character = document.data();
+
+        if (! ("hardyTalent" in character)) {
+            await document.ref.set({
+                hardyTalent: false,
+                points: {...character.points, hardyWoundsBonus: 0}
+            }, {merge: true});
+        }
+    }
+}
diff --git a/firebase/tests/Parties.ts b/firebase/tests/Parties.ts
@@ -34,25 +34,6 @@ class Parties extends Suite {
         await firebase.assertSucceeds(party.set(data))
     }
 
-    @test
-    async "users can create party without `archived` field (BC)"() {
-        const data = this.validParty();
-
-        delete data['archived'];
-
-        const party = this.authedApp(data.gameMasterId)
-            .collection("parties")
-            .doc(data.id);
-
-        // Empty name
-        await firebase.assertFails(party.set({...data, name: ""}));
-
-        // Whitespaces only name
-        await firebase.assertFails(party.set({...data, name: "\t \r"}));
-
-        await firebase.assertSucceeds(party.set(data))
-    }
-
     @test
     async "should NOT let users create party with incorrect field values"() {
         const data = this.validParty();
@@ -131,10 +112,6 @@ class Parties extends Suite {
             .collection("parties");
 
         await Promise.all(Object.keys(this.validParty()).map(field => {
-            if (field === 'archived') {
-                return; // This field is optional for now (BC)
-            }
-
             if (field === 'time') {
                 return; // This field is optional for now (BC), TODO: Remove in 1.14
             }
@@ -368,10 +345,6 @@ class Parties extends Suite {
         const data = this.validCharacter(userId);
 
         for (const field of Object.keys(data)) {
-            if (field == "maxStats") {
-                continue;  // maxStats are not used anymore and are there only for BC (TODO: Remove in 1.10)
-            }
-
             const newData = {...data};
 
             delete newData[field];
@@ -456,7 +429,7 @@ class Parties extends Suite {
     }
 
     @test
-    async "should not let users create character with invalid stats"() {
+    async "should not let users create character with invalid characteristics"() {
         const userId = "user123";
         const partyId = (await this.createUserAccessibleParty(userId)).id;
 
@@ -468,14 +441,14 @@ class Parties extends Suite {
 
         const data = this.validCharacter(userId);
 
-        for (const stat of Object.keys(data.stats)) {
-            const newData = {...data, stats: withoutField(data.stats, stat)};
+        for (const stat of Object.keys(data.characteristicsBase)) {
+            const newData = {...data, characteristicsBase: withoutField(data.characteristicsBase, stat)};
 
             // Missing stat
             await firebase.assertFails(character.set(newData));
 
             // Wrong stat type
-            newData.stats[stat] = "foo";
+            newData.characteristicsBase[stat] = "foo";
             await firebase.assertFails(character.set(newData));
         }
     }
@@ -493,7 +466,7 @@ class Parties extends Suite {
 
         const data = this.validCharacter(userId);
 
-        await firebase.assertFails(character.set({...data, stats: {...data.stats, extraStat: 10}}));
+        await firebase.assertFails(character.set({...data, characteristicsBase: {...data.characteristicsBase, extraStat: 10}}));
 
         const withPoints = (point: string, value: any) => ({...data, points: {...data.points, [point]: value}});
 
@@ -521,14 +494,6 @@ class Parties extends Suite {
         await firebase.assertSucceeds(
             document.update("points", {...this.validCharacter(userId).points, hardyWoundsBonus: 3})
         );
-
-        const character = (await document.get()).data() as Character;
-
-        await firebase.assertSucceeds(document.update({
-            characteristicsBase: character.stats,
-            characteristicsAdvances: character.stats,
-            ...withoutField(character, "stats")
-        }));
     }
 
     @test
diff --git a/firebase/tests/Suite.ts b/firebase/tests/Suite.ts
@@ -64,7 +64,7 @@ export abstract class Suite {
             career: "God",
             socialClass: "Warrior",
             race: "HUMAN",
-            stats: {
+            characteristicsAdvances: {
                 weaponSkill: 35,
                 dexterity: 20,
                 initiative: 10,
@@ -76,7 +76,7 @@ export abstract class Suite {
                 willPower: 10,
                 fellowship: 10,
             },
-            maxStats: {
+            characteristicsBase: {
                 weaponSkill: 35,
                 dexterity: 20,
                 initiative: 10,
@@ -98,6 +98,7 @@ export abstract class Suite {
                 resilience: 10,
                 resolve: 5,
                 sin: 4,
+                hardyWoundsBonus: 0,
             },
             ambitions: {
                 shortTerm: 'Kill monsters!',
@@ -110,6 +111,7 @@ export abstract class Suite {
                 pennies: 1000,
             },
             note: "",
+            hardyTalent: false,
         }
     }
 

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,8 @@ class CharacterCreationFragment(`
`119`	`119`	`resilience = points.resilience,`
`120`	`120`	`resolve = points.resilience,`
`121`	`121`	`corruption = 0,`
`122`		`- sin = 0`
	`122`	`+ sin = 0,`
	`123`	`+ hardyWoundsBonus = 0`
`123`	`124`	`)`
`124`	`125`	`)`
`125`	`126`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class CharacterTest {`
`16`	`16`	`Race.HALFLING,`
`17`	`17`	`Stats(20, 40, 2, 4, 80, 5, 5, 4, 0, 10),`
`18`	`18`	`Stats(20, 40, 2, 4, 80, 5, 5, 4, 0, 10),`
`19`		`- Points(0, 4, 4, 5, 5, 0, 0, 0, 0)`
	`19`	`+ Points(0, 4, 4, 5, 5, 0, 0, 0, 0, 0)`
`20`	`20`	`)`
`21`	`21`
`22`	`22`	`private fun characterWithHardy() = character().apply {`