fix: fixed versions assertion (DevExpress#30044) (DevExpress#30626)

Author: sergey-kras

packages/devextreme/js/__internal/core/license/license_validation.test.ts

@@ -5,7 +5,11 @@ import config from '@js/core/config';
 import errors from '@js/core/errors';
 
 import { base } from '../../ui/overlay/z_index';
-import { assertDevExtremeVersion, clearAssertedVersions } from '../../utils/version';
+import {
+  assertDevExtremeVersion,
+  assertedVersionsCompatible,
+  clearAssertedVersions,
+} from '../../utils/version';
 import {
   parseLicenseKey,
   setLicenseCheckSkipCondition,
@@ -535,3 +539,85 @@ describe('DevExpress license check', () => {
     expect(trialPanelSpy).toHaveBeenCalled();
   });
 });
+
+describe('assertedVersions integration', () => {
+  const packages = [{ packageName: 'test-package', version: '1.2.3' }];
+
+  beforeEach(() => {
+    jest.resetModules();
+    jest.spyOn(errors, 'log').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+    delete globalThis.DevExpress;
+    clearAssertedVersions();
+  });
+
+  describe('set version in assertDevExtremeVersion', () => {
+    test('returns false and logs error when asserted versions are not compatible', () => {
+      assertDevExtremeVersion('test-package', '1.2.3');
+
+      const result = assertedVersionsCompatible({ major: 2, minor: 0, patch: 0 });
+
+      expect(result).toBe(false);
+      expect(errors.log).toHaveBeenCalledWith('W0023', expect.stringContaining('test-package'));
+    });
+
+    test('returns true when asserted versions are compatible', () => {
+      assertDevExtremeVersion('test-package', '1.2.3');
+
+      const result = assertedVersionsCompatible({ major: 1, minor: 2, patch: 3 });
+
+      expect(result).toBe(true);
+      expect(errors.log).not.toHaveBeenCalled();
+    });
+
+    test('clears asserted versions from config', () => {
+      assertDevExtremeVersion('test-package-2', '1.2.3');
+      clearAssertedVersions();
+
+      expect(config().versionAssertions).toEqual([]);
+    });
+  });
+
+  describe('set version in DevExpress.config', () => {
+    test('returns true when all global version assertions are compatible', () => {
+      globalThis.DevExpress = {
+        config: {
+          versionAssertions: packages,
+        },
+      };
+
+      // eslint-disable-next-line
+      const versionUtils = require('@js/__internal/utils/version');
+      // eslint-disable-next-line
+      const errors = require('@js/core/errors').default;
+      jest.spyOn(errors, 'log').mockImplementation(() => {});
+
+      const result = versionUtils.assertedVersionsCompatible({ major: 1, minor: 2, patch: 3 });
+
+      expect(result).toBe(true);
+      expect(errors.log).not.toHaveBeenCalled();
+    });
+
+    test('returns false and log error when any global version assertion is not compatible', () => {
+      globalThis.DevExpress = {
+        config: {
+          versionAssertions: packages,
+        },
+      };
+
+      // eslint-disable-next-line
+      const versionUtils = require('@js/__internal/utils/version');
+      // eslint-disable-next-line
+      const errors = require('@js/core/errors').default;
+      jest.spyOn(errors, 'log').mockImplementation(() => {});
+
+      const result = versionUtils.assertedVersionsCompatible({ major: 2, minor: 0, patch: 0 });
+
+      expect(result).toBe(false);
+      expect(errors.log).toHaveBeenCalledWith('W0023', expect.stringContaining('test-package'));
+    });
+  });
+});

packages/devextreme/js/__internal/core/m_config.ts

