bug: when migrating a ember test, with inline templates; whitespace breaks CommentPlugin

[wondersloth]

Documented issue in TS at microsoft/TypeScript#54366

Affected Version @rehearsal/cli@3.0.5-beta

Bad

    await render(hbs`
        <AssetLoader$DeferredAssetLoader
          @bundle="custom-bundle"
          @fulfilledComponent={{component "artdeco-button" class="test-dummy-component"}}
        />
      `);

Good

    await render(hbs`<AssetLoader$DeferredAssetLoader
          @bundle="custom-bundle"
          @fulfilledComponent={{component "artdeco-button" class="test-dummy-component"}}
        />
      `);

Steps to reproduce

Create a tsconfig.json in packages/addons/asset-loader/tsconfig.json

{
  "extends": "../../../tsconfig.base.json",
  "include": ["addon", "tests", "../../../types/**/*"],
  "references": [],
  "compilerOptions": {
    "allowJs": true,
    "composite": true,
    "declarationDir": "dist-types",
    "paths": {
      "ember-cli-pemberly-tracking/*": [
        "./node_modules/@linkedin/ember-cli-pemberly-tracking/*"
      ],
      "ember-cli-pemberly-tracking/test-support/*": [
        "./node_modules/@linkedin/ember-cli-pemberly-tracking/test-support/*"
      ]
    }
  }
}

$ yarn add -D @rehearsal/cli@3.0.5-beta
$ yarn rehearsal move packages/addons/asset-loader/tests
$ yarn rehearsal fix packages/addons/asset-loader/tests/
// Make a change? Or not.
$ yarn rehearsal fix packages/addons/asset-loader/tests/

Second pass of fix breaks source code, due to plugins not acocunting for offset changes when working through fixes.

First pass

      assert.ok(
        // @ts-expect-error @rehearsal TODO TS2339: Property 'loadBundleStub' does not exist on type 'TestContext'.
        this.loadBundleStub.calledWithExactly('custom-bundle'),
        'asset-loader service was called with correct bundle name'
      );

Imports get updated with

// @ts-expect-error @rehearsal TODO TS6133: The declaration 'Property' is never read or used. Remove the declaration or use it.
import { Property } from 'node_modules/@babel/types/lib';
import { not } from 'node_modules/@types/micromatch';
import { type } from 'os';
import { type } from 'os';

Around line 60 a comment is mangled.

      // @ts-expect-ert'.
      // @ts-expect-error @rehearsal TODO TS2339: Property 'defer' does not exist on type 'TestContext'.
      this.defer.re TODO Property 'loadBundleStub' does not exist on type 'TestContext'.
        // @ts-expect-error @rehearsal TODO TS2339: Property 'this' does not exist on type '"TestContext"'.
        this.loadBundleStub.calledWithExactly('custom-bundle'),
        'asset-loader service was called with correct bundle name'
      );

Rehearsal CLI reports things completed.

➜  voyager-web git:(medwards/asset-loader) ✗ yarn rehearsal fix packages/addons/asset-loader/tests
info:    @rehearsal/fix 3.0.5-beta
✔ Initialize
✔ Analyzing project dependency graph ...
✔ Types Inferred
  30 errors caught by rehearsal
  9 have been fixed by rehearsal
  21 errors need to be fixed manually
  -- 20 ts errors, marked by @ts-expect-error @rehearsal TODO
  -- 1 eslint errors, with details in the report

Additional Recommendations

• rehearsal should not write to a file that can't be parsed, or prettified.

[lynchbomb]

This is lower priority as its non app code. App code first. Test code second.

[wondersloth]

Pausing due to prioritization.

Leaving notes for future investigation:

The ReRehearsePlugin

Fails to remove a comment when a multiline hbs tagged template expression is present.

rehearsal-js/packages/plugins/src/plugins/re-rehearse.plugin.ts

Line 29 in 654b393

.getSpanOfEnclosingComment(sourceFile.fileName, tagStart, false);

getSpanOfEnclosingComment returns an incorrect start commentSpan.start

The position does not start at the // but rather 40 to 50 characters earlier in the file.

When the comment is stripped it truncates an incorrect region.

rehearsal-js/packages/plugins/src/plugins/re-rehearse.plugin.ts

Line 37 in 654b393

text = text.substring(0, boundary.start) + text.substring(boundary.end);

[egorio]

One more thing.

Multiple imports, like:

import { type } from 'os';
import { type } from 'os';

should be resolved with EXPERIMENTAL_MODES === drain

[wondersloth]

This has been fixed in TS expected release in 5.2.0
microsoft/TypeScript#54366