sudacode/SubMiner
1
0
Fork 0
mirror of https://github.com/ksyasuda/SubMiner.git synced 2026-03-20 12:11:28 -07:00
Code Issues Packages Projects Releases Wiki Activity

Prepare Windows release and signing process (#16)

Browse Source
This commit is contained in:
Kyle Yasuda
2026-03-08 19:51:30 -07:00
committed by GitHub
parent 34d2dce8dc
commit c799a8de3c
113 changed files with 5042 additions and 386 deletions
Download Patch File Download Diff File Expand all files Collapse all files

168
src/shared/setup-state.test.ts
View File

@@ -24,13 +24,17 @@ function withTempDir(fn: (dir: string) => void): void {
}
test('getDefaultConfigDir prefers existing SubMiner config directory', () => {
const xdgConfigHome = path.join(path.sep, 'tmp', 'xdg');
const homeDir = path.join(path.sep, 'tmp', 'home');
const dir = getDefaultConfigDir({
xdgConfigHome: '/tmp/xdg',
homeDir: '/tmp/home',
existsSync: (candidate) => candidate === '/tmp/xdg/SubMiner/config.jsonc',
platform: 'linux',
xdgConfigHome,
homeDir,
existsSync: (candidate) =>
candidate === path.posix.join(xdgConfigHome, 'SubMiner', 'config.jsonc'),
});
assert.equal(dir, '/tmp/xdg/SubMiner');
assert.equal(dir, path.posix.join(xdgConfigHome, 'SubMiner'));
});
test('ensureDefaultConfigBootstrap creates config dir and default jsonc only when missing', () => {
@@ -61,6 +65,26 @@ test('ensureDefaultConfigBootstrap creates config dir and default jsonc only whe
});
});
test('ensureDefaultConfigBootstrap does not seed default config into an existing config directory', () => {
withTempDir((root) => {
const configDir = path.join(root, 'SubMiner');
fs.mkdirSync(configDir, { recursive: true });
fs.writeFileSync(path.join(configDir, 'existing-user-file.txt'), 'keep\n');
ensureDefaultConfigBootstrap({
configDir,
configFilePaths: getDefaultConfigFilePaths(configDir),
generateTemplate: () => 'should-not-write',
});
assert.equal(fs.existsSync(path.join(configDir, 'config.jsonc')), false);
assert.equal(
fs.readFileSync(path.join(configDir, 'existing-user-file.txt'), 'utf8'),
'keep\n',
);
});
});
test('readSetupState ignores invalid files and round-trips valid state', () => {
withTempDir((root) => {
const statePath = getSetupStatePath(root);
@@ -77,22 +101,126 @@ test('readSetupState ignores invalid files and round-trips valid state', () => {
});
});
test('resolveDefaultMpvInstallPaths resolves linux and macOS defaults', () => {
assert.deepEqual(resolveDefaultMpvInstallPaths('linux', '/tmp/home', '/tmp/xdg'), {
supported: true,
mpvConfigDir: '/tmp/xdg/mpv',
scriptsDir: '/tmp/xdg/mpv/scripts',
scriptOptsDir: '/tmp/xdg/mpv/script-opts',
pluginDir: '/tmp/xdg/mpv/scripts/subminer',
pluginConfigPath: '/tmp/xdg/mpv/script-opts/subminer.conf',
});
test('readSetupState migrates v1 state to v2 windows shortcut defaults', () => {
withTempDir((root) => {
const statePath = getSetupStatePath(root);
fs.writeFileSync(
statePath,
JSON.stringify({
version: 1,
status: 'incomplete',
completedAt: null,
completionSource: null,
lastSeenYomitanDictionaryCount: 0,
pluginInstallStatus: 'unknown',
pluginInstallPathSummary: null,
}),
);
assert.deepEqual(resolveDefaultMpvInstallPaths('darwin', '/Users/tester', undefined), {
supported: true,
mpvConfigDir: '/Users/tester/Library/Application Support/mpv',
scriptsDir: '/Users/tester/Library/Application Support/mpv/scripts',
scriptOptsDir: '/Users/tester/Library/Application Support/mpv/script-opts',
pluginDir: '/Users/tester/Library/Application Support/mpv/scripts/subminer',
pluginConfigPath: '/Users/tester/Library/Application Support/mpv/script-opts/subminer.conf',
assert.deepEqual(readSetupState(statePath), {
version: 2,
status: 'incomplete',
completedAt: null,
completionSource: null,
lastSeenYomitanDictionaryCount: 0,
pluginInstallStatus: 'unknown',
pluginInstallPathSummary: null,
windowsMpvShortcutPreferences: {
startMenuEnabled: true,
desktopEnabled: true,
},
windowsMpvShortcutLastStatus: 'unknown',
});
});
});
test('resolveDefaultMpvInstallPaths resolves linux, macOS, and Windows defaults', () => {
const linuxHomeDir = path.join(path.sep, 'tmp', 'home');
const xdgConfigHome = path.join(path.sep, 'tmp', 'xdg');
assert.deepEqual(resolveDefaultMpvInstallPaths('linux', linuxHomeDir, xdgConfigHome), {
supported: true,
mpvConfigDir: path.posix.join(xdgConfigHome, 'mpv'),
scriptsDir: path.posix.join(xdgConfigHome, 'mpv', 'scripts'),
scriptOptsDir: path.posix.join(xdgConfigHome, 'mpv', 'script-opts'),
pluginEntrypointPath: path.posix.join(xdgConfigHome, 'mpv', 'scripts', 'subminer', 'main.lua'),
pluginDir: path.posix.join(xdgConfigHome, 'mpv', 'scripts', 'subminer'),
pluginConfigPath: path.posix.join(xdgConfigHome, 'mpv', 'script-opts', 'subminer.conf'),
});
const macHomeDir = path.join(path.sep, 'Users', 'tester');
assert.deepEqual(resolveDefaultMpvInstallPaths('darwin', macHomeDir, undefined), {
supported: true,
mpvConfigDir: path.posix.join(macHomeDir, 'Library', 'Application Support', 'mpv'),
scriptsDir: path.posix.join(macHomeDir, 'Library', 'Application Support', 'mpv', 'scripts'),
scriptOptsDir: path.posix.join(
macHomeDir,
'Library',
'Application Support',
'mpv',
'script-opts',
),
pluginEntrypointPath: path.posix.join(
macHomeDir,
'Library',
'Application Support',
'mpv',
'scripts',
'subminer',
'main.lua',
),
pluginDir: path.posix.join(
macHomeDir,
'Library',
'Application Support',
'mpv',
'scripts',
'subminer',
),
pluginConfigPath: path.posix.join(
macHomeDir,
'Library',
'Application Support',
'mpv',
'script-opts',
'subminer.conf',
),
});
assert.deepEqual(resolveDefaultMpvInstallPaths('win32', 'C:\\Users\\tester', undefined), {
supported: true,
mpvConfigDir: path.win32.join('C:\\Users\\tester', 'AppData', 'Roaming', 'mpv'),
scriptsDir: path.win32.join('C:\\Users\\tester', 'AppData', 'Roaming', 'mpv', 'scripts'),
scriptOptsDir: path.win32.join(
'C:\\Users\\tester',
'AppData',
'Roaming',
'mpv',
'script-opts',
),
pluginEntrypointPath: path.win32.join(
'C:\\Users\\tester',
'AppData',
'Roaming',
'mpv',
'scripts',
'subminer',
'main.lua',
),
pluginDir: path.win32.join(
'C:\\Users\\tester',
'AppData',
'Roaming',
'mpv',
'scripts',
'subminer',
),
pluginConfigPath: path.win32.join(
'C:\\Users\\tester',
'AppData',
'Roaming',
'mpv',
'script-opts',
'subminer.conf',
),
});
});

80
src/shared/setup-state.ts
View File

@@ -6,15 +6,23 @@ import { resolveConfigDir } from '../config/path-resolution';
export type SetupStateStatus = 'incomplete' | 'in_progress' | 'completed' | 'cancelled';
export type SetupCompletionSource = 'user' | 'legacy_auto_detected' | null;
export type SetupPluginInstallStatus = 'unknown' | 'installed' | 'skipped' | 'failed';
export type SetupWindowsMpvShortcutInstallStatus = 'unknown' | 'installed' | 'skipped' | 'failed';
export interface SetupWindowsMpvShortcutPreferences {
startMenuEnabled: boolean;
desktopEnabled: boolean;
}
export interface SetupState {
version: 1;
version: 2;
status: SetupStateStatus;
completedAt: string | null;
completionSource: SetupCompletionSource;
lastSeenYomitanDictionaryCount: number;
pluginInstallStatus: SetupPluginInstallStatus;
pluginInstallPathSummary: string | null;
windowsMpvShortcutPreferences: SetupWindowsMpvShortcutPreferences;
windowsMpvShortcutLastStatus: SetupWindowsMpvShortcutInstallStatus;
}
export interface ConfigFilePaths {
@@ -27,10 +35,15 @@ export interface MpvInstallPaths {
mpvConfigDir: string;
scriptsDir: string;
scriptOptsDir: string;
pluginEntrypointPath: string;
pluginDir: string;
pluginConfigPath: string;
}
function getPlatformPath(platform: NodeJS.Platform): typeof path.posix | typeof path.win32 {
return platform === 'win32' ? path.win32 : path.posix;
}
function asObject(value: unknown): Record<string, unknown> | null {
return value && typeof value === 'object' && !Array.isArray(value)
? (value as Record<string, unknown>)
@@ -39,25 +52,33 @@ function asObject(value: unknown): Record<string, unknown> | null {
export function createDefaultSetupState(): SetupState {
return {
version: 1,
version: 2,
status: 'incomplete',
completedAt: null,
completionSource: null,
lastSeenYomitanDictionaryCount: 0,
pluginInstallStatus: 'unknown',
pluginInstallPathSummary: null,
windowsMpvShortcutPreferences: {
startMenuEnabled: true,
desktopEnabled: true,
},
windowsMpvShortcutLastStatus: 'unknown',
};
}
export function normalizeSetupState(value: unknown): SetupState | null {
const record = asObject(value);
if (!record) return null;
const version = record.version;
const status = record.status;
const pluginInstallStatus = record.pluginInstallStatus;
const completionSource = record.completionSource;
const windowsPrefs = asObject(record.windowsMpvShortcutPreferences);
const windowsMpvShortcutLastStatus = record.windowsMpvShortcutLastStatus;
if (
record.version !== 1 ||
(version !== 1 && version !== 2) ||
(status !== 'incomplete' &&
status !== 'in_progress' &&
status !== 'completed' &&
@@ -66,6 +87,11 @@ export function normalizeSetupState(value: unknown): SetupState | null {
pluginInstallStatus !== 'installed' &&
pluginInstallStatus !== 'skipped' &&
pluginInstallStatus !== 'failed') ||
(version === 2 &&
windowsMpvShortcutLastStatus !== 'unknown' &&
windowsMpvShortcutLastStatus !== 'installed' &&
windowsMpvShortcutLastStatus !== 'skipped' &&
windowsMpvShortcutLastStatus !== 'failed') ||
(completionSource !== null &&
completionSource !== 'user' &&
completionSource !== 'legacy_auto_detected')
@@ -74,7 +100,7 @@ export function normalizeSetupState(value: unknown): SetupState | null {
}
return {
version: 1,
version: 2,
status,
completedAt: typeof record.completedAt === 'string' ? record.completedAt : null,
completionSource,
@@ -87,6 +113,24 @@ export function normalizeSetupState(value: unknown): SetupState | null {
pluginInstallStatus,
pluginInstallPathSummary:
typeof record.pluginInstallPathSummary === 'string' ? record.pluginInstallPathSummary : null,
windowsMpvShortcutPreferences: {
startMenuEnabled:
version === 2 && typeof windowsPrefs?.startMenuEnabled === 'boolean'
? windowsPrefs.startMenuEnabled
: true,
desktopEnabled:
version === 2 && typeof windowsPrefs?.desktopEnabled === 'boolean'
? windowsPrefs.desktopEnabled
: true,
},
windowsMpvShortcutLastStatus:
version === 2 &&
(windowsMpvShortcutLastStatus === 'unknown' ||
windowsMpvShortcutLastStatus === 'installed' ||
windowsMpvShortcutLastStatus === 'skipped' ||
windowsMpvShortcutLastStatus === 'failed')
? windowsMpvShortcutLastStatus
: 'unknown',
};
}
@@ -95,11 +139,15 @@ export function isSetupCompleted(state: SetupState | null | undefined): boolean
}
export function getDefaultConfigDir(options?: {
platform?: NodeJS.Platform;
appDataDir?: string;
xdgConfigHome?: string;
homeDir?: string;
existsSync?: (candidate: string) => boolean;
}): string {
return resolveConfigDir({
platform: options?.platform ?? process.platform,
appDataDir: options?.appDataDir ?? process.env.APPDATA,
xdgConfigHome: options?.xdgConfigHome ?? process.env.XDG_CONFIG_HOME,
homeDir: options?.homeDir ?? os.homedir(),
existsSync: options?.existsSync ?? fs.existsSync,
@@ -160,15 +208,17 @@ export function ensureDefaultConfigBootstrap(options: {
const existsSync = options.existsSync ?? fs.existsSync;
const mkdirSync = options.mkdirSync ?? fs.mkdirSync;
const writeFileSync = options.writeFileSync ?? fs.writeFileSync;
const configDirExists = existsSync(options.configDir);
mkdirSync(options.configDir, { recursive: true });
if (
existsSync(options.configFilePaths.jsoncPath) ||
existsSync(options.configFilePaths.jsonPath)
existsSync(options.configFilePaths.jsonPath) ||
configDirExists
) {
return;
}
mkdirSync(options.configDir, { recursive: true });
writeFileSync(options.configFilePaths.jsoncPath, options.generateTemplate(), 'utf8');
}
@@ -177,19 +227,21 @@ export function resolveDefaultMpvInstallPaths(
homeDir: string,
xdgConfigHome?: string,
): MpvInstallPaths {
const platformPath = getPlatformPath(platform);
const mpvConfigDir =
platform === 'darwin'
? path.join(homeDir, 'Library', 'Application Support', 'mpv')
? platformPath.join(homeDir, 'Library', 'Application Support', 'mpv')
: platform === 'linux'
? path.join(xdgConfigHome?.trim() || path.join(homeDir, '.config'), 'mpv')
: path.join(homeDir, 'AppData', 'Roaming', 'mpv');
? platformPath.join(xdgConfigHome?.trim() || platformPath.join(homeDir, '.config'), 'mpv')
: platformPath.join(homeDir, 'AppData', 'Roaming', 'mpv');
return {
supported: platform === 'linux' || platform === 'darwin',
supported: platform === 'linux' || platform === 'darwin' || platform === 'win32',
mpvConfigDir,
scriptsDir: path.join(mpvConfigDir, 'scripts'),
scriptOptsDir: path.join(mpvConfigDir, 'script-opts'),
pluginDir: path.join(mpvConfigDir, 'scripts', 'subminer'),
pluginConfigPath: path.join(mpvConfigDir, 'script-opts', 'subminer.conf'),
scriptsDir: platformPath.join(mpvConfigDir, 'scripts'),
scriptOptsDir: platformPath.join(mpvConfigDir, 'script-opts'),
pluginEntrypointPath: platformPath.join(mpvConfigDir, 'scripts', 'subminer', 'main.lua'),
pluginDir: platformPath.join(mpvConfigDir, 'scripts', 'subminer'),
pluginConfigPath: platformPath.join(mpvConfigDir, 'script-opts', 'subminer.conf'),
};
}