release: v0.12.0 (#520)

Forty-one commits since v0.11.0. See CHANGELOG.md for the full list and the upgrade notes.

app/api/admin/__tests__/admin-guards.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { NextRequest } from 'next/server';
 
 vi.mock('@/lib/admin/auth', () => ({
   isAdminEnabled: vi.fn(),
@@ -73,6 +74,14 @@ const ROUTES: {
     method: 'GET',
     args: () => [],
   },
+  {
+    // Reports album titles, where passwords live and the proxy topology.
+    name: 'GET /api/admin/doctor',
+    path: 'doctor',
+    load: () => import('../doctor/route'),
+    method: 'GET',
+    args: () => [new NextRequest('http://localhost/api/admin/doctor')],
+  },
   {
     name: 'GET /api/admin/assets',
     path: 'assets',

app/api/admin/__tests__/doctor-guards.test.ts

@@ -0,0 +1,91 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+/**
+ * The report names album titles, password locations and proxy topology. Like
+ * every other /api/admin route it has to check both guards itself — there is no
+ * shared middleware (see admin-guards.test.ts).
+ */
+const enabled = vi.fn(() => true);
+const authed = vi.fn(async () => true);
+
+vi.mock('@/lib/admin/auth', () => ({
+  isAdminEnabled: () => enabled(),
+  isAdminAuthenticated: async () => authed(),
+  COOKIE_NAME: 'folio_admin_session',
+}));
+
+vi.mock('@/lib/config', () => ({
+  getConfig: () => ({
+    needsCredentials: true,
+    trustedProxyHops: 0,
+    authSecret: 'x'.repeat(64),
+    albums: [],
+    subpages: [],
+    albumPasswords: {},
+    sitePassword: '',
+    immich: { apiUrl: '', apiKey: '' },
+    immichTimeoutMs: 1000,
+  }),
+}));
+
+vi.mock('@/lib/env', () => ({ env: { AUTH_SECRET: 'x'.repeat(64) } }));
+vi.mock('@/lib/admin/journal-service', () => ({ listJournalEntries: async () => [] }));
+
+import { GET } from '../doctor/route';
+import { NextRequest } from 'next/server';
+
+function req(headers: Record<string, string> = {}) {
+  return new NextRequest('http://localhost/api/admin/doctor', { headers });
+}
+
+beforeEach(() => {
+  vi.clearAllMocks();
+  enabled.mockReturnValue(true);
+  authed.mockResolvedValue(true);
+});
+
+describe('GET /api/admin/doctor', () => {
+  it('refuses when the admin panel is disabled', async () => {
+    enabled.mockReturnValue(false);
+    expect((await GET(req())).status).toBe(403);
+  });
+
+  it('refuses an unauthenticated caller', async () => {
+    authed.mockResolvedValue(false);
+    expect((await GET(req())).status).toBe(401);
+  });
+
+  it('reports findings and the worst level', async () => {
+    const body = await (await GET(req())).json();
+    expect(Array.isArray(body.findings)).toBe(true);
+    expect(['ok', 'warn', 'error']).toContain(body.level);
+    // Missing credentials must surface as an error, not a silent pass.
+    expect(body.level).toBe('error');
+  });
+
+  /** The proxy check reads the chain off the request being served. */
+  it('measures the forwarded chain of the incoming request', async () => {
+    const body = await (await GET(req({ 'x-forwarded-for': '203.0.113.9, 10.0.0.2' }))).json();
+    const proxy = body.findings.find((f: { id: string }) => f.id === 'proxy-hops');
+    expect(proxy.level).toBe('warn');
+    expect(proxy.title).toContain('2');
+  });
+
+  /**
+   * Next writes X-Forwarded-For itself for a direct request, so this must stay
+   * quiet — otherwise the warning fires on every proxy-less deployment.
+   */
+  it('stays quiet on the single entry Next synthesises', async () => {
+    const body = await (await GET(req({ 'x-forwarded-for': '127.0.0.1' }))).json();
+    const proxy = body.findings.find((f: { id: string }) => f.id === 'proxy-hops');
+    expect(proxy.level).toBe('ok');
+  });
+
+  it('trusts a lone entry that a proxy header corroborates', async () => {
+    const body = await (
+      await GET(req({ 'x-forwarded-for': '203.0.113.9', 'x-real-ip': '203.0.113.9' }))
+    ).json();
+    const proxy = body.findings.find((f: { id: string }) => f.id === 'proxy-hops');
+    expect(proxy.level).toBe('warn');
+  });
+});

app/api/admin/__tests__/status.test.ts

@@ -20,11 +20,21 @@ vi.mock('@/lib/admin/yaml-service', () => ({
   listBackups: vi.fn(async () => []),
 }));
 
+vi.mock('@/lib/config', () => ({
+  getConfig: vi.fn(() => ({
+    needsSetup: false,
+    needsCredentials: false,
+    needsGallery: false,
+  })),
+}));
+
 import { GET } from '../status/route';
 import { readGalleryYaml, readSettingsYaml } from '@/lib/admin/yaml-service';
+import { getConfig } from '@/lib/config';
 
 const mockGallery = readGalleryYaml as unknown as ReturnType<typeof vi.fn>;
 const mockSettings = readSettingsYaml as unknown as ReturnType<typeof vi.fn>;
+const mockConfig = getConfig as unknown as ReturnType<typeof vi.fn>;
 
 async function status() {
   return (await GET()).json();
@@ -35,6 +45,11 @@ describe('GET /api/admin/status — config integrity', () => {
     vi.clearAllMocks();
     mockGallery.mockResolvedValue({ albums: ['a'] });
     mockSettings.mockResolvedValue({ title: 'Site' });
+    mockConfig.mockReturnValue({
+      needsSetup: false,
+      needsCredentials: false,
+      needsGallery: false,
+    });
   });
 
   it('reports a fully configured install as valid', async () => {
@@ -58,10 +73,76 @@ describe('GET /api/admin/status — config integrity', () => {
     expect((await status()).config).toMatchObject({ status: 'invalid', settings: 'invalid' });
   });
 
-  // gallery.yaml, unlike settings.yaml, is genuinely required.
-  it('reports a missing gallery.yaml as invalid', async () => {
+  /**
+   * gallery.yaml, unlike settings.yaml, is genuinely required — but a file that
+   * was never created is a pending setup step, not a corrupt config. Reporting
+   * both as "invalid" told a fresh deployment its config was broken and offered
+   * a backup restore as the cure (#507).
+   */
+  it('reports a missing gallery.yaml as pending setup, not as invalid', async () => {
     mockGallery.mockResolvedValue(null);
 
+    expect((await status()).config).toMatchObject({ status: 'setup', gallery: 'missing' });
+  });
+
+  it('still reports a gallery.yaml that cannot be parsed as invalid', async () => {
+    mockGallery.mockRejectedValue(new Error('bad indentation'));
+
     expect((await status()).config).toMatchObject({ status: 'invalid', gallery: 'invalid' });
   });
 });
+
+describe('GET /api/admin/status — setup state', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockGallery.mockResolvedValue({ albums: ['a'] });
+    mockSettings.mockResolvedValue({ title: 'Site' });
+  });
+
+  it('reports a finished install as complete', async () => {
+    mockConfig.mockReturnValue({
+      needsSetup: false,
+      needsCredentials: false,
+      needsGallery: false,
+    });
+
+    expect((await status()).setup).toEqual({
+      complete: true,
+      credentials: 'present',
+      gallery: 'present',
+    });
+  });
+
+  /**
+   * The case from #507: credentials from the environment, no gallery.yaml. The
+   * admin panel must be able to tell those apart to say what is actually left
+   * to do instead of "System Degraded".
+   */
+  it('separates missing credentials from a missing gallery.yaml', async () => {
+    mockConfig.mockReturnValue({
+      needsSetup: true,
+      needsCredentials: false,
+      needsGallery: true,
+    });
+
+    expect((await status()).setup).toEqual({
+      complete: false,
+      credentials: 'present',
+      gallery: 'missing',
+    });
+  });
+
+  it('reports absent credentials', async () => {
+    mockConfig.mockReturnValue({
+      needsSetup: true,
+      needsCredentials: true,
+      needsGallery: true,
+    });
+
+    expect((await status()).setup).toEqual({
+      complete: false,
+      credentials: 'missing',
+      gallery: 'missing',
+    });
+  });
+});