Implement Firebase Cloud Functions for byTag management.

Author: FactorioBlueprints

database.rules.json

@@ -65,7 +65,7 @@
 		},
 		"byTag": {
 			".read": "true",
-			".write": "true"
+			".write": "false"
 		}
 	}
 }

eslint.config.ts

@@ -8,6 +8,19 @@ import type {Linter} from 'eslint';
 
 const config: Linter.Config[] = [
 	{ignores: ['dist', 'build', '.llm/**']},
+	{
+		files: ['functions/**/*.js'],
+		languageOptions: {
+			ecmaVersion: 2020,
+			globals: {
+				...globals.node,
+			},
+			sourceType: 'commonjs',
+		},
+		rules: {
+			...js.configs.recommended.rules,
+		},
+	},
 	{
 		files: ['public/**/*.{ts,tsx}'],
 		languageOptions: {

firebase.json

@@ -2,6 +2,9 @@
 	"database": {
 		"rules": "database.rules.json"
 	},
+	"functions": {
+		"source": "functions"
+	},
 	"hosting": {
 		"public": "dist",
 		"rewrites": [

functions/.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+	root: true,
+	env: {
+		es6: true,
+		node: true,
+		commonjs: true,
+	},
+	extends: ['eslint:recommended'],
+	parserOptions: {
+		ecmaVersion: 2020,
+	},
+	rules: {
+		quotes: ['error', 'double'],
+		'object-curly-spacing': ['error', 'never'],
+		indent: ['error', 2],
+	},
+};

functions/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*

functions/index.js

@@ -0,0 +1,90 @@
+const functions = require('firebase-functions');
+const admin = require('firebase-admin');
+
+admin.initializeApp();
+
+const database = admin.database();
+
+/**
+ * Cloud function to update byTag when a blueprint is created
+ */
+exports.onBlueprintCreate = functions.database.ref('/blueprints/{blueprintId}').onCreate(async (snapshot, context) => {
+	const blueprintId = context.params.blueprintId;
+	const blueprint = snapshot.val();
+
+	if (!blueprint || !blueprint.tags || !Array.isArray(blueprint.tags)) {
+		console.log(`Blueprint ${blueprintId} has no tags`);
+		return null;
+	}
+
+	const updates = {};
+	blueprint.tags.forEach((tag) => {
+		updates[`/byTag/${tag}/${blueprintId}`] = true;
+	});
+
+	console.log(`Adding blueprint ${blueprintId} to ${blueprint.tags.length} tags`);
+	return database.ref().update(updates);
+});
+
+/**
+ * Cloud function to update byTag when a blueprint is updated
+ */
+exports.onBlueprintUpdate = functions.database.ref('/blueprints/{blueprintId}').onUpdate(async (change, context) => {
+	const blueprintId = context.params.blueprintId;
+	const beforeData = change.before.val();
+	const afterData = change.after.val();
+
+	// Handle case where blueprint might be soft-deleted
+	if (!afterData) {
+		console.log(`Blueprint ${blueprintId} was deleted`);
+		return null;
+	}
+
+	const beforeTags = beforeData?.tags || [];
+	const afterTags = afterData?.tags || [];
+
+	// Find tags that were added and removed
+	const addedTags = afterTags.filter((tag) => !beforeTags.includes(tag));
+	const removedTags = beforeTags.filter((tag) => !afterTags.includes(tag));
+
+	if (addedTags.length === 0 && removedTags.length === 0) {
+		console.log(`No tag changes for blueprint ${blueprintId}`);
+		return null;
+	}
+
+	const updates = {};
+
+	// Add blueprint to new tags
+	addedTags.forEach((tag) => {
+		updates[`/byTag/${tag}/${blueprintId}`] = true;
+	});
+
+	// Remove blueprint from old tags
+	removedTags.forEach((tag) => {
+		updates[`/byTag/${tag}/${blueprintId}`] = null;
+	});
+
+	console.log(`Updating tags for blueprint ${blueprintId}: +${addedTags.length} -${removedTags.length}`);
+	return database.ref().update(updates);
+});
+
+/**
+ * Cloud function to update byTag when a blueprint is deleted
+ */
+exports.onBlueprintDelete = functions.database.ref('/blueprints/{blueprintId}').onDelete(async (snapshot, context) => {
+	const blueprintId = context.params.blueprintId;
+	const blueprint = snapshot.val();
+
+	if (!blueprint || !blueprint.tags || !Array.isArray(blueprint.tags)) {
+		console.log(`Deleted blueprint ${blueprintId} had no tags`);
+		return null;
+	}
+
+	const updates = {};
+	blueprint.tags.forEach((tag) => {
+		updates[`/byTag/${tag}/${blueprintId}`] = null;
+	});
+
+	console.log(`Removing blueprint ${blueprintId} from ${blueprint.tags.length} tags`);
+	return database.ref().update(updates);
+});

functions/package.json

@@ -0,0 +1,25 @@
+{
+	"name": "functions",
+	"description": "Cloud Functions for Firebase",
+	"scripts": {
+		"lint": "eslint .",
+		"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": "18"
+	},
+	"main": "index.js",
+	"dependencies": {
+		"firebase-admin": "^12.0.0",
+		"firebase-functions": "^4.5.0"
+	},
+	"devDependencies": {
+		"eslint": "^8.15.0",
+		"firebase-functions-test": "^3.1.0"
+	},
+	"private": true
+}

src/Blueprint.ts

@@ -109,10 +109,8 @@ interface V15DecodedObject {
 	[key: string]: unknown;
 }
 
-// Union type for all possible decoded objects
 type DecodedObject = V15DecodedObject | undefined;
 
-// Type for converted objects
 type ConvertedBlueprint = SingleBlueprint | BlueprintBook;
 
 class Blueprint {

src/api/firebase.test.ts

@@ -206,7 +206,6 @@ describe('firebase API', () => {
 			const result = await fetchBlueprintFromCdn(mockBlueprintSummary);
 
 			expect(result).toBeNull();
-			// Network errors (status 0) should not be logged
 			expect(consoleWarnSpy).not.toHaveBeenCalled();
 
 			consoleWarnSpy.mockRestore();
@@ -294,9 +293,12 @@ describe('firebase API', () => {
 
 			const sortedByDateDesc = [...entries].sort((a, b) => (b.lastUpdatedDate || 0) - (a.lastUpdatedDate || 0));
 
-			expect(sortedByDateDesc[0].key).toBe('blueprint1'); // Newest (300) should be first
-			expect(sortedByDateDesc[1].key).toBe('blueprint2'); // Second newest (200) should be second
-			expect(sortedByDateDesc[2].key).toBe('blueprint3'); // Oldest (100) should be last
+			// Newest (300) should be first
+			expect(sortedByDateDesc[0].key).toBe('blueprint1');
+			// Second newest (200) should be second
+			expect(sortedByDateDesc[1].key).toBe('blueprint2');
+			// Oldest (100) should be last
+			expect(sortedByDateDesc[2].key).toBe('blueprint3');
 
 			expect(entries[0].key).toBe('blueprint1');
 			expect(entries[1].key).toBe('blueprint2');

src/api/firebase.ts

@@ -568,7 +568,6 @@ export const fetchPaginatedSummaries = async (
 			}
 		}
 
-		// Build the data object from the reversed entries
 		const data: Record<string, RawBlueprintSummary> = {};
 		entries.forEach(([key, value]) => {
 			data[key] = value;