@@ -17,6 +17,7 @@ const config = {
   useJQuery: undefined,
   editorStylingMode: undefined,
   useLegacyVisibleIndex: false,
+  versionAssertions: [],
 
   floatingActionButtonConfig: {
     icon: 'add',
@@ -76,6 +77,7 @@ const configMethod = (...args) => {
 
   extend(config, newConfig);
 };
+
 // @ts-expect-error typescript cant see global
 if (typeof DevExpress !== 'undefined' && DevExpress.config) {
 // @ts-expect-error typescript cant see global

packages/devextreme/js/__internal/utils/version.ts

@@ -1,15 +1,10 @@
+import type { VersionAssertion } from '@js/common';
+import config from '@js/core/config';
 import errors from '@js/core/errors';
 
 const MAX_MINOR_VERSION = 2;
 const MIN_MINOR_VERSION = 1;
 
-interface AssertedVersion {
-  packageName: string;
-  version: string;
-}
-
-const assertedVersions: AssertedVersion[] = [];
-
 export interface Version {
   major: number;
   minor: number;
@@ -34,20 +29,21 @@ export function parseVersion(version: string): Version {
   };
 }
 
+export function getAssertedVersions(): VersionAssertion[] {
+  return config()?.versionAssertions ?? [];
+}
+
 export function assertDevExtremeVersion(packageName: string, version: string): void {
-  assertedVersions.push({
-    packageName,
-    version,
-  });
+  config({ versionAssertions: [...getAssertedVersions(), { packageName, version }] });
 }
 
 export function clearAssertedVersions(): void {
   /// #DEBUG
-  assertedVersions.splice(0);
+  config({ versionAssertions: [] });
   /// #ENDDEBUG
 }
 
-function stringifyVersionList(assertedVersionList: AssertedVersion[]): string {
+function stringifyVersionList(assertedVersionList: VersionAssertion[]): string {
   return assertedVersionList
     .map((assertedVersion) => `${assertedVersion.packageName}: ${assertedVersion.version}`)
     .join('\n');
@@ -76,7 +72,7 @@ export function getPreviousMajorVersion({ major, minor, patch }: Version): Versi
 }
 
 export function assertedVersionsCompatible(currentVersion: Version): boolean {
-  const mismatchingVersions = assertedVersions.filter(
+  const mismatchingVersions = getAssertedVersions().filter(
     (assertedVersion) => !versionsEqual(
       parseVersion(assertedVersion.version),
       currentVersion,

packages/devextreme/js/common.d.ts

@@ -270,6 +270,11 @@ export type FirstDayOfWeek = 0 | 1 | 2 | 3 | 4 | 5 | 6;
  */
 export type Format = 'billions' | 'currency' | 'day' | 'decimal' | 'exponential' | 'fixedPoint' | 'largeNumber' | 'longDate' | 'longTime' | 'millions' | 'millisecond' | 'month' | 'monthAndDay' | 'monthAndYear' | 'percent' | 'quarter' | 'quarterAndYear' | 'shortDate' | 'shortTime' | 'thousands' | 'trillions' | 'year' | 'dayOfWeek' | 'hour' | 'longDateLongTime' | 'minute' | 'second' | 'shortDateShortTime';
 
+export type VersionAssertion = {
+  packageName: string;
+  version: string;
+};
+
 /**
  * @docid
  * @section commonObjectStructures
@@ -278,6 +283,7 @@ export type Format = 'billions' | 'currency' | 'day' | 'decimal' | 'exponential'
  * @type object
  */
 export type GlobalConfig = {
+  versionAssertions?: VersionAssertion[];
   /**
    * @docid
    * @default "."

packages/devextreme/ts/dx.all.d.ts

@@ -862,6 +862,13 @@ declare module DevExpress {
      */
     static validateModel(model: any): any;
   }
+  /**
+   * @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
+   */
+  export type VersionAssertion = {
+    packageName: string;
+    version: string;
+  };
 }
 declare module DevExpress.aiIntegration {
   /**
@@ -1264,6 +1271,7 @@ declare module DevExpress.common {
    * [descr:GlobalConfig]
    */
   export type GlobalConfig = {
+    versionAssertions?: VersionAssertion[];
     /**
      * [descr:GlobalConfig.decimalSeparator]
      * @deprecated [depNote:GlobalConfig.decimalSeparator]