feat(cache): refactor cache validation and storage

The cache validation and storage mechanism has been refactored. The
`StoreData` interface and `isStoreData` function have been removed. The
cache data is now directly read from the file and validated by checking
if it ends with a specific hash comment. The cache data is stored along
with this hash comment. The hash comment is generated using the `typia`
version and the cache key. The tests have been updated to reflect these
changes.

Author: ryoppippi

packages/unplugin-typia/src/core/cache.ts

@@ -2,6 +2,7 @@ import { accessSync, constants, existsSync, mkdirSync, readFileSync, rmSync, wri
 import { createHash } from 'node:crypto';
 import { basename, dirname, join } from 'pathe';
 import type { Tagged } from 'type-fest';
+import { readPackageJSON } from 'pkg-types';
 import type { transformTypia } from './typia.js';
 import type { ResolvedOptions } from './options.js';
 import { isBun } from './utils.js';
@@ -10,21 +11,8 @@ type ResolvedCacheOptions = ResolvedOptions['cache'];
 
 type Data = Awaited<ReturnType<typeof transformTypia>>;
 
-interface StoreData {
-	data: NonNullable<Data>;
-	source: string;
-}
-
-function isStoreData(value: unknown): value is StoreData {
-	if (typeof value !== 'object' || value === null) {
-		return false;
-	}
-	const data = value as StoreData;
-	return data.data != null
-		&& typeof data.source === 'string';
-}
-
 let cacheDir: string | null = null;
+let typiaVersion: string | undefined;
 
 /**
  * Get cache
@@ -45,26 +33,17 @@ export async function getCache(
 	const key = getKey(id, source);
 	const path = getCachePath(key, option);
 
-	let data: StoreData | null = null;
 	if (existsSync(path)) {
-		const cache = readFileSync(path, 'utf8');
-		const json = JSON.parse(cache);
-		if (!isStoreData(json)) {
-			return null;
-		}
-		data = json;
-	}
+		const data = readFileSync(path, 'utf8');
 
-	/** validate cache */
-	if (!isStoreData(data)) {
-		return null;
-	}
+		const hashComment = await getHashComment(key);
 
-	if (data.source !== source) {
-		return null;
+		if (data.endsWith(hashComment)) {
+			return data;
+		}
 	}
 
-	return data.data;
+	return null;
 }
 
 /**
@@ -87,14 +66,15 @@ export async function setCache(
 
 	const key = getKey(id, source);
 	const path = getCachePath(key, option);
+	const hashComment = await getHashComment(key);
 
 	if (data == null) {
 		rmSync(path);
 		return;
 	}
 
-	const json = JSON.stringify({ data, source });
-	writeFileSync(path, json, { encoding: 'utf8' });
+	const cache = data + hashComment;
+	writeFileSync(path, cache, { encoding: 'utf8' });
 }
 
 type CacheKey = Tagged<string, 'cache-key'>;
@@ -158,3 +138,8 @@ function hash(input: string): string {
 	}
 	return createHash('md5').update(input).digest('hex');
 }
+
+export async function getHashComment(cachePath: CacheKey) {
+	typiaVersion = typiaVersion ?? await readPackageJSON('typia').then(pkg => pkg.version);
+	return `/* unplugin-typia-${typiaVersion ?? ''}-${cachePath} */`;
+}

packages/unplugin-typia/test/cache.ts

@@ -8,6 +8,13 @@ type Data = Parameters<typeof cache.setCache>[2];
 
 const tmp = tmpdir();
 
+function removeComments(data: string | null) {
+	if (data == null) {
+		return data;
+	}
+	return data.replace(/\/\*[\s\S]*?\*\/|([^\\:]|^)\/\/.*$/gm, '');
+}
+
 test('return null if cache is not found', async () => {
 	const option = { enable: true, base: tmp } as const;
 	const random = Math.random().toString();
@@ -27,7 +34,10 @@ test('set and get cache', async () => {
 	/* get cache */
 	const cacheData = await cache.getCache(filename, random, option);
 
-	assertEquals(cacheData, data);
+	/* delete js asterisk comments */
+	const cacheDataStr = removeComments(cacheData);
+
+	assertEquals(data, cacheDataStr);
 });
 
 test('set and get null with different id', async () => {
@@ -40,9 +50,13 @@ test('set and get null with different id', async () => {
 	await cache.setCache(filename, random, data, option);
 
 	/* get cache */
-	const cacheData = await cache.getCache(`${random}-1`, random, option);
+	const cacheData = await cache.getCache(`111;${random}`, random, option);
+
+	/* delete js asterisk comments */
+	const cacheDataStr = removeComments(cacheData);
 
-	assertNotEquals(cacheData, data);
+	assertEquals(cacheDataStr, null);
+	assertNotEquals(data, cacheDataStr);
 });
 
 test('set and get null with cache disabled', async () => {