Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Embed UI config #107

Merged
merged 3 commits into from
Oct 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Changes


### [#107](https://github.com/jaegertracing/jaeger-ui/pull/107) Embed UI config

The query service can embed custom UI configuration into `index.html`, speeding up the initial page load and allowing custom Google Analytics tracking IDs without requiring the UI bundle to be regenerated. This also lays the ground work for other UI configuration scenarios, in the future.


### [#97](https://github.com/jaegertracing/jaeger-ui/pull/97) Change to Apache license v.2 and add DCO / CONTRIBUTING.md


Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"cytoscape-dagre": "^2.0.0",
"d3-scale": "^1.0.6",
"dagre": "^0.7.4",
"deep-freeze": "^0.0.1",
"flow-bin": "^0.53.1",
"fuzzy": "^0.1.3",
"global": "^4.3.2",
Expand Down
15 changes: 12 additions & 3 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,26 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">

<!-- prevent caching of this HTML by any server, Go or otherwise -->
<meta http-equiv="cache-control" content="max-age=0" />
<meta http-equiv="cache-control" content="no-cache" />
<meta http-equiv="expires" content="0" />
<meta http-equiv="expires" content="Tue, 01 Jan 1980 1:00:00 GMT" />
<meta http-equiv="pragma" content="no-cache" />
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">


<title>Jaeger UI</title>
<script>
// Jaeger UI config data is embedded by the query-service. This is
// later merged with defaults into the redux `state.config` via
// src/utils/config/get-config.js. The default provided by the query
// service should be an empty object or it can leave `DEFAULT_CONFIG`
// unchanged.
function getJaegerUiConfig() {
const DEFAULT_CONFIG = null;
const JAEGER_CONFIG = DEFAULT_CONFIG;
return JAEGER_CONFIG;
}
</script>
</head>
<body>
<div id="jaeger-ui-root"></div>
Expand Down
6 changes: 0 additions & 6 deletions src/actions/jaeger-api.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@
import { createAction } from 'redux-actions';
import JaegerAPI from '../api/jaeger';

/**
* async wrapper to get the api object in case we're in demo mode.
*/

export const fetchConfig = createAction('@JAEGER_API/FETCH_CONFIG', () => JaegerAPI.fetchConfig());

