AG-12669 - Deprecate getInfiniteRowCount (#84)

AndrewGlazier · web-flow · commit 7134b42fe50f · 2024-08-29T09:50:38.000+01:00
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/README.md b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/README.md
@@ -0,0 +1,27 @@
+# `transform-grid-api-methods-v32-2`
+
+> _Transform deprecated Grid API method invocations_
+
+See the [`transform-grid-api-methods`](../../plugins/transform-grid-api-methods/) plugin for usage instructions.
+
+## Common tasks
+
+### Add a test case
+
+Create a new unit test scenario for this transform:
+
+```
+pnpm run task:create-test --type transform --target transform-grid-api-methods-v32-2
+```
+
+### Add a new rule
+
+Replacement rules are specified in [`replacements.ts`](./replacements.ts)
+
+### Add to a codemod release
+
+Add this source code transformation to a codemod release:
+
+```
+pnpm run task:include-transform --transform transform-grid-api-methods-v32-2
+```
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/input.js b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/input.js
@@ -0,0 +1,9 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.getInfiniteRowCount();
+gridApi?.getInfiniteRowCount();
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/output.js b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/output.js
@@ -0,0 +1,9 @@
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.getDisplayedRowCount();
+gridApi?.getDisplayedRowCount();
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/scenario.json b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/hello-world/scenario.json
@@ -0,0 +1,6 @@
+{
+  "scenario": {
+    "input": "input.js",
+    "output": "output.js"
+  }
+}
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/input.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/input.ts
@@ -0,0 +1,11 @@
+// @ts-nocheck
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.getInfiniteRowCount();
+gridApi?.getInfiniteRowCount();
+gridApi!.getInfiniteRowCount();
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/output.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/output.ts
@@ -0,0 +1,11 @@
+// @ts-nocheck
+import { createGrid } from '@ag-grid-community/core';
+
+const gridApi = createGrid(document.body, {
+  columnDefs: [],
+  rowData: [],
+});
+
+gridApi.getDisplayedRowCount();
+gridApi?.getDisplayedRowCount();
+gridApi!.getDisplayedRowCount();
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/scenario.json b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/__fixtures__/scenarios/ts-helloworld/scenario.json
@@ -0,0 +1,6 @@
+{
+  "scenario": {
+    "input": "input.ts",
+    "output": "output.ts"
+  }
+}
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/index.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/index.ts
@@ -0,0 +1 @@
+export { default } from './transform-grid-api-methods-v32-2';
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/manifest.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/manifest.ts
@@ -0,0 +1,8 @@
+import { type TransformManifest } from '@ag-grid-devtools/types';
+
+const manifest: TransformManifest = {
+  name: 'Transform Grid API methods v32.2',
+  description: 'Transform deprecated Grid API method invocations',
+};
+
+export default manifest;
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/replacements.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/replacements.ts
@@ -0,0 +1,20 @@
+import { ast, matchNode, pattern as p, replace, template } from '@ag-grid-devtools/ast';
+import {
+  type GridApiDeprecation,
+  type GridApiReplacement,
+} from '../../plugins/transform-grid-api-methods';
+
+export const replacements: Array<GridApiReplacement> = [
+  ...['', '?', '!'].map((apiOptionalChaining) =>
+    replace(
+      matchNode(({ api }) => ast.expression`${api}${apiOptionalChaining}.getInfiniteRowCount()`, {
+        api: p.expression(),
+      }),
+      template(({ api }) => {
+        return ast.expression`${api}${apiOptionalChaining}.getDisplayedRowCount()`;
+      }),
+    ),
+  ),
+];
+
+export const deprecations: Array<GridApiDeprecation> = [];
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/transform-grid-api-methods-v32-2.test.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/transform-grid-api-methods-v32-2.test.ts
@@ -0,0 +1,16 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, onTestFinished, test } from 'vitest';
+import { loadTransformScenarios } from '../../test/runners/transform';
+
+import transformGridApiMethodsV32_2 from './transform-grid-api-methods-v32-2';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+describe(transformGridApiMethodsV32_2, () => {
+  const scenariosPath = join(__dirname, './__fixtures__/scenarios');
+  loadTransformScenarios(scenariosPath, {
+    transforms: [transformGridApiMethodsV32_2],
+    vitest: { describe, expect, test, onTestFinished },
+  });
+});
diff --git a/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/transform-grid-api-methods-v32-2.ts b/packages/cli/src/codemods/transforms/transform-grid-api-methods-v32-2/transform-grid-api-methods-v32-2.ts
@@ -0,0 +1,11 @@
+import { type AstCliContext, type AstTransform } from '@ag-grid-devtools/ast';
+import { transformGridApiMethods } from '../../plugins/transform-grid-api-methods';
+import { deprecations, replacements } from './replacements';
+
+const plugin: AstTransform<AstCliContext> = transformGridApiMethods({ replacements, deprecations });
+
+const transform: AstTransform<AstCliContext> = function transformGridApiMethodsV32_0(babel) {
+  return plugin(babel);
+};
+
+export default transform;
diff --git a/packages/cli/src/codemods/versions/32.2.0/README.md b/packages/cli/src/codemods/versions/32.2.0/README.md
@@ -0,0 +1,35 @@
+# 32.2.0
+
+Codemod for upgrading to [AG Grid v32.2.0](https://github.com/ag-grid/ag-grid/releases/tag/v32.2.0)
+
+## Usage
+
+```
+npx @ag-grid-devtools/cli migrate --to 32.2.0
+```
+
+Source code transformations applied by this codemod are specified in [`transforms.ts`](./transforms.ts).
+
+## Common tasks
+
+### Add a transform
+
+Option 1: Create a new source code transformation to add to this codemod release version:
+
+```
+pnpm run task:create-transform --release 32.2.0
+```
+
+Option 2: Add an existing source code transformation to this codemod release version:
+
+```
+pnpm run task:include-transform --version 32.2.0
+```
+
+### Add a test case
+
+Create a new unit test scenario for this version:
+
+```
+pnpm run task:create-test --type version --target 32.2.0
+```
diff --git a/packages/cli/src/codemods/versions/32.2.0/__fixtures__/scenarios/.gitignore b/packages/cli/src/codemods/versions/32.2.0/__fixtures__/scenarios/.gitignore
diff --git a/packages/cli/src/codemods/versions/32.2.0/codemod.test.ts b/packages/cli/src/codemods/versions/32.2.0/codemod.test.ts
@@ -0,0 +1,16 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { describe, expect, onTestFinished, test } from 'vitest';
+import { loadCodemodExampleScenarios } from '../../test/runners/codemod';
+
+import codemod from './codemod';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+describe(codemod, () => {
+  const scenariosPath = join(__dirname, './__fixtures__/scenarios');
+  loadCodemodExampleScenarios(scenariosPath, {
+    codemod,
+    vitest: { describe, expect, test, onTestFinished },
+  });
+});
diff --git a/packages/cli/src/codemods/versions/32.2.0/codemod.ts b/packages/cli/src/codemods/versions/32.2.0/codemod.ts
@@ -0,0 +1,24 @@
+import { transformFileAst } from '@ag-grid-devtools/codemod-utils';
+import {
+  type Codemod,
+  type CodemodInput,
+  type CodemodOptions,
+  type CodemodResult,
+} from '@ag-grid-devtools/types';
+
+import transforms from './transforms';
+
+const codemod: Codemod = function codemodV32_2_0(
+  file: CodemodInput,
+  options: CodemodOptions,
+): CodemodResult {
+  const { path, source } = file;
+  const { fs, userConfig } = options;
+  return transformFileAst(source, transforms, {
+    filename: path,
+    fs,
+    userConfig,
+  });
+};
+
+export default codemod;
diff --git a/packages/cli/src/codemods/versions/32.2.0/manifest.ts b/packages/cli/src/codemods/versions/32.2.0/manifest.ts
@@ -0,0 +1,13 @@
+import { type TransformManifest, type VersionManifest } from '@ag-grid-devtools/types';
+
+import transformGridApiMethodsV32_2 from '../../transforms/transform-grid-api-methods-v32-2/manifest.ts';
+
+const transforms: Array<TransformManifest> = [transformGridApiMethodsV32_2];
+
+const manifest: VersionManifest = {
+  version: '32.2.0',
+  codemodPath: 'versions/32.2.0',
+  transforms,
+};
+
+export default manifest;
diff --git a/packages/cli/src/codemods/versions/32.2.0/transforms.ts b/packages/cli/src/codemods/versions/32.2.0/transforms.ts
@@ -0,0 +1,7 @@
+import { type AstCliContext, type AstTransform } from '@ag-grid-devtools/ast';
+
+import transformGridApiMethodsV32_2 from '../../transforms/transform-grid-api-methods-v32-2';
+
+const transforms: Array<AstTransform<AstCliContext>> = [transformGridApiMethodsV32_2];
+
+export default transforms;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export { default } from './transform-grid-api-methods-v32-2';`