fix: make sure registered font Buffer is valid (#1014)

* fix: make sure registered font Buffer is valid

* Clippy

Cargo.toml

@@ -24,6 +24,7 @@ serde        = "1"
 serde_derive = "1"
 serde_json   = "1"
 thiserror    = "2"
+uuid         = { version = "1", features = ["v4"] }
 
 [target.'cfg(not(target_os = "linux"))'.dependencies]
 mimalloc = "0.1"

__test__/global-fonts.spec.ts

@@ -2,7 +2,7 @@ import { readFileSync } from 'fs'
 import { join } from 'path'
 import test from 'ava'
 
-import { GlobalFonts } from '../index'
+import { GlobalFonts, FontKey } from '../index'
 
 const fontPath = join(__dirname, 'fonts', 'SourceSerifPro-Regular.ttf')
 const fontData = readFileSync(fontPath)
@@ -16,8 +16,12 @@ test('should be able to register font and test font existence', (t) => {
   t.is(GlobalFonts.has('114514'), false)
 
   if (!GlobalFonts.has('Source Serif Pro')) {
-    t.true(GlobalFonts.register(fontData))
+    const fontKey = GlobalFonts.register(fontData)
+    t.true(fontKey instanceof FontKey)
     t.is(GlobalFonts.families.length, defaultCount + 1)
+    t.notThrows(() => {
+      GlobalFonts.remove(fontKey!)
+    })
   } else {
     t.is(GlobalFonts.families.length, defaultCount)
   }
@@ -32,7 +36,7 @@ test('multiple identical fonts should only exist within one font family', (t) =>
 })
 
 test('return false if font path not existed', (t) => {
-  t.false(GlobalFonts.register(Buffer.from('whatever')))
+  t.is(GlobalFonts.register(Buffer.from('whatever')), null)
 })
 
 test('should be able to register font with name alias', (t) => {

index.d.ts

@@ -390,14 +390,20 @@ export function createCanvas(width: number, height: number): Canvas
 
 export function createCanvas(width: number, height: number, svgExportFlag: SvgExportFlag): SvgCanvas
 
+export declare class FontKey {
+  // make it a unique type
+  private readonly key: symbol
+}
+
 interface IGlobalFonts {
   readonly families: { family: string; styles: { weight: number; width: string; style: string }[] }[]
   // return true if succeeded
-  register(font: Buffer, nameAlias?: string): boolean
+  register(font: Buffer, nameAlias?: string): FontKey | null
   // absolute path
   registerFromPath(path: string, nameAlias?: string): boolean
   has(name: string): boolean
   loadFontsFromDir(path: string): number
+  remove(key: FontKey): void
 }
 
 export const GlobalFonts: IGlobalFonts

index.js

@@ -9,7 +9,7 @@ const {
   Path: Path2D,
   ImageData,
   Image,
-  CanvasPattern,
+  FontKey,
   GlobalFonts,
   PathOp,
   FillType,
@@ -28,9 +28,6 @@ const SvgExportFlag = {
   RelativePathEncoding: 0x04,
 }
 
-// eslint-disable-next-line sonarjs/no-unused-collection
-const Fonts = []
-
 if (!('families' in GlobalFonts)) {
   Object.defineProperty(GlobalFonts, 'families', {
     get: function () {
@@ -113,4 +110,5 @@ module.exports = {
   DOMMatrix,
   DOMRect,
   loadImage,
+  FontKey,
 }