Firebase Development

Firebase Development

Overview

This skill system guides Firebase development using proven patterns from production projects. It covers:

• Project Setup: Initialize new Firebase projects with proper architecture
• Feature Development: Add Cloud Functions, Firestore collections, API endpoints
• Debugging: Troubleshoot emulator issues, rules violations, function errors
• Validation: Review code against security model and best practices

This skill will invoke one of four sub-skills:

• firebase-development:project-setup - Initialize new Firebase projects
• firebase-development:add-feature - Add functions/collections/endpoints
• firebase-development:debug - Troubleshoot emulator and runtime issues
• firebase-development:validate - Review Firebase code for security/patterns

The main skill detects your intent and routes to the appropriate sub-skill. All sub-skills reference shared Firebase patterns documented in this file.

When This Skill Applies

Use this skill system when working with Firebase projects:

• Starting new Firebase projects
• Adding Cloud Functions or Firestore collections
• Debugging emulator issues or rule violations
• Reviewing Firebase code for security and patterns
• Setting up multi-hosting configurations
• Implementing authentication (API keys or Firebase Auth)

How It Works

1. Intent Detection: Analyzes keywords in your request
2. Routing: Directs to appropriate sub-skill (project-setup, add-feature, debug, validate)
3. Pattern Reference: All sub-skills use shared patterns documented here
4. TodoWrite Tracking: Each sub-skill creates detailed progress checklists

Reference Projects

Patterns are extracted from three production Firebase projects:

• oneonone (/Users/dylanr/work/2389/oneonone): Express API architecture, custom API keys, server-write-only security
• bot-socialmedia (/Users/dylanr/work/2389/bot-socialmedia-server): Domain-grouped functions, Firebase Auth + roles, client-write with validation
• meme-rodeo (/Users/dylanr/work/2389/meme-rodeo): Individual function files, Firebase Auth + entitlements

These projects demonstrate different valid approaches to Firebase architecture. The skills help you choose the right pattern for your needs.

Routing Logic

This skill uses keyword-based routing to determine which sub-skill to use:

Keywords by Sub-Skill

project-setup:

• "new firebase project"
• "initialize firebase"
• "firebase init"
• "set up firebase"
• "create firebase app"
• "start firebase project"

add-feature:

• "add function"
• "create endpoint"
• "new tool"
• "add api"
• "new collection"
• "add feature"
• "build"
• "implement"

debug:

• "error"
• "not working"
• "debug"
• "emulator issue"
• "rules failing"
• "permission denied"
• "troubleshoot"
• "deployment failed"

validate:

• "review firebase"
• "check firebase"
• "validate"
• "audit firebase"
• "look at firebase code"

Routing Process

1. Analyze Request: Check for routing keywords
2. Match Sub-Skill: Identify best match based on keyword density
3. Announce: "I'm using the firebase-development:[sub-skill] skill to [action]"
4. Route: Load and execute the sub-skill
5. Fallback: If ambiguous, use AskUserQuestion with 4 options

Fallback Example

If intent is unclear, ask:

Question: "What Firebase task are you working on?"
Options:
  - "Project Setup" (Initialize new Firebase project)
  - "Add Feature" (Add functions, collections, endpoints)
  - "Debug Issue" (Troubleshoot errors or problems)
  - "Validate Code" (Review against patterns)

Shared Firebase Patterns

These patterns are documented once here and referenced by all sub-skills. Choose the approach that fits your project needs.

Multi-Hosting Setup

Firebase supports multiple hosting configurations. Choose based on your needs:

Option 1: site: Based (Preferred for Simplicity)

When to use: Multiple independent deployments with separate URLs

Configuration:

{
  "hosting": [
    {
      "site": "oneonone-mcp",
      "source": "hosting",
      "frameworksBackend": {"region": "us-central1"}
    },
    {
      "site": "oneonone-mcp-mcp",
      "public": "hosting-mcp",
      "rewrites": [{"source": "/**", "function": "mcpEndpoint"}]
    },
    {
      "site": "oneonone-mcp-api",
      "public": "hosting-api",
      "rewrites": [{"source": "/**", "function": "mcpEndpoint"}]
    }
  ]
}

Setup:

