21190337405

Committed 20 Jan 2026 10:55PM UTC coverage: 71.753%. Remained the same

Build # 21190337405

Build Type

push

github

Committed by

bandantonio

Commit Message

refactor: add debug timers

Run Details

78 of 85 branches covered (91.76%)

Branch coverage included in aggregate %.

88 of 184 new or added lines in 8 files covered. (47.83%)

17 existing lines in 3 files now uncovered.

364 of 531 relevant lines covered (68.55%)

8.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.94

/src/saveHighlightsToVault.ts

import type { App, TFile } from 'obsidian';
import path from 'path';
import { DataService } from './services/dataService';
import { HighlightProcessingService } from './services/highlightProcessingService';
import { VaultService } from './services/vaultService';
import { defaultPluginSettings } from './settings';
import type { IBookHighlightsPluginSettings, ICombinedBooksAndHighlights, IRenderService } from './types';
import type { DiagnosticsCollector } from './utils/diagnostics';
import { Timer } from './utils/timing';

export default class SaveHighlights {
  private app: App;
  private settings: IBookHighlightsPluginSettings = defaultPluginSettings;
  private highlightProcessingService: HighlightProcessingService;
  private renderService: IRenderService;
  private vaultService: VaultService;
  private diagnosticsCollector?: DiagnosticsCollector;

  constructor(
    app: App,
    settings: IBookHighlightsPluginSettings,
    renderService: IRenderService,
    diagnosticsCollector?: DiagnosticsCollector,
  ) {
    this.app = app;
    this.settings = settings;
    this.diagnosticsCollector = diagnosticsCollector;
    this.highlightProcessingService = new HighlightProcessingService(new DataService(this.diagnosticsCollector), this.diagnosticsCollector);
    this.renderService = renderService;
    this.vaultService = new VaultService(this.app, this.settings, this.renderService, this.diagnosticsCollector);
  }

  async saveAllBooksHighlightsToVault(highlights: ICombinedBooksAndHighlights[]): Promise<void> {
    const cycleTimer = new Timer('Full Save Cycle (saveAllBooksHighlightsToVault)', this.diagnosticsCollector);
    cycleTimer.start();

    const highlightsFolder = this.vaultService.getHighlightsFolder();
    const doesHighlightsFolderExist = Boolean(highlightsFolder);

    const isBackupEnabled = this.settings.backup;

    if (doesHighlightsFolderExist) {
      if (isBackupEnabled) {
        await this.vaultService.backupAllHighlights(highlightsFolder);
      } else {
        await this.vaultService.recreateHighlightsFolder(highlightsFolder);
      }
    } else {
      await this.vaultService.createHighlightsFolder();
    }

    for (const combinedHighlight of highlights) {
      // Order highlights according to the value in settings
      const sortedHighlights = this.highlightProcessingService.sortHighlights(combinedHighlight, this.settings.highlightsSortingCriterion);

      // Render template for highlights and filename based on settings
      const renderedTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.template);
      const renderedFilenameTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.filenameTemplate);

      // Save highlights to vault
      const filePath = path.join(this.settings.highlightsFolder, `${renderedFilenameTemplate}.md`);

      await this.vaultService.createNewBookFile(filePath, renderedTemplate);
    }

    cycleTimer.end();

    // Write diagnostics to file if collector is available
    if (this.diagnosticsCollector) {
      await this.diagnosticsCollector.writeDiagnosticsToFile();
    }
  }

  async saveSingleBookHighlightsToVault(highlights: ICombinedBooksAndHighlights[], shouldCreateFile: boolean): Promise<void> {
    const cycleTimer = new Timer('Full Save Cycle (saveSingleBookHighlightsToVault)', this.diagnosticsCollector);
    cycleTimer.start();

    const highlightsFolder = this.vaultService.getHighlightsFolder();
    const doesHighlightsFolderExist = Boolean(highlightsFolder);

    if (!doesHighlightsFolderExist) {
      await this.vaultService.createHighlightsFolder();
    }

    for (const combinedHighlight of highlights) {
      // Order highlights according to the value in settings
      const sortedHighlights = this.highlightProcessingService.sortHighlights(combinedHighlight, this.settings.highlightsSortingCriterion);

      // Render template for highlights and filename based on settings
      const renderedTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.template);
      const renderedFilenameTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.filenameTemplate);

      // Save highlights to vault
      const filePath = path.join(this.settings.highlightsFolder, `${renderedFilenameTemplate}.md`);

      if (shouldCreateFile) {
        await this.vaultService.createNewBookFile(filePath, renderedTemplate);
      } else {
        const isBackupEnabled = this.settings.backup;
        const vaultFile = this.vaultService.checkFileExistence(filePath) as TFile;

        if (isBackupEnabled) {
          await this.vaultService.backupSingleBookHighlights(renderedFilenameTemplate);
        }

        await this.vaultService.modifyExistingBookFile(vaultFile, renderedTemplate);
      }
    }

    cycleTimer.end();

    // Write diagnostics to file if collector is available
    if (this.diagnosticsCollector) {
      await this.diagnosticsCollector.writeDiagnosticsToFile();
    }
  }
}

