Release/3.15.0 (#146)

just-at-uber · web-flow · commit 6f8027182ea9 · 2020-04-14T10:43:39.000-07:00
* Feature/auth (#142) * Adding tracing to tchannel if bridge is on context * adding in stub for domain permission * removing reset permission * removing permission API as out-of-scope for first release * 3.8.0-beta.0 * adding console logs to debug why staging2 isnt reporting jaeger tracing * 3.8.0-beta.1 * removing log for bridge * refactoring workflow list screen * fixing spinner * removing settings cog and workflows from breadcrumb * eslint and small refactor for criteria * fixing tests * 3.14.0-beta.0 * Adding history archival and visibility archival to domain settings sc… (#113) * Adding history archival and visibility archival to domain settings screen. adding unit tests * fixing integration tests * lint fixes * PR comments * Feature/archival disabled (#115) * Adding history archival and visibility archival to domain settings screen. adding unit tests * fixing integration tests * lint fixes * starting work on archival screen * starting work on archival screen. Got async working in a vue component. * adding helpers to extract enabled flags * disabled messaging working * adding unit tests * adding more unit tests * splitting disabled messaging into new component. adding more unit tests. fixing webpack to point to new babel config file. * 3.14.0-beta.1 * fixing lint * Feature/archives disabled link (#116) * Adding history archival and visibility archival to domain settings screen. adding unit tests * adding link for copy * 3.14.0-beta.2 * adding support for multiple links * 3.14.0-beta.3 * fixing styling * 3.14.0-beta.4 * Feature/update idl (#120) * updating idl to latest * updating to latest idl. Fixing napa install to clear directory before copying * fixing tests * button-fill (#121) * button-fill * end file return * error-message (#122) * error-message * end file return * grid (#123) * grid * renaming component to flex grid * renaming flex grid column to flex grid item * loading spinner (#125) * no results (#126) * renaming archives to archival. breaking out helpers into separate files * removing unused file * more replacing archives * deleting unused file * text input (#127) * split out functions into reusable helpers (#128) * Feature/rename archives archival (#129) * renaming archives to archival. breaking out helpers into separate files * removing unused file * more replacing archives * deleting unused file * archival endpoint (#130) * archival endpoint * PR comments * Feature/archival service (#134) * archival service * PR comments * adding unit tests for workflow archival service * components and style updates to use in workflow archival screen. (#132) * components and style updates to use in workflow archival screen. * final style changes to help with scrolling table * helpers used on archival screen (#133) * Feature/archival screen (#135) * Adding history archival and visibility archival to domain settings screen. adding unit tests * renaming archives to archival for consistancy * 3.14.0-beta.5 * missed some references for rename * 3.14.0-beta.6 * adding basic screen and starting work on it. * got basic screen working with mocked data. need to hook up API. * making table into component to be reused on advanced screen. * moving search bar to grid. refactoring reusable helpers. removing advanced view for now. adding in date picker to archival screen. adding status. * fixing helpers. finished UI for archival view * formatting start time and end time * styling and fixing up potential errors * adding more protections * adding nextPageToken to query. fixing bug with next page token on workflow list screen. * moving hardcoded code into service. working on getting pagination working. * creating loading spinner component to help with loading paging. * got scrolling on table mostly working. got sticky headers working. * fixing spinner scroll bar issue. * got pagination working * hooking up archival API * adding error handling * adding advanced button to toggle between basic and advanced archival views. creating button component. * completed advanced archival screen. * removing consoles * lint fixes * splitting out basic vue functions into helpers * moving helpers into separate files * splitting out helper tests * updating spec to contain describe * using getErrorMessage common helper * adding tests for global helpers. * adding unit tests for get query params. renaming statusName to statusValue. * adding tests for get range. * getStatusValue tests * adding tests for getStatus * adding test for map response * adding tests for update query from range * lint fixes * updating idl to latest * updating to latest idl. Fixing napa install to clear directory before copying * fixing tests * 3.14.0-beta.7 * fixing bug with completed status not being set correctly. allowing workflow request to be cancellable when stacking requests. * fixing unit tests * small change from PR updates * removing grid and grid-column. these are now renamed to flex grid and flex grid item * fix lint * Feature/workflow history archival (#136) * Adding history archival and visibility archival to domain settings screen. adding unit tests * renaming archives to archival for consistancy * 3.14.0-beta.5 * missed some references for rename * 3.14.0-beta.6 * adding basic screen and starting work on it. * got basic screen working with mocked data. need to hook up API. * making table into component to be reused on advanced screen. * moving search bar to grid. refactoring reusable helpers. removing advanced view for now. adding in date picker to archival screen. adding status. * fixing helpers. finished UI for archival view * formatting start time and end time * styling and fixing up potential errors * adding more protections * adding nextPageToken to query. fixing bug with next page token on workflow list screen. * moving hardcoded code into service. working on getting pagination working. * creating loading spinner component to help with loading paging. * got scrolling on table mostly working. got sticky headers working. * fixing spinner scroll bar issue. * got pagination working * hooking up archival API * adding error handling * adding advanced button to toggle between basic and advanced archival views. creating button component. * completed advanced archival screen. * removing consoles * lint fixes * splitting out basic vue functions into helpers * moving helpers into separate files * splitting out helper tests * updating spec to contain describe * using getErrorMessage common helper * adding tests for global helpers. * adding unit tests for get query params. renaming statusName to statusValue. * adding tests for get range. * getStatusValue tests * adding tests for getStatus * adding test for map response * adding tests for update query from range * lint fixes * updating idl to latest * updating to latest idl. Fixing napa install to clear directory before copying * fixing tests * 3.14.0-beta.7 * fixing bug with completed status not being set correctly. allowing workflow request to be cancellable when stacking requests. * fixing unit tests * small change from PR updates * removing grid and grid-column. these are now renamed to flex grid and flex grid item * fix lint * got part of summary information from archival record. * adding extra data points for summary endpoint fallback * fixing list overflow * Got summary information working with archived workflows * 3.14.0-beta.8 * removing archival call as it wont work when deployed to environment. * 3.14.0-beta.9 * Feature/archival tweaks (#138) * Adding history archival and visibility archival to domain settings screen. adding unit tests * renaming archives to archival for consistancy * 3.14.0-beta.5 * missed some references for rename * 3.14.0-beta.6 * adding basic screen and starting work on it. * got basic screen working with mocked data. need to hook up API. * making table into component to be reused on advanced screen. * moving search bar to grid. refactoring reusable helpers. removing advanced view for now. adding in date picker to archival screen. adding status. * fixing helpers. finished UI for archival view * formatting start time and end time * styling and fixing up potential errors * adding more protections * adding nextPageToken to query. fixing bug with next page token on workflow list screen. * moving hardcoded code into service. working on getting pagination working. * creating loading spinner component to help with loading paging. * got scrolling on table mostly working. got sticky headers working. * fixing spinner scroll bar issue. * got pagination working * hooking up archival API * adding error handling * adding advanced button to toggle between basic and advanced archival views. creating button component. * completed advanced archival screen. * removing consoles * lint fixes * splitting out basic vue functions into helpers * moving helpers into separate files * splitting out helper tests * updating spec to contain describe * using getErrorMessage common helper * adding tests for global helpers. * adding unit tests for get query params. renaming statusName to statusValue. * adding tests for get range. * getStatusValue tests * adding tests for getStatus * adding test for map response * adding tests for update query from range * lint fixes * updating idl to latest * updating to latest idl. Fixing napa install to clear directory before copying * fixing tests * 3.14.0-beta.7 * fixing bug with completed status not being set correctly. allowing workflow request to be cancellable when stacking requests. * fixing unit tests * small change from PR updates * removing grid and grid-column. these are now renamed to flex grid and flex grid item * fix lint * got part of summary information from archival record. * adding extra data points for summary endpoint fallback * fixing list overflow * Got summary information working with archived workflows * 3.14.0-beta.8 * removing archival call as it wont work when deployed to environment. * 3.14.0-beta.9 * adjusting default time range to last 24 hours to help with performance. * adding isArchived flag and presenting in UI * adding lag message. moving constant out of helper and into constants file. need to add to advanced screen * refactoring into reusable loading-message component. added to basic and advanced screen. * 3.14.0-beta.10 * 3.15.0-beta.0 * Fix/lint and test (#139) * lint fixes * fixing unit test * adding authtoken to tchannel headers * 3.15.0-beta.1 * 3.14.0-beta.11 * adding head object to request * 3.15.0-beta.2 * attaching headers correctly * 3.15.0-beta.3 * changing to allow multiple auth token headers to be set. * 3.15.0-beta.4 * removing bridge * 3.15.0-beta.5 * enable / disable terminate workflow feature (#143) * adding feature flag to help with disabling terminate button * lint * adding tests. removing logs * adding test * 3.15.0-beta.6 * switching back to name as vue doesnt support using key as prop. config will still use key * 3.15.0-beta.7 * PR comments * PR comments * PR comments * Feature/environment selector (#145) * adding feature flag to help with disabling terminate button * lint * adding tests. removing logs * adding test * 3.15.0-beta.6 * switching back to name as vue doesnt support using key as prop. config will still use key * 3.15.0-beta.7 * adding environment select component and configuration. * Removing component and opt to use v-select. adding getEnv helper to get selected env. updating constants to not use real urls. * styling dropdown * adding tests for getEnvironment. * adding feature flag and creating examples for ENVIRONMENT_LIST. * 3.15.0-beta.8 * fixing dropdown to be clickable in all of region. * 3.15.0-beta.9 * margin already being added * adding current path to location when trying to change environment * 3.15.0-beta.10 * exclude current env from list. Adding path and query to new env path * 3.15.0-beta.11 * adding tests for new helpers * eslint fixes * PR comments * 3.15.0
diff --git a/client/App.vue b/client/App.vue
@@ -1,15 +1,38 @@
 <script>
 import { version } from '../package.json';
 import logo from './assets/logo.svg';
-import { NotificationBar } from '~components';
-import { NOTIFICATION_TIMEOUT, NOTIFICATION_TYPE_SUCCESS } from '~constants';
+import { FeatureFlag, NotificationBar } from '~components';
+import {
+  ENVIRONMENT_LIST,
+  NOTIFICATION_TIMEOUT,
+  NOTIFICATION_TYPE_SUCCESS,
+} from '~constants';
+import {
+  getEnvironment,
+  getEnvironmentList,
+  getEnvironmentLocation,
+} from '~helpers';
 
 export default {
   components: {
-    NotificationBar,
+    'feature-flag': FeatureFlag,
+    'notification-bar': NotificationBar,
   },
   data() {
+    const { origin } = window.location;
+    const environmentList = ENVIRONMENT_LIST;
+
     return {
+      environment: {
+        list: getEnvironmentList({
+          environmentList,
+          origin,
+        }),
+        value: getEnvironment({
+          environmentList,
+          origin,
+        }),
+      },
       logo,
       notification: {
         message: '',
@@ -40,6 +63,19 @@ export default {
         }
       }
     },
+    onEnvironmentSelectChange(environment) {
+      if (environment === this.environment.value) {
+        return;
+      }
+
+      const { pathname, search } = window.location;
+
+      window.location = getEnvironmentLocation({
+        environment,
+        pathname,
+        search,
+      });
+    },
     onNotification({ message, type = NOTIFICATION_TYPE_SUCCESS }) {
       this.notification.message = message;
       this.notification.type = type;
@@ -71,7 +107,7 @@ export default {
 
 <template>
   <main @click="globalClick">
-    <NotificationBar
+    <notification-bar
       :message="notification.message"
       :onClose="onNotificationClose"
       :show="notification.show"
@@ -82,6 +118,17 @@ export default {
         <div v-html="logo"></div>
         <span class="version">{{ version }}</span>
       </a>
+
+      <feature-flag name="environment-select">
+        <v-select
+          class="environment-select"
+          :on-change="onEnvironmentSelectChange"
+          :options="environment.list"
+          :searchable="false"
+          :value="environment.value"
+        />
+      </feature-flag>
+
       <div class="domain" v-if="$route.params.domain">
         <a
           class="workflows"
@@ -195,6 +242,21 @@ header.top-bar
     bottom: 0;
   }
 
+  .environment-select {
+    .dropdown-toggle {
+      border-color: transparent;
+    }
+
+    .open-indicator:before {
+      border-color: uber-blue;
+    }
+
+    .selected-tag {
+      color: white;
+      font-weight: bold;
+    }
+  }
+
 body, main
   height 100%
 main
diff --git a/client/components/feature-flag/helpers.js b/client/components/feature-flag/helpers.js
@@ -0,0 +1,10 @@
+export const isFlagEnabled = ({ flagHash = {}, name = '' }) =>
+  flagHash[name] || false;
+
+export const mapFlagsToHash = (flagArray = []) => {
+  return flagArray.reduce((accumulator, { key = '', value = false }) => {
+    accumulator[key] = value;
+
+    return accumulator;
+  }, {});
+};
diff --git a/client/components/feature-flag/helpers.spec.js b/client/components/feature-flag/helpers.spec.js
@@ -0,0 +1,38 @@
+import { isFlagEnabled, mapFlagsToHash } from './helpers';
+
+describe('feature-flag helpers', () => {
+  describe('isFlagEnabled', () => {
+    it('should return false when passed name = "workflow-terminate" and flagHash = {}.', () => {
+      const name = 'workflow-terminate';
+      const flagHash = {};
+      const output = isFlagEnabled({ flagHash, name });
+
+      expect(output).toEqual(false);
+    });
+
+    it('should return true when passed name = "workflow-terminate" and flagHash = { "workflow-terminate": true }.', () => {
+      const name = 'workflow-terminate';
+      const flagHash = { 'workflow-terminate': true };
+      const output = isFlagEnabled({ flagHash, name });
+
+      expect(output).toEqual(true);
+    });
+
+    it('should return false when passed name = "workflow-terminate" and flagHash = { "workflow-terminate": false }.', () => {
+      const name = 'workflow-terminate';
+      const flagHash = { 'workflow-terminate': false };
+      const output = isFlagEnabled({ flagHash, name });
+
+      expect(output).toEqual(false);
+    });
+  });
+
+  describe('mapFlagsToHash', () => {
+    it('should return { "workflow-terminate": true } when passed flagArray = [{ key: "workflow-terminate", value: true }].', () => {
+      const flagArray = [{ key: 'workflow-terminate', value: true }];
+      const output = mapFlagsToHash(flagArray);
+
+      expect(output).toEqual({ 'workflow-terminate': true });
+    });
+  });
+});
diff --git a/client/components/feature-flag/index.vue b/client/components/feature-flag/index.vue
@@ -0,0 +1,25 @@
+<template>
+  <div class="feature-flag" v-if="isFlagEnabled">
+    <slot></slot>
+  </div>
+</template>
+
+<script>
+import featureFlags from '../../feature-flags.json';
+import { isFlagEnabled, mapFlagsToHash } from './helpers';
+
+export default {
+  name: 'feature-flag',
+  props: ['name'],
+  computed: {
+    flagHash() {
+      return mapFlagsToHash(featureFlags);
+    },
+    isFlagEnabled() {
+      const { flagHash, name } = this;
+
+      return isFlagEnabled({ flagHash, name });
+    },
+  },
+};
+</script>
diff --git a/client/components/index.js b/client/components/index.js
@@ -6,6 +6,7 @@ export { default as DetailList } from './detail-list';
 export { default as DateRangePicker } from './date-range-picker';
 export { default as DomainNavigation } from './domain-navigation';
 export { default as ErrorMessage } from './error-message';
+export { default as FeatureFlag } from './feature-flag';
 export { default as FlexGrid } from './flex-grid';
 export { default as FlexGridItem } from './flex-grid-item';
 export { default as LoadingMessage } from './loading-message';
diff --git a/client/constants.js b/client/constants.js
@@ -1,6 +1,29 @@
 export const jsonKeys = ['result', 'input', 'details', 'data', 'Error'];
 export const preKeys = jsonKeys.concat(['stackTrace', 'details.stackTrace']);
 
+export const ENVIRONMENT_LIST = [
+  // Make sure to enable "environment-select" in feature-flags.json to enable environment select.
+  //
+  // Examples:
+  //
+  // {
+  //   label: 'Production',
+  //   value: 'http://<production-url>.com',
+  // },
+  // {
+  //   label: 'Staging',
+  //   value: 'http://<staging-url>.com',
+  // },
+  // {
+  //   label: 'Development',
+  //   value: 'http://<development-url>.com',
+  // },
+  // {
+  //   label: 'Localhost',
+  //   value: 'http://localhost:8088',
+  // },
+];
+
 export const MAXIMUM_JSON_CHARACTER_LIMIT = 5000;
 export const MAXIMUM_JSON_MESSAGE =
   '\n ... to see more open full screen mode from top right arrow.';
diff --git a/client/feature-flags.json b/client/feature-flags.json
@@ -0,0 +1,10 @@
+[
+  {
+    "key": "environment-select",
+    "value": false
+  },
+  {
+    "key": "workflow-terminate",
+    "value": true
+  }
+]
diff --git a/client/helpers/get-environment-list.js b/client/helpers/get-environment-list.js
@@ -0,0 +1,2 @@
+export default ({ environmentList, origin }) =>
+  environmentList.filter(({ value }) => value !== origin);
diff --git a/client/helpers/get-environment-list.spec.js b/client/helpers/get-environment-list.spec.js
@@ -0,0 +1,27 @@
+import getEnvironmentList from './get-environment-list';
+
+describe('getEnvironmentList', () => {
+  it('should exclude the current environment from the list.', () => {
+    const environmentList = [
+      {
+        value: 'https://production-environment.com',
+      },
+      {
+        value: 'https://staging-environment.com',
+      },
+      {
+        value: 'https://development-environment.com',
+      },
+    ];
+    const origin = 'https://production-environment.com';
+    const output = getEnvironmentList({ environmentList, origin });
+
+    expect(output.length).toEqual(2);
+    expect(output[0]).toEqual({
+      value: 'https://staging-environment.com',
+    });
+    expect(output[1]).toEqual({
+      value: 'https://development-environment.com',
+    });
+  });
+});
diff --git a/client/helpers/get-environment-location.js b/client/helpers/get-environment-location.js
@@ -0,0 +1,2 @@
+export default ({ environment: { value }, pathname = '', search = '' }) =>
+  `${value}${pathname}${search}`;
diff --git a/client/helpers/get-environment-location.spec.js b/client/helpers/get-environment-location.spec.js
@@ -0,0 +1,17 @@
+import getEnvironmentLocation from './get-environment-location';
+
+describe('getEnvironmentLocation', () => {
+  it(`should return "https://production-environment.com/path/to/page?query=hello" when passed
+      environment = { value: "https://production-environment.com" }
+      pathname = "/path/to/page"
+      search = "?query=hello"`, () => {
+    const environment = { value: 'https://production-environment.com' };
+    const pathname = '/path/to/page';
+    const search = '?query=hello';
+    const output = getEnvironmentLocation({ environment, pathname, search });
+
+    expect(output).toEqual(
+      'https://production-environment.com/path/to/page?query=hello'
+    );
+  });
+});
diff --git a/client/helpers/get-environment.js b/client/helpers/get-environment.js
@@ -0,0 +1,5 @@
+export default ({ environmentList, origin }) =>
+  environmentList.find(({ value }) => value === origin) || {
+    label: 'Unknown',
+    value: origin,
+  };
diff --git a/client/helpers/get-environment.spec.js b/client/helpers/get-environment.spec.js
@@ -0,0 +1,35 @@
+import getEnvironment from './get-environment';
+
+describe('getEnvironment', () => {
+  const LOCALHOST_DOMAIN = 'http://localhost:8088';
+  const LOCALHOST_OPTION = {
+    label: 'Localhost',
+    value: LOCALHOST_DOMAIN,
+  };
+
+  const UNKNOWN_DOMAIN = 'http://unknown.domain.com';
+  const UNKNOWN_OPTION = {
+    label: 'Unknown',
+    value: UNKNOWN_DOMAIN,
+  };
+
+  const ENVIRONMENT_LIST = [LOCALHOST_OPTION];
+
+  it('should return UNKNOWN_OPTION when origin = UNKNOWN_DOMAIN and is not part of environmentList.', () => {
+    const output = getEnvironment({
+      environmentList: ENVIRONMENT_LIST,
+      origin: UNKNOWN_DOMAIN,
+    });
+
+    expect(output).toEqual(UNKNOWN_OPTION);
+  });
+
+  it('should return LOCALHOST_OPTION when origin = LOCALHOST_DOMAIN and environmentList = [LOCALHOST_OPTION].', () => {
+    const output = getEnvironment({
+      environmentList: ENVIRONMENT_LIST,
+      origin: LOCALHOST_DOMAIN,
+    });
+
+    expect(output).toEqual(LOCALHOST_OPTION);
+  });
+});
diff --git a/client/helpers/index.js b/client/helpers/index.js
@@ -1,4 +1,7 @@
 export { default as getEndTimeIsoString } from './get-end-time-iso-string';
+export { default as getEnvironment } from './get-environment';
+export { default as getEnvironmentList } from './get-environment-list';
+export { default as getEnvironmentLocation } from './get-environment-location';
 export { default as getErrorMessage } from './get-error-message';
 export { default as getJsonStringObject } from './get-json-string-object';
 export { default as getKeyValuePairs } from './get-key-value-pairs';
diff --git a/client/routes/workflow/summary.vue b/client/routes/workflow/summary.vue
@@ -1,14 +1,16 @@
 <template>
   <section class="workflow-summary">
     <aside class="actions">
-      <a
-        href=""
-        class="terminate"
-        v-show="isWorkflowRunning"
-        @click.prevent="$modal.show('confirm-termination')"
-      >
-        Terminate
-      </a>
+      <feature-flag name="workflow-terminate">
+        <a
+          href=""
+          class="terminate"
+          v-show="isWorkflowRunning"
+          @click.prevent="$modal.show('confirm-termination')"
+        >
+          Terminate
+        </a>
+      </feature-flag>
     </aside>
 
     <modal name="confirm-termination">
@@ -133,7 +135,7 @@ import moment from 'moment';
 import { TERMINATE_DEFAULT_ERROR_MESSAGE } from './constants';
 import { NOTIFICATION_TYPE_ERROR, NOTIFICATION_TYPE_SUCCESS } from '~constants';
 import { getErrorMessage } from '~helpers';
-import { BarLoader, DataViewer, DetailList } from '~components';
+import { BarLoader, DataViewer, DetailList, FeatureFlag } from '~components';
 
 export default {
   data() {
@@ -156,6 +158,7 @@ export default {
     'bar-loader': BarLoader,
     'data-viewer': DataViewer,
     'detail-list': DetailList,
+    'feature-flag': FeatureFlag,
   },
   computed: {
     workflowCloseTime() {
diff --git a/client/styles/select.styl b/client/styles/select.styl
diff --git a/package.json b/package.json
diff --git a/server/middleware/tchannel-client.js b/server/middleware/tchannel-client.js

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export default ({ environmentList, origin }) =>`
	`2`	`+ environmentList.filter(({ value }) => value !== origin);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export default ({ environment: { value }, pathname = '', search = '' }) =>`
	`2`	+ `${value}${pathname}${search}`;