Remove deprecated APIs (#1453)

* Remove deprecated method ValueCellVertex.setCellValue * Remove deprecated config option binarySearchThreshold * Add changelog entry and adjust documentation Co-authored-by: Krzysztof ‘Budzio’ Budnik <[email protected]>
handsontable · Nov 6, 2024 · 34d0a37 · 34d0a37
1 parent 096aadf
commit 34d0a37
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 55 deletions.
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]
 
+### Changed
+
+- **Breaking change**: Removed the `binarySearchThreshold` configuration option. [#1439](https://github.com/handsontable/hyperformula/issues/1439)
+
 ## [2.7.1] - 2024-07-18
 
 ### Fixed

diff --git a/docs/guide/migration-from-2.x-to-3.0.md b/docs/guide/migration-from-2.x-to-3.0.md
@@ -0,0 +1,7 @@
+# Migrating from 2.x to 3.0
+
+To upgrade your HyperFormula version from 2.x.x to 3.0.0, follow this guide.
+
+## Removal of the `binarySearchThreshold` configuration option (deprecated since version 1.1.0)
+
+The `binarySearchThreshold` has no effect since version 1.1.0. If your codebase still uses this option, please remove it.
diff --git a/docs/guide/performance.md b/docs/guide/performance.md
@@ -17,9 +17,6 @@ not be used despite the option `useColumnIndex` enabled when  using
 
 Leaving this option disabled will cause the engine to use binary
 search when dealing with sorted data, and the naive approach otherwise.
-However, binary search will not be used if the size of the data being
-searched is below a given threshold, which can be customized using the
-`binarySearchThreshold` option in the configuration.
 
 ## Address mapping strategies
 

diff --git a/src/Config.ts b/src/Config.ts
@@ -30,7 +30,6 @@ export class Config implements ConfigParams, ParserConfig {
 
   public static defaultConfig: ConfigParams = {
     accentSensitive: false,
-    binarySearchThreshold: 20,
     currencySymbol: ['$'],
     caseSensitive: false,
     caseFirst: 'lower',
@@ -130,8 +129,6 @@ export class Config implements ConfigParams, ParserConfig {
   /** @inheritDoc */
   public readonly useStats: boolean
   /** @inheritDoc */
-  public readonly binarySearchThreshold: number
-  /** @inheritDoc */
   public readonly nullDate: SimpleDate
   /** @inheritDoc */
   public readonly currencySymbol: string[]
@@ -167,7 +164,6 @@ export class Config implements ConfigParams, ParserConfig {
   constructor(options: Partial<ConfigParams> = {}, showDeprecatedWarns: boolean = true) {
     const {
       accentSensitive,
-      binarySearchThreshold,
       caseSensitive,
       caseFirst,
       chooseAddressMappingPolicy,
@@ -240,7 +236,6 @@ export class Config implements ConfigParams, ParserConfig {
     validateNumberToBeAtLeast(this.precisionEpsilon, 'precisionEpsilon', 0)
     this.useColumnIndex = configValueFromParam(useColumnIndex, 'boolean', 'useColumnIndex')
     this.useStats = configValueFromParam(useStats, 'boolean', 'useStats')
-    this.binarySearchThreshold = binarySearchThreshold ?? Config.defaultConfig.binarySearchThreshold
     this.parseDateTime = configValueFromParam(parseDateTime, 'function', 'parseDateTime')
     this.stringifyDateTime = configValueFromParam(stringifyDateTime, 'function', 'stringifyDateTime')
     this.stringifyDuration = configValueFromParam(stringifyDuration, 'function', 'stringifyDuration')
@@ -315,7 +310,8 @@ export class Config implements ConfigParams, ParserConfig {
   }
 
   private static warnDeprecatedOptions(options: Partial<ConfigParams>) {
-    Config.warnDeprecatedIfUsed(options.binarySearchThreshold, 'binarySearchThreshold', '1.1')
+    // an example of deprecation warning
+    // Config.warnDeprecatedIfUsed(options.binarySearchThreshold, 'binarySearchThreshold', '1.1')
   }
 
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

diff --git a/src/ConfigParams.ts b/src/ConfigParams.ts
@@ -16,13 +16,6 @@ export interface ConfigParams {
    * @category String
    */
   accentSensitive: boolean,
-  /**
-   * Sets a minimum number of elements that a range must have to use binary search.
-   * @deprecated Every search of sorted data always uses binary search.
-   * @default 20
-   * @category Engine
-   */
-  binarySearchThreshold: number,
   /**
    * When set to `true`, makes string comparison case-sensitive.
    *

diff --git a/src/DependencyGraph/ValueCellVertex.ts b/src/DependencyGraph/ValueCellVertex.ts
@@ -37,8 +37,4 @@ export class ValueCellVertex {
   public getCellValue(): ValueCellVertexValue {
     return this.parsedValue
   }
-
-  public setCellValue(_cellValue: ValueCellVertexValue): never {
-    throw Error('SetCellValue is deprecated for ValueCellVertex')
-  }
 }
diff --git a/test/config.spec.ts b/test/config.spec.ts
@@ -402,37 +402,6 @@ describe('Config', () => {
     afterEach(() => {
       resetSpy(console.warn)
     })
-
-    it('should log usage of deprecated options when they are passed while engine initialization', () => {
-      new Config({
-        binarySearchThreshold: 20,
-      })
-
-      expect(console.warn).toHaveBeenCalledWith('binarySearchThreshold option is deprecated since 1.1')
-      expect(console.warn).toHaveBeenCalledTimes(1)
-    })
-
-    it('should log usage of deprecated options when they are passed while merging the Config object', () => {
-      const config = new Config()
-
-      config.mergeConfig({
-        binarySearchThreshold: 20
-      })
-
-      expect(console.warn).toHaveBeenCalledTimes(1)
-      expect(console.warn).toHaveBeenCalledWith('binarySearchThreshold option is deprecated since 1.1')
-    })
-
-    it('should not log usage of deprecated options when they are not passed while merging the Config object', () => {
-      const config = new Config({
-        binarySearchThreshold: 20,
-      })
-      resetSpy(console.warn)
-
-      config.mergeConfig({})
-
-      expect(console.warn).not.toHaveBeenCalled()
-    })
   })
 })
 

diff --git a/test/cruds/change-cell-content.spec.ts b/test/cruds/change-cell-content.spec.ts
@@ -196,16 +196,12 @@ describe('changing cell content', () => {
       ['1', '2', '=SUM(A1:B1)'],
     ]
     const engine = HyperFormula.buildFromArray(sheet)
-    const b1 = engine.addressMapping.getCell(adr('B1'))
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    const b1setCellValueSpy = spyOn(b1 as any, 'setCellValue')
     const c1 = engine.addressMapping.getCell(adr('C1'))
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const c1setCellValueSpy = spyOn(c1 as any, 'setCellValue')
 
     engine.setCellContents(adr('B1'), [['2']])
 
-    expect(b1setCellValueSpy).not.toHaveBeenCalled()
     expect(c1setCellValueSpy).not.toHaveBeenCalled()
   })