Tractor to Playwright upgrade script 🚜🔥

lerna.json

@@ -3,7 +3,7 @@
     "packages/*",
     "plugins/*"
   ],
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/cli",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "CLI for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -35,18 +35,18 @@
     "build": "src/**/*.js"
   },
   "dependencies": {
-    "@tractor/core": "^1.9.4-alpha.4",
+    "@tractor/core": "^1.9.4-tractor-to-playwright.0",
     "commander": "^2.13.0"
   },
   "devDependencies": {
-    "@tractor/config-loader": "^1.9.4-alpha.4",
-    "@tractor/dependency-injection": "^1.9.4-alpha.4",
-    "@tractor/error-handler": "^1.9.4-alpha.4",
-    "@tractor/file-structure": "^1.9.4-alpha.4",
-    "@tractor/logger": "^1.9.4-alpha.4",
-    "@tractor/server": "^1.9.4-alpha.4",
-    "@tractor/tractor": "^1.9.4-alpha.4",
-    "@tractor/unit-test": "^1.9.4-alpha.4"
+    "@tractor/config-loader": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/dependency-injection": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/error-handler": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/file-structure": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/logger": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/server": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/tractor": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/unit-test": "^1.9.4-tractor-to-playwright.0"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"
 }

packages/cli/src/upgrade/index.ts

@@ -3,12 +3,13 @@ import { inject } from '@tractor/dependency-injection';
 import { info } from '@tractor/logger';
 import { Tractor } from '@tractor/tractor';
 
-export const upgrade = inject(async (tractor: Tractor): Promise<Array<void>> => Promise.all(
-    tractor.plugins.map(plugin => {
-        info(`Upgrading tractor-plugin-${plugin.name} files...`);
+export const upgrade = inject(async (tractor: Tractor): Promise<void> => tractor.plugins.reduce(
+    async (p, plugin) => {
+        await p;
+        info(`Upgrading @tractor-plugin/${plugin.name} files...`);
         // HACK:
         // Here's another reason to kill the custom DI stuff:
         // tslint:disable-next-line:no-unbound-method
-        return tractor.call(plugin.upgrade);
-    })
-) , 'tractor');
+        await tractor.call(plugin.upgrade);
+    }, Promise.resolve())
+, 'tractor');

packages/config-loader/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/config-loader",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "Config loader for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -37,9 +37,9 @@
     "@tractor/core": "^1.0.0"
   },
   "devDependencies": {
-    "@tractor/error-handler": "^1.9.4-alpha.4",
-    "@tractor/logger": "^1.9.4-alpha.4",
-    "@tractor/unit-test": "^1.9.4-alpha.4"
+    "@tractor/error-handler": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/logger": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/unit-test": "^1.9.4-tractor-to-playwright.0"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"
 }

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/core",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "Core module for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -32,19 +32,19 @@
     "build": "src/**/*.js"
   },
   "dependencies": {
-    "@tractor/config-loader": "^1.9.4-alpha.4",
-    "@tractor/dependency-injection": "^1.9.4-alpha.4",
-    "@tractor/error-handler": "^1.9.4-alpha.4",
-    "@tractor/file-javascript": "^1.9.4-alpha.4",
-    "@tractor/file-structure": "^1.9.4-alpha.4",
-    "@tractor/logger": "^1.9.4-alpha.4",
-    "@tractor/plugin-loader": "^1.9.4-alpha.4",
-    "@tractor/server": "^1.9.4-alpha.4",
-    "@tractor/tractor": "^1.9.4-alpha.4",
-    "@tractor/ui": "^1.9.4-alpha.4"
+    "@tractor/config-loader": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/dependency-injection": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/error-handler": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/file-javascript": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/file-structure": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/logger": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/plugin-loader": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/server": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/tractor": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/ui": "^1.9.4-tractor-to-playwright.0"
   },
   "devDependencies": {
-    "@tractor/unit-test": "^1.9.4-alpha.4"
+    "@tractor/unit-test": "^1.9.4-tractor-to-playwright.0"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"
 }

packages/dependency-injection/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/dependency-injection",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "DI container for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "@tractor/core": "^1.0.0"
   },
   "devDependencies": {
-    "@tractor/error-handler": "^1.9.4-alpha.4"
+    "@tractor/error-handler": "^1.9.4-tractor-to-playwright.0"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"
 }

