@joystick.js/cli-canary 0.0.0-canary.172 → 0.0.0-canary.1721

package/src/commands/push_v2/build_docker_image.js

@@ -0,0 +1,78 @@
+import { exec, execSync } from 'child_process';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fs from 'fs';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const check_docker_installation = () => {
+  try {
+    execSync('docker --version', { stdio: 'ignore' });
+    return true;
+  } catch (error) {
+    return false;
+  }
+};
+
+const build_docker_image = (
+  image_name = '',
+  context_path = '',
+  {
+    apt_deps = [],
+    npm_deps = []
+  } = {}
+) => {
+  return new Promise((resolve, reject) => {
+    if (!check_docker_installation()) {
+      process.loader.print("Push requires Docker to deploy your app. Please visit https://docs.docker.com/get-started/get-docker/ to download Docker for your OS.");
+      reject(new Error("Docker is not installed or not in the PATH"));
+      return;
+    }
+
+    process.loader.print('Building Docker image for deployment...');
+    
+    const dockerfile_path = path.join(__dirname, 'Dockerfile');
+    
+    if (!fs.existsSync(dockerfile_path)) {
+      reject(new Error(`Dockerfile not found at ${dockerfile_path}`));
+      return;
+    }
+
+    // Ensure context_path is set and contains the .build directory
+    if (!context_path || !fs.existsSync(path.join(context_path, '.build'))) {
+      reject(new Error('Invalid context path or .build directory not found'));
+      return;
+    }
+
+    // Prepare build arguments for dependencies
+    const build_args = [
+      `CUSTOM_APT_DEPS=${apt_deps.join(' ')}`,
+      `GLOBAL_NPM_PACKAGES=${npm_deps.join(' ')}`,
+      `CACHEBUST=${Date.now()}` // Add timestamp to invalidate cache
+    ].map(arg => `--build-arg ${arg}`).join(' ');
+
+    // Add --quiet flag to suppress verbose output
+    const command = `docker build --quiet ${build_args} -t ${image_name} -f "${dockerfile_path}" "${context_path}"`;
+
+    exec(command, { stdio: ['ignore', 'pipe', 'pipe'] }, (error, stdout, stderr) => {
+      if (error) {
+        console.error(`Error building Docker image: ${error.message}`);
+        reject(error);
+        return;
+      }
+      
+      // The --quiet flag will output only the image ID, which we can ignore
+      
+      // Check if stderr contains actual error messages
+      if (stderr.trim() && !stderr.includes("Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them")) {
+        console.error(`Docker build stderr: ${stderr}`);
+      }
+      
+      process.loader.print(`Successfully built Docker image: ${image_name}`);
+      resolve();
+    });
+  });
+};
+
+export default build_docker_image;

package/src/commands/push_v2/cdn_mirrors.js

@@ -0,0 +1,7 @@
+const cdn_mirrors = [
+  'https://push-versions-1.cheatcode.co',
+  'https://push-versions-2.cheatcode.co',
+  'https://push-versions-3.cheatcode.co',
+];
+
+export default cdn_mirrors;

package/src/commands/push_v2/check_if_settings_valid.js

@@ -0,0 +1,10 @@
+const check_if_settings_valid = (settings = '') => {
+  try {
+    JSON.parse(settings);
+    return true;
+  } catch (exception) {
+    return false;
+  }
+};
+
+export default check_if_settings_valid;

package/src/commands/push_v2/create_version.js

@@ -0,0 +1,20 @@
+import fetch from 'node-fetch';
+
+const create_version = (options = {}) => {
+	return fetch(`${options?.push_provision_domain}/api/versions/${options?.domain}`, {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/json',
+			'x-push-session-token': options?.session_token,
+		},
+		body: JSON.stringify(options?.body),
+	})?.then(async (response) => {
+		// NOTE: We only care about the response body here so parse it out and return it.
+		const data = await response.json();
+		return data?.data;
+	}).catch((error) => {
+		console.warn(error);
+	});
+};
+
+export default create_version;

package/src/commands/push_v2/definition.js

