[dev-tool] codemods compilation errors due to typescript version mismatch

[jeremymeng]

Likely due to the usage of ts-morph internals in our codemods

> tsc && npm run lint && npm run check-format

src/util/admin/migrate-package/codemods/replaceChaiAsPromised.ts:40:14 - error TS2352: Conversion of type 'Node' to type 'Expression' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
  Property '_expressionBrand' is missing in type 'Node' but required in type 'Expression'.

40             [args[0].compilerNode as ts.Expression],
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  ../../temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript.d.ts:4831:9
    4831         _expressionBrand: any;
                 ~~~~~~~~~~~~~~~~
    '_expressionBrand' is declared here.

src/util/admin/migrate-package/codemods/replaceChaiAsPromised.ts:48:26 - error TS2345: Argument of type '() => ts.AwaitExpression' is not assignable to parameter of type '(traversal: TransformTraversalControl) => Node'.
  Call signature return types 'AwaitExpression' and 'Node' are incompatible.
    The types of 'kind' are incompatible between these types.
      Type 'SyntaxKind.AwaitExpression' is not assignable to type 'SyntaxKind'.

48           node.transform(() => {
                            ~~~~~~~

src/util/admin/migrate-package/codemods/replaceChaiAsPromised.ts:57:36 - error TS2352: Conversion of type 'Node' to type 'Expression' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
  Property '_expressionBrand' is missing in type 'Node' but required in type 'Expression'.

57                 args.length > 1 ? [args[1].compilerNode as ts.Expression] : [], // Pass second argument if provided
                                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  ../../temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript.d.ts:4831:9
    4831         _expressionBrand: any;
                 ~~~~~~~~~~~~~~~~
    '_expressionBrand' is declared here.

src/util/admin/migrate-package/codemods/replaceSinonStubs.ts:80:39 - error TS2345: Argument of type 'LeftHandSideExpression' is not assignable to parameter of type 'Node'.
  Types of property 'kind' are incompatible.
    Type 'import("/home/meng/git/jssdk/common/temp/node_modules/.pnpm/@[email protected]/node_modules/@ts-morph/common/lib/typescript").ts.SyntaxKind' is not assignable to type 'import("/home/meng/git/jssdk/common/temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript").SyntaxKind'.
      Each declaration of 'SyntaxKind.PartiallyEmittedExpression' differs in its value, where '355' was expected but '354' was given.

80         ts.isPropertyAccessExpression(callee.compilerNode) &&
                                         ~~~~~~~~~~~~~~~~~~~

src/util/admin/migrate-package/codemods/replaceSinonStubs.ts:81:47 - error TS2339: Property 'expression' does not exist on type 'never'.
  The intersection 'LeftHandSideExpression & PropertyAccessExpression' was reduced to 'never' because property 'kind' has conflicting types in some constituents.

81         isSinonIdentifier(callee.compilerNode.expression.getText()) &&
                                                 ~~~~~~~~~~

src/util/admin/migrate-package/codemods/replaceSinonStubs.ts:82:29 - error TS2339: Property 'name' does not exist on type 'never'.
  The intersection 'LeftHandSideExpression & PropertyAccessExpression' was reduced to 'never' because property 'kind' has conflicting types in some constituents.

82         callee.compilerNode.name.getText() === "restore"
                               ~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:40:51 - error TS2345: Argument of type 'LeftHandSideExpression' is not assignable to parameter of type 'Node'.
  Types of property 'kind' are incompatible.
    Type 'import("/home/meng/git/jssdk/common/temp/node_modules/.pnpm/@[email protected]/node_modules/@ts-morph/common/lib/typescript").ts.SyntaxKind' is not assignable to type 'import("/home/meng/git/jssdk/common/temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript").SyntaxKind'.
      Each declaration of 'SyntaxKind.PartiallyEmittedExpression' differs in its value, where '355' was expected but '354' was given.

40       if (callee && ts.isPropertyAccessExpression(callee.compilerNode)) {
                                                     ~~~~~~~~~~~~~~~~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:42:47 - error TS2339: Property 'expression' does not exist on type 'never'.
  The intersection 'LeftHandSideExpression & PropertyAccessExpression' was reduced to 'never' because property 'kind' has conflicting types in some constituents.

42           ts.isIdentifier(callee.compilerNode.expression) &&
                                                 ~~~~~~~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:43:31 - error TS2339: Property 'expression' does not exist on type 'never'.
  The intersection 'LeftHandSideExpression & PropertyAccessExpression' was reduced to 'never' because property 'kind' has conflicting types in some constituents.

43           callee.compilerNode.expression.text === "expect" &&
                                 ~~~~~~~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:44:31 - error TS2339: Property 'name' does not exist on type 'never'.
  The intersection 'LeftHandSideExpression & PropertyAccessExpression' was reduced to 'never' because property 'kind' has conflicting types in some constituents.

44           callee.compilerNode.name.text === "extend"
                                 ~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:92:26 - error TS2345: Argument of type '() => ts.AwaitExpression' is not assignable to parameter of type '(traversal: TransformTraversalControl) => Node'.
  Call signature return types 'AwaitExpression' and 'Node' are incompatible.
    The types of 'kind' are incompatible between these types.
      Type 'SyntaxKind.AwaitExpression' is not assignable to type 'SyntaxKind'.

92           node.transform(() => {
                            ~~~~~~~

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:99:22 - error TS2352: Conversion of type 'Node' to type 'Expression' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
  Property '_expressionBrand' is missing in type 'Node' but required in type 'Expression'.

99                     [asyncFunction.compilerNode as ts.Expression],
                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  ../../temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript.d.ts:4831:9
    4831         _expressionBrand: any;
                 ~~~~~~~~~~~~~~~~
    '_expressionBrand' is declared here.

src/util/admin/migrate-package/codemods/replaceSupportsTracing.ts:104:18 - error TS2352: Conversion of type 'Node' to type 'Expression' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first.
  Property '_expressionBrand' is missing in type 'Node' but required in type 'Expression'.

104                 [methodArray.compilerNode as ts.Expression],
                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  ../../temp/node_modules/.pnpm/[email protected]/node_modules/typescript/lib/typescript.d.ts:4831:9
    4831         _expressionBrand: any;
                 ~~~~~~~~~~~~~~~~
    '_expressionBrand' is declared here.


Found 13 errors in 3 files.

[jeremymeng]

ts-morph v25 now depends on typescript 5.7.2

However, this could happen again in future updates. Should we

• skip type checking for the codemods, or
• retire the codemods when ESM migration completes, or
• fix codemodes so no internals are used.

[xirzec]

@maorleger thoughts?

[maorleger]

ts-morph v25 now depends on typescript 5.7.2

However, this could happen again in future updates. Should we

• skip type checking for the codemods, or
• retire the codemods when ESM migration completes, or
• fix codemodes so no internals are used.

hmm I can try to fix the codemods but to be honest my intention was always to:

1. Complete migration
2. Delete all the codemods
3. Delete the migrate-package script

Thanks to all of @mpodwysocki 's push we are almost all migrated so they should not be long-lived. So I think I lean towards a combination of "skip type checking for the codemods" and "retire the codemods when ESM migration completes"

@jeremymeng - do you happen to have a branch with this repro by any chance? Or do I just upgrade to latest typescript and see it fail? I can play around with seeing how easy it would be to fix?

[jeremymeng]

So I think I lean towards a combination of "skip type checking for the codemods" and "retire the codemods when ESM migration completes"

+1. I don't want us spending a lot of time on things that will be retired soon

@jeremymeng - do you happen to have a branch with this repro by any chance? Or do I just upgrade to latest typescript and see it fail? I can play around with seeing how easy it would be to fix?

@maorleger downgrading ts-morph to previous version (v24)?

[maorleger]

@jeremymeng - do you happen to have a branch with this repro by any chance? Or do I just upgrade to latest typescript and see it fail? I can play around with seeing how easy it would be to fix?

@maorleger downgrading ts-morph to previous version (v24)?

Right, of course... new year's 🧠still warming up 😆