feat: add support for output manifest

Author: jeremydw

.gitignore

@@ -5,3 +5,4 @@ dist/
 docs/
 key.json
 node_modules/
+upload.json

src/commands/upload.ts

@@ -1,3 +1,5 @@
+// eslint-disable-next-line node/no-extraneous-import
+import * as _colors from 'colors';
 import * as fs from 'fs';
 import * as fsPath from 'path';
 import * as manifest from '../manifest';
@@ -11,6 +13,7 @@ interface UploadOptions {
   bucket: string;
   force?: boolean;
   googleCloudProject?: string;
+  outputFile?: string;
   ref?: string;
   site: string;
   ttl?: string;
@@ -75,7 +78,8 @@ export class UploadCommand {
       (site as string) || 'default',
       this.options.ref || gitData.ref,
       this.options.branch || gitData.branch || '',
-      gitData.commit
+      gitData.commit,
+      googleCloudProject
     );
     await manifestObj.createFromDirectory(path);
     if (config.redirectTrailingSlashes === false) {
@@ -105,5 +109,27 @@ export class UploadCommand {
       this.options.force,
       ttl
     );
+
+    if (this.options.outputFile) {
+      const data = JSON.stringify(manifestObj.toOutputJSON(), null, 2);
+      const outputDir = fsPath.dirname(this.options.outputFile);
+      if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir, {recursive: true});
+      }
+      fs.writeFileSync(this.options.outputFile, data);
+    }
+
+    console.log(
+      `Finalized upload for site: ${manifestObj.site} -> ${manifestObj.branch} @ ${manifestObj.shortSha}`
+    );
+    const cleanDate = new Date(manifestObj.commit.author.timestamp * 1000);
+    console.log(
+      `[${cleanDate.getFullYear()}-${cleanDate.getMonth()}-${cleanDate.getDate()}] <${
+        manifestObj.commit.author.email
+      }> ${manifestObj.commit.message.split('Change-Id')[0].trim()}`
+    );
+    console.log('Dashboard:'.blue + ` ${manifestObj.urls.ui}`);
+    console.log('    Build:'.blue + ` ${manifestObj.urls.stagingSha}`);
+    console.log('  Staging:'.green + ` ${manifestObj.urls.stagingBranch}`);
   }
 }

src/gitdata.ts

