mirror of
https://github.com/willmiao/ComfyUI-Lora-Manager.git
synced 2026-09-26 21:44:09 -03:00
After migrating to centralized sidecar storage users had no indication where their files went, and portable-mode installs silently placed the sidecar root inside the plugin folder where a reinstall or git clean would delete it. - Migration now also covers models excluded from the library view and returns the resolved sidecar root in its result payload - get_settings exposes the resolved sidecar root, whether it is the default, and whether it lives inside the installation folder - New POST /api/lm/sidecars/open-location endpoint opens (or copies) the sidecar storage folder - Settings UI always shows the effective storage path with an open-folder button, and warns when the root is inside the installation folder (portable-mode hazard) - Migration confirmation shows the destination; on completion a result dialog summarizes moved/skipped/conflict counts with the storage location and an open-folder action - Ignore /sidecars/ at the repository root so portable-mode sidecars are never committed Refs #1045
512 lines
20 KiB
JavaScript
512 lines
20 KiB
JavaScript
import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
|
|
|
|
vi.mock('../../../static/js/managers/ModalManager.js', () => ({
|
|
modalManager: {
|
|
closeModal: vi.fn(),
|
|
},
|
|
}));
|
|
|
|
vi.mock('../../../static/js/utils/uiHelpers.js', () => ({
|
|
showToast: vi.fn(),
|
|
}));
|
|
|
|
vi.mock('../../../static/js/state/index.js', () => {
|
|
const settings = {};
|
|
return {
|
|
state: {
|
|
global: {
|
|
settings,
|
|
},
|
|
loadingManager: {
|
|
showSimpleLoading: vi.fn(),
|
|
hide: vi.fn(),
|
|
},
|
|
},
|
|
createDefaultSettings: () => ({
|
|
language: 'en',
|
|
sidecar_storage_mode: 'alongside',
|
|
sidecar_storage_path: '',
|
|
}),
|
|
};
|
|
});
|
|
|
|
vi.mock('../../../static/js/api/modelApiFactory.js', () => ({
|
|
resetAndReload: vi.fn(),
|
|
getModelApiClient: vi.fn(),
|
|
}));
|
|
|
|
vi.mock('../../../static/js/utils/constants.js', () => ({
|
|
DOWNLOAD_PATH_TEMPLATES: {},
|
|
DEFAULT_PATH_TEMPLATES: {},
|
|
MAPPABLE_BASE_MODELS: [],
|
|
PATH_TEMPLATE_PLACEHOLDERS: {},
|
|
FILENAME_TEMPLATE_PLACEHOLDERS: [],
|
|
DEFAULT_FILENAME_TEMPLATES: { lora: '', checkpoint: '', embedding: '' },
|
|
DEFAULT_PRIORITY_TAG_CONFIG: {
|
|
lora: 'character, style',
|
|
checkpoint: 'base, guide',
|
|
embedding: 'hint',
|
|
},
|
|
getMappableBaseModelsDynamic: () => [],
|
|
}));
|
|
|
|
vi.mock('../../../static/js/utils/i18nHelpers.js', () => ({
|
|
translate: (_key, _params, fallback) => fallback ?? '',
|
|
}));
|
|
|
|
vi.mock('../../../static/js/i18n/index.js', () => ({
|
|
i18n: {
|
|
getCurrentLocale: () => 'en',
|
|
setLanguage: vi.fn().mockResolvedValue(),
|
|
},
|
|
}));
|
|
|
|
vi.mock('../../../static/js/components/shared/ModelCard.js', () => ({
|
|
configureModelCardVideo: vi.fn(),
|
|
}));
|
|
|
|
import { SettingsManager } from '../../../static/js/managers/SettingsManager.js';
|
|
import { showToast } from '../../../static/js/utils/uiHelpers.js';
|
|
import { resetAndReload } from '../../../static/js/api/modelApiFactory.js';
|
|
import { state } from '../../../static/js/state/index.js';
|
|
|
|
const createManager = () => {
|
|
state.global.settings = {};
|
|
const initSettingsSpy = vi
|
|
.spyOn(SettingsManager.prototype, 'initializeSettings')
|
|
.mockResolvedValue();
|
|
const initializeSpy = vi
|
|
.spyOn(SettingsManager.prototype, 'initialize')
|
|
.mockImplementation(() => {});
|
|
|
|
const manager = new SettingsManager();
|
|
|
|
initSettingsSpy.mockRestore();
|
|
initializeSpy.mockRestore();
|
|
|
|
return manager;
|
|
};
|
|
|
|
const appendSidecarControls = () => {
|
|
const select = document.createElement('select');
|
|
select.id = 'sidecarStorageMode';
|
|
['alongside', 'centralized'].forEach((value) => {
|
|
const option = document.createElement('option');
|
|
option.value = value;
|
|
select.appendChild(option);
|
|
});
|
|
|
|
const pathSetting = document.createElement('div');
|
|
pathSetting.id = 'sidecarStoragePathSetting';
|
|
pathSetting.style.display = 'none';
|
|
|
|
const pathInput = document.createElement('input');
|
|
pathInput.id = 'sidecarStoragePath';
|
|
|
|
const migrateBtn = document.createElement('button');
|
|
migrateBtn.id = 'migrateSidecarsBtn';
|
|
|
|
document.body.append(select, pathSetting, pathInput, migrateBtn);
|
|
return { select, pathSetting, pathInput, migrateBtn };
|
|
};
|
|
|
|
const appendMigrationModal = () => {
|
|
const modal = document.createElement('div');
|
|
modal.id = 'sidecarMigrationConfirmModal';
|
|
modal.innerHTML = `
|
|
<h2 data-role="title"></h2>
|
|
<p data-role="message"></p>
|
|
<p data-role="destination" style="display:none"></p>
|
|
<button data-action="confirm-sidecar-migration"></button>
|
|
<button data-action="cancel-sidecar-migration"></button>`;
|
|
document.body.appendChild(modal);
|
|
return modal;
|
|
};
|
|
|
|
const mockFetchOk = (payload = { success: true }) => {
|
|
global.fetch = vi.fn().mockResolvedValue({
|
|
ok: true,
|
|
json: () => Promise.resolve(payload),
|
|
});
|
|
};
|
|
|
|
beforeEach(() => {
|
|
document.body.innerHTML = '';
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
afterEach(() => {
|
|
delete global.fetch;
|
|
});
|
|
|
|
describe('SettingsManager sidecar storage', () => {
|
|
describe('loadSidecarStorageSettings', () => {
|
|
it('loads alongside mode and hides the centralized path input', () => {
|
|
const manager = createManager();
|
|
const { select, pathSetting, pathInput } = appendSidecarControls();
|
|
state.global.settings = { sidecar_storage_mode: 'alongside', sidecar_storage_path: '/data/sidecars' };
|
|
|
|
manager.loadSidecarStorageSettings();
|
|
|
|
expect(select.value).toBe('alongside');
|
|
expect(pathInput.value).toBe('/data/sidecars');
|
|
expect(pathSetting.style.display).toBe('none');
|
|
expect(manager._loadedSidecarStorageMode).toBe('alongside');
|
|
});
|
|
|
|
it('loads centralized mode and shows the path input', () => {
|
|
const manager = createManager();
|
|
const { select, pathSetting } = appendSidecarControls();
|
|
state.global.settings = { sidecar_storage_mode: 'centralized' };
|
|
|
|
manager.loadSidecarStorageSettings();
|
|
|
|
expect(select.value).toBe('centralized');
|
|
expect(pathSetting.style.display).toBe('block');
|
|
expect(manager._loadedSidecarStorageMode).toBe('centralized');
|
|
});
|
|
|
|
it('falls back to alongside for unknown stored modes', () => {
|
|
const manager = createManager();
|
|
const { select } = appendSidecarControls();
|
|
state.global.settings = { sidecar_storage_mode: 'bogus' };
|
|
|
|
manager.loadSidecarStorageSettings();
|
|
|
|
expect(select.value).toBe('alongside');
|
|
});
|
|
});
|
|
|
|
describe('handleSidecarStorageModeChange', () => {
|
|
it('does not prompt for migration when the mode is unchanged', async () => {
|
|
const manager = createManager();
|
|
const { select } = appendSidecarControls();
|
|
appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'alongside' };
|
|
manager._loadedSidecarStorageMode = 'alongside';
|
|
select.value = 'alongside';
|
|
mockFetchOk();
|
|
|
|
await manager.handleSidecarStorageModeChange();
|
|
|
|
expect(global.fetch).not.toHaveBeenCalledWith(
|
|
'/api/lm/sidecars/migrate',
|
|
expect.anything()
|
|
);
|
|
expect(showToast).toHaveBeenCalledWith(
|
|
'toast.settings.settingsUpdated',
|
|
expect.anything(),
|
|
'success'
|
|
);
|
|
});
|
|
|
|
it('migrates to centralized after the user confirms the prompt', async () => {
|
|
const manager = createManager();
|
|
const { select, pathSetting } = appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'alongside' };
|
|
manager._loadedSidecarStorageMode = 'alongside';
|
|
select.value = 'centralized';
|
|
mockFetchOk();
|
|
|
|
const changePromise = manager.handleSidecarStorageModeChange();
|
|
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
modal.querySelector('[data-action="confirm-sidecar-migration"]').click();
|
|
await changePromise;
|
|
|
|
expect(state.global.settings.sidecar_storage_mode).toBe('centralized');
|
|
expect(pathSetting.style.display).toBe('block');
|
|
expect(global.fetch).toHaveBeenCalledWith('/api/lm/sidecars/migrate', expect.objectContaining({
|
|
method: 'POST',
|
|
body: JSON.stringify({ direction: 'to_centralized', force: true }),
|
|
}));
|
|
expect(showToast).toHaveBeenCalledWith('settings.sidecarStorage.migrateSuccess', {}, 'success');
|
|
expect(resetAndReload).toHaveBeenCalledWith(true);
|
|
expect(modal.classList.contains('show')).toBe(false);
|
|
});
|
|
|
|
it('names the resolved destination in the confirm dialog', async () => {
|
|
const manager = createManager();
|
|
const { select } = appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = {
|
|
sidecar_storage_mode: 'alongside',
|
|
sidecar_storage_root: '/data/sidecars',
|
|
};
|
|
manager._loadedSidecarStorageMode = 'alongside';
|
|
select.value = 'centralized';
|
|
mockFetchOk();
|
|
|
|
const changePromise = manager.handleSidecarStorageModeChange();
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
|
|
const destination = modal.querySelector('[data-role="destination"]');
|
|
expect(destination.textContent).toContain('/data/sidecars');
|
|
expect(destination.style.display).toBe('block');
|
|
|
|
modal.querySelector('[data-action="cancel-sidecar-migration"]').click();
|
|
await changePromise;
|
|
});
|
|
|
|
it('shows a deferred notice and skips migration when the user cancels', async () => { const manager = createManager();
|
|
const { select } = appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'centralized' };
|
|
manager._loadedSidecarStorageMode = 'centralized';
|
|
select.value = 'alongside';
|
|
mockFetchOk();
|
|
|
|
const changePromise = manager.handleSidecarStorageModeChange();
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
modal.querySelector('[data-action="cancel-sidecar-migration"]').click();
|
|
await changePromise;
|
|
|
|
const migrateCalls = global.fetch.mock.calls.filter(([url]) => url === '/api/lm/sidecars/migrate');
|
|
expect(migrateCalls).toHaveLength(0);
|
|
expect(showToast).toHaveBeenCalledWith('settings.sidecarStorage.migrationDeferred', {}, 'info');
|
|
});
|
|
});
|
|
|
|
describe('confirmAndMigrateSidecars', () => {
|
|
it('derives the migration direction from the saved mode', async () => {
|
|
const manager = createManager();
|
|
appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'centralized' };
|
|
mockFetchOk();
|
|
|
|
const confirmPromise = manager.confirmAndMigrateSidecars();
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
modal.querySelector('[data-action="confirm-sidecar-migration"]').click();
|
|
await confirmPromise;
|
|
|
|
expect(global.fetch).toHaveBeenCalledWith('/api/lm/sidecars/migrate', expect.objectContaining({
|
|
body: JSON.stringify({ direction: 'to_centralized', force: true }),
|
|
}));
|
|
});
|
|
});
|
|
|
|
describe('migrateSidecars', () => {
|
|
it('surfaces backend failures as an error toast', async () => {
|
|
const manager = createManager();
|
|
const { migrateBtn } = appendSidecarControls();
|
|
mockFetchOk({ success: false, error: 'disk full' });
|
|
|
|
await manager.migrateSidecars('to_alongside');
|
|
|
|
expect(showToast).toHaveBeenCalledWith(
|
|
'settings.sidecarStorage.migrateFailed',
|
|
{ message: 'disk full' },
|
|
'error'
|
|
);
|
|
expect(resetAndReload).not.toHaveBeenCalled();
|
|
expect(migrateBtn.disabled).toBe(false);
|
|
});
|
|
});
|
|
|
|
describe('handleSidecarStoragePathChange', () => { it('offers root relocation when the path changes in centralized mode', async () => {
|
|
const manager = createManager();
|
|
const { pathInput } = appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'centralized', sidecar_storage_path: '/old/root' };
|
|
manager._loadedSidecarStoragePath = '/old/root';
|
|
pathInput.value = '/new/root';
|
|
mockFetchOk();
|
|
|
|
const changePromise = manager.handleSidecarStoragePathChange();
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
modal.querySelector('[data-action="confirm-sidecar-migration"]').click();
|
|
await changePromise;
|
|
|
|
expect(global.fetch).toHaveBeenCalledWith('/api/lm/sidecars/migrate', expect.objectContaining({
|
|
body: JSON.stringify({ direction: 'relocate_root', force: true, old_root: '/old/root' }),
|
|
}));
|
|
expect(manager._loadedSidecarStoragePath).toBe('/new/root');
|
|
});
|
|
|
|
it('does not prompt when the path changes in alongside mode', async () => {
|
|
const manager = createManager();
|
|
const { pathInput } = appendSidecarControls();
|
|
appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'alongside', sidecar_storage_path: '/old/root' };
|
|
manager._loadedSidecarStoragePath = '/old/root';
|
|
pathInput.value = '/new/root';
|
|
mockFetchOk();
|
|
|
|
await manager.handleSidecarStoragePathChange();
|
|
|
|
const migrateCalls = global.fetch.mock.calls.filter(([url]) => url === '/api/lm/sidecars/migrate');
|
|
expect(migrateCalls).toHaveLength(0);
|
|
});
|
|
|
|
it('shows a deferred notice when relocation is cancelled', async () => {
|
|
const manager = createManager();
|
|
const { pathInput } = appendSidecarControls();
|
|
const modal = appendMigrationModal();
|
|
state.global.settings = { sidecar_storage_mode: 'centralized', sidecar_storage_path: '/old/root' };
|
|
manager._loadedSidecarStoragePath = '/old/root';
|
|
pathInput.value = '/new/root';
|
|
mockFetchOk();
|
|
|
|
const changePromise = manager.handleSidecarStoragePathChange();
|
|
await vi.waitFor(() => expect(modal.classList.contains('show')).toBe(true));
|
|
modal.querySelector('[data-action="cancel-sidecar-migration"]').click();
|
|
await changePromise;
|
|
|
|
const migrateCalls = global.fetch.mock.calls.filter(([url]) => url === '/api/lm/sidecars/migrate');
|
|
expect(migrateCalls).toHaveLength(0);
|
|
expect(showToast).toHaveBeenCalledWith('settings.sidecarStorage.migrationDeferred', {}, 'info');
|
|
});
|
|
});
|
|
|
|
describe('renderSidecarStorageInfo', () => {
|
|
const appendStorageInfoElements = () => {
|
|
const resolved = document.createElement('code');
|
|
resolved.id = 'sidecarStorageResolvedPath';
|
|
const warning = document.createElement('div');
|
|
warning.id = 'sidecarStorageRepoWarning';
|
|
warning.style.display = 'none';
|
|
document.body.append(resolved, warning);
|
|
return { resolved, warning };
|
|
};
|
|
|
|
it('shows the resolved root and the repo warning when inside the install folder', () => {
|
|
const manager = createManager();
|
|
const { resolved, warning } = appendStorageInfoElements();
|
|
state.global.settings = {
|
|
sidecar_storage_root: '/repo/ComfyUI-Lora-Manager/sidecars',
|
|
sidecar_storage_root_in_repo: true,
|
|
};
|
|
|
|
manager.renderSidecarStorageInfo();
|
|
|
|
expect(resolved.textContent).toBe('/repo/ComfyUI-Lora-Manager/sidecars');
|
|
expect(warning.style.display).toBe('block');
|
|
});
|
|
|
|
it('hides the repo warning when the root lives outside the install folder', () => {
|
|
const manager = createManager();
|
|
const { resolved, warning } = appendStorageInfoElements();
|
|
state.global.settings = {
|
|
sidecar_storage_root: '/data/sidecars',
|
|
sidecar_storage_root_in_repo: false,
|
|
};
|
|
|
|
manager.renderSidecarStorageInfo();
|
|
|
|
expect(resolved.textContent).toBe('/data/sidecars');
|
|
expect(warning.style.display).toBe('none');
|
|
});
|
|
});
|
|
|
|
describe('openSidecarStorageLocation', () => {
|
|
it('posts to the open-location endpoint', async () => {
|
|
const manager = createManager();
|
|
mockFetchOk({ success: true });
|
|
|
|
await manager.openSidecarStorageLocation();
|
|
|
|
expect(global.fetch).toHaveBeenCalledWith('/api/lm/sidecars/open-location', { method: 'POST' });
|
|
expect(showToast).toHaveBeenCalledWith('settings.sidecarStorage.openLocationSuccess', {}, 'success');
|
|
});
|
|
|
|
it('copies the path to the clipboard in clipboard mode', async () => {
|
|
const manager = createManager();
|
|
mockFetchOk({ success: true, mode: 'clipboard', path: '/data/sidecars' });
|
|
const writeText = vi.fn().mockResolvedValue();
|
|
Object.defineProperty(navigator, 'clipboard', {
|
|
value: { writeText },
|
|
configurable: true,
|
|
});
|
|
|
|
await manager.openSidecarStorageLocation();
|
|
|
|
expect(writeText).toHaveBeenCalledWith('/data/sidecars');
|
|
expect(showToast).toHaveBeenCalledWith(
|
|
'settings.sidecarStorage.openLocationCopied',
|
|
{ path: '/data/sidecars' },
|
|
'success'
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('showSidecarMigrationResult', () => {
|
|
const appendResultModal = () => {
|
|
const modal = document.createElement('div');
|
|
modal.id = 'sidecarMigrationResultModal';
|
|
modal.innerHTML = `
|
|
<h2 data-role="title"></h2>
|
|
<p data-role="message"></p>
|
|
<p data-role="destination" style="display:none"></p>
|
|
<button data-action="open-sidecar-location" style="display:none"></button>
|
|
<button data-action="close-sidecar-result"></button>`;
|
|
document.body.appendChild(modal);
|
|
return modal;
|
|
};
|
|
|
|
it('renders counters and location, reloads only when closed', async () => {
|
|
const manager = createManager();
|
|
const modal = appendResultModal();
|
|
mockFetchOk({ success: true });
|
|
|
|
manager.showSidecarMigrationResult({
|
|
success: true,
|
|
direction: 'to_centralized',
|
|
moved: 12,
|
|
models_moved: 5,
|
|
skipped: 1,
|
|
conflicts: 2,
|
|
error_count: 0,
|
|
sidecar_root: '/data/sidecars',
|
|
});
|
|
|
|
expect(modal.classList.contains('show')).toBe(true);
|
|
expect(modal.querySelector('[data-role="message"]').textContent).toContain('12');
|
|
expect(modal.querySelector('[data-role="destination"]').textContent).toContain('/data/sidecars');
|
|
expect(modal.querySelector('[data-action="open-sidecar-location"]').style.display).not.toBe('none');
|
|
expect(resetAndReload).not.toHaveBeenCalled();
|
|
|
|
// "Open Folder" keeps the result modal open.
|
|
modal.querySelector('[data-action="open-sidecar-location"]').click();
|
|
await vi.waitFor(() => expect(global.fetch).toHaveBeenCalledWith(
|
|
'/api/lm/sidecars/open-location',
|
|
{ method: 'POST' }
|
|
));
|
|
expect(modal.classList.contains('show')).toBe(true);
|
|
|
|
modal.querySelector('[data-action="close-sidecar-result"]').click();
|
|
expect(modal.classList.contains('show')).toBe(false);
|
|
expect(resetAndReload).toHaveBeenCalledWith(true);
|
|
});
|
|
|
|
it('hides the location row and open button when migrating back alongside', () => {
|
|
const manager = createManager();
|
|
const modal = appendResultModal();
|
|
|
|
manager.showSidecarMigrationResult({
|
|
success: true,
|
|
direction: 'to_alongside',
|
|
moved: 3,
|
|
models_moved: 3,
|
|
skipped: 0,
|
|
conflicts: 0,
|
|
error_count: 0,
|
|
sidecar_root: '/data/sidecars',
|
|
});
|
|
|
|
expect(modal.querySelector('[data-role="destination"]').style.display).toBe('none');
|
|
expect(modal.querySelector('[data-action="open-sidecar-location"]').style.display).toBe('none');
|
|
});
|
|
|
|
it('falls back to toast plus reload when the modal is absent', () => {
|
|
const manager = createManager();
|
|
|
|
manager.showSidecarMigrationResult({ success: true, direction: 'to_centralized' });
|
|
|
|
expect(showToast).toHaveBeenCalledWith('settings.sidecarStorage.migrateSuccess', {}, 'success');
|
|
expect(resetAndReload).toHaveBeenCalledWith(true);
|
|
});
|
|
});
|
|
});
|