mirror of
https://github.com/lfnovo/open-notebook.git
synced 2026-04-30 20:39:55 +00:00
* feat(i18n): complete 100% internationalization and fix Next.js 15 compatibility
* feat(i18n): complete 100% internationalization coverage
* chore(test): finalize component tests and project cleanup
* test(logic): add unit tests for useModalManager hook
* fix(test): resolve timeout in AppSidebar tests by mocking TooltipProvider
* feat(i18n): comprehensive i18n audit, fixes for hardcoded strings, and complete zh-TW support
* fix(i18n): resolve TypeScript warnings and improve translation hook stability
- Remove unused useTranslation import from ConnectionGuard
- Add ref-based checking state to prevent dependency cycles
- Fix useTranslation hook to return empty string for undefined translations
- Add comment for backward compatibility on ExtractedReference interface
- Ensure .replace() string methods work safely with nested translation keys
* feat(i18n): complete internationalization implementation with Docker deployment
- Add LanguageLoadingOverlay component for smooth language transitions
- Update all translation files (en-US, zh-CN, zh-TW) with improved terminology
- Optimize Docker configuration for better performance
- Update version check and config handling for i18n support
- Fix route handling for language-specific content
- Add comprehensive task documentation
* fix(i18n): resolve localization errors, duplicates, and type issues
* chore(i18n): finalize 100% internationalization coverage
* chore(test): supplement i18n test cases and cleanup redundant files
* fix(test): resolve lint type errors and finalize delivery documents
* feat(i18n): finalize full internationalization and zh-TW localization
* fix(frontend): add missing devDependency and fix build tsconfig
* feat(ui): enhance sidebar hover effects with better visual feedback
* fix(frontend): resolve accessibility, i18n, and lint issues
- fix: add missing id, name, autocomplete attributes to dialog inputs
- fix: add aria labels and DialogDescription for accessibility
- fix: resolve uncontrolled component warning in SettingsForm
- fix: correct duplicate 'Traditional Chinese' label in zh-TW locale
- feat: add i18n support for podcast template names
- chore: fix lint errors in Dialogs
* fix: address all 21 PR feedback items from cubic-dev-ai bot
Configuration:
- Remove ignoreDuringBuilds flags from next.config.ts
Testing:
- Fix AppSidebar.test.tsx regex pattern and add missing assertion
Logic:
- Fix ConnectionGuard.tsx re-entry prevention logic
Internationalization (I18n) - Translations:
- Add missing keys: notebooks.archived, common.note/insight, accessibility keys
- Add specific keys: sources.allSourcesDescShort, transformations.selectModel
- Add singular/plural keys: podcasts.usedByCount_one/other, common.note/notes
- Add common.created/updated with {time} placeholder
Internationalization (I18n) - Usage:
- SourcesPage: use allSourcesDescShort instead of string splitting
- TransformationPlayground: use navigation.transformation and selectModel
- CommandPalette: use dedicated keys instead of string concatenation
- GeneratePodcastDialog: fix zh-TW date locale handling
- NotebookHeader: correctly interpolate {time} placeholder
- TransformationCard: use common.description instead of undefined key
- ChatPanel/SpeakerProfilesPanel: implement proper pluralization
- SystemInfo: correctly interpolate {version} placeholder
- LanguageLoadingOverlay: use t.common.loading instead of hardcoded string
- MessageActions: use specific error key cannotSaveNoteNoNotebook
Other:
- Fix SessionManager.tsx exhaustive-deps warning
* fix: remove duplicate locale keys and add missing zh-CN translations
- en-US: remove duplicate loading key (line 59) and addNew key (sources)
- zh-CN: remove duplicate common keys (loading, note, insight, newSource, newNotebook, newPodcast)
- zh-CN: remove duplicate accessibility.searchNotebooks key
- zh-CN: remove duplicate sources.addNew key
- zh-CN: remove duplicate navigation.transformation key
- zh-CN: add missing usedByCount_one and usedByCount_other keys in podcasts
- zh-TW: remove duplicate common keys (loading, note, insight, newSource, newNotebook, newPodcast)
- zh-TW: remove duplicate accessibility.searchNotebooks key
- zh-TW: remove duplicate sources.addNew key
* docs: remove info.md
* fix: remove duplicate notebook keys and unused ts-expect-error
- zh-CN: remove duplicate notebooks keys (archived, archive, unarchive, deleteNotebook, deleteNotebookDesc)
- zh-TW: remove duplicate notebooks keys (archived, archive, unarchive, deleteNotebook, deleteNotebookDesc)
- GeneratePodcastDialog: remove unused @ts-expect-error directive
* fix(a11y): fix unassociated labels in search page
- Replace <Label> with role='group' + aria-labelledby for search type section
- Replace <Label> with role='group' + aria-labelledby for search in section
- Follows WAI-ARIA best practices for labeling form field groups
* fix(a11y): fix unassociated labels across multiple components
- search/page.tsx: use role='group' + aria-labelledby for search type and search in sections
- RebuildEmbeddings.tsx: use role='group' + aria-labelledby for include checkboxes
- TransformationPlayground.tsx: replace Label with span for non-form output label
* chore: revert to npm stack and ensure i18n compatibility
* chore: polish zh-TW translations for better idiomatic usage
* fix: resolve linter errors (ruff import sort, mypy config duplicate)
* style: apply ruff formatting
* fix: finalize upstream compliance (Dockerfile.single, i18n hooks, docker-compose)
* style: polish strings, fix timeout cleanup, and improve test mocks
* fix: use relative imports in test setup to resolve IDE path errors
* perf(docker): optimize build speed by removing apt-get upgrade and build tools
- Remove apt-get upgrade from both builder and runtime stages (saves 10-15 min each)
- Remove gcc/g++/make/git from builder (uv downloads pre-built wheels)
- Add --no-install-recommends to minimize package footprint
- Keep npm mirror (npmmirror.com) for faster frontend deps
- Add npm registry config for reliable China network access
Also includes:
- fix(a11y): add missing labels and aria attributes to form fields
- fix(i18n): add 2s safety timeout to LanguageLoadingOverlay
- fix(i18n): add robustness checks to use-translation proxy
Build time reduced from 2+ hours to ~34 minutes (~70% improvement)
* fix(a11y): resolve 16 form field accessibility warnings in notebook and podcast pages
* fix(a11y): resolve 4 button and 1 select field accessibility warnings in models page
* fix(a11y): resolve redundant attributes and residual warnings in transformations and podcast forms
* fix(i18n): deep fix for language switch hang using proxy protection and safer access
* fix(a11y): add name attributes to ModelSelector, TransformationPlayground, and SourceDetailContent
* fix: add missing Label import to SourceDetailContent
* fix(i18n): use native react-i18next in LanguageLoadingOverlay to prevent hang during language switch
* fix(i18n): rewrite use-translation Proxy with strict depth limit and expanded blocked props to prevent language switch hang
* fix: add type assertion to fix TypeScript comparison error
* fix(i18n): disable useSuspense to prevent thread hang during language resource loading
* fix(i18n): add infinite loop detection circuit breaker to useTranslation hook
* fix(i18n): update traditional chinese label to native script in en-US
* feat: add new localization strings for notebook and note management.
* fix: resolve config priority, docker build deps, and ui glitches
* refactor: improve ui details and test coverage based on feedback
* refactor: improve ui details (version check/lang toggle) and test coverage
* fix: polish language matching and test cleanup
* fix(test): update mocks to resolve timeouts and proxy errors
* fix(frontend): restore tsconfig.json structure and enable IDE support for tests
* fix: address PR review findings and resolve CI OIDC failure
* fix: merge exception headers in custom handler
* fix: comprehensive PR review remediations and async performance fixes
* refactor: address all PR #371 review feedback
- Docker: consolidate SURREAL_URL to docker.env, add single-container override
- Security: restore apt-get upgrade in Dockerfile and Dockerfile.single
- Create centralized getDateLocale helper (lib/utils/date-locale.ts)
- Refactor 7 files to use getDateLocale helper
- Revert config/route.ts to origin/main version
- Move test files to co-located pattern (3 files)
- Remove local useTranslation mock from ConfirmDialog.test.tsx
- Simplify use-version-check to single useEffect pattern
- Fix test import paths after moving to co-located pattern
* fix: add jest-dom types for test files
* fix: address remaining review issues
- Add apt-get upgrade -y to Dockerfile.single backend-builder stage
- Refactor ChatColumn.test.tsx: use 'as unknown as ReturnType<typeof hook>' instead of 'as any'
- Use toBeInTheDocument() assertions instead of toBeDefined()
160 lines
5.1 KiB
Python
160 lines
5.1 KiB
Python
import asyncio
|
|
import os
|
|
import time
|
|
import tomllib
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
from fastapi import APIRouter, Request
|
|
from loguru import logger
|
|
|
|
from open_notebook.database.repository import repo_query
|
|
from open_notebook.utils.version_utils import (
|
|
compare_versions,
|
|
get_version_from_github_async,
|
|
)
|
|
|
|
router = APIRouter()
|
|
|
|
# In-memory cache for version check results
|
|
_version_cache: dict = {
|
|
"latest_version": None,
|
|
"has_update": False,
|
|
"timestamp": 0,
|
|
"check_failed": False,
|
|
}
|
|
|
|
# Cache TTL in seconds (24 hours)
|
|
VERSION_CACHE_TTL = 24 * 60 * 60
|
|
|
|
|
|
def get_version() -> str:
|
|
"""Read version from pyproject.toml"""
|
|
try:
|
|
pyproject_path = Path(__file__).parent.parent.parent / "pyproject.toml"
|
|
with open(pyproject_path, "rb") as f:
|
|
pyproject = tomllib.load(f)
|
|
return pyproject.get("project", {}).get("version", "unknown")
|
|
except Exception as e:
|
|
logger.warning(f"Could not read version from pyproject.toml: {e}")
|
|
return "unknown"
|
|
|
|
|
|
async def get_latest_version_cached(current_version: str) -> tuple[Optional[str], bool]:
|
|
"""
|
|
Check for the latest version from GitHub with caching.
|
|
|
|
Returns:
|
|
tuple: (latest_version, has_update)
|
|
- latest_version: str or None if check failed
|
|
- has_update: bool indicating if update is available
|
|
"""
|
|
global _version_cache
|
|
|
|
# Check if cache is still valid (within TTL)
|
|
cache_age = time.time() - _version_cache["timestamp"]
|
|
if _version_cache["timestamp"] > 0 and cache_age < VERSION_CACHE_TTL:
|
|
logger.debug(f"Using cached version check result (age: {cache_age:.0f}s)")
|
|
return _version_cache["latest_version"], _version_cache["has_update"]
|
|
|
|
# Cache expired or not yet set
|
|
if _version_cache["timestamp"] > 0:
|
|
logger.info(f"Version cache expired (age: {cache_age:.0f}s), refreshing...")
|
|
|
|
# Perform version check with strict error handling
|
|
try:
|
|
logger.info("Checking for latest version from GitHub...")
|
|
|
|
# Fetch latest version from GitHub with 10-second timeout
|
|
latest_version = await get_version_from_github_async(
|
|
"https://github.com/lfnovo/open-notebook", "main"
|
|
)
|
|
|
|
logger.info(
|
|
f"Latest version from GitHub: {latest_version}, Current version: {current_version}"
|
|
)
|
|
|
|
# Compare versions
|
|
has_update = compare_versions(current_version, latest_version) < 0
|
|
|
|
# Cache the result
|
|
_version_cache["latest_version"] = latest_version
|
|
_version_cache["has_update"] = has_update
|
|
_version_cache["timestamp"] = time.time()
|
|
_version_cache["check_failed"] = False
|
|
|
|
logger.info(f"Version check complete. Update available: {has_update}")
|
|
|
|
return latest_version, has_update
|
|
|
|
except Exception as e:
|
|
logger.warning(f"Version check failed: {e}")
|
|
|
|
# Cache the failure to avoid repeated attempts
|
|
_version_cache["latest_version"] = None
|
|
_version_cache["has_update"] = False
|
|
_version_cache["timestamp"] = time.time()
|
|
_version_cache["check_failed"] = True
|
|
|
|
return None, False
|
|
|
|
|
|
async def check_database_health() -> dict:
|
|
"""
|
|
Check if database is reachable using a lightweight query.
|
|
|
|
Returns:
|
|
dict with 'status' ("online" | "offline") and optional 'error'
|
|
"""
|
|
try:
|
|
# 2-second timeout for database health check
|
|
result = await asyncio.wait_for(repo_query("RETURN 1"), timeout=2.0)
|
|
if result:
|
|
return {"status": "online"}
|
|
return {"status": "offline", "error": "Empty result"}
|
|
except asyncio.TimeoutError:
|
|
logger.warning("Database health check timed out after 2 seconds")
|
|
return {"status": "offline", "error": "Health check timeout"}
|
|
except Exception as e:
|
|
logger.warning(f"Database health check failed: {e}")
|
|
return {"status": "offline", "error": str(e)}
|
|
|
|
|
|
@router.get("/config")
|
|
async def get_config(request: Request):
|
|
"""
|
|
Get frontend configuration.
|
|
|
|
Returns version information and health status.
|
|
Note: The frontend determines the API URL via its own runtime-config endpoint,
|
|
so this endpoint no longer returns apiUrl.
|
|
|
|
Also checks for version updates from GitHub (with caching and error handling).
|
|
"""
|
|
# Get current version
|
|
current_version = get_version()
|
|
|
|
# Check for updates (with caching and error handling)
|
|
# This MUST NOT break the endpoint - wrapped in try-except as extra safety
|
|
latest_version = None
|
|
has_update = False
|
|
|
|
try:
|
|
latest_version, has_update = await get_latest_version_cached(current_version)
|
|
except Exception as e:
|
|
# Extra safety: ensure version check never breaks the config endpoint
|
|
logger.error(f"Unexpected error during version check: {e}")
|
|
|
|
# Check database health
|
|
db_health = await check_database_health()
|
|
db_status = db_health["status"]
|
|
|
|
if db_status == "offline":
|
|
logger.warning(f"Database offline: {db_health.get('error', 'Unknown error')}")
|
|
|
|
return {
|
|
"version": current_version,
|
|
"latestVersion": latest_version,
|
|
"hasUpdate": has_update,
|
|
"dbStatus": db_status,
|
|
}
|