# Create sites in Firebase Console or via CLI
firebase hosting:sites:create oneonone-mcp
firebase hosting:sites:create oneonone-mcp-mcp
firebase hosting:sites:create oneonone-mcp-api

# Deploy specific site
firebase deploy --only hosting:oneonone-mcp

# Deploy all hosting sites
firebase deploy --only hosting

URLs: Each site gets its own URL: oneonone-mcp.web.app, oneonone-mcp-mcp.web.app, oneonone-mcp-api.web.app

Emulator Testing: When using emulators, all sites are served on the same hosting port (5000). Test one site at a time or use paths to differentiate.

Benefits:

• Simple, straightforward deployment
• Each site is completely independent
• No build coordination needed
• Easy to deploy one site at a time

Note: predeploy hooks are not supported with site-based configs. Use target-based (Option 2) if you need build scripts before deployment.

Example: oneonone uses 3 separate sites (main app, MCP endpoint, API endpoint)

Reference: /Users/dylanr/work/2389/oneonone/firebase.json

Option 2: target: Based (Use for Predeploy Hooks)

When to use: Need build scripts before deployment, monorepo coordination

Configuration:

{
  "hosting": [
    {
      "target": "main",
      "source": "hosting",
      "frameworksBackend": {"region": "us-central1"}
    },
    {
      "target": "streamer",
      "public": "streamer",
      "predeploy": ["cd streamer-app && npm install", "cd streamer-app && npm run build"]
    },
    {
      "target": "api",
      "public": "api",
      "rewrites": [
        {"source": "/api**/**", "function": "api"}
      ]
    }
  ]
}

Setup:

# Link targets to sites (one-time setup stored in .firebaserc)
firebase target:apply hosting main bot-socialmedia-main
firebase target:apply hosting streamer bot-socialmedia-streamer
firebase target:apply hosting api bot-socialmedia-api

# Deploy specific target (runs predeploy hooks)
firebase deploy --only hosting:main

# Deploy all targets
firebase deploy --only hosting

Emulator Configuration with Targets:

{
  "emulators": {
    "hosting": [
      {"target": "main", "port": 5000},
      {"target": "api", "port": 5002}
    ]
  }
}

Benefits:

• Predeploy hooks run build scripts automatically
• Better for monorepo patterns
• Coordinate builds across multiple apps

Trade-offs:

• More complex setup (requires target:apply commands)
• Target mappings stored in .firebaserc (must track this file)

Example: bot-socialmedia uses targets with predeploy hooks for builds

Reference: /Users/dylanr/work/2389/bot-socialmedia-server/firebase.json

Option 3: Single Hosting with Rewrites

When to use: Smaller projects, all content under one domain

Configuration:

{
  "hosting": {
    "source": "hosting",
    "site": "rodeo-meme",
    "frameworksBackend": {"region": "us-central1"},
    "rewrites": [
      {
        "source": "/images/memes/**",
        "function": {
          "functionId": "proxyMemeFile",
          "region": "us-central1"
        }
      }
    ]
  }
}

Setup:

# No special setup needed - just deploy
firebase deploy --only hosting

Benefits:

• Simplest configuration
• All content under one domain
• Perfect for smaller projects
• Easy to understand

Trade-offs:

• All routes share same hosting site
• Can't deploy parts independently
• Less flexible for complex architectures

Example: meme-rodeo uses single hosting with function rewrites

Reference: /Users/dylanr/work/2389/meme-rodeo/firebase.json

Guidance

• Use site: if: You need multiple independent URLs, straightforward deployment
• Use target: if: You need predeploy build scripts, monorepo patterns
• Use single+rewrites if: Simpler project, all under one domain

Migration path: Start with single hosting, migrate to site: based when you need multiple URLs

Authentication

Firebase projects can use custom API keys, Firebase Auth, or both. Choose based on your use case.

Custom API Keys (MCP Tools, APIs, Server-to-Server)

When to use:

• MCP server endpoints
• Programmatic API access
• Server-to-server communication
• No user login UI needed

Format: {projectPrefix}_ + unique identifier

• Choose 3-4 character project abbreviation
• Examples: ooo_abc123 (OneOnOne), meme_xyz789 (Meme Rodeo), bot_def456 (Bot Social)

Storage Pattern:

/users/{userId}/apiKeys/{keyId}
  - keyId: "ooo_abc123..." (the actual key)
  - userId: string
  - active: boolean
  - createdAt: timestamp

Note: The keyId field contains the actual API key and enables collection group queries (used by middleware to find keys across all users).

Middleware Pattern:

// functions/src/middleware/apiKeyGuard.ts
import { Request, Response, NextFunction } from 'express';
import * as admin from 'firebase-admin';

export async function apiKeyGuard(req: Request, res: Response, next: NextFunction) {
  const apiKey = req.headers['x-api-key'] as string;

  if (!apiKey || !apiKey.startsWith('ooo_')) { // Replace 'ooo_' with your project prefix
    res.status(401).json({ error: 'Invalid API key' });
    return;
  }

  const db = admin.firestore();
  const apiKeysQuery = await db
    .collectionGroup('apiKeys')
    .where('keyId', '==', apiKey)
    .where('active', '==', true)
    .limit(1)
    .get();

  if (apiKeysQuery.empty) {
    res.status(401).json({ error: 'Invalid API key' });
    return;
  }

  req.userId = apiKeysQuery.docs[0].data().userId;
  next();
}

Example: oneonone's API key implementation

Reference: /Users/dylanr/work/2389/oneonone/functions/src/middleware/apiKeyGuard.ts

Firebase Auth + Roles (User-Facing Apps)

When to use:

• Web/mobile apps with user login
• Social features requiring user identity
• Role-based access control

Role Storage:

/users/{userId}
  - role: "admin" | "teamlead" | "user"  (or)
  - entitlement: "admin" | "moderator" | "public" | "waitlist"
  - displayName: string
  - email: string

Firestore Rules Pattern:

function isAdmin() {
  return get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == 'admin';
}

function isModerator() {
  return get(/databases/$(database)/documents/users/$(request.auth.uid)).data.entitlement == 'moderator';
}

match /users/{userId} {
  allow read: if request.auth != null && (request.auth.uid == userId || isAdmin());
  allow update: if request.auth != null && request.auth.uid == userId;
}

Examples:

• bot-socialmedia uses role field (admin/teamlead/user)
• meme-rodeo uses entitlement field (admin/moderator/public/waitlist)

References:

• /Users/dylanr/work/2389/bot-socialmedia-server/firestore.rules
• /Users/dylanr/work/2389/meme-rodeo/firestore.rules

Both Can Coexist

Pattern: Firebase Auth for web UI + API keys for programmatic access

Example Use Case:

• Users log in via Firebase Auth in web app
• MCP tools/scripts use API keys for automation
• Same backend, different authentication methods

Implementation:

• Web routes check request.auth.uid
• API routes check x-api-key header via middleware
• Both methods access same Firestore data with appropriate rules

Cloud Functions Architecture

Choose an architecture pattern based on your project type. All patterns work with hosting rewrites for API routing.

Express App with Routing (API Projects)

When to use:

• API-like projects with many related endpoints
• Need middleware (auth, logging, CORS)
• RESTful routing patterns

Structure:

functions/src/
├── index.ts              # Express app export
├── middleware/
│   ├── apiKeyGuard.ts
│   └── loggingMiddleware.ts
├── tools/               # Or "routes/"
│   ├── requestSession.ts
│   ├── sendMessage.ts
│   └── endSession.ts
├── services/
│   └── sessionManager.ts
└── shared/
    ├── types.ts
    └── config.ts

index.ts Pattern:

// ABOUTME: Main entry point for Firebase Functions - exports MCP endpoint with tool routing
// ABOUTME: Configures Express app with authentication, CORS, and health check

import * as admin from 'firebase-admin';
import { onRequest } from 'firebase-functions/v2/https';
import express, { Request, Response } from 'express';
import cors from 'cors';
import { apiKeyGuard } from './middleware/apiKeyGuard';
import { handleRequestSession } from './tools/requestSession';

admin.initializeApp();
const app = express();

app.use(cors({ origin: true }));
app.use(express.json());

app.get('/health', (_req, res) => {
  res.status(200).json({ status: 'ok' });
});

app.post('/mcp', apiKeyGuard, async (req, res) => {
  const { tool, params } = req.body;
  const userId = req.userId!;

  let result;
  switch (tool) {
    case 'request_session':
      result = await handleRequestSession(userId, params);
      break;
    default:
      res.status(400).json({ success: false, error: 'Unknown tool' });
      return;
  }

  res.status(200).json(result);
});

