test: gate perf tests behind env flag

Author: chhoumann

src/engine/template-property-types-feature-flag.test.ts

@@ -1,5 +1,6 @@
-import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
 import type { TFile } from 'obsidian';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+import { itPerf } from '../../tests/perfUtils';
 import { log } from '../logger/logManager';
 
 // Mock logger to capture error messages
@@ -179,16 +180,24 @@ describe('Template Property Types Feature Flag & Edge Cases', () => {
 			// Create large array
 			const largeArray = new Array(10000).fill(0).map((_, i) => ({ id: i, data: `item-${i}` }));
 			formatter.setVariable('bigData', largeArray);
-			
+
+			formatter.formatContent('items: {{bigData}}');
+
+			const vars = formatter.getAndClearTemplatePropertyVars();
+			expect(vars.get('items')).toBe(largeArray);
+		});
+
+		itPerf('formats very large data structures within budget', () => {
+			const formatter = new TestFormatter(mockApp, mockPlugin);
+
+			const largeArray = new Array(10000).fill(0).map((_, i) => ({ id: i, data: `item-${i}` }));
+			formatter.setVariable('bigData', largeArray);
+
 			const start = performance.now();
 			formatter.formatContent('items: {{bigData}}');
 			const duration = performance.now() - start;
 
-			// Should complete within reasonable time (< 1 second)
 			expect(duration).toBeLessThan(1000);
-			
-			const vars = formatter.getAndClearTemplatePropertyVars();
-			expect(vars.get('items')).toBe(largeArray);
 		});
 
 		it('should handle undefined and null values properly', () => {
@@ -329,18 +338,34 @@ describe('Template Property Types Feature Flag & Edge Cases', () => {
 				template += `prop${i}: {{var${i}}}\n`;
 			}
 
-			const start = performance.now();
 			formatter.formatContent(template);
 			const vars = formatter.getAndClearTemplatePropertyVars();
-			const duration = performance.now() - start;
 
 			expect(vars.size).toBe(1000);
-			expect(duration).toBeLessThan(2000); // Should complete within 2 seconds
 
 			// After clearing, should be empty
 			const clearedVars = formatter.getAndClearTemplatePropertyVars();
 			expect(clearedVars.size).toBe(0);
 		});
+
+		itPerf('formats large variable maps within budget', () => {
+			const formatter = new TestFormatter(mockApp, mockPlugin);
+
+			for (let i = 0; i < 1000; i++) {
+				formatter.setVariable(`var${i}`, { data: `value${i}` });
+			}
+
+			let template = '';
+			for (let i = 0; i < 1000; i++) {
+				template += `prop${i}: {{var${i}}}\n`;
+			}
+
+			const start = performance.now();
+			formatter.formatContent(template);
+			const duration = performance.now() - start;
+
+			expect(duration).toBeLessThan(2000);
+		});
 	});
 });
 

src/gui/suggesters/FileIndex.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect, beforeEach, vi } from 'vitest';
+import { itPerf } from '../../../tests/perfUtils';
 import { FileIndex } from './FileIndex';
 import { normalizeForSearch } from './utils';
 import type { App, TFile, Vault, MetadataCache, Workspace } from 'obsidian';
@@ -423,7 +424,7 @@ describe('FileIndex', () => {
 	});
 
 	describe('performance', () => {
-		it.skip('should handle large vaults efficiently', async () => {
+		itPerf('should handle large vaults efficiently', async () => {
 			// Mock a large number of files
 			const mockFiles = Array.from({ length: 1000 }, (_, i) => ({
 				path: `file-${i}.md`,

src/gui/suggesters/headingSanitizer.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect } from 'vitest';
+import { itPerf } from '../../../tests/perfUtils';
 import { sanitizeHeading } from './utils';
 
 describe('sanitizeHeading', () => {
@@ -50,7 +51,7 @@ describe('sanitizeHeading', () => {
 	});
 
 	// Performance test - ensure regex caching works
-	it('performs well with many calls', () => {
+	itPerf('performs well with many calls', () => {
 		const heading = '**Important** [[Note|Alias]] with ![[image.png]]';
 		const start = performance.now();
 

src/template-property-types-performance.test.ts

@@ -1,4 +1,5 @@
 import { describe, test, expect, beforeEach, vi, type MockedFunction } from 'vitest';
+import { describePerf } from '../tests/perfUtils';
 import type { TFile } from 'obsidian';
 import type QuickAdd from '../src/main';
 
@@ -177,7 +178,7 @@ class MockTemplateEngine {
 	}
 }
 
-describe('Template Property Types Performance Tests', () => {
+describePerf('Template Property Types Performance Tests', () => {
 	let mockPlugin: QuickAdd;
 	let mockApp: any;
 	let templateEngine: MockTemplateEngine;

src/utils/FieldValueDeduplicator.test.ts

@@ -1,4 +1,5 @@
 import { describe, it, expect } from "vitest";
+import { describePerf } from "../../tests/perfUtils";
 import { FieldValueDeduplicator } from "./FieldValueDeduplicator";
 
 describe("FieldValueDeduplicator", () => {
@@ -152,7 +153,7 @@ describe("FieldValueDeduplicator", () => {
 		});
 	});
 
-	describe("performance with large datasets", () => {
+	describePerf("performance with large datasets", () => {
 		it("should handle 1000+ values efficiently", () => {
 			const values: string[] = [];
 			for (let i = 0; i < 1000; i++) {
@@ -331,4 +332,4 @@ describe("FieldValueDeduplicator", () => {
 			expect(result.values).toHaveLength(1);
 		});
 	});
-});
+});

tests/perfUtils.ts

@@ -0,0 +1,11 @@
+import { describe, it, test } from 'vitest';
+
+const runPerfTests =
+	process.env.RUN_PERF_TESTS === '1' ||
+	process.env.RUN_PERF_TESTS === 'true';
+
+const describePerf = runPerfTests ? describe : describe.skip;
+const itPerf = runPerfTests ? it : it.skip;
+const testPerf = runPerfTests ? test : test.skip;
+
+export { runPerfTests, describePerf, itPerf, testPerf };