packages/error-handler/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/error-handler",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "JavaScript file handler for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -40,8 +40,8 @@
     "@tractor/core": "^1.0.0"
   },
   "devDependencies": {
-    "@tractor/logger": "^1.9.4-alpha.4",
-    "@tractor/unit-test": "^1.9.4-alpha.4",
+    "@tractor/logger": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/unit-test": "^1.9.4-tractor-to-playwright.0",
     "@types/express": "^4.16.1"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"

packages/file-javascript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/file-javascript",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "JavaScript file handler for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -37,15 +37,17 @@
   "dependencies": {
     "escodegen": "^1.9.0",
     "esprima": "^4.0.1",
-    "esquery": "^1.0.1"
+    "esquery": "^1.0.1",
+    "prettier": "^2.3.2"
   },
   "peerDependencies": {
     "@tractor/core": "^1.0.0"
   },
   "devDependencies": {
-    "@tractor/file-structure": "^1.9.4-alpha.4",
+    "@tractor/file-structure": "^1.9.4-tractor-to-playwright.0",
     "@types/escodegen": "^0.0.6",
-    "@types/esprima": "^4.0.2"
+    "@types/esprima": "^4.0.2",
+    "@types/prettier": "^2.3.2"
   },
   "gitHead": "aac58387d7addbeceb2683c730fd7801922f7426"
 }

packages/file-javascript/src/index.ts

@@ -1,3 +1,6 @@
 export * from './javascript-file-metadata';
 export * from './javascript-file-refactorer';
 export * from './javascript-file';
+export * from './typescript-file-metadata';
+export * from './typescript-file-refactorer';
+export * from './typescript-file';

packages/file-javascript/src/javascript-file.ts

@@ -50,10 +50,12 @@ export class JavaScriptFile <MetadataType extends JavaScriptFileMetaType = JavaS
 
         await refactor;
         const change = JAVASCRIPT_FILE_REFACTORER[type];
-        if (!change) {
-            return;
+        if (change) {
+            const result = await change(this, data);
+            if (result === null) {
+                return;
+            }
         }
-        await change(this, data);
         await this.save(this.ast as Program);
     }
 

packages/file-javascript/src/typescript-file-metadata.ts

@@ -0,0 +1,17 @@
+// Dependencies:
+import { FileMetadata } from '@tractor/file-structure';
+import { SourceFile } from 'typescript';
+
+export type TypeScriptFileMetaItem = {
+  name?: string;
+  version?: string;
+};
+
+export type TypeScriptFileMetaType = TypeScriptFileMetaItem & {
+  [key: string]: Array<TypeScriptFileMetaItem>;
+};
+
+export type TypeScriptFileMetadata<MetaType extends TypeScriptFileMetaType = TypeScriptFileMetaType> = FileMetadata & {
+  ast?: SourceFile;
+  meta: MetaType | null;
+};

packages/file-javascript/src/typescript-file-refactorer.ts

@@ -0,0 +1,5 @@
+// Dependencies:
+import { Refactorer } from '@tractor/file-structure';
+import { TypeScriptFile } from './typescript-file';
+
+export const TYPESCRIPT_FILE_REFACTORER: Refactorer<TypeScriptFile> = {};

packages/file-javascript/src/typescript-file.ts

