refactor logger - brings back jobID and experienceName to android logs

# Why

To make it easier to find logs in GCloud Console.

# How

Basically, I copy-pasted `HackyLogglyStream` that we previously used in the project - https://github.com/expo/turtle/blob/de4837f36105c03be9afb4028241cff7459da974/src/logger/hackyLogglyStream.ts

# Test Plan

Tested locally.
<img width="487" alt="Screenshot 2019-04-15 at 15 09 37" src="https://user-images.githubusercontent.com/5256730/56135267-a3d3b200-5f90-11e9-9c96-505380b9f10c.png">

.babelrc

@@ -1,16 +0,0 @@
-{
-  "presets": [
-    ["env", {
-      "targets": {
-        "node": "8.9"
-      }
-    }]
-  ],
-  "plugins": [
-    ["module-resolver", {
-      "alias": {
-        "turtle": "./build"
-      }
-    }]
-  ]
-}

.envrc

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 source_local() {
   file=./.envrc.local
@@ -17,8 +17,7 @@ export EXPO_TURTLE_TOOLS_DIR="$(pwd)/tools"
 
 if [ -z "$EXPO_UNIVERSE_DIR" ]; then
   PATH_add $EXPO_TURTLE_TOOLS_DIR/bin
-fi
-
-if [[ $CI = "true" ]]; then
-  PATH_add $EXPO_TURTLE_TOOLS_DIR/ci/bin
+  if [ "$CI" = "true" ]; then
+    PATH_add $EXPO_TURTLE_TOOLS_DIR/ci/bin
+  fi
 fi

.gitignore

@@ -2,6 +2,7 @@
 
 node_modules
 yarn-error.log
+google-cloud-credentials.json
 
 /build/
 /workingdir/*

.ignore

@@ -0,0 +1 @@
+fixtures/

CHANGELOG.md

@@ -5,12 +5,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.6.1] - 2019-04-23
+### Added
+- Checking fastlane version before running build (turtle-cli).
 ### Changed
-- Updated iOS shell app for SDK 32 to fix AppAuth issue
+- Updated iOS shell app for SDK 32 to fix AppAuth issue.
+- Babel replaced by ttypescript.
+- Updated xdl to 53.5.3 and @expo/spawn-async to 1.4.2, so that error stack traces should be more informative now.
+### Fixed
+- Brought back `jobID` and `experienceName` fields to GCloud logs.
+### Removed
+- `buidAndroidTarballLocally.sh` script (it has been moved to expo repository - [expo/expo#4022](https://github.com/expo/expo/pull/4022)).
 
 ## [0.6.0] - 2019-04-09
 ### Changed
-- Removed Branch module from Android shell apps for all SDK versions
+- Removed Branch module from Android shell apps for all SDK versions.
 
 ## [0.5.15] - 2019-04-03
 ### Added

Dockerfile

@@ -99,9 +99,6 @@ RUN rm gradle-4.4-all.zip
 ENV GRADLE_HOME /usr/local/gradle-4.4
 ENV PATH ${GRADLE_HOME}/bin:$PATH
 
-# Install Gulp
-RUN npm install -g gulp-cli
-
 ADD . /app
 
 RUN for SDK_VERSION in `ls /app/workingdir/android/`; do \

bin/turtle.js

@@ -1,6 +1,15 @@
 #!/usr/bin/env node
 'use strict';
 
+const subcommand = process.argv[2];
+if (subcommand) {
+  const [, platform] = subcommand.split(':');
+  if (platform === 'ios' || platform === 'android') {
+    // so that logs have correct platform set
+    process.env.PLATFORM = platform;
+  }
+}
+
 require('source-map-support').install();
 require('../build/bin/env').initOfflineEnv();
 require('../build/bin/index').run('turtle');

gulpfile.js

@@ -1,91 +0,0 @@
-'use strict';
-
-const childProcess = require('child_process');
-const util = require('util');
-const path = require('path');
-
-const gulp = require('gulp');
-const babel = require('gulp-babel');
-const changed = require('gulp-changed');
-const nodemon = require('gulp-nodemon');
-const plumber = require('gulp-plumber');
-const sourcemaps = require('gulp-sourcemaps');
-const ts = require('gulp-typescript');
-const rimraf = require('rimraf');
-
-const rimrafAsync = util.promisify(rimraf);
-
-const tsProject = ts.createProject('tsconfig.json');
-
-gulp.task('clean', async () => {
-  console.log(`Removing build directories...`);
-  await rimrafAsync('build');
-});
-
-gulp.task('build:server', () => {
-  console.log(`Compiling the Node.js server JavaScript...`);
-  return tsProject
-    .src()
-    .pipe(plumber())
-    .pipe(changed('build'))
-    .pipe(sourcemaps.init())
-    .pipe(tsProject())
-    .pipe(babel())
-    .pipe(
-      sourcemaps.write('.', {
-        includeContent: false,
-        sourceRoot: '../src',
-      })
-    )
-    .pipe(gulp.dest('build'));
-});
-
-gulp.task('watch:source', async () => {
-  console.log(`Watching for changes to the Node.js server JavaScript...`);
-  gulp.watch('src/**/*.(t|j)s', gulp.series('build:server'));
-});
-
-gulp.task('watch:local', createWatchTask('development'));
-gulp.task('watch:server', createWatchTask('production'));
-
-function createWatchTask(nodeEnv) {
-  return async () => {
-    console.log(`Starting the Node.js server and watching for changes (NODE_ENV=${nodeEnv})...`);
-    // Run nodemon in a separate process to isolate its side effects on stdio streams
-    let nodeCmd = 'node';
-    if (nodeEnv === 'development') {
-      nodeCmd += ' --inspect=:9315';
-    }
-    nodemon({
-      script: './build/server.js',
-      execMap: {
-        js: nodeCmd,
-      },
-      env: {
-        NODE_ENV: nodeEnv,
-      },
-
-      watch: ['./build'],
-      stdout: false,
-      readable: false,
-    }).on('readable', function() {
-      const bunyan = childProcess.fork(
-        path.join('.', 'node_modules', '.bin', 'bunyan'),
-        ['-o', 'short', '-l', 'debug', '--color'],
-        { silent: true }
-      );
-
-      bunyan.stdout.pipe(process.stdout);
-      bunyan.stderr.pipe(process.stderr);
-      this.stdout.pipe(bunyan.stdin);
-      this.stderr.pipe(bunyan.stdin);
-    });
-  };
-}
-
-gulp.task(
-  'watch',
-  gulp.series('clean', 'build:server', gulp.parallel('watch:source', 'watch:local'))
-);
-
-gulp.task('default', gulp.series('watch'));

nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["src"],
+  "ext": "ts",
+  "ignore": ["src/**/*.test.ts"],
+  "exec": "ts-node -r tsconfig-paths/register --files src/server.ts"
+}

package.json

@@ -1,20 +1,18 @@
 {
   "name": "turtle-cli",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "The command-line tool for building standalone Expo apps",
   "preferGlobal": true,
   "scripts": {
-    "start": "EXPENV_OVERRIDES=local-common,local,local-queue expenv gulp",
+    "start": "EXPENV_OVERRIDES=local-common,local,local-queue expenv nodemon | bunyan -o short -l debug --color",
     "start:ios": "PLATFORM=ios yarn start",
     "start:android": "PLATFORM=android yarn start",
-    "watch": "EXPENV_OVERRIDES=local-common,local,local-queue expenv gulp watch:source",
     "bin:turtle": "./bin/turtle.js",
     "lint": "tslint -c tslint.json 'src/**/*.ts'",
     "lint:fix": "yarn lint --fix",
-    "prepare": "yarn build",
-    "build": "gulp build:server",
+    "prepare": "rimraf ./build && yarn build",
+    "build": "ttsc",
     "build:production": "./scripts/build.sh",
-    "build:android-tarball:local": "./scripts/android/buildAndroidTarballLocally.sh",
     "secrets:init-private": "./scripts/initPrivateSecrets.sh",
     "set-workingdir:remote": "./scripts/setWorkingdirMode.sh remote",
     "set-workingdir:local": "./scripts/setWorkingdirMode.sh local",
@@ -35,9 +33,10 @@
     "ssh:android:connect": "./scripts/ssh/connectToAndroidPod.sh",
     "ssh:ios:ips": "./scripts/ssh/findIosIps.sh",
     "set-priorities": "yarn set-priorities:local",
-    "set-priorities:local": "EXPENV_OVERRIDES=local-common,local,local-queue expenv babel-node scripts/setConfigurations.js",
-    "set-priorities:staging": "expenv babel-node scripts/setConfigurations.js",
-    "set-priorities:production": "EXPENV_OVERRIDES=prod expenv babel-node scripts/setConfigurations.js"
+    "set-priorities:default": "expenv ts-node -r tsconfig-paths/register --files src/scripts/setConfigurations.ts",
+    "set-priorities:local": "EXPENV_OVERRIDES=local-common,local,local-queue yarn set-priorities:default",
+    "set-priorities:staging": "yarn set-priorities:default",
+    "set-priorities:production": "EXPENV_OVERRIDES=prod yarn set-priorities:default"
   },
   "husky": {
     "hooks": {
@@ -84,37 +83,29 @@
     "@types/progress": "^2.0.1",
     "@types/raven": "^2.5.1",
     "@types/request": "^2.47.1",
+    "@types/semver": "^6.0.0",
     "@types/sharp": "^0.17.8",
     "@types/tar": "^4.0.0",
     "@types/uuid": "^3.4.3",
     "@types/which": "^1.3.1",
-    "babel-cli": "^6.26.0",
-    "babel-core": "^6.26.3",
-    "babel-jest": "^23.6.0",
-    "babel-plugin-module-resolver": "^3.1.1",
-    "babel-preset-env": "^1.6.1",
-    "gulp": "github:gulpjs/gulp#4.0",
-    "gulp-babel": "^7.0.1",
-    "gulp-changed": "^3.2.0",
-    "gulp-nodemon": "^2.4.1",
-    "gulp-plumber": "^1.2.0",
-    "gulp-sourcemaps": "^2.6.4",
-    "gulp-typescript": "^4.0.2",
     "husky": "^1.3.1",
     "jest": "^23.6.0",
     "lint-staged": "^8.1.5",
     "nock": "^10.0.1",
-    "nodemon": "^1.18.7",
+    "nodemon": "^1.18.11",
     "release-it": "^10.0.0",
     "rimraf": "^2.6.2",
-    "source-map-loader": "^0.2.3",
     "ts-jest": "^23.10.4",
+    "ts-node": "^8.0.3",
+    "ts-transformer-imports": "^0.4.1",
+    "tsconfig-paths": "^3.8.0",
     "tslint": "^5.10.0",
     "tslint-eslint-rules": "^5.4.0",
-    "typescript": "^3.0.1"
+    "ttypescript": "^1.5.6",
+    "typescript": "^3.4.2"
   },
   "dependencies": {
-    "@expo/spawn-async": "^1.4.0",
+    "@expo/spawn-async": "^1.4.2",
     "@google-cloud/logging-bunyan": "^0.9.5",
     "async-retry": "^1.2.1",
     "aws-sdk": "^2.226.1",
@@ -133,12 +124,13 @@
     "raven": "^2.6.2",
     "request": "^2.88.0",
     "request-progress": "^3.0.0",
+    "semver": "^6.0.0",
     "sharp": "^0.21.0",
     "source-map-support": "^0.5.6",
     "tar": "^4.4.6",
     "uuid": "^3.2.1",
     "which": "^1.3.1",
-    "xdl": "53.1.6-alpha.2"
+    "xdl": "53.5.3"
   },
   "optionalDependencies": {
     "@expo/traveling-fastlane-darwin": "^1.8.1"

scripts/android/buildAndroidTarballLocally.sh

@@ -1,32 +0,0 @@
-#!/usr/bin/env bash
-
-set -xeo pipefail
-
-ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )"/../.. && pwd )"
-ARTIFACTS_DIR="$ROOT_DIR/artifacts"
-TEMP_DIR="/tmp/android-shell-app"
-
-mkdir -p $ARTIFACTS_DIR
-rm -rf $TEMP_DIR
-mkdir -p $TEMP_DIR
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/tools-public $TEMP_DIR/tools-public
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/secrets $TEMP_DIR/secrets
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/template-files $TEMP_DIR/template-files
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/android $TEMP_DIR/android
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/package.json $TEMP_DIR/package.json
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/expokit-npm-package $TEMP_DIR/expokit-npm-package
-ln -s ${EXPO_UNIVERSE_DIR}/exponent/packages $TEMP_DIR/packages
-ln -s ${EXPO_UNIVERSE_DIR}/libraries/eslint-config-universe $TEMP_DIR/eslint-config-universe
-ln -s ${EXPO_UNIVERSE_DIR}/libraries/json-file $TEMP_DIR/json-file
-ln -s ${EXPO_UNIVERSE_DIR}/libraries/osascript $TEMP_DIR/osascript
-ln -s ${EXPO_UNIVERSE_DIR}/libraries/schemer $TEMP_DIR/schemer
-ln -s ${EXPO_UNIVERSE_DIR}/package.json $TEMP_DIR/universe-package.json
-
-# generate dynamic macros
-mkdir -p $TEMP_DIR/android/expoview/src/main/java/host/exp/exponent/generated/
-cd $TEMP_DIR/tools-public
-./generate-dynamic-macros-android.sh
-rm -rf $TEMP_DIR/secrets
-
-cd $TEMP_DIR; tar -czhf $ARTIFACTS_DIR/android-shell-builder.tar.gz .
-rm -rf $TEMP_DIR

src/bin/commands/setup.ts

@@ -6,7 +6,7 @@ import setup from 'turtle/bin/setup/setup';
 import { PLATFORMS } from 'turtle/constants';
 import logger from 'turtle/logger';
 
-const l = logger.withFields({ buildPhase: 'setting up environment' });
+const l = logger.child({ buildPhase: 'setting up environment' });
 
 function createSetupCommand(platform: string, os?: string) {
   return (program: any) => {

src/bin/setup/android/index.ts

@@ -41,7 +41,7 @@ const REQUIRED_TOOLS: IToolDefinition[] = [
   },
 ];
 const LOGGER_FIELDS = { buildPhase: 'setting up environment' };
-const l = logger.withFields(LOGGER_FIELDS);
+const l = logger.child(LOGGER_FIELDS);
 
 export default async function setup(sdkVersion?: string) {
   await checkSystem(REQUIRED_TOOLS);

src/bin/setup/android/ndk.ts

@@ -12,7 +12,7 @@ import logger from 'turtle/logger';
 const ANDROID_NDK_URL = `https://dl.google.com/android/repository/android-ndk-r10e-${os.platform()}-x86_64.zip`;
 
 const LOGGER_FIELDS = { buildPhase: 'setting up environment' };
-const l = logger.withFields(LOGGER_FIELDS);
+const l = logger.child(LOGGER_FIELDS);
 
 export default async function ensureAndroidNDKIsPresent() {
   const androidNdkDir = path.join(config.directories.androidDependenciesDir, 'ndk');

src/bin/setup/android/sdk.ts

@@ -13,7 +13,7 @@ import logger from 'turtle/logger';
 const ANDROID_SDK_URL = 'https://dl.google.com/android/repository/sdk-tools-linux-4333796.zip';
 
 const LOGGER_FIELDS = { buildPhase: 'setting up environment' };
-const l = logger.withFields(LOGGER_FIELDS);
+const l = logger.child(LOGGER_FIELDS);
 
 export default async function ensureAndroidSDKIsPresent() {
   const androidSdkDir = path.join(config.directories.androidDependenciesDir, 'sdk');

src/bin/setup/ios.ts

@@ -1,4 +1,7 @@
+import last from 'lodash/last';
+import trim from 'lodash/trim';
 import path from 'path';
+import semver from 'semver';
 
 import { ExponentTools } from 'xdl';
 
@@ -16,6 +19,19 @@ const REQUIRED_TOOLS: IToolDefinition[] = [
   {
     command: 'fastlane',
     missingDescription: 'Please check https://docs.fastlane.tools/getting-started/ios/setup/',
+    versionCheckFn: async () => {
+      const MINIMAL_VERSION = '2.99.0';
+
+      const { stdout } = await ExponentTools.spawnAsyncThrowError(
+        'fastlane',
+        ['--version'],
+        { stdio: 'pipe', env: { ...process.env, FASTLANE_SKIP_UPDATE_CHECK: '1' } },
+      );
+      const fastlaneVersion = parseFastlaneVersion(stdout);
+      if (fastlaneVersion && !semver.satisfies(fastlaneVersion, `>= ${MINIMAL_VERSION}`)) {
+        throw new Error(`Please install newer version of fastlane (>= ${MINIMAL_VERSION})`);
+      }
+    },
   },
   {
     command: 'xcode',
@@ -47,3 +63,11 @@ export default async function setup(sdkVersion?: string) {
 function formatShellAppTarballUriPath(sdkMajorVersion: string) {
   return path.join(config.directories.shellTarballsDir, PLATFORMS.IOS, `sdk${sdkMajorVersion}`);
 }
+
+function parseFastlaneVersion(stdout: string) {
+  const lastLine = last(trim(stdout).split('\n'));
+  if (!lastLine) {
+    return null;
+  }
+  return last(lastLine.split(' ')) || null;
+}

src/bin/setup/utils/common.ts

@@ -10,7 +10,7 @@ import { IShellAppDirectoryConfig } from 'turtle/builders/utils/workingdir';
 import config from 'turtle/config';
 import logger from 'turtle/logger';
 
-const l = logger.withFields({ buildPhase: 'setting up environment' });
+const l = logger.child({ buildPhase: 'setting up environment' });
 
 interface IShellAppFormaters {
   formatShellAppDirectory: (config: IShellAppDirectoryConfig) => string;

src/bin/setup/utils/toolsDetector.ts

@@ -4,17 +4,18 @@ import _which from 'which';
 import logger from 'turtle/logger';
 
 const which = util.promisify(_which);
-const l = logger.withFields({ buildPhase: 'setting up environment' });
+const l = logger.child({ buildPhase: 'setting up environment' });
 
 export interface IToolDefinition {
   command: string;
   missingDescription: string;
   testFn?: () => Promise<boolean>;
+  versionCheckFn?: () => void;
 }
 
 export async function ensureToolsAreInstalled(tools: IToolDefinition[]) {
   let isAnyToolMissing = false;
-  for (const { command, missingDescription, testFn } of tools) {
+  for (const { command, missingDescription, testFn, versionCheckFn } of tools) {
     try {
       if (testFn) {
         if (!await testFn()) {
@@ -30,6 +31,14 @@ export async function ensureToolsAreInstalled(tools: IToolDefinition[]) {
       }
       l.error({ err }, missingDescription);
     }
+    if (versionCheckFn) {
+      try {
+        await versionCheckFn();
+      } catch (err) {
+        isAnyToolMissing = true;
+        l.error({ err }, `wrong version of ${command} installed`);
+      }
+    }
   }
   if (isAnyToolMissing) {
     throw new Error('Tools required to perform standalone app build are missing. Please install them.');

src/builders/ios/archive.ts

@@ -29,7 +29,7 @@ export default async function buildArchive(ctx: IContext, job: IJob) {
 }
 
 async function buildAndSignIPA(ctx: IContext, job: IJob, keychainPath: string, manifest: any) {
-  const l = logger.withFields({ buildPhase: 'building and signing IPA' });
+  const l = logger.child({ buildPhase: 'building and signing IPA' });
   l.info('building and signing IPA');
 
   const {

src/builders/ios/simulator.ts

@@ -4,7 +4,7 @@ import { IJob } from 'turtle/job';
 import logger from 'turtle/logger';
 
 export default async function buildSimulator(ctx: IContext, job: IJob) {
-  const l = logger.withFields({ buildPhase: 'running simulator builder' });
+  const l = logger.child({ buildPhase: 'running simulator builder' });
   l.info('running simulator build');
   await runShellAppBuilder(ctx, job);
   l.info('build complete');

src/builders/utils/android/credentials.ts

@@ -12,7 +12,7 @@ import { isOffline } from 'turtle/turtleContext';
 
 async function getOrCreateCredentials(jobData: IJob): Promise<IAndroidCredentials> {
   if (!jobData.credentials) {
-    const l = logger.withFields({ buildPhase: 'generating keystore' });
+    const l = logger.child({ buildPhase: 'generating keystore' });
     const credentials: any = {};
     l.info('Creating keystore');
     const keystoreFilename = `/tmp/keystore-${jobData.id}.tmp.jks`;

src/builders/utils/ios/keychain.ts

@@ -9,7 +9,7 @@ interface IKeychain {
 }
 
 export async function create(ctx: IContext): Promise<IKeychain> {
-  const l = logger.withFields({ buildPhase: 'creating keychain' });
+  const l = logger.child({ buildPhase: 'creating keychain' });
   try {
     l.info('creating keychain...');
     const keychainInfo = await IosKeychain.createKeychain(ctx.appUUID, false);
@@ -22,7 +22,7 @@ export async function create(ctx: IContext): Promise<IKeychain> {
 }
 
 export async function remove(ctx: IContext, keychainPath: string) {
-  const l = logger.withFields({ buildPhase: 'deleting keychain' });
+  const l = logger.child({ buildPhase: 'deleting keychain' });
   try {
     l.info('delete keychain...');
     const keychainInfo = await IosKeychain.deleteKeychain({
@@ -49,7 +49,7 @@ export async function importCert(
     certPassword,
   }: { keychainPath: string; certP12: string; certPassword: string },
 ) {
-  const l = logger.withFields({ buildPhase: 'importing certificate into keychain' });
+  const l = logger.child({ buildPhase: 'importing certificate into keychain' });
   try {
     l.info('importing distribution certificate into keychain...');
     const { tempCertPath: certPath } = ctx;

src/builders/utils/uploader.ts

@@ -12,14 +12,14 @@ interface IUploadCtx {
 
 export async function uploadBuildToS3(ctx: IUploadCtx) {
   if (config.builder.fakeUpload) {
-    const l = logger.withFields({ buildPhase: 'copying build artifact' });
+    const l = logger.child({ buildPhase: 'copying build artifact' });
     const { fakeUploadBuildPath, uploadPath } = ctx;
     l.info('copying build to fake upload directory');
     await fs.copy(uploadPath, fakeUploadBuildPath as string);
     l.info(`copied build to ${fakeUploadBuildPath}`);
     return fakeUploadBuildPath as string;
   } else {
-    const l = logger.withFields({ buildPhase: 'uploading to S3' });
+    const l = logger.child({ buildPhase: 'uploading to S3' });
     l.info('uploading build artifact to S3');
     const { Location: fileLocation } = await uploadFile({
       key: ctx.s3FileKey as string,

src/config.ts

@@ -43,7 +43,7 @@ export default {
   },
   logger: {
     level: env('LOGGER_LEVEL', 'info'),
-    interval: envNum('LOGGER_INTERVAL', 5),
+    intervalMs: envNum('LOGGER_INTERVAL_MS', 5000),
     client: {
       level: env('CLIENT_LOGGER_LEVEL', 'info'),
     },

src/jobManager.ts

@@ -121,7 +121,7 @@ function failAfterMaxJobTime(priority: string, receiptHandle: string, job: any)
 
 async function build(job: any) {
   const startTimestamp = Date.now();
-  const s3Url = await logger.init(job);
+  const s3Url = await logger.initForJob(job);
   const calculateBuildDuration = () => Math.ceil((Date.now() - startTimestamp) / 1000);
 
   try {
@@ -151,7 +151,7 @@ async function build(job: any) {
     });
     return false;
   } finally {
-    await logger.cleanup(job);
+    await logger.cleanup();
   }
 }
 

src/logger/index.ts

@@ -1,92 +1,75 @@
 import bunyan from 'bunyan';
-import bunyanDebugStream from 'bunyan-debug-stream';
-import { SentryStream } from 'bunyan-sentry-stream';
-import { Client as RavenClient } from 'raven';
 
 import config from 'turtle/config';
-import * as constants from 'turtle/constants/logger';
 import { IJob } from 'turtle/job';
-import S3Stream from 'turtle/logger/s3Stream';
-import { isOffline } from 'turtle/turtleContext';
+import streams from 'turtle/logger/streams';
 
-// type error when using import
-// https://github.com/googleapis/nodejs-logging-bunyan/issues/241
-// tslint:disable-next-line:no-var-requires
-const { LoggingBunyan } = require('@google-cloud/logging-bunyan');
-
-interface IStream {
-  stream: any;
-  type?: string;
-  level?: string;
-  reemitErrorEvents?: boolean;
+interface ILoggerFields {
+  [key: string]: string | number;
 }
 
-export const s3logger = new S3Stream();
+class Logger {
+  private parentLogger: any;
+  private currentLogger: any;
 
-const streams: IStream[] = [];
+  constructor(parentLogger?: any) {
+    this.parentLogger = parentLogger || bunyan.createLogger({
+      name: 'turtle',
+      level: config.logger.level,
+      platform: config.platform,
+      ...config.deploymentEnv && { environment: config.deploymentEnv },
+      streams: Object.values(streams),
+    });
+    this.currentLogger = this.parentLogger;
+  }
 
-if (isOffline()) {
-  const prettyStdOut = new bunyanDebugStream({ forceColor: true });
-  streams.push({ stream: prettyStdOut, type: 'raw', level: config.logger.client.level });
-} else {
-  streams.push(
-    { stream: process.stdout },
-    {
-      type: 'raw',
-      stream: s3logger,
-      reemitErrorEvents: true,
-      level: config.logger.client.level,
-    },
-  );
+  public async initForJob(job: IJob) {
+    this.currentLogger = this.parentLogger.child({
+      jobID: job.id,
+      experienceName: job.experienceName,
+    });
+    const s3Url = await streams.s3.stream.init(job);
+    return s3Url;
+  }
+
+  public async cleanup() {
+    this.currentLogger = this.parentLogger;
+    await streams.s3.stream.cleanup();
+  }
+
+  public trace(...all: any[]) {
+    this.currentLogger.trace(...all);
+  }
+
+  public debug(...all: any[]) {
+    this.currentLogger.debug(...all);
+  }
+
+  public info(...all: any[]) {
+    this.currentLogger.info(...all);
+  }
+
+  public warn(...all: any[]) {
+    this.currentLogger.warn(...all);
+  }
+
+  public error(...all: any[]) {
+    this.currentLogger.error(...all);
+  }
+
+  public fatal(...all: any[]) {
+    this.currentLogger.fatal(...all);
+  }
+
+  public child(fields: ILoggerFields) {
+    const newLogger = this.currentLogger.child(fields);
+    return new Logger(newLogger);
+  }
+
+  // only for backward compatibility
+  public withFields(fields: ILoggerFields) {
+    return this.child(fields);
+  }
 }
 
-if (config.sentry.dsn && config.deploymentEnv !== 'development') {
-  const raven = new RavenClient();
-  raven.config(config.sentry.dsn, { environment: config.deploymentEnv });
-  streams.push({
-    level: 'error',
-    type: 'raw', // Mandatory type for SentryStream
-    stream: new SentryStream(raven),
-  });
-}
-
-if (config.google.credentials) {
-  const resource = {
-    type: 'generic_node',
-    labels: {
-      node_id: config.hostname,
-      location: '', // default value
-      namespace: '', // default value
-    },
-  };
-  streams.push(new LoggingBunyan({ name: 'turtle', resource }).stream('info'));
-}
-
-const logger = bunyan.createLogger({
-  name: 'turtle',
-  level: config.logger.level,
-  platform: config.platform,
-  environment: config.deploymentEnv,
-  streams,
-});
-
-logger.withFields = (extraFields: any) => withFields(logger, extraFields);
-
-logger.init = async (job: IJob) => {
-  return await s3logger.init(job);
-};
-
-logger.cleanup = async () => {
-  // a little hacky, but works
-  logger.info({ lastBuildLog: true }, 'this is the last log from this build');
-  await s3logger.waitForLogger();
-};
-
-export default logger;
-
-export function withFields(loggerObj: any, extraFields: any) {
-  return constants.LEVELS.reduce((obj, level) => {
-    obj[level] = (...args: any[]) => loggerObj[level](extraFields, ...args);
-    return obj;
-  }, {} as any);
-}
+export default new Logger();

src/logger/s3Stream.ts

@@ -1,111 +0,0 @@
-
-import EventEmitter from 'events';
-import path from 'path';
-
-import fs from 'fs-extra';
-import _ from 'lodash';
-
-import { uploadFile } from 'turtle/aws/s3';
-import config from 'turtle/config';
-import * as constants from 'turtle/constants/logger';
-import { IJob } from 'turtle/job';
-
-export default class S3Stream extends EventEmitter {
-  private s3Url: string | null;
-  private lastFlush: number | null;
-  private filePath: string | null;
-  private fileHandle: number | null;
-  private finishedPromise: Promise<any> | null;
-  private finishedPromiseResolveFn: any;
-  private secrets: any;
-
-  constructor() {
-    super();
-    this.s3Url = null;
-    this.lastFlush = null;
-    this.filePath = null;
-    this.fileHandle = null;
-    this.finishedPromise = null;
-    this.finishedPromiseResolveFn = null;
-  }
-
-  public async init(job: IJob) {
-    this.s3Url = `logs/${job.experienceName}/${job.id}`;
-    const dir = config.directories.tempS3LogsDir;
-    const exists = await fs.pathExists(dir);
-    if (!exists) {
-      await fs.mkdir(dir);
-    }
-    this.filePath = path.join(dir, job.id);
-    this.fileHandle = await fs.open(this.filePath, 'w+', 0o660);
-    this.secrets = {};
-    this.finishedPromise = new Promise((resolveFn) => (this.finishedPromiseResolveFn = resolveFn));
-    const res = await this.flush() as any;
-    return res.Location;
-  }
-
-  public async cleanup() {
-    const res = this.finishedPromiseResolveFn;
-    try {
-      await this.flush(true);
-      await fs.close(this.fileHandle as number);
-      this.fileHandle = null;
-      this.lastFlush = null;
-      this.secrets = {};
-    } finally {
-      this.finishedPromise = null;
-      this.finishedPromiseResolveFn = null;
-      res();
-    }
-  }
-
-  public flush(force = false) {
-    if (force || !this.lastFlush) {
-      return this._flush();
-    }
-    const now = Date.now();
-    if (now - this.lastFlush > config.logger.interval) {
-      return this._flush();
-    }
-  }
-
-  public write(recRaw: any) {
-    if (this.fileHandle) {
-      const rec = JSON.stringify({
-        ...recRaw,
-        level: constants.LEVELS_MAPPING[recRaw.level].toLowerCase(),
-      });
-      if (recRaw.lastBuildLog) {
-        return this.cleanup();
-      }
-      const recSanitized = Object.keys(this.secrets).reduce(
-        (acc, secret) => acc.replace(new RegExp(secret, 'g'), this.secrets[secret]),
-        rec,
-      );
-      fs
-        .write(this.fileHandle as number, `${recSanitized}\n`)
-        .then(() => {
-          this.flush();
-        });
-    }
-  }
-
-  public addSecretsToFilter(secrets: any) {
-    const filteredSecrets = secrets.filter((i: any) => i !== undefined && i !== null);
-    const replacements = filteredSecrets.map((i: any) => 'X'.repeat(i.length));
-    const toAdd = _.zipObject(filteredSecrets, replacements);
-    this.secrets = Object.assign({}, this.secrets, toAdd);
-  }
-
-  public waitForLogger() {
-    return this.finishedPromise;
-  }
-
-  private _flush() {
-    this.lastFlush = Date.now();
-    return uploadFile({
-      srcPath: this.filePath as string,
-      key: this.s3Url as string,
-    });
-  }
-}

src/logger/streams/gcloud.ts

@@ -0,0 +1,29 @@
+import config from 'turtle/config';
+
+// type error when using import
+// https://github.com/googleapis/nodejs-logging-bunyan/issues/241
+// tslint:disable-next-line:no-var-requires
+const { LoggingBunyan } = require('@google-cloud/logging-bunyan');
+
+export default function create() {
+  if (!config.google.credentials) {
+    return null;
+  }
+
+  const gcloudStream = new LoggingBunyan({
+    name: 'turtle',
+    resource: {
+      type: 'generic_node',
+      labels: {
+        node_id: config.hostname,
+        location: '', // default value
+        namespace: '', // default value
+      },
+    },
+  });
+  return {
+    level: 'info',
+    type: 'raw',
+    stream: gcloudStream,
+  };
+}

src/logger/streams/index.ts

@@ -0,0 +1,38 @@
+import pickBy from 'lodash/pickBy';
+
+import createGCloudStream from 'turtle/logger/streams/gcloud';
+import createOfflineStream from 'turtle/logger/streams/offline';
+import createS3Stream from 'turtle/logger/streams/s3';
+import createSentryStream from 'turtle/logger/streams/sentry';
+import { isOffline } from 'turtle/turtleContext';
+
+interface IStream {
+  stream: any;
+  type?: string;
+  level?: string;
+  reemitErrorEvents?: boolean;
+}
+
+interface IStreamMap {
+  [key: string]: IStream;
+}
+
+function prepareStreams(): IStreamMap {
+  if (isOffline()) {
+    return {
+      stdout: createOfflineStream(),
+    };
+  } else {
+    const allStreams = {
+      stdout: { stream: process.stdout },
+      gcloud: createGCloudStream(),
+      s3: createS3Stream(),
+      sentry: createSentryStream(),
+    };
+    return pickBy(allStreams) as IStreamMap;
+  }
+}
+
+const streams = prepareStreams();
+
+export default streams;

src/logger/streams/offline.ts

@@ -0,0 +1,11 @@
+import bunyanDebugStream from 'bunyan-debug-stream';
+import config from 'turtle/config';
+
+export default function create() {
+  const prettyStdOut = new bunyanDebugStream({ forceColor: true });
+  return {
+    stream: prettyStdOut,
+    type: 'raw',
+    level: config.logger.client.level,
+  };
+}

src/logger/streams/s3.ts

@@ -0,0 +1,106 @@
+
+import EventEmitter from 'events';
+import path from 'path';
+
+import fs from 'fs-extra';
+import _ from 'lodash';
+
+import { uploadFile } from 'turtle/aws/s3';
+import config from 'turtle/config';
+import { IJob } from 'turtle/job';
+
+export default function create() {
+  const s3 = new S3Stream();
+  return {
+    type: 'raw',
+    stream: s3,
+    reemitErrorEvents: true,
+    level: config.logger.client.level,
+  };
+}
+
+class S3Stream extends EventEmitter {
+  private s3Url: string | null = null;
+  private lastFlush: number | null = null;
+  private filePath: string | null = null;
+  private fileHandle: number | null = null;
+  private uploadingPromise: Promise<void> | null = null;
+  private uploadingPromiseResolveFn: any;
+  private waitingOnPromise: boolean = false;
+
+  public async init(job: IJob) {
+    this.s3Url = `logs/${job.experienceName}/${job.id}`;
+    const dir = config.directories.tempS3LogsDir;
+    const exists = await fs.pathExists(dir);
+    if (!exists) {
+      await fs.mkdir(dir);
+    }
+    this.filePath = path.join(dir, job.id);
+    this.fileHandle = await fs.open(this.filePath, 'w+', 0o660);
+    this.lastFlush = null;
+
+    const res = await this.flush() as any;
+    return res.Location;
+  }
+
+  public async cleanup() {
+    await this.flush(true);
+    await fs.close(this.fileHandle as number);
+    this.fileHandle = null;
+    this.waitingOnPromise = false;
+  }
+
+  public flush(force = false) {
+    if (force || !this.lastFlush) {
+      return this.flushInternal();
+    }
+    const now = Date.now();
+    if (now - this.lastFlush > config.logger.intervalMs) {
+      return this.flushInternal();
+    }
+  }
+
+  public write(rec: any) {
+    if (!this.fileHandle) {
+      return;
+    }
+    fs
+      .write(this.fileHandle as number, `${JSON.stringify(rec)}\n`)
+      .then(() => {
+        this.flush();
+      });
+  }
+
+  private flushInternal(): any {
+    this.lastFlush = Date.now();
+    if (!this.uploadingPromise) {
+      this.uploadingPromise = new Promise((res) => {
+        this.uploadingPromiseResolveFn = res;
+      });
+      return this
+        .upload()
+        .then((result) => {
+          setTimeout(() => this.uploadingPromiseResolveFn(), 0);
+          return result;
+        });
+    } else {
+      if (this.waitingOnPromise) {
+        return;
+      }
+      this.waitingOnPromise = true;
+      return this.uploadingPromise
+        .then(() => {
+          this.waitingOnPromise = false;
+          this.uploadingPromise = null;
+          return this.flushInternal();
+        });
+    }
+  }
+
+  private upload() {
+    return uploadFile({
+      srcPath: this.filePath as string,
+      key: this.s3Url as string,
+    });
+  }
+}

src/logger/streams/sentry.ts

@@ -0,0 +1,18 @@
+import { SentryStream } from 'bunyan-sentry-stream';
+import { Client as RavenClient } from 'raven';
+
+import config from 'turtle/config';
+
+export default function create() {
+  if (!config.sentry.dsn || config.deploymentEnv === 'development') {
+    return null;
+  }
+
+  const raven = new RavenClient();
+  raven.config(config.sentry.dsn, { environment: config.deploymentEnv });
+  return {
+    level: 'error',
+    type: 'raw', // Mandatory type for SentryStream
+    stream: new SentryStream(raven),
+  };
+}

src/scripts/setConfigurations.ts

@@ -1,12 +1,13 @@
-import { env } from 'turtle/utils/env';
-import { connect, RedisClient } from 'turtle/utils/redis';
+
 import { PLATFORMS } from 'turtle/constants';
+import logger from 'turtle/logger';
 import {
   createConfigurationsKey,
   createDefaultConfigurationKey,
   HIGH_CONFIGURATION,
   NORMAL_CONFIGURATION,
 } from 'turtle/utils/priorities';
+import { connect, RedisClient } from 'turtle/utils/redis';
 
 const TIMEOUT = 3000;
 
@@ -25,7 +26,6 @@ const TIMEOUT = 3000;
 // they should come back to using configurations no. 1 and 2.
 // If there are no more available configurations from the table, the default configuration is used.
 
-
 const AVAILABLE_CONFIGURATIONS_IOS = [
   HIGH_CONFIGURATION,
   HIGH_CONFIGURATION,
@@ -54,7 +54,6 @@ const AVAILABLE_CONFIGURATIONS_ANDROID = [
   NORMAL_CONFIGURATION,
 ];
 
-
 const DEFAULT_CONFIGURATION = HIGH_CONFIGURATION;
 
 async function run() {
@@ -68,6 +67,8 @@ async function run() {
   redis.disconnect();
 }
 
-run()
-  .then(() => console.log('All done'))
-  .catch(err => console.error('Error:', err));
+if (require.main === module) {
+  run()
+    .then(() => logger.info('All done'))
+    .catch((err) => logger.error('Error:', err));
+}

src/utils/redis.ts

@@ -20,7 +20,7 @@ const clientToUrl: IClientConfig = {
   [RedisClient.Configuration]: config.redis.configUrl,
 };
 
-export function connect(timeoutMs: number, type: string) {
+export function connect(timeoutMs: number, type: string): Promise<any> {
   return new Promise((resolve, reject) => {
     const redisClient = new Redis(clientToUrl[type], {
       maxRetriesPerRequest: 2,

tsconfig.json

@@ -6,17 +6,20 @@
     "sourceMap": true,
     "inlineSources": true,
     "outDir": "./build",
-    "rootDir": "./src",
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
     "esModuleInterop": true,
-    "baseUrl": "./",
+    "baseUrl": ".",
     "paths": {
       "turtle/*": ["src/*"],
     },
-    "allowJs": true
+    "allowJs": true,
+    "plugins": [
+      { "transform": "ts-transformer-imports" }
+    ]
   },
+  "include": ["src"],
   "exclude": ["node_modules", "build", "workingdir"]
 }