export const mcpEndpoint = onRequest({ invoker: 'public', cors: true }, app);

Hosting Rewrite (firebase.json):

{
  "hosting": {
    "rewrites": [
      {"source": "/**", "function": "mcpEndpoint"}
    ]
  }
}

Example: oneonone uses Express routing for MCP tools

Reference: /Users/dylanr/work/2389/oneonone/functions/src/index.ts

Domain-Grouped Files (Feature-Rich Apps)

When to use:

• Apps with distinct feature areas
• Multiple related functions per domain
• Clear domain boundaries

Structure:

functions/src/
├── index.ts              # Re-exports all functions
├── posts.ts              # All post-related functions
├── journal.ts            # All journal functions
├── admin.ts              # Admin functions
├── teamSummaries.ts      # Summary generation
└── shared/
    ├── types/
    ├── validators/
    └── utils/

Domain File Pattern (posts.ts):

// ABOUTME: Post creation, reading, and management functions
// ABOUTME: Includes API endpoints and real-time triggers

import { onRequest } from 'firebase-functions/v2/https';
import { onDocumentCreated } from 'firebase-functions/v2/firestore';

export const createPost = onRequest(async (req, res) => {
  // Implementation
});

export const getPosts = onRequest(async (req, res) => {
  // Implementation
});

export const async (event) => {
  // Trigger implementation
});

index.ts Pattern:

// ABOUTME: Main entry point - re-exports all Cloud Functions
// ABOUTME: Organizes functions by domain for clear structure

export * from './posts';
export * from './journal';
export * from './admin';
export * from './teamSummaries';

Example: bot-socialmedia uses domain-grouped architecture

Reference: /Users/dylanr/work/2389/bot-socialmedia-server/functions/src/

Individual Function Files (Independent Functions)

When to use:

• Collection of independent functions
• Maximum modularity
• Simple projects with few dependencies

Structure:

functions/
├── index.js              # Imports and exports all
└── functions/
    ├── upload.js
    ├── searchMemes.js
    ├── generateInvite.js
    ├── onFileUploaded.js
    └── periodicFileCheck.js

Function File Pattern:

const { onRequest } = require('firebase-functions/v2/https');

exports.upload = onRequest(async (req, res) => {
  // Implementation
});

index.js Pattern:

const { upload } = require("./functions/upload");
const { searchMemes } = require("./functions/searchMemes");

exports.upload = upload;
exports.searchMemes = searchMemes;

Example: meme-rodeo uses individual function files

Reference: /Users/dylanr/work/2389/meme-rodeo/functions/

Guidance

• Use Express if: Building API with related endpoints, need middleware
• Use domain-grouped if: Feature-rich app with distinct areas (posts, admin, etc.)
• Use individual files if: Independent functions, maximum modularity
• All work with hosting rewrites for API routing patterns

Security Model

Choose a security philosophy based on your write patterns.

Server-Write-Only (Default, Preferred)

When to use:

• Light-write applications (mostly reads)
• High security requirements
• API/MCP projects
• Admin dashboards

Pattern:

// firestore.rules
rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Helper functions
    function isAuthenticated() {
      return request.auth != null;
    }

    function isOwner(userId) {
      return isAuthenticated() && request.auth.uid == userId;
    }

    // All collections: read allowed, write denied
    match /config/{configId} {
      allow read: if true;
      allow write: if false;  // Only Cloud Functions can write
    }

    match /users/{userId} {
      allow read: if isOwner(userId);
      allow write: if false;  // Only Cloud Functions can write

      // User API keys subcollection
      match /apiKeys/{keyId} {
        allow read: if isOwner(userId);
        allow write: if false;  // Only Cloud Functions can write
      }
    }

    // Default deny
    match /{document=**} {
      allow read, write: if false;
    }
  }
}

Benefits:

• Maximum security
• Single source of truth (Cloud Functions)
• Easier to audit
• Simpler rules

Trade-offs:

• Requires Cloud Function for every mutation
• Slightly higher latency
• More function invocations (cost)

Example: oneonone uses server-write-only exclusively

