chore: move tt-automation to platforms folder (#544)

package.json

@@ -30,6 +30,7 @@
     "taboule": "yarn workspace @trex/taboule",
     "shared": "yarn workspace @trex/shared",
     "guardoni": "yarn workspace guardoni",
+    "tt-automate": "yarn workspace tt-automate",
     "tk:docs": "yarn workspace @tktrex/docs",
     "tk:shared": "yarn workspace @tktrex/shared",
     "tk:backend": "yarn workspace @tktrex/backend",

platforms/guardoni/package.json

@@ -20,13 +20,10 @@
     "postinstall": "electron-builder install-app-deps",
     "prepack": "yarn build",
     "check-stealth": "ts-node ./bin/check-stealth.ts",
-    "automate:dev": "ts-node ./src/tx-automate/index.ts",
-    "automate": "node dist/index.js",
     "tdd": "jest --watch --verbose"
   },
   "bin": {
-    "cli": "./bin/guardoni-cli.js",
-    "tk-cli": "./bin/guardoni-tk-cli.js"
+    "cli": "./bin/guardoni-cli.js"
   },
   "main": "./build/electron/main.js",
   "repository": {
@@ -70,8 +67,6 @@
     "lodash": "^4.17.21",
     "nconf": "^0.11.3",
     "node-fetch": "^2.6.7",
-    "pouchdb-find": "^7.2.2",
-    "pouchdb-node": "^7.2.2",
     "puppeteer-core": "^13.7.0",
     "puppeteer-extra": "^3.2.3",
     "puppeteer-extra-plugin-stealth": "^2.9.0",
@@ -89,8 +84,6 @@
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
     "@types/lodash": "^4.14.182",
     "@types/nconf": "^0.10.2",
-    "@types/pouchdb-find": "^6.3.7",
-    "@types/pouchdb-node": "^6.1.4",
     "@types/prettier": "^2.6.3",
     "@types/react": "^17.0.45",
     "@types/react-dom": "^17.0.17",

platforms/guardoni/tsconfig.json

@@ -32,7 +32,7 @@
       "@tktrex/shared/*": ["../../tktrex/shared/src/*"]
     }
   },
-  "include": ["./src", "__mocks__", "__tests__"],
+  "include": ["./src", "__mocks__", "__tests__", "./typings"],
   "exclude": ["node_modules", "build", "dist"],
   "watchOptions": {
     "watchFile": "useFsEvents",

platforms/guardoni/webpack.config.ts

@@ -162,48 +162,6 @@ guardoniConfig.module?.rules?.push(
   }
 );
 
-const { buildENV: guardoniTkBuildEnv, ...guardoniTKConfig } = getConfig({
-  cwd: __dirname,
-  outputDir: path.resolve(__dirname, 'build/guardoni'),
-  env: t.strict({}),
-  hot: false,
-  target: 'node16',
-  entry: {
-    'tk-cli': path.resolve(__dirname, 'src/guardoni/tx-automate/index.ts'),
-  },
-});
-
-guardoniTKConfig.module?.rules?.push(
-  {
-    // this is a hack to get webpack to be able to bundle
-    // puppeteer-extra, found here:
-    // https://github.com/berstend/puppeteer-extra/issues/93
-    // this also requires the TypeScript to emit import / export statements
-    // i.e. ES6+ nodules to work
-    test: /node_modules\/puppeteer-extra\/dist\/index\.esm\.js/,
-    loader: 'string-replace-loader',
-    options: {
-      // match a require function call where the argument isn't a string
-      // also capture the first character of the args so we can ignore it later
-      search: 'require[(]([^\'"])',
-      // replace the 'require(' with a '__non_webpack_require__(', meaning it will require the files at runtime
-      // $1 grabs the first capture group from the regex, the one character we matched and don't want to lose
-      replace: '__non_webpack_require__($1',
-      flags: 'g',
-    },
-  },
-  {
-    // also part of the puppeteer-extra hack
-    test: /\.js$/,
-    use: 'unlazy-loader',
-  },
-  {
-    // this is required by canvas, part of linkedom
-    test: /\.node$/,
-    use: 'node-loader',
-  }
-);
-
 export default [
   {
     ...rendererConfig,
@@ -226,16 +184,4 @@ export default [
     },
     devtool: 'source-map',
   },
-  // guardoni TK cli
-  {
-    ...guardoniTKConfig,
-    output: {
-      ...guardoniTKConfig.output,
-      libraryTarget: 'commonjs',
-    },
-    node: {
-      __dirname: false,
-    },
-    devtool: 'source-map',
-  },
 ];

platforms/guardoni/bin/guardoni-tk-cli.js → platforms/tt-automate/bin/cli.js

@@ -2,6 +2,6 @@
 
 /* eslint-disable no-console */
 
-const { cli } = require('../build/guardoni/tk-cli.js');
+const { cli } = require('../build/cli.js');
 
 cli.parse();

platforms/tktrex/automation/package.json → platforms/tt-automate/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@trex/tt-automation",
+  "name": "tt-automate",
   "version": "2.5.4",
   "packageManager": "[email protected]",
   "engines": {
@@ -14,6 +14,9 @@
     "test": "jest --verbose",
     "tdd": "jest --watch --verbose"
   },