@@ -39,6 +39,7 @@ export async function getGitData(path: string): Promise<GitData> {
     commit: {
       message: cleanMessage,
       author: {
+        timestamp: commit.committer.timestamp,
         name: commit.author.name,
         email: commit.author.email,
       },

src/index.ts

@@ -16,6 +16,7 @@ async function main() {
     .option('-b, --branch <branch>', 'branch', '')
     .option('-f, --force', 'force', false)
     .option('-t, --ttl <ttl>', 'ttl', undefined)
+    .option('-o, --output-file <path>', 'output file', '')
     .action(async (path, options) => {
       const cmd = new UploadCommand(options);
       await cmd.run(path);

src/manifest.ts

@@ -3,6 +3,8 @@ import * as fs from 'fs';
 import * as fsPath from 'path';
 import * as mimeTypes from 'mime-types';
 
+import {branchToHostnameToken} from './server';
+
 const walk = function (path: string, newFiles?: string[]) {
   let files = newFiles || [];
   fs.readdirSync(path).forEach(file => {
@@ -34,13 +36,20 @@ export interface Redirect {
 interface GitAuthor {
   email: string;
   name: string;
+  timestamp: number;
 }
 
 export interface Commit {
   message: string;
   author: GitAuthor;
 }
 
+export interface ManifestUrls {
+  stagingBranch: string;
+  stagingSha: string;
+  ui: string;
+}
+
 export interface SerializedManifest {
   site: string;
   ref: string;
@@ -66,8 +75,15 @@ export class Manifest {
   localizationPathFormat: string;
   headers: Record<string, Record<string, string>>;
   commit: Commit;
-
-  constructor(site: string, ref: string, branch: string, commit: Commit) {
+  googleCloudProject: string;
+
+  constructor(
+    site: string,
+    ref: string,
+    branch: string,
+    commit: Commit,
+    googleCloudProject: string
+  ) {
     this.files = [];
     this.redirects = [];
     this.site = site;
@@ -78,6 +94,7 @@ export class Manifest {
     this.localizationPathFormat = DEFAULT_LOCALIZATION_PATH_FORMAT;
     this.headers = {};
     this.commit = commit;
+    this.googleCloudProject = googleCloudProject;
   }
 
   async createFromDirectory(path: string) {
@@ -136,4 +153,32 @@ export class Manifest {
     });
     return pathsToHashes;
   }
+
+  toOutputJSON() {
+    return {
+      urls: this.urls,
+      files: this.files,
+      commit: this.commit,
+    };
+  }
+
+  get urls(): ManifestUrls {
+    // TODO: Allow customizing the staging URL using `fileset.yaml` configuration.
+    const hostnameSuffix = `fileset-dot-${this.googleCloudProject}.appspot.com`;
+    const stagingShaUrl =
+      this.site === 'default'
+        ? `https://${this.shortSha}-dot-${hostnameSuffix}`
+        : `https://${this.site}-${this.shortSha}-dot-${hostnameSuffix}`;
+    const branchToken = branchToHostnameToken(this.branch);
+    const stagingBranchUrl =
+      this.site === 'default'
+        ? `https://${branchToken}-dot-${hostnameSuffix}`
+        : `https://${this.site}-${branchToken}-dot-${hostnameSuffix}`;
+    const uiUrl = `https://${hostnameSuffix}/fileset/sites/${this.site}/${this.shortSha}`;
+    return {
+      stagingBranch: stagingBranchUrl,
+      stagingSha: stagingShaUrl,
+      ui: uiUrl,
+    };
+  }
 }

src/server.test.ts

@@ -3,6 +3,14 @@ import * as server from './server';
 import {ExecutionContext} from 'ava';
 import test from 'ava';
 
+test('Test branchToHostnameToken', (t: ExecutionContext) => {
+  t.deepEqual(server.branchToHostnameToken('main'), 'main');
+  t.deepEqual(server.branchToHostnameToken('feature/foo'), 'foo');
+  t.deepEqual(server.branchToHostnameToken('workspace/foo'), 'foo');
+  t.deepEqual(server.branchToHostnameToken('b/foo'), 'foo');
+  t.deepEqual(server.branchToHostnameToken('foo/bar'), 'foo--bar');
+});
+
 test('Test parseHostname', (t: ExecutionContext) => {
   t.deepEqual(
     server.parseHostname({

src/server.ts

@@ -90,6 +90,15 @@ export const listManifests = async (siteId: string, manifestType?: string) => {
   return null;
 };
 
+export function branchToHostnameToken(branch: string) {
+  let hostname = branch;
+  for (const prefix of defaults.COMMON_BRANCH_PREFIXES) {
+    hostname = hostname.replace(prefix, '');
+  }
+  hostname = hostname.replace(/\//g, '--');
+  return hostname;
+}
+
 export function parseHostname(
   options: ParseHostnameOptions
 ): ManifestLookupOptions[] {

src/upload.ts

@@ -217,17 +217,4 @@ async function finalize(
   // const routerKey = datastore.key(['Fileset2Router', manifest.site]);
   // const router =  await datastore.get(routerKey);
   // const entity = router && router[0];
-  console.log(
-    `Finalized upload for site: ${manifest.site} -> ${manifest.branch} @ ${manifest.shortSha}`
-  );
-  // TODO: Allow customizing the staging URL using `fileset.yaml` configuration.
-  if (manifest.site === 'default') {
-    console.log(
-      `Staged: https://${manifest.shortSha}-dot-fileset-dot-${googleCloudProject}.appspot.com`
-    );
-  } else {
-    console.log(
-      `Staged: https://${manifest.site}-${manifest.shortSha}-dot-fileset-dot-${googleCloudProject}.appspot.com`
-    );
-  }
 }