Tag: performance

  • ISR Deep Dive: Making Headless WordPress Lightning Fast

    ISR Deep Dive: Making Headless WordPress Lightning Fast

    Incremental Static Regeneration (ISR) is the killer feature that makes Next.js perfect for headless WordPress. But understanding when and how to use it can be tricky.

    What is ISR?

    ISR lets you update static pages after build time without rebuilding your entire site. You get the speed of static generation with the freshness of server-side rendering.

    Here’s how it works: Next.js generates static HTML at build time. After deployment, when someone requests a page, they get the cached version. In the background, Next.js regenerates the page and updates the cache.

    Data visualization dashboard

    Time-Based vs On-Demand Revalidation

    Next.js offers two ISR strategies:

    Time-based revalidation regenerates pages after a specified interval:

    export const revalidate = 3600; // 1 hour

    This is great for content that updates predictably, like archive pages or dashboards.

    On-demand revalidation regenerates pages when triggered by an API call. This is what FlatWP uses. When you save a post in WordPress, our plugin immediately triggers revalidation:

    await fetch('/api/revalidate', {
      method: 'POST',
      body: JSON.stringify({ paths: ['/blog/my-post'] })
    });

    Computer code on screen

    The FlatWP Approach

    We use different strategies for different content types:

    • Blog posts: On-demand ISR (update immediately when edited)
    • Static pages: No revalidation (fully static)
    • Archives: Short time-based ISR (5 minutes)
    • Homepage: Very short ISR or server component

    This gives you instant updates where they matter, without sacrificing performance.

    Performance Impact

    With ISR, first-time visitors get sub-100ms page loads. The page is pre-rendered, served from the edge, and cached globally. Subsequent visitors get even faster loads from CDN cache.

    Compare this to server-side rendering, which queries WordPress on every request. ISR gives you the best of both worlds.

  • Image Optimization in Headless WordPress: Beyond next/image

    Full-Stack TypeScript: WordPress Meets Next.js

    TypeScript transformed our Next.js + WordPress setup. Here’s everything we learned shipping type-safe headless sites for real clients with zero compromises maximum confidence.

    TypeScript code in IDE

    The Promise of TypeScript

    When WordPress meets Next.js, you’re dealing with two systems that speak different languages. WordPress returns PHP-shaped data; Next.js expects JavaScript objects. TypeScript bridges this gap with compile-time safety.

    “Without types, you catch bugs in production. With types, you catch them before your first commit.” – Every developer who’s been burned by runtime errors

    Type Generation from GraphQL

    The magic happens when you generate TypeScript types directly from your GraphQL schema. Here’s how we do it with graphql-codegen:

    // codegen.yml
    schema: 'https://cms.flatwp.com/graphql'
    generates:
      src/types/graphql.ts:
        plugins:
          - 'typescript'
          - 'typescript-operations'
          - 'typed-document-node'
        config:
          skipTypename: false
          withHooks: true
          withComponent: false
    

    Now every GraphQL query in your Next.js app is fully typed. When WordPress admins add fields, developers get instant type errors if components aren’t updated. Check out the GraphQL Code Generator docs for more details.

    Developer reviewing code

    Example: Typed Post Query

    Here’s what a typical WordPress post query looks like with TypeScript:

    import { useQuery } from '@apollo/client';
    import { GetPostDocument, GetPostQuery } from '@/types/graphql';
    
    interface PostPageProps {
      slug: string;
    }
    
    export function PostPage({ slug }: PostPageProps) {
      const { data, loading, error } = useQuery<GetPostQuery>(
        GetPostDocument,
        { variables: { slug } }
      );
    
      if (loading) return <Skeleton />;
      if (error) return <ErrorBoundary error={error} />;
      
      const post = data?.post;
      if (!post) return <NotFound />;
    
      // TypeScript knows exactly what properties exist!
      return (
        <article>
          <h1>{post.title}</h1>
          <time dateTime={post.date}>{formatDate(post.date)}</time>
          <div dangerouslySetInnerHTML={{ __html: post.content }} />
        </article>
      );
    }

    Advanced Type Patterns

    Here are some advanced TypeScript patterns we use throughout FlatWP:

    1. Discriminated Unions – Perfect for ACF flexible content blocks
    2. Mapped Types – Transform WP data structures safely
    3. Conditional Types – Handle optional ACF fields elegantly
    4. Template Literal Types – Type-safe route generation

    Code on multiple monitors

    Discriminated Union Example

    Here’s how we handle flexible content blocks with type safety:

    type ContentBlock =
      | { type: 'hero'; heading: string; image: WPImage }
      | { type: 'features'; items: Feature[] }
      | { type: 'testimonial'; quote: string; author: string }
      | { type: 'cta'; text: string; url: string };
    
    function renderBlock(block: ContentBlock) {
      switch (block.type) {
        case 'hero':
          // TypeScript knows block.heading and block.image exist
          return <HeroBlock heading={block.heading} image={block.image} />;
        case 'features':
          // TypeScript knows block.items exists
          return <FeaturesGrid items={block.items} />;
        // ... other cases
      }
    }
    Utility Types for WordPress

    We’ve created several utility types that make working with WordPress data much cleaner. These are included in the FlatWP starter:

    • WPImage – Standardized image object with URL, alt, dimensions
    • WPPost<T> – Generic post type with custom field support
    • WPCategory – Taxonomy term with full hierarchy
    • WPMenu – Navigation menu with nested items

    Strict Mode Configuration

    We run TypeScript in strict mode with additional checks enabled:

    {
      "compilerOptions": {
        "strict": true,
        "noUncheckedIndexedAccess": true,
        "noImplicitReturns": true,
        "noFallthroughCasesInSwitch": true,
        "forceConsistentCasingInFileNames": true,
        "isolatedModules": true
      }
    }

    This configuration catches edge cases that would otherwise slip through. Yes, it requires more upfront work, but the elimination of runtime errors is worth it.

    Key principle: Make invalid states unrepresentable. If WordPress can’t return null for a required field, your TypeScript types shouldn’t allow null either.

    Handling WordPress Nullability

    WordPress is infamous for returning null or undefined unexpectedly. Here’s how we handle it:

    // Bad: Optimistic typing
    interface Post {
      title: string;  // Might actually be null!
      content: string; // Might be empty string OR null
    }
    
    // Good: Defensive typing
    interface Post {
      title: string | null;
      content: string | null;
    }
    
    // Better: Use type guards
    function isValidPost(post: Post): post is Required<Post> {
      return post.title !== null && post.content !== null;
    }
    
    // Usage
    if (isValidPost(post)) {
      // TypeScript knows title and content are strings
      return <h1>{post.title}</h1>;
    }

    TypeScript error checking

    Testing Strategy

    TypeScript dramatically improves our testing strategy. Here’s what we test:

    Test Type Coverage Tools Frequency
    Type Checking 100% tsc –noEmit Pre-commit
    Unit Tests 80%+ Vitest PR
    Integration Critical paths Playwright Pre-deploy
    Type Coverage 95%+ type-coverage Weekly

    Example Test Suite

    Here’s how we test a typed WordPress component:

    import { describe, it, expect } from 'vitest';
    import { render, screen } from '@testing-library/react';
    import { PostCard } from './PostCard';
    import type { Post } from '@/types/graphql';
    
    describe('PostCard', () => {
      it('renders post with all required fields', () => {
        const post: Post = {
          id: '1',
          title: 'Test Post',
          excerpt: 'Test excerpt',
          date: '2024-01-01',
          author: { name: 'John Doe' },
          featuredImage: {
            node: {
              sourceUrl: '/test.jpg',
              altText: 'Test image',
            },
          },
        };
    
        render(<PostCard post={post} />);
        
        expect(screen.getByText('Test Post')).toBeInTheDocument();
        expect(screen.getByAltText('Test image')).toBeInTheDocument();
      });
    
      it('handles missing optional fields gracefully', () => {
        const post: Post = {
          id: '2',
          title: 'Minimal Post',
          excerpt: null,  // TypeScript allows this
          date: '2024-01-01',
          author: { name: 'Jane Doe' },
          featuredImage: null,  // Also allowed
        };
    
        render(<PostCard post={post} />);
        expect(screen.getByText('Minimal Post')).toBeInTheDocument();
      });
    });

    Real-World Performance Impact

    After implementing strict TypeScript across 10+ client projects, we measured the impact:

    • 90% reduction in production runtime errors
    • 40% faster feature development (thanks to autocomplete + refactoring)
    • Zero “undefined is not a function” errors in 6 months
    • 50% less time spent in code review catching type issues

    The upfront investment in TypeScript configuration pays for itself within the first sprint. Don’t skip this step!

    Team celebrating success

    Resources & Next Steps

    Want to dive deeper? Here are our recommended resources:

    1. Read the official TypeScript handbook
    2. Explore WPGraphQL documentation
    3. Check out the FlatWP repository for examples
    4. Join our Discord community for help

    Conclusion

    TypeScript + WordPress + Next.js is a powerful combination. With proper type safety, you get the flexibility of WordPress with the developer experience of modern React development.

    The FlatWP starter includes all of this configuration out-of-the-box, so you can focus on building features instead of fighting with types. Ship faster. Ship safer.

  • GraphQL vs REST API: Why We Chose GraphQL for FlatWP

    WordPress offers both REST API and GraphQL for headless implementations. We deliberately chose GraphQL for FlatWP, and here’s why.

    The Over-Fetching Problem

    WordPress REST API returns everything about a post, whether you need it or not:

    GET /wp-json/wp/v2/posts/123

    You get the author object, meta fields, embedded media, comment stats, and dozens of other fields you’ll never use. This bloats response sizes and slows down your site.

    GraphQL’s Precision

    With GraphQL, you request exactly what you need:

    query GetPost($id: ID!) {
      post(id: $id) {
        title
        content
        featuredImage {
          url
          alt
        }
      }
    }

    The response contains only those fields. Nothing more, nothing less.

    TypeScript Integration

    GraphQL’s typed schema enables automatic TypeScript generation. Our codegen process creates perfect types from your queries:

    // Auto-generated from GraphQL schema
    interface GetPostQuery {
      post: {
        title: string;
        content: string;
        featuredImage: {
          url: string;
          alt: string;
        };
      };
    }

    This is nearly impossible with REST API without manually maintaining types.

    Nested Data in One Request

    REST API requires multiple requests for nested data:

    // Get post
    GET /wp-json/wp/v2/posts/123
    // Get author
    GET /wp-json/wp/v2/users/5
    // Get categories
    GET /wp-json/wp/v2/categories?post=123

    GraphQL fetches everything in one query:

    query GetPost($id: ID!) {
      post(id: $id) {
        title
        author {
          name
          avatar
        }
        categories {
          name
          slug
        }
      }
    }

    Better Performance

    Fewer requests = faster page loads. We measured:

    • REST API: 3 requests, 45KB total, 280ms
    • GraphQL: 1 request, 12KB, 95ms

    The WPGraphQL Plugin

    WPGraphQL is mature, well-maintained, and has a huge ecosystem:

    • WPGraphQL for ACF
    • WPGraphQL for WooCommerce
    • WPGraphQL for Yoast SEO
    • WPGraphQL JWT Authentication

    Popular plugins have GraphQL extensions, making integration seamless.

    When to Use REST API

    GraphQL isn’t always the answer. Use REST API when:

    • You need file uploads (GraphQL doesn’t handle multipart well)
    • Your WordPress host doesn’t support WPGraphQL
    • You’re building a simple integration with minimal data needs

    But for full-featured headless sites, GraphQL’s benefits are undeniable.

  • Building a Search Experience Without Algolia

    Algolia is great, but $99/month for search on a small site feels excessive. FlatWP includes a fast, free alternative using static generation and client-side search.

    The Static Search Index Approach

    We generate a lightweight JSON index at build time:

    // app/search-index.json/route.ts
    export const revalidate = 3600;
    
    export async function GET() {
      const posts = await fetchAllPosts();
      
      const index = posts.map(post => ({
        id: post.id,
        title: post.title,
        excerpt: post.excerpt,
        slug: post.slug,
        category: post.category.name,
      }));
      
      return Response.json(index);
    }

    This creates a ~50KB JSON file (for 100 posts) that browsers cache.

    Client-Side Search with Fuse.js

    Fuse.js provides fuzzy search on the client:

    import Fuse from 'fuse.js';
    
    const fuse = new Fuse(searchIndex, {
      keys: ['title', 'excerpt', 'category'],
      threshold: 0.3,
      includeScore: true
    });
    
    const results = fuse.search(query);

    Search is instant – no network request needed.

    When Does This Break Down?

    This approach works well up to ~2000 posts. Beyond that:

    • Index size becomes noticeable (~300KB+)
    • Initial download impacts performance
    • Search slowdown on lower-end devices

    At that scale, consider upgrading to a search service.

    Enhancing the Experience

    We add keyboard shortcuts (⌘K), instant results as you type, and proper highlighting:

    <Command.Dialog>
      <Command.Input 
        placeholder="Search posts..."
        value={query}
        onValueChange={setQuery}
      />
      <Command.List>
        {results.map(result => (
          <Command.Item key={result.item.id}>
            <Link href={`/blog/${result.item.slug}`}>
              {highlightMatch(result.item.title, query)}
            </Link>
          </Command.Item>
        ))}
      </Command.List>
    </Command.Dialog>

    Progressive Enhancement

    For FlatWP Pro, we’re adding optional Algolia integration. It’s a feature flag:

    const searchProvider = process.env.SEARCH_PROVIDER || 'static';
    
    if (searchProvider === 'algolia') {
      // Use Algolia
    } else {
      // Use static JSON + Fuse.js
    }

    Start free, upgrade when needed. No lock-in.

    Performance Comparison

    We tested search on a 500-post site:

    • Static + Fuse.js: 15ms, 0 network requests
    • Algolia: 45ms average (includes network latency)
    • WordPress search: 300ms+ (full database query)

    The static approach is actually faster for most use cases.