@@ -0,0 +1,58 @@
+import push from './index.js';
+
+const [_node, _bin, ...raw_args] = process.argv;
+
+const definition = {
+  description: 'Deploy your Joystick app using Push.',
+  args: {},
+  options: {
+    domain: {
+      flags: {
+        '-d': {
+          set: !!raw_args.includes('-d'),
+          value: !!raw_args.includes('-d') && raw_args[raw_args.indexOf('-d') + 1],
+          parent: 'push',
+        },
+        '--domain': {
+          set: !!raw_args.includes('--domain'),
+          value: !!raw_args.includes('--domain') && raw_args[raw_args.indexOf('--domain') + 1],
+          parent: 'push',
+        },
+      },
+      description: 'The domain of the app Push should deploy to.',      
+    },
+    push_server: {
+     flags: {
+       '-s': {
+         set: !!raw_args.includes('-s'),
+         value: !!raw_args.includes('-s') && raw_args[raw_args.indexOf('-s') + 1],
+         parent: 'push',
+       },
+       '--server': {
+         set: !!raw_args.includes('--server'),
+         value: !!raw_args.includes('--server') && raw_args[raw_args.indexOf('--server') + 1],
+         parent: 'push',
+       },
+     },
+     description: 'The Push provision server to target (development or production).',
+    },
+    deployment_token: {
+      flags: {
+        '-t': {
+          set: !!raw_args.includes('-t'),
+          value: !!raw_args.includes('-t') && raw_args[raw_args.indexOf('-t') + 1],
+          parent: 'push',
+        },
+        '--token': {
+          set: !!raw_args.includes('--token'),
+          value: !!raw_args.includes('--token') && raw_args[raw_args.indexOf('--token') + 1],
+          parent: 'push',
+        },
+      },
+      description: 'The deployment token for your Push user account.',
+     },    
+  },
+  command: push,
+};
+
+export default definition;

package/src/commands/push_v2/get_app_domain.js

@@ -0,0 +1,11 @@
+const get_app_domain = (provision_server = 'production') => {
+	// NOTE: Rely on provision_server CLI option flag here because that will need
+	// to be paired with the appropriate app server.
+	return {
+		development: 'http://localhost:2600',
+		staging: 'https://staging.push.cheatcode.co',
+		production: 'https://push.cheatcode.co',
+	}[provision_server];
+};
+
+export default get_app_domain;

package/src/commands/push_v2/get_deployment.js

@@ -0,0 +1,19 @@
+import fetch from 'node-fetch';
+
+const get_deployment = (options = {}) => {
+	return fetch(`${options?.push_domain}/api/deployments/${options?.domain}`, {
+		method: 'GET',
+		headers: {
+			'x-push-deployment-token': options?.deployment_token,
+			Accept: 'application/json',
+		},
+	})?.then(async (response) => {
+		// NOTE: We only care about the data in the response here so just return it.
+		const data = await response.json();
+		return data;
+	}).catch((error) => {
+		console.warn(error);
+	});
+};
+
+export default get_deployment;

package/src/commands/push_v2/get_deployment_token.js

@@ -0,0 +1,30 @@
+import os from 'os';
+import fs from 'fs';
+import path_exists from '../../lib/path_exists.js';
+
+const { readFile, mkdir, writeFile } = fs.promises;
+
+const get_deployment_token = async (deployment_token = '') => { 
+  const home_directory = os.homedir();
+
+  if (deployment_token) {
+	  if (!(await path_exists(`${home_directory}/.push`))) {
+	    await mkdir(`${home_directory}/.push`);
+	  }
+
+	  await writeFile(`${home_directory}/.push/deployment_token`, deployment_token);
+
+	  return deployment_token;
+  }
+
+  const deployment_token_path = `${home_directory}/.push/deployment_token`;
+  const deployment_token_exists = await path_exists(deployment_token_path);
+
+  if (deployment_token_exists) {
+    return readFile(deployment_token_path, 'utf-8');
+  }
+
+  return null;
+};
+
+export default get_deployment_token;

package/src/commands/push_v2/get_push_domain.js

@@ -0,0 +1,8 @@
+const get_push_domain = (push_server = 'production') => {
+	return {
+		development: 'http://localhost:2600',
+		production: 'https://push.cheatcode.co',
+	}[push_server];
+};
+
+export default get_push_domain;

package/src/commands/push_v2/get_settings_file.js

@@ -0,0 +1,47 @@
+import fs from 'fs';
+import cli_log from '../../lib/cli_log.js';
+import is_valid_json_string from '../../lib/is_valid_json_string.js';
+import path_exists from '../../lib/path_exists.js';
+
+const { readFile } = fs.promises;
+
+const read_settings_file = async (environment = '') => {
+  const settings_file_name = `settings.${environment}.json`;
+  const settings_file_exists = await path_exists(settings_file_name);
+
+  if (!settings_file_exists) {
+    cli_log(
+      `Could not find a ${settings_file_name} in your project. Double-check this exists and try again.`,
+      {
+        level: "danger",
+        docs: "https://cheatcode.co/docs/push/config"
+      }
+    );
+
+    return process.exit(0);
+  }
+
+  return readFile(settings_file_name, 'utf-8');
+};
+
+const get_settings_file = async (options) => {
+  const settings_file_name = `settings.${options?.environment}.json`;
+  const raw_settings_file = await read_settings_file(options?.environment);
+  const settings_file_is_valid_json = is_valid_json_string(raw_settings_file);
+
+  if (!settings_file_is_valid_json) {
+    cli_log(
+      `${settings_file_name} contains invalid JSON. Double-check the syntax and try again.`,
+      {
+        level: "danger",
+        docs: "https://cheatcode.co/docs/push/config"
+      }
+    );
+
+    return process.exit(0);
+  }
+
+  return JSON.parse(raw_settings_file);
+};
+
+export default get_settings_file;