@@ -0,0 +1,131 @@
+// Constants:
+const REQUEST_ERROR = 400;
+const IMPORT_QUERY = 'ImportDeclaration > StringLiteral';
+
+// Dependencies:
+import { File, RefactorData } from '@tractor/file-structure';
+import { tsquery } from '@phenomnomnominal/tsquery';
+import { createPrinter, SourceFile, StringLiteral } from 'typescript';
+import * as path from 'path';
+import { format } from 'prettier';
+import { TYPESCRIPT_FILE_REFACTORER } from './typescript-file-refactorer';
+import { TypeScriptFileMetadata, TypeScriptFileMetaType } from './typescript-file-metadata';
+
+// Errors:
+import { TractorError } from '@tractor/error-handler';
+
+export class TypeScriptFile<MetadataType extends TypeScriptFileMetaType = TypeScriptFileMetaType> extends File {
+  public ast?: SourceFile;
+  public initialised = false;
+
+  public async meta (): Promise<MetadataType | null> {
+    if (!this.ast) {
+      await this.read();
+    }
+    return this._getMetaSync();
+  }
+
+  public async read (): Promise<string> {
+    const read = super.read();
+
+    try {
+      const content = await read;
+      this._setAST(content);
+      this._getReferences();
+      return this.content!;
+    } catch {
+      throw new TractorError(`Parsing "${this.path}" failed.`, REQUEST_ERROR);
+    }
+  }
+
+  public async refactor (type: string, data?: RefactorData): Promise<void> {
+    const refactor = super.refactor(type, data);
+
+    await refactor;
+    const change = TYPESCRIPT_FILE_REFACTORER[type];
+    if (change) {
+      const result = await change(this, data);
+      if (result === null) {
+        return;
+      }
+    }
+    await this.save(this.ast as SourceFile);
+  }
+
+  public async save (typescript: string | Buffer | SourceFile): Promise<string> {
+    let toSave: string | Buffer;
+    if (typeof typescript !== 'string' && !Buffer.isBuffer(typescript)) {
+      const printer = createPrinter();
+      toSave = printer.printFile(typescript);
+      toSave = format(toSave.toString(), { printWidth: 200, singleQuote: true, parser: 'typescript' });
+    } else {
+      toSave = typescript;
+    }
+
+    const save = super.save(toSave);
+
+    try {
+      const content = await save;
+      this._setAST(content);
+      this._getReferences();
+      return this.content as string;
+    } catch {
+      throw new TractorError(`Saving "${this.path}" failed.`, REQUEST_ERROR);
+    }
+  }
+
+  public serialise (): TypeScriptFileMetadata<MetadataType> {
+    const serialised = super.serialise() as TypeScriptFileMetadata<MetadataType>;
+
+    serialised.ast = this.ast;
+    return serialised;
+  }
+
+  public toJSON (): TypeScriptFileMetadata<MetadataType> {
+    const json = super.toJSON() as TypeScriptFileMetadata<MetadataType>;
+    json.meta = this._getMetaSync();
+    return json;
+  }
+
+  private _getMetaSync (): MetadataType | null {
+    try {
+      return {} as MetadataType;
+    } catch {
+      return null;
+    }
+  }
+
+  private _getReferences (): void {
+    if (this.initialised) {
+      this.fileStructure.referenceManager.clearReferences(this.path);
+    }
+
+    tsquery(this.ast!, IMPORT_QUERY).forEach(importPath => {
+      const directoryPath = path.dirname(this.path);
+      let referencePath = path.resolve(
+        directoryPath,
+        (importPath as StringLiteral).text
+      );
+      if (referencePath.endsWith('.page')) {
+        referencePath = referencePath.replace('.page', '.po.js');
+      }
+      if (!path.extname(referencePath)) {
+        referencePath = `${referencePath}${TypeScriptFile.prototype.extension}`;
+      }
+      const reference =
+        this.fileStructure.referenceManager.getReference(referencePath);
+      if (reference) {
+        this.addReference(reference);
+      }
+    });
+
+    this.initialised = true;
+  }
+
+  private _setAST (content: string): string {
+    this.ast = tsquery.ast(content);
+    return content;
+  }
+}
+
+TypeScriptFile.prototype.extension = '.ts';

packages/file-structure/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tractor/file-structure",
-  "version": "1.9.4-alpha.4",
+  "version": "1.9.4-tractor-to-playwright.0",
   "description": "File structure handler for tractor",
   "author": "Craig Spence <[email protected]>",
   "license": "MIT",
@@ -45,10 +45,10 @@
     "@tractor/core": "^1.0.0"
   },
   "devDependencies": {
-    "@tractor/dependency-injection": "^1.9.4-alpha.4",
-    "@tractor/error-handler": "^1.9.4-alpha.4",
-    "@tractor/logger": "^1.9.4-alpha.4",
-    "@tractor/unit-test": "^1.9.4-alpha.4",
+    "@tractor/dependency-injection": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/error-handler": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/logger": "^1.9.4-tractor-to-playwright.0",
+    "@tractor/unit-test": "^1.9.4-tractor-to-playwright.0",
     "@types/body-parser": "^1.17.0",
     "@types/graceful-fs": "^4.1.3",
     "@types/node-fetch": "^2.1.6",