Add a configuration option context that can be used to pass data to…

… custom functions (#1400) Add generic context option for custom function resolution (#1398) * Add generic context option for custom function resolution * Apply suggestions from code review * Unknown type; add function test * Update changelog Co-authored-by: Michael Bridge <[email protected]>
handsontable · Apr 3, 2024 · 2404ac4 · 2404ac4
1 parent a752b76
commit 2404ac4
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Added
+
+- Added a configuration option `context` that can be used to pass data to custom functions.
+
 ## [2.6.2] - 2024-02-15
 
 ### Changed

diff --git a/src/Config.ts b/src/Config.ts
@@ -34,6 +34,7 @@ export class Config implements ConfigParams, ParserConfig {
     currencySymbol: ['$'],
     caseSensitive: false,
     caseFirst: 'lower',
+    context: undefined,
     chooseAddressMappingPolicy: new AlwaysDense(),
     dateFormats: ['DD/MM/YYYY', 'DD/MM/YY'],
     decimalSeparator: '.',
@@ -136,6 +137,8 @@ export class Config implements ConfigParams, ParserConfig {
   public readonly currencySymbol: string[]
   /** @inheritDoc */
   public readonly undoLimit: number
+  /** @inheritDoc */
+  public readonly context: unknown
 
   /**
    * Built automatically based on translation package.
@@ -168,6 +171,7 @@ export class Config implements ConfigParams, ParserConfig {
       caseSensitive,
       caseFirst,
       chooseAddressMappingPolicy,
+      context,
       currencySymbol,
       dateFormats,
       decimalSeparator,
@@ -254,6 +258,7 @@ export class Config implements ConfigParams, ParserConfig {
     this.maxColumns = configValueFromParam(maxColumns, 'number', 'maxColumns')
     this.currencySymbol = this.setupCurrencySymbol(currencySymbol)
     validateNumberToBeAtLeast(this.maxColumns, 'maxColumns', 1)
+    this.context = context
 
     privatePool.set(this, {
       licenseKeyValidityState: checkLicenseKeyValidity(this.licenseKey)

diff --git a/src/ConfigParams.ts b/src/ConfigParams.ts
@@ -52,6 +52,12 @@ export interface ConfigParams {
    * @category Engine
    */
   chooseAddressMappingPolicy: ChooseAddressMapping,
+  /**
+   * A generic parameter that can be used to pass data to custom functions.
+   * @default undefined
+   * @category Engine
+   */
+  context: unknown,
   /**
    * Sets symbols that denote currency numbers.
    *

diff --git a/test/config.spec.ts b/test/config.spec.ts
@@ -97,6 +97,12 @@ describe('Config', () => {
     expect(() => new Config({caseFirst: 'abcd'})).toThrowError('Expected one of \'upper\' \'lower\' \'false\' for config parameter: caseFirst')
   })
 
+  it('should return the specified context', () => {
+    const context ={a: 1, b: 2}
+    const config = new Config({context})
+    expect(config.context).toBe(context)
+  })
+
   it('should throw error when Function Translation cannot be found', () => {
     const config = new Config()
     const functionName = '0123456ABCDEFGH'

diff --git a/test/custom-functions.spec.ts b/test/custom-functions.spec.ts
@@ -191,7 +191,7 @@ class GreetingsPlugin extends FunctionPlugin {
       EXAMPLE_ARRAY_FUNCTION: 'EXAMPLE_ARRAY_FUNCTION',
     }
   }
-  
+
   greet(ast: ProcedureAst, state: InterpreterState) {
     return this.runFunction(
       ast.args,
@@ -219,6 +219,18 @@ class GreetingsPlugin extends FunctionPlugin {
   }
 }
 
+class ContextPlugin extends FunctionPlugin {
+  public static implementedFunctions = {
+    'GETCONTEXT': {
+      method: 'getContext',
+    }
+  }
+
+  public getContext(ast: ProcedureAst, state: InterpreterState): unknown {
+    return this.config.context
+  }
+}
+
 describe('Register static custom plugin', () => {
   it('should register plugin with translations', () => {
     HyperFormula.registerLanguage('plPL', plPL)
@@ -552,3 +564,17 @@ describe('Custom function implemented with runFunction)', () => {
     }).toThrow(new Error('Function returning array cannot be vectorized.'))
   })
 })
+
+describe('Context accessible within custom function', () => {
+  it('works', () => {
+    HyperFormula.registerFunctionPlugin(ContextPlugin)
+    HyperFormula.getLanguage('enGB').extendFunctions({GETCONTEXT: 'GETCONTEXT'})
+
+    const context = 'abc'
+    const engine = HyperFormula.buildFromArray([
+      ['=GETCONTEXT()'],
+    ], {context})
+
+    expect(engine.getCellValue(adr('A1'))).toEqual(context)
+  })
+})