export const fetchTrace = createAction(
'@JAEGER_API/FETCH_TRACE',
id => JaegerAPI.fetchTrace(id),
Expand Down
3 changes: 0 additions & 3 deletions src/api/jaeger.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ export const DEFAULT_DEPENDENCY_LOOKBACK = moment.duration(1, 'weeks').asMillise

const JaegerAPI = {
apiRoot: DEFAULT_API_ROOT,
fetchConfig() {
return getJSON(`${this.apiRoot}config`).catch(err => ({ error: err }));
},
fetchTrace(id) {
return getJSON(`${this.apiRoot}traces/${id}`);
},
Expand Down
4 changes: 2 additions & 2 deletions src/components/App/Page.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import './Page.css';
type PageProps = {
location: Location,
children: React.Node,
config: { data: Config },
config: Config,
};

class Page extends React.Component<PageProps> {
Expand All @@ -49,7 +49,7 @@ class Page extends React.Component<PageProps> {

render() {
const { children, config } = this.props;
const menu = config && config.data && config.data.menu;
const menu = config && config.menu;
return (
<section className="jaeger-ui-page" id="jaeger-ui">
<Helmet title="Jaeger UI" />
Expand Down
2 changes: 0 additions & 2 deletions src/components/App/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import NotFound from './NotFound';
import { ConnectedDependencyGraphPage } from '../DependencyGraph';
import { ConnectedSearchTracePage } from '../SearchTracePage';
import { ConnectedTracePage } from '../TracePage';
import { fetchConfig } from '../../actions/jaeger-api';
import JaegerAPI, { DEFAULT_API_ROOT } from '../../api/jaeger';
import configureStore from '../../utils/configure-store';
import prefixUrl from '../../utils/prefix-url';
Expand All @@ -39,7 +38,6 @@ export default class JaegerUIApp extends Component {
super(props);
this.store = configureStore(history);
JaegerAPI.apiRoot = DEFAULT_API_ROOT;
this.store.dispatch(fetchConfig());
}

render() {
Expand Down
6 changes: 4 additions & 2 deletions src/constants/default-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@
// See the License for the specific language governing permissions and
// limitations under the License.

export default {
import deepFreeze from 'deep-freeze';

export default deepFreeze({
menu: [
{
label: 'About Jaeger',
Expand Down Expand Up @@ -44,4 +46,4 @@ export default {
],
},
],
};
});
39 changes: 5 additions & 34 deletions src/reducers/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,40 +12,11 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import { handleActions } from 'redux-actions';
import getConfig from '../utils/config/get-config';

import { fetchConfig } from '../actions/jaeger-api';
import defaultConfig from '../constants/default-config';

const initialState = {
data: {},
loading: false,
error: null,
};

function fetchStarted(state) {
return { ...state, loading: true };
}

function fetchDone(state, { payload }) {
const data = payload;
// fetchConfig action creator is set to handle rejected promises
if (data.error) {
const { message, stack } = data.error;
return { ...state, error: { message, stack }, loading: false, data: defaultConfig };
export default function reduceConfig(state) {
if (state === undefined) {
return getConfig();
}
return { ...state, data, error: null, loading: false };
return state;
}

function fetchErred(state, { payload: error }) {
return { ...state, error: error.message, loading: false, data: defaultConfig };
}

export default handleActions(
{
[`${fetchConfig}_PENDING`]: fetchStarted,
[`${fetchConfig}_FULFILLED`]: fetchDone,
[`${fetchConfig}_REJECTED`]: fetchErred,
},
initialState
);
1 change: 1 addition & 0 deletions src/types/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,6 @@ export type ConfigMenuGroup = {
};

export type Config = {
gaTrackingID?: ?string,
menu: (ConfigMenuGroup | ConfigMenuItem)[],
};
37 changes: 37 additions & 0 deletions src/utils/config/get-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// @flow

// Copyright (c) 2017 Uber Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import defaultConfig from '../../constants/default-config';

let haveWarned = false;

/**
* Merge the embedded config from the query service (if present) with the
* default config from `../../constants/default-config`.
*/
export default function getConfig() {
const getJaegerUiConfig = window.getJaegerUiConfig;
if (typeof getJaegerUiConfig !== 'function') {
if (!haveWarned) {
// eslint-disable-next-line no-console
console.warn('Embedded config not available');
haveWarned = true;
}
return { ...defaultConfig };
}
const embedded = getJaegerUiConfig() || {};
return { ...defaultConfig, ...embedded };
}
8 changes: 5 additions & 3 deletions src/utils/metrics.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@

import ReactGA from 'react-ga';

import getConfig from './config/get-config';

export function init() {
if (process.env.NODE_ENV === 'production' && process.env.REACT_APP_GA_TRACKING_ID) {
const GA_CODE = process.env.REACT_APP_GA_TRACKING_ID;
ReactGA.initialize(GA_CODE);
const config = getConfig();
if (process.env.NODE_ENV === 'production' && config.gaTrackingID) {
ReactGA.initialize(config.gaTrackingID);
}
}

Expand Down
4 changes: 4 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2095,6 +2095,10 @@ deep-extend@~0.4.0:
version "0.4.2"
resolved "https://registry.yarnpkg.com/deep-extend/-/deep-extend-0.4.2.tgz#48b699c27e334bf89f10892be432f6e4c7d34a7f"

deep-freeze@^0.0.1:
version "0.0.1"
resolved "https://registry.yarnpkg.com/deep-freeze/-/deep-freeze-0.0.1.tgz#3a0b0005de18672819dfd38cd31f91179c893e84"

deep-is@~0.1.3:
version "0.1.3"
resolved "https://registry.yarnpkg.com/deep-is/-/deep-is-0.1.3.tgz#b369d6fb5dbc13eecf524f91b070feedc357cf34"
Expand Down