Rin
  • English

      • Changelog

      v0.3.0 - February 4, 2025

      Architecture Refactoring

      • Lightweight Framework: Refactored ElysiaJS backend framework to a lightweight custom framework, specifically optimized for Cloudflare Workers
        • Removed approximately 15 heavyweight dependencies, core framework code < 10KB
        • Implemented on-demand loading architecture, only initializing necessary services per request
        • Optimized startup time and memory footprint

      New Features

      • Caching System: Implemented a flexible caching system supporting both database and S3

        • Added CACHE_STORAGE_MODE environment variable, supporting database or s3 mode
        • Supports automatic serialization and deserialization of cache data
        • Added cache table for high-frequency data storage

      • HyperLogLog Statistics: Migrated PV/UV statistics to HyperLogLog algorithm

        • Uses 16384 registers with ~0.81% error rate
        • Added visit_stats table with pv counter and hll_data
        • Optimized feed visit tracking from O(n) query to O(1) lookup
        • Significantly reduced query time for high-traffic articles

      • Error Handling System: Implemented comprehensive error handling mechanism

        • Added structured error classes (ValidationError, NotFoundError, etc.)
        • Implemented GlobalErrorBoundary for capturing React rendering errors
        • Added useError hooks for handling asynchronous operations and API calls
        • Server-side middleware for logging errors and generating request IDs

      • Cookie Authentication: Migrated from Authorization Header to Cookie-based authentication

        • Backend sets HttpOnly, Secure, SameSite=lax cookies
        • Frontend removes Authorization Header, relies on browser cookies
        • Enhanced CSRF protection

      Improvements and Optimizations

      • API Client Refactoring: Replaced Elysia/Eden with custom API client

        • Removed @elysiajs/eden and rin-server dependencies
        • Created type-safe API client
        • Simplified API call pattern (from treaty pattern to direct method calls)
        • BREAKING CHANGE: Client API interface changed, e.g., client.feed.index.get() → client.feed.list()

      • Custom OAuth Implementation: Replaced elysia-oauth2 with custom OAuth2 implementation

        • Generic OAuth2 plugin architecture supporting any OAuth2 provider
        • Built-in GitHub OAuth provider as default
        • CSRF protection via state parameter validation
        • Full TypeScript type support

      • Dependency Injection Refactoring: Replaced typedi with native mechanisms

        • Removed typedi dependency injection container
        • Uses Elysia's decorate() and derive() for dependency injection
        • Services access dependencies via store instead of Container.get()

      • Friend Links Optimization: Updated Friend interface and adjusted related API calls

        • Improved type safety

      Bug Fixes

      • Fixed UV migration to HLL failure
      • Fixed schema validation issue in GitHub callback route
      • Fixed query parameter integer parsing
      • Fixed CORS preflight request handling
      • Optimized code and reduced bundle size

      Database Migrations

      • Added cache table cache (key, type, data, created_at, updated_at)
      • Added visit stats table visit_stats (feed_id, pv, hll_data)
      • Database migration script: 0006.sql

      Environment Variables

      New environment variable:

      CACHE_STORAGE_MODE=<Cache storage mode: database or s3, default database>

      v0.2.0 Updated on 2024-06-07

      • Added S3_CACHE_FOLDER environment variable
      • Updated the list of encrypted environment variables, keeping only the essential ones
      • Encrypted variables can now be configured directly via GitHub
      • Updated GitHub variable configuration, added encrypted variables that must be configured through GitHub (S3 storage for SEO index storage)
      • GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET are now prefixed with RIN_ (RIN_GITHUB_CLIENT_ID, RIN_GITHUB_CLIENT_SECRET) to solve the issue where GitHub variables cannot start with GITHUB_. Variables configured through the Cloudflare panel (GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET) are not affected.

      Migration Guide

      For normal version updates without special instructions, simply synchronize the forked repository.

      v0.2.0 Migration Guide

      • Due to the introduction of SEO optimization, it is necessary to configure S3 storage environment variables in GitHub. Therefore, you need to additionally configure the following environment variables in GitHub (plain text, add to Variables):
      SEO_BASE_URL=<SEO base URL for SEO indexing>
SEO_CONTAINS_KEY=<SEO indexing only includes links starting with SEO_BASE_URL or containing the SEO_CONTAINS_KEY keyword, defaults to empty>
S3_FOLDER=<Folder for storing S3 image resources, defaults to 'images/'>
S3_CACHE_FOLDER=<S3 cache folder (for SEO and high-frequency request caching), defaults to 'cache/'>
S3_BUCKET=<Name of the S3 bucket>
S3_REGION=<Region of the S3 bucket, use 'auto' if using Cloudflare R2>
S3_ENDPOINT=<S3 bucket endpoint address>
S3_ACCESS_HOST=<S3 bucket access address, without trailing '/'>

      Additionally, add the following encrypted environment variables (encrypted, add to Secrets):

      S3_ACCESS_KEY_ID=<Your S3AccessKeyID>
S3_SECRET_ACCESS_KEY=<Your S3SecretAccessKey>

      These environment variables were previously configured through the Cloudflare panel. Now they need to be migrated to GitHub. The new version's deployment GitHub Action will automatically upload them to Cloudflare, so you no longer need to configure these environment variables in the Cloudflare panel.