package/src/commands/push_v2/handle_initial_deployment.js

@@ -0,0 +1,24 @@
+import fetch from "node-fetch";
+
+const handle_initial_deployment = async (options = {}) => {
+  return fetch(`${options?.push_provision_domain}/api/deployments/${options?.deployment?.domain}`, {
+   method: "POST",
+   headers: {
+     "x-push-session-token": options?.session_token,
+     'Content-Type': 'application/json',
+   },
+   body: JSON.stringify({
+     environment: options?.environment,
+     build_timestamp: options?.build_timestamp,
+     domain: options?.deployment?.domain,
+     deployment_id: options?.deployment?._id,
+   }),
+  }).then(async (response) => {
+   const data = await response.json();
+   return data?.data;
+  }).catch((error) => {
+    console.warn(error);
+  });
+};
+
+export default handle_initial_deployment;

package/src/commands/push_v2/handle_version_deployment.js

@@ -0,0 +1,23 @@
+import fetch from "node-fetch";
+
+const handle_version_deployment = async (options = {}) => {
+  return fetch(`${options?.push_provision_domain}/api/deployments/${options?.deployment?.domain}`, {
+   method: "PUT",
+   headers: {
+     "x-push-session-token": options?.session_token,
+     'Content-Type': 'application/json',
+   },
+   body: JSON.stringify({
+     build_timestamp: options?.build_timestamp,
+     domain: options?.deployment?.domain,
+     deployment_id: options?.deployment?._id,
+   }),
+  }).then(async (response) => {
+   const data = await response.json();
+   return data?.data;
+  }).catch((error) => {
+    console.warn(error);
+  });
+};
+
+export default handle_version_deployment;

package/src/commands/push_v2/index.js

@@ -0,0 +1,90 @@
+import build from '../../lib/build/index.js';
+import cli_log from '../../lib/cli_log.js';
+import get_deployment from './get_deployment.js';
+import get_push_domain from './get_push_domain.js';
+import get_settings_file from './get_settings_file.js';
+import get_deployment_token from './get_deployment_token.js';
+import upload_build_to_push from './upload_build_to_push.js';
+import Loader from '../../lib/loader.js';
+
+const get_token_for_deployment = async (input_deployment_token = '') => {
+	const deployment_token = await get_deployment_token(input_deployment_token);
+
+	if (!deployment_token) {
+    cli_log(
+      'Must pass a deployment token via the -t or --token flag, or, have an existing deployment token on your machine.',
+      {
+        level: "danger",
+        docs: "https://cheatcode.co/docs/push/authentication"
+      }
+    );
+
+    return process.exit(0);
+	}
+
+	return deployment_token;
+};
+
+const push = async (args = {}, options = {}) => {
+	if (!options?.domain) {
+    cli_log(
+      `Must pass a deployment via -d or --domain flag.`,
+      {
+        level: "danger",
+        docs: "https://cheatcode.co/docs/push/cli"
+      }
+    );
+
+    return process.exit(0);	
+	}
+
+	process.loader = new Loader();
+	process.loader.print('Starting deployment...');
+
+	const deployment_token = await get_token_for_deployment(options?.deployment_token);
+  const push_domain = get_push_domain(options?.push_server);
+
+	const deployment = await get_deployment({
+		domain: options?.domain,
+		deployment_token,
+		push_domain,
+	});
+
+	if (!deployment) {
+    cli_log(
+      `Sorry, we couldn\'t find a deployment with the domain ${options?.domain} on your account. If you haven\'t created it yet, head over to the Push dashboard: https://push.cheatcode.co/deployments/create`,
+      {
+        level: "danger",
+        docs: "https://cheatcode.co/docs/push/deployments/create-a-new-deployment"
+      }
+    );
+
+    return process.exit(0);		
+	}
+
+	const environment = deployment?.environment || 'production';
+	const build_timestamp = new Date().toISOString();
+	const settings = await get_settings_file({ environment });
+		
+	await build({
+		environment,
+		encrypt_build: true,
+		encryption_key: deployment?.deployment_secret,
+		silence_confirmation: true,
+	});
+
+	process.loader.print('Deploying to Push...');
+
+	await upload_build_to_push({
+		build_timestamp,
+		deployment,
+		deployment_token,
+		push_domain,
+		settings,
+	});
+
+	process.loader.print('Deploying...')
+	console.log(deployment?.intial_deployment_completed ? `\nMonitor your deployment at ${push_domain}/deployments/${deployment?._id}.\n` : `\nFinish your deployment's setup at ${push_domain}/deployments/${deployment?._id}/setup.\n`);
+};
+
+export default push;