Reference: /Users/dylanr/work/2389/oneonone/firestore.rules

Client-Write with Validation

When to use:

• High-volume writing (social feeds, messaging, real-time updates)
• Need fastest UX
• Client applications with many mutations

Pattern:

// firestore.rules
match /teams/{teamId}/posts/{postId} {
  // Allow users to create their own posts
  allow create: if request.auth != null &&
                   request.resource.data.userId == request.auth.uid &&
                   request.resource.data.teamId == teamId;

  // Allow users to update only specific fields of their posts
  allow update: if request.auth != null &&
                   resource.data.userId == request.auth.uid &&
                   request.resource.data.diff(resource.data).affectedKeys()
                     .hasOnly(['content', 'tags', 'updatedAt']);

  // Allow users to delete their own posts
  allow delete: if request.auth != null &&
                   resource.data.userId == request.auth.uid;
}

Benefits:

• Faster UX (no function latency)
• Fewer function invocations
• Real-time updates

Trade-offs:

• Complex rules required
• Larger attack surface
• Harder to audit

Examples:

• bot-socialmedia allows client writes for posts/journal
• meme-rodeo allows client file updates

References:

• /Users/dylanr/work/2389/bot-socialmedia-server/firestore.rules
• /Users/dylanr/work/2389/meme-rodeo/firestore.rules

Guidance

• Strongly prefer server-write-only for light-write applications
• Use client-write only when write volume justifies the complexity
• Never mix approaches within the same collection (confusing security model)

Firestore Rules Patterns

Common patterns used across all projects.

Helper Function Extraction (Universal Pattern)

Always extract reusable logic into functions:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // Authentication helpers
    function isAuthenticated() {
      return request.auth != null;
    }

    function isOwner(userId) {
      return isAuthenticated() && request.auth.uid == userId;
    }

    // Role-based helpers
    function isAdmin() {
      return get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == 'admin';
    }

    function isTeamMember(teamId, userId) {
      let team = get(/databases/$(database)/documents/teams/$(teamId)).data;
      return team != null && team.members.hasAny([{'uid': userId}]);
    }

    // Use helpers in rules
    match /users/{userId} {
      allow read: if isOwner(userId) || isAdmin();
      allow write: if isOwner(userId);
    }
  }
}

Benefits:

• Makes rules readable
• Reuse logic across collections
• Easier to test and maintain

All three projects use this pattern heavily

diff().affectedKeys() Validation (Client-Write Security)

Use when allowing client writes to restrict which fields can change:

// Only allow updating specific safe fields
allow update: if request.auth != null &&
                 request.resource.data.diff(resource.data).affectedKeys()
                   .hasOnly(['displayName', 'bio', 'photoURL']);

// Prevent privilege escalation
allow update: if request.auth != null &&
                 get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == 'admin' &&
                 request.resource.data.diff(resource.data).affectedKeys()
                   .hasOnly(['role', 'updatedAt']);

Example: bot-socialmedia uses extensively to protect sensitive fields

Reference: /Users/dylanr/work/2389/bot-socialmedia-server/firestore.rules:22

Role-Based Access with get() Lookups

Look up user roles from /users collection:

function isAdmin() {
  return get(/databases/$(database)/documents/users/$(request.auth.uid)).data.role == 'admin';
}

function hasEntitlement(level) {
  return get(/databases/$(database)/documents/users/$(request.auth.uid)).data.entitlement == level;
}

match /files/{fileId} {
  allow read: if true;
  allow delete: if request.auth != null && isAdmin();
  allow update: if request.auth != null && (isAdmin() || hasEntitlement('moderator'));
}

Examples:

• bot-socialmedia checks role field
• meme-rodeo checks entitlement field

Collection Group Query Support

Add separate rules when using collectionGroup() queries:

// Regular collection rules
match /project-agents/{agentId}/sessions/{sessionId} {
  allow read, write: if false;
}

// Collection group query rules (separate match)
match /{path=**}/sessions/{sessionId} {
  allow read: if true;
}

Example: oneonone supports collectionGroup queries for sessions/messages

Reference: /Users/dylanr/work/2389/oneonone/firestore.rules:44-52

Guidance Summary

