Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

fix(engine-formula): refresh defined names after sheet rename (#7894)

wpxp1234567e73a4d83edb
diff --git a/packages/engine-formula/src/engine/analysis/lexer-tree-builder.ts b/packages/engine-formula/src/engine/analysis/lexer-tree-builder.ts
index 8b099d6f99..931ae5939a 100644
--- a/packages/engine-formula/src/engine/analysis/lexer-tree-builder.ts
+++ b/packages/engine-formula/src/engine/analysis/lexer-tree-builder.ts
@@ -722,7 +722,8 @@ export class LexerTreeBuilder extends Disposable {
: `${injectDefinedNameParam.unitId ?? ''}\0${injectDefinedNameParam.sheetId ?? ''}\0${injectDefinedNameParam.refOffsetX}\0${injectDefinedNameParam.refOffsetY}\0${formulaString}`;
if (transformSuffix === true && isCacheable) {
const lexerNode = FormulaLexerNodeCache.get(cacheKey);
- const simpleCheckDefinedNameResult = injectDefinedNameParam && this._simpleCheckDefinedName?.(formulaString, injectDefinedNameParam);
+ const simpleCheckDefinedNameResult = injectDefinedNameParam
+ && this._simpleCheckDefinedName(formulaString, injectDefinedNameParam, lexerNode);
if (lexerNode && !simpleCheckDefinedNameResult) {
return lexerNode;
}
@@ -829,21 +830,17 @@ export class LexerTreeBuilder extends Disposable {
const definedNameToken = token.trim();
const definedContent = getValueByName(unitId, definedNameToken, sheetId);
if (definedContent) {
+ definedNames.push(definedContent.name);
const refOffsetX = definedContent.localSheetId === 'AllDefaultWorkbook'
? param.refOffsetX - 1
: param.refOffsetX;
const refString = definedContent.formulaOrRefString.startsWith('=')
? definedContent.formulaOrRefString
: this._moveDefinedNameRefOffset(definedContent.formulaOrRefString, refOffsetX, param.refOffsetY);
- // if (refString.substring(0, 1) === operatorToken.EQUALS) {
- // refString = refString.substring(1);
- // }
-
const nestedDefinedNameParam = this._handleNestedDefinedName(refString, param);
if (nestedDefinedNameParam == null || typeof nestedDefinedNameParam !== 'object') {
sequenceString += nestedDefinedNameParam || ErrorType.NAME;
hasDefinedName = true;
- definedNames.push(definedNameToken);
} else if (typeof nestedDefinedNameParam === 'object') {
const { sequenceString: nestedSequenceString, definedNames: nestedDefinedNames } = nestedDefinedNameParam;
sequenceString += nestedSequenceString;
@@ -948,7 +945,11 @@ export class LexerTreeBuilder extends Disposable {
return this._handleDefinedName(sequenceArray, param);
}
- private _simpleCheckDefinedName(formulaString: string, injectDefinedNameParam: IInjectDefinedNameParam) {
+ private _simpleCheckDefinedName(
+ formulaString: string,
+ injectDefinedNameParam: IInjectDefinedNameParam,
+ lexerNode?: LexerNode
+ ) {
const { getDirtyDefinedNameMap, unitId } = injectDefinedNameParam;
const definedNameMap = getDirtyDefinedNameMap();
const executeUnitId = unitId;
@@ -956,7 +957,7 @@ export class LexerTreeBuilder extends Disposable {
const names = Object.keys(definedNameMap[executeUnitId]!);
for (let i = 0, len = names.length; i < len; i++) {
const name = names[i];
- if (formulaString.indexOf(name) > -1) {
+ if (formulaString.indexOf(name) > -1 || lexerNode?.getDefinedNames().includes(name)) {
return true;
}
}
diff --git a/packages/sheets-formula/src/controllers/__tests__/update-defined-name.controller.spec.ts b/packages/sheets-formula/src/controllers/__tests__/update-defined-name.controller.spec.ts
index cfa81b6591..d200eff302 100644
--- a/packages/sheets-formula/src/controllers/__tests__/update-defined-name.controller.spec.ts
+++ b/packages/sheets-formula/src/controllers/__tests__/update-defined-name.controller.spec.ts
@@ -15,13 +15,25 @@
*/
import type { Dependency, IWorkbookData } from '@univerjs/core';
-import { LocaleType } from '@univerjs/core';
+import { LocaleService, LocaleType, LogLevel, Univer } from '@univerjs/core';
+import { FUniver } from '@univerjs/core/facade';
import { ErrorType, IDefinedNamesService, SetDefinedNameMutation } from '@univerjs/engine-formula';
-import { MoveRangeCommand, RemoveDefinedNameCommand, RemoveSheetCommand, SetDefinedNameCommand, SetWorksheetNameCommand, SheetInterceptorService } from '@univerjs/sheets';
+import {
+ MoveRangeCommand,
+ RemoveDefinedNameCommand,
+ RemoveSheetCommand,
+ SCOPE_WORKBOOK_VALUE_DEFINED_NAME,
+ SetDefinedNameCommand,
+ SetWorksheetNameCommand,
+ SheetInterceptorService,
+} from '@univerjs/sheets';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
-
import { createFacadeTestBed } from '../../facade/__tests__/create-test-bed';
+import { UniverSheetsFormulaPlugin } from '../../plugin';
import { UpdateDefinedNameController } from '../update-defined-name.controller';
+import '@univerjs/engine-formula/facade';
+import '@univerjs/sheets/facade';
+import '../../facade';
function createWorkbookData(): IWorkbookData {
return {
@@ -68,21 +80,21 @@ describe('UpdateDefinedNameController', () => {
id: 'range-name',
name: 'RANGE_NAME',
formulaOrRefString: 'Sheet1!$A$1:$B$2',
- localSheetId: 'AllDefaultWorkbook',
+ localSheetId: SCOPE_WORKBOOK_VALUE_DEFINED_NAME,
comment: '',
},
rowsName: {
id: 'rows-name',
name: 'ROWS_NAME',
formulaOrRefString: 'Sheet1!$1:$3',
- localSheetId: 'AllDefaultWorkbook',
+ localSheetId: SCOPE_WORKBOOK_VALUE_DEFINED_NAME,
comment: '',
},
otherSheetName: {
id: 'other-sheet-name',
name: 'OTHER_SHEET_NAME',
formulaOrRefString: 'Sheet2!$C$3',
- localSheetId: 'AllDefaultWorkbook',
+ localSheetId: SCOPE_WORKBOOK_VALUE_DEFINED_NAME,
comment: '',
},
});
@@ -104,7 +116,7 @@ describe('UpdateDefinedNameController', () => {
id: 'temp',
name: 'TEMP_NAME',
formulaOrRefString: 'Sheet1!$A$1',
- localSheetId: 'AllDefaultWorkbook',
+ localSheetId: SCOPE_WORKBOOK_VALUE_DEFINED_NAME,
},
});
const removeDefinedNameResult = interceptorService.onCommandExecute({
@@ -217,3 +229,85 @@ describe('UpdateDefinedNameController', () => {
expect(result.redos.find((mutation) => (mutation.params as { name?: string } | undefined)?.name === 'OTHER_SHEET_NAME')).toBeUndefined();
});
});
+
+describe('defined name recalculation after sheet rename', () => {
+ const instances: Univer[] = [];
+
+ async function createCalculationTestBed() {
+ const univer = new Univer({
+ locale: LocaleType.EN_US,
+ locales: { [LocaleType.EN_US]: {} },
+ logLevel: LogLevel.SILENT,
+ });
+ instances.push(univer);
+ const localeService = univer.__getInjector().get(LocaleService);
+ localeService.setLocale(LocaleType.EN_US);
+ localeService.setDirection('ltr');
+ univer.registerPlugin(UniverSheetsFormulaPlugin);
+ const api = FUniver.newAPI(univer);
+ const workbook = api.createWorkbook(createWorkbookData());
+ const main = workbook.getSheetByName('Sheet1')!;
+ const rates = workbook.getSheetByName('Sheet2')!;
+ rates.getRange('A1').setValue(5);
+ workbook.insertDefinedName('Q', 'Sheet2!$A$1');
+ workbook.insertDefinedName('Alias', '=Q');
+ main.getRange('D2:E2').setFormulas([['=q+1', '=alias+1']]);
+ const settle = () => api.getFormula().onCalculationResultApplied(10_000);
+ await settle();
+ expect(main.getRange('D2:E2').getValues()).toEqual([[6, 6]]);
+ return { api, workbook, main, rates, settle };
+ }
+
+ afterEach(() => {
+ instances.forEach((univer) => univer.dispose());
+ instances.length = 0;
+ });
+
+ it('keeps direct and nested names calculating through rename, undo, redo and reload', async () => {
+ const { api, workbook, main, rates, settle } = await createCalculationTestBed();
+ rates.setName('Rates2');
+ await settle();
+ expect(workbook.getDefinedName('Q')!.getFormulaOrRefString()).toBe('Rates2!$A$1');
+ expect(main.getRange('D2:E2').getValues()).toEqual([[6, 6]]);
+
+ workbook.undo();
+ await settle();
+ expect(rates.getSheetName()).toBe('Sheet2');
+ expect(workbook.getDefinedName('Q')!.getFormulaOrRefString()).toBe('Sheet2!$A$1');
+
+ workbook.redo();
+ await settle();
+ expect(rates.getSheetName()).toBe('Rates2');
+ rates.getRange('A1').setValue(9);
+ await settle();
+ expect(main.getRange('D2:E2').getValues()).toEqual([[10, 10]]);
+
+ const snapshot = workbook.save();
+ api.disposeUnit(workbook.getId());
+ const restored = api.createWorkbook(snapshot);
+ await settle();
+ const restoredMain = restored.getSheetByName('Sheet1')!;
+ expect(restored.getDefinedName('Q')!.getFormulaOrRefString()).toBe('Rates2!$A$1');
+ expect(restoredMain.getRange('D2:E2').getValues()).toEqual([[10, 10]]);
+ restored.getSheetByName('Rates2')!.getRange('A1').setValue(12);
+ await settle();
+ expect(restoredMain.getRange('D2:E2').getValues()).toEqual([[13, 13]]);
+ });
+
+ it('rebuilds direct and nested cached formulas when a renamed name is retargeted', async () => {
+ const { workbook, main, rates, settle } = await createCalculationTestBed();
+ rates.setName('Rates2');
+ await settle();
+ rates.getRange('A2').setValue(8);
+ workbook.getDefinedName('Q')!.setRef('Rates2!$A$2');
+ await settle();
+ expect(main.getRange('D2:E2').getValues()).toEqual([[9, 9]]);
+
+ rates.getRange('A2').setValue(11);
+ await settle();
+ expect(main.getRange('D2:E2').getValues()).toEqual([[12, 12]]);
+ workbook.getDefinedName('Alias')!.setRef('=Q*2');
+ await settle();
+ expect(main.getRange('D2:E2').getValues()).toEqual([[12, 23]]);
+ });
+});