+  "bin": {
+    "cli": "./bin/cli.js"
+  },
   "main": "./dist/index.js",
   "devDependencies": {
     "@types/node": "^16.11.36",

platforms/tt-automate/src/config.ts

@@ -0,0 +1,11 @@
+import * as t from 'io-ts';
+
+export const MinimalProjectConfig = t.type(
+  {
+    experimentType: t.string,
+    useStealth: t.boolean,
+    proxy: t.union([t.null, t.string]),
+  },
+  'MinimalProjectConfig'
+);
+export type MinimalProjectConfig = t.TypeOf<typeof MinimalProjectConfig>;

platforms/guardoni/src/guardoni/tx-automate/platform/TikTok/experiment/french-elections.ts → platforms/tt-automate/src/platform/TikTok/experiment/french-elections.ts

@@ -6,7 +6,10 @@ import { MinimalProjectConfig } from '../../../config';
 import { ExperimentDescriptor } from '@experiment/index';
 import { decodeOrThrow } from '@util/fp';
 import { sleep } from '@util/misc';
-import { createHandleCaptcha, ensureLoggedIn } from '@platform/TikTok/util/page';
+import {
+  createHandleCaptcha,
+  ensureLoggedIn,
+} from '@platform/TikTok/util/page';
 import { parseSearchTop } from '@platform/TikTok/parser/index';
 import { loadQueriesCSV } from '@util/csv';
 import { fillInput } from '@util/page';
@@ -18,8 +21,6 @@ import {
   confirmPublicKeyNoted,
 } from '@platform/TikTok/util/project';
 
-
-
 const Config = t.intersection(
   [
     MinimalProjectConfig,

platforms/guardoni/src/guardoni/tx-automate/project/init.ts → platforms/tt-automate/src/project/init.ts

@@ -6,8 +6,6 @@ import { shellEscape } from '@util/misc';
 import { createLogger } from '@util/logger';
 import experimentDescriptors from '@experiment/descriptors';
 
-
-
 export const generateDirectoryStructure = (
   projectDirectory: string
 ): Record<string, string> => ({

platforms/guardoni/src/guardoni/tx-automate/project/run.ts → platforms/tt-automate/src/project/run.ts

@@ -3,11 +3,9 @@ import { join } from 'path';
 
 import yaml from 'yaml';
 
-import { getChromePath } from '../../utils';
+import { getChromePath } from '@guardoni/guardoni/utils';
 
-import {
-  generateDirectoryStructure,
-} from '@project/init';
+import { generateDirectoryStructure } from '@project/init';
 
 import { decodeOrThrow, rightOrThrow } from '@util/fp';
 import { fileExists } from '@util/fs';

platforms/tktrex/automation/tsconfig.json → platforms/tt-automate/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../../tsconfig.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "allowSyntheticDefaultImports": true,
     "allowJs": true,
@@ -18,23 +18,23 @@
     "lib": ["ES2021"],
     "skipLibCheck": true,
     "paths": {
-      "@shared/*": ["../../../../packages/shared/src/*"],
+      "@shared/*": ["../../../packages/shared/src/*"],
       "@tktrex/*": ["../../shared/src/*"],
-      "@guardoni/*": ["../../../../guardoni/src/*"],
+      "@guardoni/*": ["../../guardoni/src/*"],
       "@experiment/*": ["./experiment/*"],
       "@experiment": ["./experiment/index"],
       "@project/*": ["./project/*"],
       "@project": ["./project/index"],
       "@storage/*": ["./storage/*"],
       "@util/*": ["./util/*"],
-      "@TikTok/*": ["./platform/TikTok/*"]
+      "@platform/*": ["./platform/*"]
     },
     "sourceMap": true
   },
   "references": [
-    { "path": "../../../packages/shared" },
-    { "path": "../shared" },
-    { "path": "../../guardoni" }
+    { "path": "../../packages/shared" },
+    { "path": "../tktrex/shared" },
+    { "path": "../guardoni" }
   ],
   "ts-node": {
     "require": ["tsconfig-paths/register"],

platforms/tt-automate/webpack.config.ts

@@ -0,0 +1,63 @@
+import * as t from 'io-ts';
+import * as path from 'path';
+import { getConfig } from '../../packages/shared/src/webpack/config';
+import packageJson from './package.json';
+
+process.env.VERSION = packageJson.version;
+
+const { buildENV: env, ...config } = getConfig({
+  cwd: __dirname,
+  outputDir: path.resolve(__dirname, 'build'),
+  env: t.strict({}),
+  hot: false,
+  target: 'node16',
+  entry: {
+    'cli': path.resolve(__dirname, 'src/index.ts'),
+  },
+});
+
+config.module?.rules?.push(
+  {
+    // this is a hack to get webpack to be able to bundle
+    // puppeteer-extra, found here:
+    // https://github.com/berstend/puppeteer-extra/issues/93
+    // this also requires the TypeScript to emit import / export statements
+    // i.e. ES6+ nodules to work
+    test: /node_modules\/puppeteer-extra\/dist\/index\.esm\.js/,
+    loader: 'string-replace-loader',
+    options: {
+      // match a require function call where the argument isn't a string
+      // also capture the first character of the args so we can ignore it later
+      search: 'require[(]([^\'"])',
+      // replace the 'require(' with a '__non_webpack_require__(', meaning it will require the files at runtime
+      // $1 grabs the first capture group from the regex, the one character we matched and don't want to lose
+      replace: '__non_webpack_require__($1',
+      flags: 'g',
+    },
+  },
+  {
+    // also part of the puppeteer-extra hack
+    test: /\.js$/,
+    use: 'unlazy-loader',
+  },
+  {
+    // this is required by canvas, part of linkedom
+    test: /\.node$/,
+    use: 'node-loader',
+  }
+);
+
+export default [
+  // guardoni TK cli
+  {
+    ...config,
+    output: {
+      ...config.output,
+      libraryTarget: 'commonjs',
+    },
+    node: {
+      __dirname: false,
+    },
+    devtool: 'source-map',
+  },
+];