feat(@sirutils/schema): added signature check to improve performance

Author: giveerr

bun.lockb

@@ -2,20 +2,23 @@
   "name": "@sirutils/builder",
   "type": "module",
   "version": "0.0.1",
-
   "bin": {
     "builder": "./command.js"
   },
-
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": ["dist", "./command.js", "src"],
 
-  "devDependencies": {},
+  "devDependencies": {
+    "@sirutils/schema": "workspace:*"
+  },
   "dependencies": {
     "commander": "^12.0.0",
     "dts-bundle-generator": "^9.5.1",
     "get-tsconfig": "^4.7.4"
+  },
+  "peerDependencies": {
+    "@sirutils/schema": "^0.0.0"
   }
 }

tools/builder/package.json

@@ -0,0 +1,8 @@
+export interface CommanderOptions {
+  cwd: string
+  watch: boolean
+  externalAll: boolean
+  schema: boolean
+  schemaDir: string
+  external: string[]
+}

tools/builder/src/definitions.ts

@@ -1,7 +1,9 @@
 import { watch } from 'fs'
+import { join } from 'path'
 import { Command } from 'commander'
 
 import pkg from '../package.json'
+import type { CommanderOptions } from './definitions'
 import { build, dependencies } from './utils'
 
 const program = new Command()
@@ -14,19 +16,21 @@ program
   .option('-w --watch', 'watch', false)
   .option('--cwd <string>', 'cwd', process.cwd())
   .option('-a --external-all', 'externals', false)
