Merge pull request #46 from nitrictech/feature/deployment-logging

Add basic deployment logging

Author: jyecusch

packages/common/package.json

@@ -19,13 +19,15 @@
     "eventemitter3": "^4.0.7",
     "multimatch": "^5.0.0",
     "rxjs": "^6.6.3",
+    "stream-to-promise": "^3.0.0",
     "tslib": "^1",
     "yaml": "^1.10.0"
   },
   "devDependencies": {
     "@types/jest": "^26.0.15",
     "@types/listr": "latest",
     "@types/node": "^10",
+    "@types/stream-to-promise": "^2.2.1",
     "jest": "^26.6.1",
     "openapi-types": "^7.2.3",
     "rimraf": "3.0.2",

packages/common/src/stack/stack.ts

@@ -18,7 +18,8 @@ import rimraf from 'rimraf';
 import { Function } from './function';
 import { Site } from './site';
 import { findFileRead } from '../utils';
-//import multimatch from 'multimatch';
+
+const NITRIC_DIRECTORY = '.nitric';
 
 export class Stack {
 	private file: string;
@@ -107,6 +108,43 @@ export class Stack {
 		return `${STAGING_DIR}/${this.name}`;
 	}
 
+	private async makeRelativeDirectory(directory: string): Promise<string> {
+		const dir = path.join(this.getDirectory(), directory);
+
+		if (!fs.existsSync(dir)) {
+			await fs.promises.mkdir(dir, { recursive: true })
+		}
+
+		return dir;
+	}
+
+	/**
+	 * Returns the nitric directory and creates it if it doesn't exist
+	 */
+	async makeNitricDirectory(): Promise<string> {
+		return await this.makeRelativeDirectory(`./${NITRIC_DIRECTORY}/`);
+	}
+
+	/**
+	 * Returns the nitric log directory and creates it if it doesn't exist
+	 */
+	async makeLoggingDirectory(): Promise<string> {
+		return await this.makeRelativeDirectory(`./${NITRIC_DIRECTORY}/logs/`)
+	}
+
+	/**
+	 * Returns a new log file location. If the log directories are missing, they will be created.
+	 * @param prefix used along with the current time to generate a unique log filename.
+	 */
+	async getLoggingFile(prefix: string): Promise<string> {
+		const currentTime = (new Date().getTime());
+		const logFileName = `${prefix}-${currentTime}`;
+
+		const loggingDirectory = await this.makeLoggingDirectory();
+
+		return path.join(loggingDirectory, `./${logFileName}.log`);
+	}
+
 	/**
 	 * Parse a Nitric Stack definition from the given file.
 	 *

packages/plugins/aws/src/tasks/deploy/index.ts

@@ -11,6 +11,7 @@ import { LocalWorkspace } from '@pulumi/pulumi/x/automation';
 import { ecr } from '@pulumi/aws';
 import { createSite } from './site';
 import { createEntrypoints } from './entrypoint';
+import fs from 'fs';
 
 /**
  * Common Task Options
@@ -31,7 +32,7 @@ interface DeployOptions extends CommonOptions {
 }
 
 /**
- * Deploys the given Nitric Stack to AWS as a CloudFormation Stack
+ * Deploys the given Nitric Stack
  */
 export class Deploy extends Task<void> {
 	private stack: Stack;
@@ -57,7 +58,9 @@ export class Deploy extends Task<void> {
 		this.update('Defining functions');
 
 		try {
-			// Upload the stack to AWS
+			// Upload the stack
+			const logFile = await stack.getLoggingFile('deploy:aws');
+
 			const pulumiStack = await LocalWorkspace.createOrSelectStack({
 				// TODO: Incorporate additional stack detail. E.g. dev/test/prod
 				stackName: 'aws',
@@ -93,8 +96,14 @@ export class Deploy extends Task<void> {
 				},
 			});
 			await pulumiStack.setConfig('aws:region', { value: region });
+			const update = this.update.bind(this);
 			// deploy the stack, tailing the logs to console
-			const upRes = await pulumiStack.up({ onOutput: this.update.bind(this) });
+			const upRes = await pulumiStack.up({
+				onOutput: (out: string) => {
+					update(out);
+					fs.appendFileSync(logFile, out);
+				},
+			});
 
 			console.log(upRes);
 		} catch (e) {

packages/plugins/azure/src/tasks/deploy/index.ts

@@ -7,6 +7,7 @@ import { createFunctionAsApp } from './function';
 import { createQueue } from './queue';
 import { createAPI } from './api';
 import * as pulumi from '@pulumi/pulumi';
+import fs from 'fs';
 //import { createSchedule } from './schedule';
 
 interface DeployOptions {
@@ -34,10 +35,9 @@ export class Deploy extends Task<void> {
 		const { stack, orgName, adminEmail, region } = this;
 		const { buckets = [], apis = [], topics = [], schedules = [], queues = [] } = stack.asNitricStack();
 
-		const messages: string[] = [];
-
 		try {
-			// Upload the stack to AWS
+			// Upload the stack
+			const logFile = await stack.getLoggingFile('deploy:azure');
 			const pulumiStack = await LocalWorkspace.createOrSelectStack({
 				// TODO: Incorporate additional stack detail. E.g. dev/test/prod
 				stackName: 'azure',
@@ -130,13 +130,12 @@ export class Deploy extends Task<void> {
 			const upRes = await pulumiStack.up({
 				onOutput: (out) => {
 					update(out);
-					messages.push(out);
+					fs.appendFileSync(logFile, out);
 				},
 			});
 			console.log(upRes);
 		} catch (e) {
 			console.log(e);
-			console.log(messages);
 		}
 	}
 }

packages/plugins/gcp/src/tasks/deploy/index.ts

@@ -9,6 +9,7 @@ import { LocalWorkspace } from '@pulumi/pulumi/x/automation';
 import { createSite } from './site';
 import { createEntrypoints } from './entrypoints';
 import * as pulumi from '@pulumi/pulumi';
+import fs from 'fs';
 
 interface CommonOptions {
 	gcpProject: string;
@@ -40,7 +41,8 @@ export class Deploy extends Task<void> {
 		const authClient = await auth.getClient();
 
 		try {
-			// Upload the stack to AWS
+			// Upload the stack
+			const logFile = await stack.getLoggingFile('deploy:gcp');
 			const pulumiStack = await LocalWorkspace.createOrSelectStack({
 				// TODO: Incorporate additional stack detail. E.g. dev/test/prod
 				stackName: 'gcp',
@@ -79,8 +81,14 @@ export class Deploy extends Task<void> {
 			});
 			await pulumiStack.setConfig('gcp:project', { value: gcpProject });
 			await pulumiStack.setConfig('gcp:region', { value: region });
+			const update = this.update.bind(this);
 			// deploy the stack, tailing the logs to console
-			const upRes = await pulumiStack.up({ onOutput: this.update.bind(this) });
+			const upRes = await pulumiStack.up({
+				onOutput: (out: string) => {
+					update(out);
+					fs.appendFileSync(logFile, out);
+				},
+			});
 
 			console.log(upRes);
 		} catch (e) {

yarn.lock

@@ -658,12 +658,14 @@ __metadata:
     "@types/jest": ^26.0.15
     "@types/listr": latest
     "@types/node": ^10
+    "@types/stream-to-promise": ^2.2.1
     eventemitter3: ^4.0.7
     jest: ^26.6.1
     multimatch: ^5.0.0
     openapi-types: ^7.2.3
     rimraf: 3.0.2
     rxjs: ^6.6.3
+    stream-to-promise: ^3.0.0
     ts-jest: ^26.4.3
     tslib: ^1
     typescript: ^3.3