chore(number-formatter): upgrade pretty-ms to 9.1.0 (apache#30599)

preset-io · Oct 15, 2024 · 7132d5a · 7132d5a
1 parent 55f18a3
commit 7132d5a
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 69 deletions.
diff --git a/superset-frontend/jest.config.js b/superset-frontend/jest.config.js
@@ -56,7 +56,7 @@ module.exports = {
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json'],
   snapshotSerializers: ['@emotion/jest/enzyme-serializer'],
   transformIgnorePatterns: [
-    'node_modules/(?!d3-(interpolate|color|time)|remark-gfm|markdown-table|micromark-*.|decode-named-character-reference|character-entities|mdast-util-*.|unist-util-*.|ccount|escape-string-regexp|nanoid|@rjsf/*.|sinon|echarts|zrender|fetch-mock)',
+    'node_modules/(?!d3-(interpolate|color|time)|remark-gfm|markdown-table|micromark-*.|decode-named-character-reference|character-entities|mdast-util-*.|unist-util-*.|ccount|escape-string-regexp|nanoid|@rjsf/*.|sinon|echarts|zrender|fetch-mock|pretty-ms|parse-ms)',
   ],
   globals: {
     __DEV__: true,

diff --git a/superset-frontend/package-lock.json b/superset-frontend/package-lock.json
diff --git a/superset-frontend/packages/superset-ui-core/package.json b/superset-frontend/packages/superset-ui-core/package.json
@@ -37,7 +37,7 @@
     "jed": "^1.1.1",
     "lodash": "^4.17.21",
     "math-expression-evaluator": "^1.3.8",
-    "pretty-ms": "^7.0.0",
+    "pretty-ms": "^9.1.0",
     "react-error-boundary": "^1.2.5",
     "react-markdown": "^8.0.7",
     "rehype-raw": "^7.0.0",

diff --git a/...frontend/packages/superset-ui-core/src/number-format/factories/createDurationFormatter.ts b/...frontend/packages/superset-ui-core/src/number-format/factories/createDurationFormatter.ts
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import prettyMsFormatter from 'pretty-ms';
+import prettyMilliseconds, { Options } from 'pretty-ms';
 import NumberFormatter from '../NumberFormatter';
 
 export default function createDurationFormatter(
@@ -26,13 +26,14 @@ export default function createDurationFormatter(
     id?: string;
     label?: string;
     multiplier?: number;
-  } & prettyMsFormatter.Options = {},
+  } & Options = {},
 ) {
   const { description, id, label, multiplier = 1, ...prettyMsOptions } = config;
 
   return new NumberFormatter({
     description,
-    formatFunc: value => prettyMsFormatter(value * multiplier, prettyMsOptions),
+    formatFunc: value =>
+      prettyMilliseconds(value * multiplier, prettyMsOptions),
     id: id ?? 'duration_format',
     label: label ?? `Duration formatter`,
   });

diff --git a/...nd/packages/superset-ui-core/test/number-format/factories/createDurationFormatter.test.ts b/...nd/packages/superset-ui-core/test/number-format/factories/createDurationFormatter.test.ts
@@ -19,40 +19,41 @@
 
 import { NumberFormatter, createDurationFormatter } from '@superset-ui/core';
 
-describe('createDurationFormatter()', () => {
-  it('creates an instance of NumberFormatter', () => {
-    const formatter = createDurationFormatter();
-    expect(formatter).toBeInstanceOf(NumberFormatter);
-  });
-  it('format milliseconds in human readable format with default options', () => {
-    const formatter = createDurationFormatter();
-    expect(formatter(0)).toBe('0ms');
-    expect(formatter(1000)).toBe('1s');
-    expect(formatter(1337)).toBe('1.3s');
-    expect(formatter(10500)).toBe('10.5s');
-    expect(formatter(60 * 1000)).toBe('1m');
-    expect(formatter(90 * 1000)).toBe('1m 30s');
+test('creates an instance of NumberFormatter', () => {
+  const formatter = createDurationFormatter();
+  expect(formatter).toBeInstanceOf(NumberFormatter);
+});
+test('format milliseconds in human readable format with default options', () => {
+  const formatter = createDurationFormatter();
+  expect(formatter(-1000)).toBe('-1s');
+  expect(formatter(0)).toBe('0ms');
+  expect(formatter(1000)).toBe('1s');
+  expect(formatter(1337)).toBe('1.3s');
+  expect(formatter(10500)).toBe('10.5s');
+  expect(formatter(60 * 1000)).toBe('1m');
+  expect(formatter(90 * 1000)).toBe('1m 30s');
+});
+test('format seconds in human readable format with default options', () => {
+  const formatter = createDurationFormatter({ multiplier: 1000 });
+  expect(formatter(-0.5)).toBe('-500ms');
+  expect(formatter(0.5)).toBe('500ms');
+  expect(formatter(1)).toBe('1s');
+  expect(formatter(30)).toBe('30s');
+  expect(formatter(60)).toBe('1m');
+  expect(formatter(90)).toBe('1m 30s');
+});
+test('format milliseconds in human readable format with additional pretty-ms options', () => {
+  const colonNotationFormatter = createDurationFormatter({
+    colonNotation: true,
   });
-  it('format seconds in human readable format with default options', () => {
-    const formatter = createDurationFormatter({ multiplier: 1000 });
-    expect(formatter(0.5)).toBe('500ms');
-    expect(formatter(1)).toBe('1s');
-    expect(formatter(30)).toBe('30s');
-    expect(formatter(60)).toBe('1m');
-    expect(formatter(90)).toBe('1m 30s');
+  expect(colonNotationFormatter(-10500)).toBe('-0:10.5');
+  expect(colonNotationFormatter(10500)).toBe('0:10.5');
+  const zeroDecimalFormatter = createDurationFormatter({
+    secondsDecimalDigits: 0,
   });
-  it('format milliseconds in human readable format with additional pretty-ms options', () => {
-    const colonNotationFormatter = createDurationFormatter({
-      colonNotation: true,
-    });
-    expect(colonNotationFormatter(10500)).toBe('0:10.5');
-    const zeroDecimalFormatter = createDurationFormatter({
-      secondsDecimalDigits: 0,
-    });
-    expect(zeroDecimalFormatter(10500)).toBe('10s');
-    const subMillisecondFormatter = createDurationFormatter({
-      formatSubMilliseconds: true,
-    });
-    expect(subMillisecondFormatter(100.40008)).toBe('100ms 400µs 80ns');
+  expect(zeroDecimalFormatter(10500)).toBe('10s');
+  const subMillisecondFormatter = createDurationFormatter({
+    formatSubMilliseconds: true,
   });
+  expect(subMillisecondFormatter(100.40008)).toBe('100ms 400µs 80ns');
 });