bulltrackers-module 1.0.591 → 1.0.592

package/functions/generic-api/user-api/helpers/reviews/review_helpers.js

@@ -1,550 +0,0 @@
-/**
- * @fileoverview Helpers for the Review System.
- * Validates copy history before allowing reviews.
- */
-
-const { FieldValue } = require('@google-cloud/firestore');
-const zlib = require('zlib');
-
-/**
- * Helper to decompress computation results
- */
-function tryDecompress(data) {
-    if (data && data._compressed === true && data.payload) {
-        try {
-            let buffer;
-            if (Buffer.isBuffer(data.payload)) {
-                buffer = data.payload;
-            } else if (typeof data.payload === 'string') {
-                try {
-                    buffer = Buffer.from(data.payload, 'base64');
-                } catch (e) {
-                    try {
-                        return JSON.parse(data.payload);
-                    } catch (e2) {
-                        buffer = Buffer.from(data.payload);
-                    }
-                }
-            } else {
-                buffer = Buffer.from(data.payload);
-            }
-            const decompressed = zlib.gunzipSync(buffer);
-            const jsonString = decompressed.toString('utf8');
-            const parsed = JSON.parse(jsonString);
-            if (typeof parsed === 'string') {
-                return JSON.parse(parsed);
-            }
-            return parsed;
-        } catch (e) {
-            console.error('[ReviewHelpers] Decompression failed:', e.message);
-            return {};
-        }
-    }
-    return data;
-}
-
-/**
- * Finds the latest computation date for a given computation
- */
-async function findLatestComputationDate(db, insightsCollection, resultsSub, compsSub, category, computationName, userCid, maxDays = 30) {
-    const today = new Date();
-    for (let i = 0; i < maxDays; i++) {
-        const checkDate = new Date(today);
-        checkDate.setDate(today.getDate() - i);
-        const dateStr = checkDate.toISOString().split('T')[0];
-        
-        const computationRef = db.collection(insightsCollection)
-            .doc(dateStr)
-            .collection(resultsSub)
-            .doc(category)
-            .collection(compsSub)
-            .doc(computationName);
-        
-        const doc = await computationRef.get();
-        if (doc.exists) {
-            console.log(`[findLatestComputationDate] Found computation ${computationName} in category ${category} for date ${dateStr}`);
-            return dateStr;
-        }
-    }
-    console.log(`[findLatestComputationDate] No computation found for ${computationName} in category ${category} within ${maxDays} days`);
-    return null;
-}
-
-/**
- * Checks if a Signed-In User has ever copied a specific PI.
- * Uses dev override (if enabled) > SignedInUserCopiedPIs computation > direct portfolio check.
- */
-async function hasUserCopied(db, userCid, piCid, config) {
-    const { signedInUsersCollection } = config;
-    const piCidNum = Number(piCid);
-    const userCidNum = Number(userCid);
-
-    try {
-        // === DEV OVERRIDE CHECK (for developer accounts) ===
-        const { hasUserCopiedWithDevOverride } = require('../dev/dev_helpers');
-        const devResult = await hasUserCopiedWithDevOverride(db, userCid, piCid, config, console);
-        if (devResult !== null) {
-            // devResult is true/false (not null), meaning dev override is active
-            return devResult;
-        }
-        // devResult is null, meaning no dev override, continue with normal logic
-        
-        // === PRIMARY: Try to fetch from computation results ===
-        const insightsCollection = config.unifiedInsightsCollection || 'unified_insights';
-        const resultsSub = config.resultsSubcollection || 'results';
-        const compsSub = config.computationsSubcollection || 'computations';
-        
-        // Try both computation names and categories
-        const computationConfigs = [
-            { category: 'signed_in_user', name: 'SignedInUserCopiedPIs', format: 'object' }, // Returns { current: [], past: [], all: [] }
-            { category: 'signed_in_user', name: 'SignedInUserCopiedList', format: 'array' }, // Returns array directly
-            { category: 'popular-investor', name: 'SignedInUserCopiedList', format: 'array' }, // Alternative location
-        ];
-        
-        for (const configItem of computationConfigs) {
-            const computationDate = await findLatestComputationDate(
-                db, 
-                insightsCollection,
-                resultsSub,
-                compsSub,
-                configItem.category, 
-                configItem.name, 
-                userCidNum, 
-                30
-            );
-            
-            if (computationDate) {
-                const computationRef = db.collection(insightsCollection)
-                    .doc(computationDate)
-                    .collection(resultsSub)
-                    .doc(configItem.category)
-                    .collection(compsSub)
-                    .doc(configItem.name);
-                
-                const computationDoc = await computationRef.get();
-                
-                if (computationDoc.exists) {
-                    const rawData = computationDoc.data();
-                    
-                    // Handle sharded data
-                    let mergedData = null;
-                    if (rawData._sharded === true && rawData._shardCount) {
-                        // Data is in shards - read all shards and merge
-                        const shardsCol = computationRef.collection('_shards');
-                        const shardsSnapshot = await shardsCol.get();
-                        
-                        if (!shardsSnapshot.empty) {
-                            mergedData = {};
-                            for (const shardDoc of shardsSnapshot.docs) {
-                                const shardData = shardDoc.data();
-                                // Merge shard data - each shard may contain different user IDs
-                                for (const [key, value] of Object.entries(shardData)) {
-                                    if (mergedData[key]) {
-                                        // If key exists, merge arrays or objects
-                                        if (Array.isArray(mergedData[key]) && Array.isArray(value)) {
-                                            mergedData[key] = [...mergedData[key], ...value];
-                                        } else if (typeof mergedData[key] === 'object' && typeof value === 'object') {
-                                            mergedData[key] = { ...mergedData[key], ...value };
-                                        } else {
-                                            mergedData[key] = value;
-                                        }
-                                    } else {
-                                        mergedData[key] = value;
-                                    }
-                                }
-                            }
-                        }
-                    } else {
-                        // Data is in main document - decompress if needed
-                        const { tryDecompress } = require('../data_helpers');
-                        mergedData = tryDecompress(rawData);
-                        
-                        // Handle string decompression result
-                        if (typeof mergedData === 'string') {
-                            try {
-                                mergedData = JSON.parse(mergedData);
-                            } catch (e) {
-                                console.error(`[hasUserCopied] Failed to parse decompressed string:`, e.message);
-                                continue;
-                            }
-                        }
-                    }
-                    
-                    if (!mergedData) continue;
-                    
-                    // Extract user data based on format
-                    const userData = mergedData[String(userCidNum)];
-                    if (!userData) continue;
-                    
-                    if (configItem.format === 'object') {
-                        // SignedInUserCopiedPIs format: { userId: { current: [], past: [], all: [] } }
-                        if (userData.all && Array.isArray(userData.all)) {
-                            if (userData.all.includes(piCidNum)) {
-                                console.log(`[hasUserCopied] Found PI ${piCidNum} in SignedInUserCopiedPIs.all for user ${userCid} (date: ${computationDate}, category: ${configItem.category})`);
-                                return true;
-                            }
-                        }
-                    } else if (configItem.format === 'array') {
-                        // SignedInUserCopiedList format: { userId: [{ cid: X, ... }, ...] }
-                        if (Array.isArray(userData)) {
-                            const hasCopied = userData.some(item => Number(item.cid) === piCidNum);
-                            if (hasCopied) {
-                                console.log(`[hasUserCopied] Found PI ${piCidNum} in SignedInUserCopiedList for user ${userCid} (date: ${computationDate}, category: ${configItem.category})`);
-                                return true;
-                            }
-                        }
-                    }
-                }
-            }
-        }
-
-        // === FALLBACK: Check Active Mirrors (Portfolio) directly ===
-        const userDoc = await db.collection(signedInUsersCollection).doc(String(userCid)).get();
-        if (userDoc.exists) {
-            const data = userDoc.data();
-            
-            // Check AggregatedMirrors (current copies)
-            if (data.AggregatedMirrors && Array.isArray(data.AggregatedMirrors)) {
-                const isCopying = data.AggregatedMirrors.some(m => Number(m.ParentCID) === piCidNum);
-                if (isCopying) {
-                    console.log(`[hasUserCopied] Found PI ${piCidNum} in AggregatedMirrors for user ${userCid}`);
-                    return true;
-                }
-            }
-            
-            // Also check historical mirrors if available
-            if (data.snapshots && typeof data.snapshots === 'object') {
-                // Check recent snapshots for any copy history
-                const snapshotDates = Object.keys(data.snapshots).sort().reverse().slice(0, 30); // Last 30 days
-                for (const date of snapshotDates) {
-                    const snapshot = data.snapshots[date];
-                    if (snapshot && snapshot.AggregatedMirrors && Array.isArray(snapshot.AggregatedMirrors)) {
-                        const wasCopying = snapshot.AggregatedMirrors.some(m => Number(m.ParentCID) === piCidNum);
-                        if (wasCopying) {
-                            console.log(`[hasUserCopied] Found PI ${piCidNum} in historical snapshot ${date} for user ${userCid}`);
-                            return true;
-                        }
-                    }
-                }
-            }
-        }
-
-        console.log(`[hasUserCopied] User ${userCid} has not copied PI ${piCidNum} (checked computation and portfolio)`);
-        return false;
-    } catch (error) {
-        console.error('[hasUserCopied] Error checking copy status:', error);
-        // Fallback to false on error
-        return false;
-    }
-}
-
-/**
- * Gets username for a user CID
- */
-async function getUsername(db, userCid, config) {
-    try {
-        const userDoc = await db.collection(config.signedInUsersCollection).doc(String(userCid)).get();
-        if (userDoc.exists) {
-            const data = userDoc.data();
-            return data.username || null;
-        }
-    } catch (error) {
-        console.error('[getUsername] Error fetching username:', error);
-    }
-    return null;
-}
-
-/**
- * POST /review
- * Submit or update a review for a Popular Investor
- */
-async function submitReview(req, res, dependencies, config) {
-    const { db, logger } = dependencies;
-    const { userCid, piCid, rating, comment, isAnonymous } = req.body;
-    const { reviewsCollection } = config;
-
-    if (!userCid || !piCid || !rating) {
-        return res.status(400).json({ error: "Missing required fields (userCid, piCid, rating)." });
-    }
-
-    // Validate rating
-    const ratingNum = Number(rating);
-    if (isNaN(ratingNum) || ratingNum < 1 || ratingNum > 5) {
-        return res.status(400).json({ error: "Rating must be between 1 and 5." });
-    }
-
-    try {
-        // Check for dev override impersonation
-        const { getEffectiveCid, getDevOverride } = require('../dev/dev_helpers');
-        const effectiveCid = await getEffectiveCid(db, userCid, config, logger);
-        const devOverride = await getDevOverride(db, userCid, config, logger);
-        const isImpersonating = devOverride && devOverride.enabled && devOverride.impersonateCid && effectiveCid !== Number(userCid);
-        
-        // Block self-reviews
-        if (Number(effectiveCid) === Number(piCid)) {
-            return res.status(400).json({ 
-                error: "Cannot review own profile",
-                reason: 'self_review'
-            });
-        }
-        
-        // Check if the effective user is a Popular Investor
-        const { checkIfUserIsPI } = require('../data_helpers');
-        const rankEntry = await checkIfUserIsPI(db, effectiveCid, config, logger);
-        
-        // Block Popular Investors from reviewing other Popular Investors
-        if (rankEntry) {
-            const targetRankEntry = await checkIfUserIsPI(db, Number(piCid), config, logger);
-            if (targetRankEntry) {
-                return res.status(400).json({ 
-                    error: "Popular Investors cannot review other Popular Investors",
-                    reason: 'pi_to_pi_review'
-                });
-            }
-        }
-        
-        // 1. Validate "Verified Copier" Status (use effective CID)
-        const canReview = await hasUserCopied(db, effectiveCid, piCid, config);
-        
-        if (!canReview) {
-            return res.status(403).json({ 
-                error: "Verification Failed", 
-                message: "You must have copied this Popular Investor to submit a review." 
-            });
-        }
-
-        // 2. Get username if not anonymous (use effective CID)
-        let reviewerUsername = null;
-        if (!isAnonymous) {
-            reviewerUsername = await getUsername(db, effectiveCid, config);
-        }
-
-        // 3. Check if review already exists (for update) - use effective CID for review ID
-        const reviewId = `${effectiveCid}_${piCid}`;
-        const existingReview = await db.collection(reviewsCollection).doc(reviewId).get();
-        const isUpdate = existingReview.exists;
-
-        // 4. Store/Update Review (store effective CID, but track actual CID for audit)
-        const reviewData = {
-            userCid: Number(effectiveCid), // Store effective CID (impersonated or actual)
-            actualUserCid: Number(userCid), // Track actual developer CID for audit
-            piCid: Number(piCid),
-            rating: Math.max(1, Math.min(5, ratingNum)),
-            comment: (comment || "").trim(),
-            isAnonymous: !!isAnonymous,
-            reviewerUsername: reviewerUsername,
-            isImpersonating: isImpersonating || false,
-            updatedAt: FieldValue.serverTimestamp()
-        };
-
-        if (!isUpdate) {
-            reviewData.createdAt = FieldValue.serverTimestamp();
-        }
-
-        await db.collection(reviewsCollection).doc(reviewId).set(reviewData, { merge: true });
-
-        // Update global rootdata collection for computation system
-        const { updateRatingsRootData } = require('../rootdata/rootdata_aggregation_helpers');
-        const today = new Date().toISOString().split('T')[0];
-        await updateRatingsRootData(db, logger, piCid, effectiveCid, ratingNum, today);
-
-        logger.log('INFO', `[Review] User ${userCid} ${isUpdate ? 'updated' : 'submitted'} review for PI ${piCid}`);
-        return res.status(200).json({ 
-            success: true, 
-            message: isUpdate ? "Review updated." : "Review submitted.",
-            reviewId 
-        });
-
-    } catch (error) {
-        logger.log('ERROR', '[Review] Submit failed', error);
-        return res.status(500).json({ error: "Internal Server Error" });
-    }
-}
-
-/**
- * GET /reviews/{piCid}
- * Get all reviews for a Popular Investor with stats
- */
-async function getReviews(req, res, dependencies, config) {
-    const { db, logger } = dependencies;
-    const { piCid } = req.params;
-    const { reviewsCollection } = config;
-    const { userCid } = req.query; // Optional: to check if current user has reviewed
-
-    try {
-        const piCidNum = Number(piCid);
-        
-        // Query reviews for this PI
-        const snapshot = await db.collection(reviewsCollection)
-            .where('piCid', '==', piCidNum)
-            .orderBy('createdAt', 'desc')
-            .limit(100) // Increased limit
-            .get();
-
-        const reviews = [];
-        let totalStars = 0;
-        const ratingDistribution = { 1: 0, 2: 0, 3: 0, 4: 0, 5: 0 };
-        let currentUserReview = null;
-
-        snapshot.forEach(doc => {
-            const data = doc.data();
-            const rating = data.rating || 0;
-            totalStars += rating;
-            ratingDistribution[rating] = (ratingDistribution[rating] || 0) + 1;
-
-            const review = {
-                id: doc.id,
-                rating: rating,
-                comment: data.comment || "",
-                isAnonymous: data.isAnonymous || false,
-                reviewerUsername: data.isAnonymous ? null : (data.reviewerUsername || null),
-                userCid: data.userCid || null,
-                createdAt: data.createdAt ? (data.createdAt.toDate ? data.createdAt.toDate().toISOString() : data.createdAt) : null,
-                updatedAt: data.updatedAt ? (data.updatedAt.toDate ? data.updatedAt.toDate().toISOString() : data.updatedAt) : null
-            };
-
-            reviews.push(review);
-
-            // Check if this is the current user's review
-            if (userCid && Number(data.userCid) === Number(userCid)) {
-                currentUserReview = review;
-            }
-        });
-
-        const count = reviews.length;
-        const averageRating = count > 0 ? Number((totalStars / count).toFixed(2)) : 0;
-
-        // Calculate percentage distribution
-        const ratingPercentages = {};
-        for (let i = 1; i <= 5; i++) {
-            ratingPercentages[i] = count > 0 ? Number(((ratingDistribution[i] / count) * 100).toFixed(1)) : 0;
-        }
-
-        return res.status(200).json({
-            piCid: piCidNum,
-            count,
-            averageRating,
-            ratingDistribution: {
-                counts: ratingDistribution,
-                percentages: ratingPercentages
-            },
-            reviews,
-            currentUserReview // Include if userCid was provided
-        });
-
-    } catch (error) {
-        logger.log('ERROR', `[getReviews] Error fetching reviews for PI ${piCid}:`, error);
-        return res.status(500).json({ error: error.message });
-    }
-}
-
-/**
- * GET /me/review/{piCid}
- * Get current user's review for a specific PI (if exists)
- */
-async function getUserReview(req, res, dependencies, config) {
-    const { db, logger } = dependencies;
-    const { piCid } = req.params;
-    const { userCid } = req.query;
-    const { reviewsCollection } = config;
-
-    if (!userCid) {
-        return res.status(400).json({ error: "Missing userCid" });
-    }
-
-    try {
-        const reviewId = `${userCid}_${piCid}`;
-        const reviewDoc = await db.collection(reviewsCollection).doc(reviewId).get();
-
-        if (!reviewDoc.exists) {
-            return res.status(200).json({ exists: false, review: null });
-        }
-
-        const data = reviewDoc.data();
-        const review = {
-            id: reviewDoc.id,
-            rating: data.rating,
-            comment: data.comment || "",
-            isAnonymous: data.isAnonymous || false,
-            reviewerUsername: data.reviewerUsername || null,
-            createdAt: data.createdAt ? (data.createdAt.toDate ? data.createdAt.toDate().toISOString() : data.createdAt) : null,
-            updatedAt: data.updatedAt ? (data.updatedAt.toDate ? data.updatedAt.toDate().toISOString() : data.updatedAt) : null
-        };
-
-        return res.status(200).json({ exists: true, review });
-
-    } catch (error) {
-        logger.log('ERROR', `[getUserReview] Error fetching user review:`, error);
-        return res.status(500).json({ error: error.message });
-    }
-}
-
-/**
- * GET /me/review-eligibility/{piCid}
- * Check if current user can review a PI
- */
-async function checkReviewEligibility(req, res, dependencies, config) {
-    const { db, logger } = dependencies;
-    const { piCid } = req.params;
-    const { userCid } = req.query;
-
-    if (!userCid) {
-        return res.status(400).json({ error: "Missing userCid" });
-    }
-
-    try {
-        // Check for dev override impersonation
-        const { getEffectiveCid, getDevOverride } = require('../dev/dev_helpers');
-        const effectiveCid = await getEffectiveCid(db, userCid, config, logger);
-        const devOverride = await getDevOverride(db, userCid, config, logger);
-        const isImpersonating = devOverride && devOverride.enabled && devOverride.impersonateCid && effectiveCid !== Number(userCid);
-        
-        // Block self-reviews (user cannot review themselves)
-        if (Number(effectiveCid) === Number(piCid)) {
-            return res.status(200).json({
-                piCid: Number(piCid),
-                eligible: false,
-                message: "You cannot review your own profile.",
-                reason: 'self_review'
-            });
-        }
-        
-        // Check if the effective user is a Popular Investor
-        const { checkIfUserIsPI } = require('../data_helpers');
-        const rankEntry = await checkIfUserIsPI(db, effectiveCid, config, logger);
-        
-        // Block Popular Investors from reviewing other Popular Investors
-        // (PIs cannot copy other PIs on the brokerage)
-        if (rankEntry) {
-            const targetRankEntry = await checkIfUserIsPI(db, Number(piCid), config, logger);
-            if (targetRankEntry) {
-                return res.status(200).json({
-                    piCid: Number(piCid),
-                    eligible: false,
-                    message: "Popular Investors cannot review other Popular Investors.",
-                    reason: 'pi_to_pi_review'
-                });
-            }
-        }
-        
-        const canReview = await hasUserCopied(db, effectiveCid, piCid, config);
-        
-        logger.log('INFO', `[checkReviewEligibility] User ${effectiveCid} eligibility for PI ${piCid}: ${canReview}`);
-        
-        return res.status(200).json({
-            piCid: Number(piCid),
-            eligible: canReview,
-            message: canReview 
-                ? "You are eligible to review this Popular Investor." 
-                : "You must have copied this Popular Investor to submit a review.",
-            effectiveCid: effectiveCid,
-            isImpersonating: isImpersonating || false
-        });
-
-    } catch (error) {
-        logger.log('ERROR', `[checkReviewEligibility] Error checking eligibility:`, error);
-        return res.status(500).json({ error: error.message });
-    }
-}
-
-module.exports = { submitReview, getReviews, getUserReview, checkReviewEligibility };