-  .option('-e --external <numbers...>', 'externals', [])
-  .action(async (paths: string[], options) => {
+  .option('-s --schema', 'schema', false)
+  .option('-sd --schema-dir', 'schema directory', join(process.cwd(), 'schemas'))
+  .option('-e --external <packages...>', 'externals', [])
+  .action(async (paths: string[], options: CommanderOptions) => {
     const externals = [
       ...(options.externalAll ? await dependencies(options.cwd) : []),
       ...(options.external || []),
     ]
 
-    await build(paths, options.cwd, externals)
+    await build(paths, options, externals)
 
     if (options.watch) {
       watch(options.cwd, { recursive: true }, async (event, filename) => {
         if (typeof filename === 'string' && !filename.includes('dist')) {
-          await build(paths, options.cwd, externals)
+          await build(paths, options, externals)
         }
       })
     }

tools/builder/src/index.ts

@@ -1,6 +1,7 @@
 import { join } from 'path'
 import type { BunPlugin } from 'bun'
 
+import type { CommanderOptions } from './definitions'
 import { definitionGeneratorPlugin } from './plugins'
 
 export const dependencies = async (cwd = process.cwd()): Promise<string[]> => {
@@ -19,14 +20,29 @@ export const dependencies = async (cwd = process.cwd()): Promise<string[]> => {
 
 export const build = async (
   paths: string[],
-  cwd: string = process.cwd(),
+  options: CommanderOptions,
   // biome-ignore lint/suspicious/noExplicitAny: <explanation>
   external = [] as any[]
 ) => {
-  const entryPoints = paths.map(p => join(cwd, p))
-  const outDir = join(cwd, './dist')
+  const entryPoints = paths.map(p => join(options.cwd, p))
+  const outDir = join(options.cwd, './dist')
   const plugins: BunPlugin[] = [definitionGeneratorPlugin]
 
+  if (options.schema) {
+    try {
+      const schemaGeneratorPlugin = await import('@sirutils/schema')
+
+      plugins.push(
+        schemaGeneratorPlugin.schemaGeneratorPlugin({
+          dir: options.schemaDir,
+        })
+      )
+    } catch (err) {
+      // biome-ignore lint/nursery/noConsole: <explanation>
+      console.warn(`[@sirutils/builder] cannot build schemas: ${err}`)
+    }
+  }
+
   await Bun.build({
     entrypoints: entryPoints,
     outdir: outDir,
@@ -36,5 +52,5 @@ export const build = async (
   })
 
   // biome-ignore lint/nursery/noConsole: <explanation>
-  console.log(`[@sirutils/builder] building: ${cwd.split('/').slice(-2).join('/')}`)
+  console.log(`[@sirutils/builder] building: ${options.cwd.split('/').slice(-2).join('/')}`)
 }

tools/builder/src/utils.ts

@@ -2,10 +2,12 @@
   "name": "@sirutils/schema",
   "version": "0.0.1",
   "type": "module",
+
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "types": "dist/index.d.ts",
   "files": ["dist", "src"],
-  "types": "src/index.ts",
+
   "devDependencies": {
     "@sirutils/builder": "workspace:*"
   },

tools/schema/command.js

@@ -1,4 +1,4 @@
-/// <reference types="packages/core" />
-/// <reference types="packages/seql" />
+/// <reference types="@sirutils/core" />
+/// <reference types="@sirutils/seql" />
 
 import './schema'

tools/schema/package.json

@@ -1,3 +1,5 @@
+import type { BlobType } from '@sirutils/core'
+
 import type { SchemaTags } from '../tag'
 
 declare global {
@@ -8,6 +10,25 @@ declare global {
     }
 
     // biome-ignore lint/style/noNamespace: Redundant
-    namespace Schema {}
+    namespace Schema {
+      export interface Normalized {
+        name: string
+        path: string
+        checksum: string
+        exists: boolean
+
+        importMaps: Record<string, Sirutils.Schema.Normalized>
+
+        fields: {
+          name: string
+          type: string
+          [x: string]: BlobType
+        }[]
+        indexes: {
+          name: string
+          fields: string[]
+        }[]
+      }
+    }
   }
 }

tools/schema/src/definitions/index.ts

@@ -3,3 +3,4 @@ import './definitions'
 export * from './tag'
 
 export * from './utils/traverse'
+export * from './utils/plugin'

tools/schema/src/definitions/schema.ts

@@ -15,7 +15,7 @@ export const readJsonFile = ResultAsync.fromThrowable(
 )
 
 export const getFileChecksum = ResultAsync.fromThrowable(
-  (path: string) => {
+  (path: string): Promise<string> => {
     return new Promise((resolve, reject) => {
       const hasher = new Bun.CryptoHasher('blake2b512')
       const input = fs.createReadStream(path)
@@ -35,21 +35,12 @@ export const getFileChecksum = ResultAsync.fromThrowable(
 )
 
 export const getChecksum = Result.fromThrowable(
-  (path: string) => {
-    return new Promise((resolve, reject) => {
-      const hasher = new Bun.CryptoHasher('blake2b512')
-      const input = fs.createReadStream(path)
+  (data: Bun.BlobOrStringOrBuffer) => {
+    const hasher = new Bun.CryptoHasher('blake2b512')
 
-      input.on('error', reject)
-
-      input.on('data', chunk => {
-        hasher.update(chunk)
-      })
+    hasher.update(data)
 
-      input.on('close', () => {
-        resolve(hasher.digest('hex'))
-      })
-    })
+    return hasher.digest('hex')
   },
   e => ProjectError.create(schemaTags.getFileChecksum, `${e}`)
 )

tools/schema/src/index.ts

@@ -0,0 +1,27 @@
+import { existsSync, mkdirSync } from 'node:fs'
+import { join } from 'node:path'
+import { unwrap } from '@sirutils/core'
+import type { BunPlugin } from 'bun'
+
+import { traverse } from './traverse'
+
+export interface SchemaGeneratorPluginConfig {
+  dir?: string
+}
+
+export const schemaGeneratorPlugin = (config: SchemaGeneratorPluginConfig): BunPlugin => {
+  return {
+    name: 'schema-generator-plugin',
+    async setup(build) {
+      const outDir = build.config.outdir || './dist'
+      if (!existsSync(outDir)) {
+        mkdirSync(outDir)
+      }
+
+      const missingFiles = unwrap(await traverse(config.dir ?? join(process.cwd(), 'schemas')))
+
+      // biome-ignore lint/nursery/noConsole: <explanation>
+      console.log(missingFiles)
+    },
+  }
+}

tools/schema/src/internal/fs.ts

@@ -1,15 +1,21 @@
-import path from 'node:path'
+import { join } from 'node:path'
 import { ResultAsync, unwrap, wrapAsync } from '@sirutils/core/dist'
 
 import { fetchJson, isURL } from '../internal/common'
-import { readJsonFile, readdir } from '../internal/fs'
+import { getFileChecksum, readJsonFile, readdir } from '../internal/fs'
 import { schemaTags } from '../tag'
 
 export const traverse = wrapAsync(async (dirPath: string) => {
-  const filePaths = unwrap(await readdir(dirPath)).map(filePath => path.join(dirPath, filePath))
+  const filePaths = unwrap(await readdir(dirPath)).map(filePath => join(dirPath, filePath))
   const files = unwrap(await ResultAsync.combine(filePaths.map(filePath => readJsonFile(filePath))))
 
   for (const file of files) {
+    const index = files.indexOf(file)
+
+    file.path = filePaths[index]
+    file.checksum = unwrap(await getFileChecksum(file.path))
+    file.exists = await Bun.file(join(dirPath, 'dist/generated', file.checksum)).exists()
+
     if (file.importMaps) {
       for (const [name, extendedPath] of Object.entries(file.importMaps)) {
         const valid = isURL(extendedPath as string)
@@ -24,7 +30,7 @@ export const traverse = wrapAsync(async (dirPath: string) => {
           continue
         }
 
-        const relativeExtendedPath = path.join(dirPath, extendedPath as string)
+        const relativeExtendedPath = join(dirPath, extendedPath as string)
         const foundIndex = filePaths.indexOf(relativeExtendedPath)
 
         if (foundIndex === -1) {
@@ -33,8 +39,12 @@ export const traverse = wrapAsync(async (dirPath: string) => {
           file.importMaps[name] = files[foundIndex]
         }
       }
+
+      continue
     }
+
+    file.importMaps = {}
   }
 
-  return files
+  return files as Sirutils.Schema.Normalized[]
 }, schemaTags.traverse)