package/src/commands/push_v2/prompts/confirm_deployment.js

@@ -0,0 +1,73 @@
+import AsciiTable from 'ascii-table';
+import chalk from 'chalk';
+
+const render_instance_row = (table, [continent_name = '', continent_instances = []]) => {
+	table.addRow(`${chalk.magenta(continent_name)}\n`);
+
+	for (let i = 0; i < continent_instances?.length; i += 1) {
+		const instance = continent_instances[i];
+		table.addRow(
+			`${chalk.yellow(instance?.provider)} (${chalk.green(instance?.region)})`,
+			`${chalk.white(instance?.size)}  $${chalk.green(instance?.pricePerMonth)}/mo.  x${chalk.blue(instance?.quantity)}  ${chalk.white('=')}  $${chalk.green((instance?.quantity * instance?.pricePerMonth))}/mo.${i + 1 === continent_instances?.length ? '\n' : ''}`,
+		);
+	}
+};
+
+const get_total_monthly_cost_for_instances = (instances = []) => {
+	const instances_by_continent = Object.values(instances)?.flatMap((instances_for_continent) => instances_for_continent);
+	return instances_by_continent?.reduce((total = 0, instance = {}) => {
+		total += instance?.pricePerMonth * instance?.quantity;
+		return total;
+	}, 0);
+};
+
+const confirm_deployment = (instances = {}) => {
+	const load_balancer_total_per_month = get_total_monthly_cost_for_instances(instances?.load_balancer);
+	const app_total_per_month = get_total_monthly_cost_for_instances(instances?.app);
+	const total_monthly_cost = load_balancer_total_per_month + app_total_per_month;
+
+	const table = new AsciiTable();
+
+	table.removeBorder();
+	table.addRow(`${chalk.blue('Load Balancer')}\n`);
+
+	const load_balancer_continents = Object.entries(instances?.load_balancer);
+	const app_continents = Object.entries(instances?.app);
+
+	for (let i = 0; i < load_balancer_continents?.length; i += 1) {
+		render_instance_row(table, load_balancer_continents[i]);
+	}
+
+	table.addRow(`\n  ${chalk.blue('App')}\n`);
+
+	for (let i = 0; i < app_continents?.length; i += 1) {
+		render_instance_row(table, app_continents[i]);
+	}
+	
+	table.addRow(chalk.white('\n  ---\n'));
+	
+	table.addRow(
+		chalk.green('Monthly Cost'),
+		chalk.white(`$${chalk.green(total_monthly_cost)}/mo.`)
+	);
+
+	table.addRow(
+		chalk.green('Annual Cost'),
+		chalk.white(`$${chalk.green(total_monthly_cost * 12)}/yr.`)
+	);
+
+	const is_abnormal = total_monthly_cost > 100;
+
+	return [{
+	  name: 'confirm_deployment',
+	  type: 'confirm',
+	  prefix: '',
+	  message: `\n ${chalk.greenBright('>')} Start deployment and provision these instances?`,
+	  suffix: `
+	  \n${table.toString()}
+	  ${is_abnormal ? `\n\n  ${chalk.yellowBright(`!!! >>> These costs are ${chalk.magenta('high')}. Be absolutely ${chalk.magenta('CERTAIN')} you want to run this deployment. <<< !!!`)}
+	  \n ` : '\n'}`,
+	}];
+};
+
+export default confirm_deployment;

package/src/commands/push_v2/prompts/session_token.js

@@ -0,0 +1,11 @@
+import chalk from 'chalk';
+
+const session_token = () => [{
+  name: 'session_token',
+  type: 'text',
+  prefix: '',
+  message: `\n${chalk.yellowBright('>')} To login to Push, paste your session token below:\n`,
+  suffix: `  ${chalk.yellowBright('Find your session token here:')} https://push.cheatcode.co/account/profile\n\n`,
+}];
+
+export default session_token;

