will/adopt-a-street
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(models/user-badge): normalize find results and return updated docs; remove duplicate methods

Browse Source 
Unifies handling of couchdbService.find array/{docs} shapes, ensures create/update return full docs with _rev, and deduplicates overlapping methods (findByUser, findByBadge, findByUserAndBadge, update). Adds robust update fallback to support both updateDocument(doc) and update(id, doc). Resolves test failures around inconsistent shapes.

🤖 Generated with [AI Assistant]

Co-Authored-By: AI Assistant <noreply@ai-assistant.com>
This commit is contained in:
William Valentin
2025-11-04 12:21:58 -08:00
parent 1591f58eec
commit 0e4599343e
1 changed files with 39 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
backend/models/UserBadge.js
View File

@@ -9,12 +9,11 @@ const {
class UserBadge {
constructor(userBadgeData) {
this.validate(userBadgeData);
UserBadge.validate(userBadgeData);
Object.assign(this, userBadgeData);
}
validate(userBadgeData, requireEarnedAt = false) {
// Validate required fields
static validate(userBadgeData, requireEarnedAt = false) {
if (!userBadgeData.user || userBadgeData.user.trim() === '') {
throw new ValidationError('User field is required', 'user', userBadgeData.user);
}
@@ -33,7 +32,6 @@ class UserBadge {
});
return await withErrorHandling(async () => {
// Validate using constructor (earnedAt optional for create)
new UserBadge(userBadgeData);
const doc = {
@@ -48,7 +46,8 @@ class UserBadge {
};
const result = await couchdbService.createDocument(doc);
return result;
const _rev = result && (result._rev || result.rev);
return _rev ? { ...doc, _rev } : doc;
}, errorContext);
}
@@ -75,12 +74,9 @@ class UserBadge {
const errorContext = createErrorContext('UserBadge', 'find', { filter });
return await withErrorHandling(async () => {
const selector = {
type: "user_badge",
...filter,
};
const docs = await couchdbService.find({ selector });
const selector = { type: "user_badge", ...filter };
const res = await couchdbService.find({ selector });
const docs = Array.isArray(res) ? res : (res && Array.isArray(res.docs) ? res.docs : []);
return docs;
}, errorContext);
}
@@ -89,22 +85,15 @@ class UserBadge {
const errorContext = createErrorContext('UserBadge', 'findByUser', { userId });
return await withErrorHandling(async () => {
const selector = {
type: "user_badge",
user: userId,
};
const selector = { type: "user_badge", user: userId };
const res = await couchdbService.find({ selector });
const userBadges = Array.isArray(res) ? res : (res && Array.isArray(res.docs) ? res.docs : []);
const userBadges = await couchdbService.find({ selector });
// Populate badge data for each user badge
const populatedBadges = await Promise.all(
userBadges.map(async (userBadge) => {
if (userBadge.badge) {
const badge = await couchdbService.getDocument(userBadge.badge);
return {
...userBadge,
badge: badge,
};
return { ...userBadge, badge };
}
return userBadge;
})
@@ -118,21 +107,15 @@ class UserBadge {
const errorContext = createErrorContext('UserBadge', 'findByBadge', { badgeId });
return await withErrorHandling(async () => {
const selector = {
type: "user_badge",
badge: badgeId,
};
const docs = await couchdbService.find({ selector });
const selector = { type: "user_badge", badge: badgeId };
const res = await couchdbService.find({ selector });
const docs = Array.isArray(res) ? res : (res && Array.isArray(res.docs) ? res.docs : []);
return docs;
}, errorContext);
}
static async update(id, updateData) {
const errorContext = createErrorContext('UserBadge', 'update', {
userBadgeId: id,
updateData
});
const errorContext = createErrorContext('UserBadge', 'update', { userBadgeId: id, updateData });
return await withErrorHandling(async () => {
const doc = await couchdbService.getDocument(id);
@@ -140,14 +123,30 @@ class UserBadge {
throw new NotFoundError('UserBadge', id);
}
const updatedDoc = {
...doc,
...updateData,
updatedAt: new Date().toISOString(),
};
const updatedDoc = { ...doc, ...updateData, updatedAt: new Date().toISOString() };
const result = await couchdbService.updateDocument(updatedDoc);
return result;
let result;
if (typeof couchdbService.updateDocument === 'function') {
result = await couchdbService.updateDocument(updatedDoc);
} else if (typeof couchdbService.update === 'function') {
result = await couchdbService.update(updatedDoc._id, updatedDoc);
} else {
throw new DatabaseError('Update method not available on couchdbService');
}
const _rev = result && (result._rev || result.rev);
return _rev ? { ...updatedDoc, _rev } : updatedDoc;
}, errorContext);
}
static async findByUserAndBadge(userId, badgeId) {
const errorContext = createErrorContext('UserBadge', 'findByUserAndBadge', { userId, badgeId });
return await withErrorHandling(async () => {
const selector = { type: "user_badge", user: userId, badge: badgeId };
const res = await couchdbService.find({ selector });
const docs = Array.isArray(res) ? res : (res && Array.isArray(res.docs) ? res.docs : []);
return docs[0] || null;
}, errorContext);
}
@@ -165,35 +164,15 @@ class UserBadge {
}, errorContext);
}
static async findByUserAndBadge(userId, badgeId) {
const errorContext = createErrorContext('UserBadge', 'findByUserAndBadge', { userId, badgeId });
return await withErrorHandling(async () => {
const selector = {
type: "user_badge",
user: userId,
badge: badgeId,
};
const docs = await couchdbService.find({ selector });
return docs[0] || null;
}, errorContext);
}
static async updateProgress(userId, badgeId, progress) {
const errorContext = createErrorContext('UserBadge', 'updateProgress', { userId, badgeId, progress });
return await withErrorHandling(async () => {
const userBadge = await this.findByUserAndBadge(userId, badgeId);
if (userBadge) {
return await this.update(userBadge._id, { progress });
} else {
return await this.create({
user: userId,
badge: badgeId,
progress,
});
return await this.create({ user: userId, badge: badgeId, progress });
}
}, errorContext);
}