mirror of
https://github.com/vrtmrz/obsidian-livesync.git
synced 2026-07-31 08:51:23 +00:00
b6746be73e
Continues the source-key migration inside the application boundary introduced in 1.0.0, where LiveSync owns its catalogue and consumes Commonlib as a published package. - Replace hardcoded user-visible strings in the Obsidian UI (Setup Wizard dialogues, P2P panes, Customisation Sync panes, Global History, the JSON conflict pane and the remote-configuration menu) with `$msg` calls, keeping the English source string as the key. - Wire up strings whose translations already existed in the catalogue but were still rendered as literals, for example the whole Intro dialogue. - Add the new entries to `src/common/messagesYAML/en.yaml` and `es.yaml`, then regenerate `messagesJson/` and `combinedMessages.prod.ts` through the documented `i18n:bake` pipeline. - No Commonlib gitlink or catalogue is involved; every change is LiveSync-owned. Regenerating the catalogue also normalises three pre-existing entries each in `ko.json` and `zh.json`, where the committed JSON kept a trailing space before a newline that YAML cannot represent. Verified with tsc-check, tsc-check:apps, svelte-check and lint. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
161 lines
5.9 KiB
Svelte
161 lines
5.9 KiB
Svelte
<script lang="ts">
|
|
/**
|
|
* Panel to check and fix CouchDB configuration issues
|
|
*/
|
|
import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
|
|
import Decision from "@/modules/services/LiveSyncUI/components/Decision.svelte";
|
|
import UserDecisions from "@/modules/services/LiveSyncUI/components/UserDecisions.svelte";
|
|
import { checkConfig, type ConfigCheckResult, type ResultError, type ResultErrorMessage } from "./utilCheckCouchDB";
|
|
import { LOG_LEVEL_VERBOSE, Logger } from "octagonal-wheels/common/logger";
|
|
import { $msg as translateMessage } from "@/common/translation";
|
|
import { getDialogContext } from "@/modules/services/LiveSyncUI/svelteDialog";
|
|
import { getCouchDBServerFixConfirmation } from "./couchDBServerFixConfirmation";
|
|
type Props = {
|
|
trialRemoteSetting: ObsidianLiveSyncSettings;
|
|
};
|
|
const { trialRemoteSetting }: Props = $props();
|
|
const context = getDialogContext();
|
|
let detectedIssues = $state<ConfigCheckResult[]>([]);
|
|
async function testAndFixSettings() {
|
|
detectedIssues = [];
|
|
try {
|
|
const fixResults = await checkConfig(trialRemoteSetting);
|
|
detectedIssues = fixResults;
|
|
} catch (e) {
|
|
Logger(e, LOG_LEVEL_VERBOSE, "setup-couchdb-check");
|
|
detectedIssues.push({
|
|
message: translateMessage("Error during testAndFixSettings: ${reason}", { reason: `${e}` }),
|
|
result: "error",
|
|
classes: [],
|
|
});
|
|
}
|
|
}
|
|
function isErrorResult(result: ConfigCheckResult): result is ResultError<unknown> | ResultErrorMessage {
|
|
return "result" in result && result.result === "error";
|
|
}
|
|
function isFixableError(result: ConfigCheckResult): result is ResultError<unknown> {
|
|
return isErrorResult(result) && "fix" in result && typeof result.fix === "function";
|
|
}
|
|
function isSuccessResult(result: ConfigCheckResult): result is { message: string; result: "ok"; value?: any } {
|
|
return "result" in result && result.result === "ok";
|
|
}
|
|
let processing = $state(false);
|
|
async function fixIssue(issue: ResultError<unknown>) {
|
|
const confirmation = getCouchDBServerFixConfirmation(issue.settingKey, issue.expectedValue);
|
|
const confirmed = await context.services.confirm.askYesNoDialog(confirmation.message, {
|
|
title: confirmation.title,
|
|
defaultOption: "No",
|
|
});
|
|
if (confirmed !== "yes") {
|
|
return;
|
|
}
|
|
try {
|
|
processing = true;
|
|
await issue.fix();
|
|
} catch (e) {
|
|
Logger(e, LOG_LEVEL_VERBOSE, "setup-couchdb-fix");
|
|
} finally {
|
|
await testAndFixSettings();
|
|
processing = false;
|
|
}
|
|
}
|
|
const errorIssueCount = $derived.by(() => {
|
|
return detectedIssues.filter((issue) => isErrorResult(issue)).length;
|
|
});
|
|
const isAllSuccess = $derived.by(() => {
|
|
return !(errorIssueCount > 0 && detectedIssues.length > 0);
|
|
});
|
|
|
|
</script>
|
|
|
|
{#snippet result(issue: ConfigCheckResult)}
|
|
<div class="check-result {isErrorResult(issue) ? 'error' : isSuccessResult(issue) ? 'success' : ''}">
|
|
<div class="message">
|
|
{issue.message}
|
|
</div>
|
|
{#if isFixableError(issue)}
|
|
<div class="operations">
|
|
<button onclick={() => fixIssue(issue)} class="mod-cta" disabled={processing}
|
|
>{translateMessage("Fix")}</button
|
|
>
|
|
</div>
|
|
{/if}
|
|
</div>
|
|
{/snippet}
|
|
<UserDecisions>
|
|
<Decision title={translateMessage("Check server requirements")} important={true} commit={testAndFixSettings} />
|
|
</UserDecisions>
|
|
<div class="check-results">
|
|
<details open={!isAllSuccess}>
|
|
<summary>
|
|
{#if detectedIssues.length === 0}
|
|
{translateMessage("No checks have been performed yet.")}
|
|
{:else if isAllSuccess}
|
|
{translateMessage("All checks passed successfully!")}
|
|
{:else}
|
|
{translateMessage("${count} issue(s) detected!", { count: `${errorIssueCount}` })}
|
|
{/if}
|
|
</summary>
|
|
{#if detectedIssues.length > 0}
|
|
<h3>{translateMessage("Issue detection log:")}</h3>
|
|
{#each detectedIssues as issue}
|
|
{@render result(issue)}
|
|
{/each}
|
|
{/if}
|
|
</details>
|
|
</div>
|
|
|
|
<style>
|
|
/* Make .check-result a CSS Grid: let .message expand and keep .operations at minimum width, aligned to the right */
|
|
.check-results {
|
|
/* Adjust spacing as required */
|
|
margin-top: 0.75rem;
|
|
}
|
|
|
|
.check-result {
|
|
display: grid;
|
|
grid-template-columns: 1fr auto; /* message takes remaining space, operations use minimum width */
|
|
align-items: center; /* vertically centre align */
|
|
gap: 0.5rem 1rem;
|
|
padding: 0rem 0.5rem;
|
|
border-radius: 0;
|
|
box-shadow: none;
|
|
border-left: 0.5em solid var(--interactive-accent);
|
|
margin-bottom: 0.25lh;
|
|
}
|
|
.check-result.error {
|
|
border-left: 0.5em solid var(--text-error);
|
|
}
|
|
.check-result.success {
|
|
border-left: 0.5em solid var(--text-success);
|
|
}
|
|
|
|
.check-result .message {
|
|
/* Wrap long messages */
|
|
white-space: normal;
|
|
word-break: break-word;
|
|
font-size: 0.95rem;
|
|
color: var(--text-normal);
|
|
}
|
|
|
|
.check-result .operations {
|
|
/* Centre the button(s) vertically and align to the right */
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: flex-end;
|
|
gap: 0.5rem;
|
|
}
|
|
|
|
/* For small screens: move .operations below and stack vertically */
|
|
@media (max-width: 520px) {
|
|
.check-result {
|
|
grid-template-columns: 1fr;
|
|
grid-auto-rows: auto;
|
|
}
|
|
.check-result .operations {
|
|
justify-content: flex-start;
|
|
margin-top: 0.5rem;
|
|
}
|
|
}
|
|
</style>
|