1	import type { App, TFile } from 'obsidian';	1✔
2	import path from 'path';
3	import { DataService } from './services/dataService';
4	import { HighlightProcessingService } from './services/highlightProcessingService';
5	import { VaultService } from './services/vaultService';
6	import { defaultPluginSettings } from './settings';
7	import type { IBookHighlightsPluginSettings, ICombinedBooksAndHighlights, IRenderService } from './types';
8	import type { DiagnosticsCollector } from './utils/diagnostics';
9	import { Timer } from './utils/timing';
10
11	export default class SaveHighlights {	1✔
12	private app: App;
13	private settings: IBookHighlightsPluginSettings = defaultPluginSettings;	1✔
14	private highlightProcessingService: HighlightProcessingService;
15	private renderService: IRenderService;
16	private vaultService: VaultService;
17	private diagnosticsCollector?: DiagnosticsCollector;
18
19	constructor(	1✔
20	app: App,	11✔
21	settings: IBookHighlightsPluginSettings,	11✔
22	renderService: IRenderService,	11✔
23	diagnosticsCollector?: DiagnosticsCollector,	11✔
24	) {	11✔
25	this.app = app;	11✔
26	this.settings = settings;	11✔
27	this.diagnosticsCollector = diagnosticsCollector;	11✔
28	this.highlightProcessingService = new HighlightProcessingService(new DataService(this.diagnosticsCollector), this.diagnosticsCollector);	11✔
29	this.renderService = renderService;	11✔
30	this.vaultService = new VaultService(this.app, this.settings, this.renderService, this.diagnosticsCollector);	11✔
31	}	11✔
32
33	async saveAllBooksHighlightsToVault(highlights: ICombinedBooksAndHighlights[]): Promise<void> {	1✔
34	const cycleTimer = new Timer('Full Save Cycle (saveAllBooksHighlightsToVault)', this.diagnosticsCollector);	7✔
35	cycleTimer.start();	7✔
36
37	const highlightsFolder = this.vaultService.getHighlightsFolder();	7✔
38	const doesHighlightsFolderExist = Boolean(highlightsFolder);	7✔
39
40	const isBackupEnabled = this.settings.backup;	7✔
41
42	if (doesHighlightsFolderExist) {	7✔
43	if (isBackupEnabled) {	5✔
44	await this.vaultService.backupAllHighlights(highlightsFolder);	1✔
45	} else {	5✔
46	await this.vaultService.recreateHighlightsFolder(highlightsFolder);	4✔
47	}	4✔
48	} else {	7✔
49	await this.vaultService.createHighlightsFolder();	2✔
50	}	2✔
51
52	for (const combinedHighlight of highlights) {	7✔
53	// Order highlights according to the value in settings
54	const sortedHighlights = this.highlightProcessingService.sortHighlights(combinedHighlight, this.settings.highlightsSortingCriterion);	7✔
55
56	// Render template for highlights and filename based on settings
57	const renderedTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.template);	7✔
58	const renderedFilenameTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.filenameTemplate);	7✔
59
60	// Save highlights to vault
61	const filePath = path.join(this.settings.highlightsFolder, `${renderedFilenameTemplate}.md`);	7✔
62
63	await this.vaultService.createNewBookFile(filePath, renderedTemplate);	7✔
64	}	7✔
65
66	cycleTimer.end();	7✔
67
68	// Write diagnostics to file if collector is available
69	if (this.diagnosticsCollector) {	7!
NEW 70	await this.diagnosticsCollector.writeDiagnosticsToFile();	×
NEW 71	}	×
72	}	7✔
73
74	async saveSingleBookHighlightsToVault(highlights: ICombinedBooksAndHighlights[], shouldCreateFile: boolean): Promise<void> {	1✔
75	const cycleTimer = new Timer('Full Save Cycle (saveSingleBookHighlightsToVault)', this.diagnosticsCollector);	4✔
76	cycleTimer.start();	4✔
77
78	const highlightsFolder = this.vaultService.getHighlightsFolder();	4✔
79	const doesHighlightsFolderExist = Boolean(highlightsFolder);	4✔
80
81	if (!doesHighlightsFolderExist) {	4✔
82	await this.vaultService.createHighlightsFolder();	2✔
83	}	2✔
84
85	for (const combinedHighlight of highlights) {	4✔
86	// Order highlights according to the value in settings
87	const sortedHighlights = this.highlightProcessingService.sortHighlights(combinedHighlight, this.settings.highlightsSortingCriterion);	4✔
88
89	// Render template for highlights and filename based on settings
90	const renderedTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.template);	4✔
91	const renderedFilenameTemplate = this.renderService.renderTemplate(sortedHighlights, this.settings.filenameTemplate);	4✔
92
93	// Save highlights to vault
94	const filePath = path.join(this.settings.highlightsFolder, `${renderedFilenameTemplate}.md`);	4✔
95
96	if (shouldCreateFile) {	4✔
97	await this.vaultService.createNewBookFile(filePath, renderedTemplate);	2✔
98	} else {	2✔
99	const isBackupEnabled = this.settings.backup;	2✔
100	const vaultFile = this.vaultService.checkFileExistence(filePath) as TFile;	2✔
101
102	if (isBackupEnabled) {	2✔
103	await this.vaultService.backupSingleBookHighlights(renderedFilenameTemplate);	1✔
104	}	1✔
105
106	await this.vaultService.modifyExistingBookFile(vaultFile, renderedTemplate);	2✔
107	}	2✔
108	}	4✔
109
110	cycleTimer.end();	4✔
111
112	// Write diagnostics to file if collector is available
113	if (this.diagnosticsCollector) {	4!
NEW 114	await this.diagnosticsCollector.writeDiagnosticsToFile();	×
NEW 115	}	×
116	}	4✔
117	}	1✔

bandantonio / obsidian-apple-books-highlights-plugin / 21190337405

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous