fix(cli): eliminate config side effects of render function

hikerpig · Dec 23, 2023 · 75d84af · 75d84af
1 parent befb11e
commit 75d84af
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 9 deletions.
diff --git a/.changeset/sharp-lizards-learn.md b/.changeset/sharp-lizards-learn.md
@@ -0,0 +1,6 @@
+---
+'@pintora/cli': patch
+'@pintora/core': patch
+---
+
+eliminate config side effects of `render` function
diff --git a/packages/pintora-cli/src/__tests__/render.spec.ts b/packages/pintora-cli/src/__tests__/render.spec.ts
@@ -1,6 +1,7 @@
+import { pintoraStandalone } from '@pintora/standalone'
+import { EXAMPLES } from '@pintora/test-shared'
 import { SVG_MIME_TYPE } from '../const'
 import { render } from '../render'
-import { EXAMPLES } from '@pintora/test-shared'
 
 describe('render', () => {
   it('can output svg', async () => {
@@ -19,4 +20,22 @@ describe('render', () => {
     expect(buf.constructor).toBe(Buffer)
     expect(buf.length).toBeGreaterThan(0)
   })
+
+  it('pintoraConfig should not alter global config', async () => {
+    const oldTheme = pintoraStandalone.configApi.getConfig().themeConfig.theme
+    const oldUseMaxWidth = pintoraStandalone.configApi.getConfig().core?.useMaxWidth
+    await render({
+      code: EXAMPLES.er.code,
+      width: 1000,
+      pintoraConfig: {
+        themeConfig: {
+          theme: 'light',
+        },
+      },
+    })
+
+    const config = pintoraStandalone.configApi.getConfig()
+    expect(config.themeConfig.theme).toBe(oldTheme)
+    expect(config.core.useMaxWidth).toBe(oldUseMaxWidth)
+  })
 })
diff --git a/packages/pintora-cli/src/render.ts b/packages/pintora-cli/src/render.ts
@@ -1,5 +1,5 @@
 import { RenderOptions, IRenderer } from '@pintora/renderer'
-import { pintoraStandalone, PintoraConfig } from '@pintora/standalone'
+import { pintoraStandalone, PintoraConfig, DeepPartial } from '@pintora/standalone'
 import { JSDOM } from 'jsdom'
 import { implForWrapper } from 'jsdom/lib/jsdom/living/generated/utils'
 import { Canvas, CanvasPattern } from 'canvas'
@@ -16,7 +16,7 @@ export type CLIRenderOptions = {
    * Assign extra background color
    */
   backgroundColor?: string
-  pintoraConfig?: Partial<PintoraConfig>
+  pintoraConfig?: DeepPartial<PintoraConfig>
   /**
    * width of the output, height will be calculated according to the diagram content ratio
    */
@@ -41,15 +41,14 @@ function renderPrepare(opts: CLIRenderOptions) {
   return {
     container,
     pintorRender(renderOpts: Pick<RenderOptions, 'renderer'>) {
+      let config = pintoraStandalone.getConfig<PintoraConfig>()
       if (pintoraConfig) {
-        pintoraStandalone.setConfig(pintoraConfig)
+        config = pintoraStandalone.configApi.gnernateNewConfig(pintoraConfig)
       }
 
       const containerSize = opts.width ? { width: opts.width } : undefined
       if (opts.width) {
-        pintoraStandalone.setConfig({
-          core: { useMaxWidth: true },
-        })
+        config = pintoraStandalone.configApi.gnernateNewConfig({ core: { useMaxWidth: true } })
       }
 
       return new Promise<IRenderer>((resolve, reject) => {
@@ -59,7 +58,8 @@ function renderPrepare(opts: CLIRenderOptions) {
           containerSize,
           enhanceGraphicIR(ir) {
             if (!ir.bgColor) {
-              const themeVariables = pintoraStandalone.getConfig<PintoraConfig>().themeConfig.themeVariables
+              const themeVariables: Partial<PintoraConfig['themeConfig']['themeVariables']> =
+                config.themeConfig.themeVariables || {}
               const newBgColor =
                 backgroundColor ||
                 themeVariables.canvasBackground ||
@@ -81,6 +81,11 @@ function renderPrepare(opts: CLIRenderOptions) {
   }
 }
 
+/**
+ * Renders the Pintora CLI options to the specified output format.
+ * @param opts - The CLIRenderOptions.
+ * @returns A promise that resolves to the rendered output.
+ */
 export function render(opts: CLIRenderOptions) {
   const mimeType = opts.mimeType || 'image/png'
 

diff --git a/packages/pintora-core/src/config.ts b/packages/pintora-core/src/config.ts
@@ -38,6 +38,9 @@ const configApi = {
   getConfig<T = PintoraConfig>() {
     return config as any as T
   },
+  /**
+   * Sets the configuration for Pintora.
+   */
   setConfig<T extends PintoraConfig = PintoraConfig>(c: DeepPartial<T>) {
     const newConfig = configApi.gnernateNewConfig(c)
     config = newConfig
@@ -65,7 +68,7 @@ const configApi = {
         newConfig.themeConfig = newConfig.themeConfig || ({} as any)
         newConfig.themeConfig.themeVariables = { ...themeVars }
       }
-      if (configThemeVars) {
+      if (configThemeVars && newConfig.themeConfig.themeVariables) {
         Object.assign(newConfig.themeConfig.themeVariables, configThemeVars)
       }
     }