package/src/commands/push_v2/upload_build_to_push.js

@@ -0,0 +1,37 @@
+import fetch from "node-fetch";
+import FormData from "form-data";
+import fs from "fs";
+import _ from 'lodash';
+
+const { readFile } = fs.promises;
+
+const upload_build_to_push = async (options = {}) => {
+  const form_data = new FormData();
+
+  form_data.append(
+    "version_tar",
+    await readFile(`.build/build.encrypted.tar.gz`),
+    `${options?.build_timestamp}.tar.gz`
+  );
+
+  form_data.append("build_timestamp", options?.build_timestamp);
+  form_data.append("domain", options?.deployment?.domain);
+  form_data.append("deployment_id", options?.deployment?._id);
+  form_data.append("settings", JSON.stringify(options?.settings));
+
+  return fetch(`${options?.push_domain}/api/deploy`, {
+   method: "POST",
+   headers: {
+     ...form_data.getHeaders(),
+     "x-push-deployment-token": options?.deployment_token,
+   },
+   body: form_data,
+  }).then(async (response) => {
+   const data = await response.json();
+   return data?.data;
+  }).catch((error) => {
+    console.warn(error);
+  });
+};
+
+export default upload_build_to_push;

package/src/commands/push_v2/validate_deployment.js

@@ -0,0 +1,19 @@
+import fetch from 'node-fetch';
+
+const validate_deployment = (options = {}) => {
+	return fetch(`${options?.push_provision_domain}/api/deployments/${options?.push_config?.domain}/validate`, {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/json',
+			'x-push-session-token': options?.session_token,
+		},
+		body: JSON.stringify(options?.push_config),
+	})?.then(async (response) => {
+		const data = await response.json();
+		return data?.data;
+	}).catch((error) => {
+		console.warn(error);
+	});
+};
+
+export default validate_deployment;

package/src/commands/push_v2/validate_push_config.js

@@ -0,0 +1,18 @@
+import fetch from 'node-fetch';
+
+const validate_push_config = (options = {}) => {
+	return fetch(`${options?.push_provision_domain}/api/validate/config`, {
+		method: 'POST',
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		body: JSON.stringify(options?.push_config),
+	})?.then(async (response) => {
+		const data = await response.json();
+		return data?.data;
+	}).catch((error) => {
+		console.warn(error);
+	});
+};
+
+export default validate_push_config;

package/src/commands/start/definition.js

@@ -0,0 +1,58 @@
+import start from './index.js';
+
+const [_node, _bin, ...raw_args] = process.argv;
+
+const definition = {
+  description: 'Start an existing Joystick app.',
+  args: {},
+  options: {
+    environment: {
+      flags: {
+        '-e': {
+          set: !!raw_args.includes('-e'),
+          value: !!raw_args.includes('-e') && raw_args[raw_args.indexOf('-e') + 1],
+          parent: 'start'
+        },
+        '--environment': {
+          set: !!raw_args.includes('--environment'),
+          value: !!raw_args.includes('--environment') && raw_args[raw_args.indexOf('--environment') + 1],
+          parent: 'start'
+        },
+      },
+      description: 'Environment to set for process.env.NODE_ENV.',
+    },
+    port: {
+      flags: {
+        '-p': {
+          set: !!raw_args.includes('-p'),
+          value: !!raw_args.includes('-p') && parseInt(raw_args[raw_args.indexOf('-p') + 1], 10),
+          parent: 'start'
+        },
+        '--port': {
+          set: !!raw_args.includes('--port'),
+          value: !!raw_args.includes('--port') && parseInt(raw_args[raw_args.indexOf('--port') + 1], 10),
+          parent: 'start'
+        },
+      },
+      description: 'Port number to run the app on.',
+    },
+    debug: {
+      flags: {
+        '-d': {
+          set: !!raw_args.includes('-d'),
+          value: !!raw_args.includes('-d'),
+          parent: 'start'
+        },
+        '--debug': {
+          set: !!raw_args.includes('--debug'),
+          value: !!raw_args.includes('--debug'),
+          parent: 'start'
+        },
+      },
+      description: 'Run the Joystick app\'s Node.js process in debug mode with --inspect.',
+    }
+  },
+  command: start,
+}
+
+export default definition;

package/src/commands/start/index.js

@@ -0,0 +1,11 @@
+import development_server from "../../lib/development_server/index.js";
+
+const start = async (args = {}, options = {}) => {
+  await development_server({
+    environment: options?.environment || 'development',
+    port: options?.port || 2600,
+    debug: !!options?.debug,
+  });
+};
+
+export default start;