1. Always extract helper functions - makes rules maintainable
2. Use diff().affectedKeys() for any client-write validation
3. Use role lookups when you have user hierarchies
4. Add collection group rules when querying across subcollections
5. Default deny at the end: match /{document=**} { allow read, write: if false; }

Emulator-First Development

Always develop locally with emulators. Never test directly in production.

Essential Configuration

firebase.json emulators section:

{
  "emulators": {
    "auth": { "port": 9099 },
    "functions": { "port": 5001 },
    "firestore": { "port": 8080 },
    "hosting": { "port": 5000 },
    "ui": { "enabled": true, "port": 4000 },
    "singleProjectMode": true
  }
}

Key settings:

• singleProjectMode: true - Essential: Allows emulators to work together
• ui.enabled: true - Essential: Access debug UI at http://127.0.0.1:4000
• Consistent ports across projects

All three projects use these exact settings

Example: oneonone's emulator configuration

Reference: /Users/dylanr/work/2389/oneonone/firebase.json:55-73

Client-Side Emulator Detection

Pattern for Next.js/React apps:

// hosting/lib/firebase.ts
// ABOUTME: Firebase client-side configuration and initialization
// ABOUTME: Exports auth, firestore, and functions instances for use in components

import { initializeApp, getApps } from 'firebase/app';
import { getAuth, connectAuthEmulator } from 'firebase/auth';
import { getFirestore, connectFirestoreEmulator } from 'firebase/firestore';
import { getFunctions, connectFunctionsEmulator } from 'firebase/functions';

const firebaseConfig = {
  apiKey: process.env.NEXT_PUBLIC_FIREBASE_API_KEY,
  projectId: process.env.NEXT_PUBLIC_FIREBASE_PROJECT_ID,
  // ... other config
};

const app = getApps().length === 0 ? initializeApp(firebaseConfig) : getApps()[0];

export const auth = getAuth(app);
export const db = getFirestore(app);
export const functions = getFunctions(app, 'us-central1');

// Connect to emulators in development
if (process.env.NODE_ENV === 'development' && typeof window !== 'undefined') {
  const useEmulators = process.env.NEXT_PUBLIC_USE_EMULATORS === 'true';

  if (useEmulators) {
    console.log('🔧 Connecting to Firebase emulators...');
    connectAuthEmulator(auth, 'http://127.0.0.1:9099', { disableWarnings: true });
    connectFirestoreEmulator(db, '127.0.0.1', 8080);
    connectFunctionsEmulator(functions, '127.0.0.1', 5001);
    console.log('✅ Connected to emulators');
  }
}

Environment variable (hosting/.env.local):

NEXT_PUBLIC_USE_EMULATORS=true
NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id

Important:

• Check typeof window !== 'undefined' to avoid SSR issues
• Use NEXT_PUBLIC_ prefix for client-side env vars in Next.js
• disableWarnings: true prevents auth emulator warning spam

Example: oneonone's emulator detection pattern

Reference: /Users/dylanr/work/2389/oneonone/hosting/lib/firebase.ts:28-54

Data Persistence

Export/Import Pattern:

# Data is automatically imported from this directory on startup
.firebase/emulator-data/

# Export data (preserves state)
firebase emulators:export ./backup

# Import data on startup
firebase emulators:start --import=./backup

# Fresh start (delete all data)
rm -rf .firebase/emulator-data

Important:

• Always stop emulators with Ctrl+C (graceful shutdown exports data automatically)
• Do NOT kill emulators (data won't export)
• Add .firebase/ to .gitignore
• Data persists automatically between emulator runs

Default behavior: When you start emulators, they automatically import from .firebase/emulator-data/ if it exists.

Daily Workflow

# Start emulators (auto-imports data from .firebase/emulator-data)
firebase emulators:start

# Access emulator UI
open http://127.0.0.1:4000

# Make code changes (functions/hosting auto-reload)

# Test changes in browser or with curl

# Stop emulators (auto-exports data)
Ctrl+C

Emulator UI Features:

• View/edit Firestore data
• View Auth users
• See Function logs
• Test Firestore rules in Rules Playground
• Monitor function invocations

Auto-reload behavior:

• Functions: TypeScript recompiles on save, hot-reloads
• Hosting: Next.js dev server detects changes automatically
• Rules: Must restart emulators to reload Firestore rules

Modern Tooling Standards

TypeScript Only

All code examples use TypeScript:

• No JavaScript examples (simplifies maintenance)
• Both recent projects (oneonone, bot-socialmedia) use TypeScript
• Better type safety and IDE support

tsconfig.json basics:

{
  "compilerOptions": {
    "target": "es2017",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "outDir": "lib",
    "rootDir": "..",
    "sourceMap": true,
    "moduleResolution": "node",
    "isolatedModules": true
  },
  "include": ["src"],
  "exclude": ["node_modules", "**/__tests__/**", "**/*.test.ts"]
}

Key settings:

• strict: true - Enable all strict type checking
• target: "es2017" - Matches Firebase Functions runtime
• outDir: "lib" - Standard Firebase Functions output directory
• Exclude test files from compilation

Example: bot-socialmedia's TypeScript configuration

Reference: /Users/dylanr/work/2389/bot-socialmedia-server/functions/tsconfig.json

Testing with vitest

Main config (vitest.config.ts):

// ABOUTME: Vitest configuration for Firebase Cloud Functions testing
// ABOUTME: Configures Node.js test environment with TypeScript support and coverage settings

import { defineConfig } from 'vitest/config';

export default defineConfig({
  test: {
    environment: 'node',
    globals: true,
    setupFiles: './vitest.setup.ts',
    include: ['**/__tests__/**/*.test.ts', '**/*.test.ts'],
    exclude: ['**/node_modules/**', '**/lib/**', '**/__tests__/emulator/**'],
    coverage: {
      provider: 'v8',
      reporter: ['text', 'lcov', 'html'],
      thresholds: {
        branches: 50,
        functions: 60,
        lines: 60,
        statements: 60,
      },
    },
    clearMocks: true,
    restoreMocks: true,
  },
});

Emulator-specific config (vitest.emulator.config.ts):

// ABOUTME: Vitest configuration specifically for emulator tests
// ABOUTME: Used when running tests that require Firebase emulators

import { defineConfig, mergeConfig } from 'vitest/config';
import baseConfig from './vitest.config';

export default mergeConfig(
  baseConfig,
  defineConfig({
    test: {
      include: ['**/__tests__/emulator/**/*.test.ts'],
      exclude: ['**/node_modules/**', '**/lib/**'],
    },
  })
);

Run commands:

# Unit tests (fast, no emulators)
npm run test

# Integration tests (with emulators)
npm run test:emulator

# Watch mode
npm run test -- --watch

# Coverage
npm run test -- --coverage

package.json scripts:

{
  "scripts": {
    "test": "vitest run",
    "test:emulator": "vitest run --config vitest.emulator.config.ts",
    "test:watch": "vitest",
    "test:coverage": "vitest run --coverage"
  }
}

Example: bot-socialmedia's vitest setup

Reference: /Users/dylanr/work/2389/bot-socialmedia-server/functions/vitest.config.ts

Linting with biome

Configuration (biome.json):

{
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  },
  "formatter": {
    "enabled": true,
    "indentStyle": "space",
    "indentWidth": 2,
    "lineWidth": 100
  }
}

Run commands:

# Check for issues
npm run lint

# Auto-fix issues
npm run lint:fix

# Format code
npm run format

package.json scripts:

{
  "scripts": {
    "lint": "biome check .",
    "lint:fix": "biome check --write .",
    "format": "biome format --write ."
  }
}

Benefits:

• Fast (written in Rust)
• Single tool for linting + formatting
• Works with TypeScript/JavaScript
• Compatible with pre-commit hooks

ABOUTME Comment Pattern

Every TypeScript file starts with 2-line comment:

// ABOUTME: Brief description of what this file does
// ABOUTME: Second line with additional context

import { something } from 'somewhere';
// ... rest of file

Examples from production:

// ABOUTME: Main entry point for Firebase Functions - exports MCP endpoint with tool routing
// ABOUTME: Configures Express app with authentication, CORS, and health check

// ABOUTME: Post creation, reading, and management functions
// ABOUTME: Includes API endpoints and real-time triggers

// ABOUTME: Vitest configuration for Firebase Cloud Functions testing
// ABOUTME: Configures Node.js test environment with TypeScript support and coverage settings

Benefits:

• Easy to grep: grep "ABOUTME:" **/*.ts
• Quick file purpose understanding
• Self-documenting codebase
• Enforces intentional file organization

Both TypeScript projects use this pattern

Testing Requirements

Unit Tests:

• Test handlers, utilities, validators in isolation
• Mock Firestore/Auth when needed
• Fast execution, no emulator dependency
• Located in src/__tests__/ or next to source files
• File naming: *.test.ts

Integration Tests:

• Test complete workflows with emulators running
• Real Firestore/Auth/Functions interaction
• Use vitest.emulator.config.ts
• Verify end-to-end behavior
• Located in src/__tests__/emulator/
• File naming: *.test.ts

Both types required for every feature

Example test structure:

functions/src/
├── __tests__/
│   ├── middleware/
│   │   └── apiKeyGuard.test.ts      # Unit test
│   ├── tools/
│   │   └── requestSession.test.ts   # Unit test
│   └── emulator/
│       └── mcp-workflow.test.ts     # Integration test

Test naming convention:

• Unit tests: Describe the function being tested
• Integration tests: Describe the user workflow
• Use describe() and it() blocks for organization

Coverage expectations:

• Unit tests: Aim for 60%+ coverage
• Integration tests: Cover critical user paths
• Don't test Firebase SDK itself (trust Google)
• Focus on your business logic

Common Gotchas

Document these issues when encountered:

1. Emulator ports in use

   • Check: lsof -i :5001
   • Fix: Kill process or change port in firebase.json

2. Admin SDK vs Client SDK confusion

   • Functions use admin SDK (bypasses Firestore rules)
   • Client apps use client SDK (respects Firestore rules)
   • Rules only validate client SDK operations

3. Rules testing mistakes

   • Firestore rules only affect client SDK
   • Admin SDK always has full access
   • Test rules with Emulator UI Rules Playground

4. Cold start delays

   • First function call in emulators can take 5-10 seconds
   • Subsequent calls are fast
   • Normal behavior, not a bug

5. Data persistence issues

   • Must use Ctrl+C to stop emulators (graceful shutdown)
   • Killing emulators prevents data export
   • Data stored in .firebase/emulator-data/

6. Node version compatibility

   • Match Firebase Functions runtime: nodejs18 or nodejs20
   • Check functions/package.json: "engines": {"node": "20"}

7. Environment variables

   • Functions: .env file (never commit)
   • Hosting: .env.local with NEXT_PUBLIC_ prefix
   • Different files, different naming conventions

8. CORS in functions

   • Must explicitly enable CORS: app.use(cors({ origin: true }))
   • Or use cors: true in onRequest options
   • Browsers block requests without CORS headers

9. Index requirements

   • Complex queries need indexes in firestore.indexes.json
   • Error message includes index creation URL
   • Follow URL or manually add to indexes file

10. Deployment order

    • Sometimes need to deploy rules before functions
    • Functions may depend on new rules being active
    • Deploy order: rules → functions → hosting

Cost Awareness

Emulators: Free, no charges during local development

Production Costs:

• Firestore: ~$0.36 per 100k reads/writes
• Functions: ~$0.40 per million invocations + compute time
• Hosting: Free up to 10 GB/month, then ~$0.15 per GB
• Auth: Free for most use cases

Why Server-Write-Only Can Be Cost-Effective:

• Fewer function invocations overall
• No complex security rules processing
• Easier to optimize and cache on server side
• Better for light-write applications

Monitor costs: Firebase Console → Usage and Billing

Summary

This Firebase development skill system provides:

1. Orchestrator routing based on keyword detection
2. Four specialized sub-skills with TodoWrite checklists
3. Shared patterns extracted from three production projects
4. Complete code examples with exact file paths
5. Guidance on architectural choices (hosting, auth, functions, security)
6. Emulator-first workflow for safe local development
7. Modern tooling (TypeScript, vitest, biome)
8. Testing standards (unit + integration required)

Next Steps:

• Choose the sub-skill that matches your task
• Follow the TodoWrite checklist
• Reference these patterns as needed
• Test with emulators before deploying

Sub-Skills:

• @firebase-development/project-setup - Initialize new projects
• @firebase-development/add-feature - Add functions/collections
• @firebase-development/debug - Troubleshoot issues
• @firebase-development/validate - Review code