Skip to content

Add zoom controls to the Trace Details Page #27

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 21, 2023
Merged

Add zoom controls to the Trace Details Page #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6b0ca2
Add zoom controls to the Trace Search Page
kshmidt-digma Jun 19, 2023
22bae2d
Add keyboard shortcuts
kshmidt-digma Jun 20, 2023
547108e
Hide zoom buttons if they are not enabled
kshmidt-digma Jun 21, 2023
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
1 change: 1 addition & 0 deletions packages/jaeger-ui/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
window.embeddedMode;
window.isUserDefinedJaegerQueryURL;
window.staticPath;
window.enableZoomControls;
</script>
</head>
<body>
Expand Down
4 changes: 4 additions & 0 deletions packages/jaeger-ui/src/Contexts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { createContext } from 'react';
import ZoomManager from './utils/ZoomManager';

export const ZoomContext = createContext<null | ZoomManager>(null);
58 changes: 43 additions & 15 deletions packages/jaeger-ui/src/components/App/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ import configureStore from '../../utils/configure-store';
import processScripts from '../../utils/config/process-scripts';
import prefixUrl from '../../utils/prefix-url';
import { isString } from '../../utils/ts/typeGuards/isString';
import ZoomManager from '../../utils/ZoomManager';
import { ZoomContext } from '../../Contexts';

import '../common/vars.css';
import '../common/utils.css';
Expand All @@ -52,6 +54,30 @@ export default class JaegerUIApp extends Component {
this.store = configureStore(history);
JaegerAPI.apiRoot = DEFAULT_API_ROOT;
processScripts();
this.zoomManager = new ZoomManager();
this._handleZoomKeyboardShortcuts = this._handleZoomKeyboardShortcuts.bind(this);
}

componentDidMount() {
document.addEventListener('keydown', this._handleZoomKeyboardShortcuts);
}

componentWillUnmount() {
document.removeEventListener('keydown', this._handleZoomKeyboardShortcuts);
}

_handleZoomKeyboardShortcuts(e) {
if (window.enableZoomControls && (e.metaKey || e.ctrlKey)) {
switch (e.key) {
case '-':
this.zoomManager.zoomOut();
break;
case '=':
this.zoomManager.zoomIn();
break;
default:
}
}
}

render() {
Expand All @@ -65,23 +91,25 @@ export default class JaegerUIApp extends Component {
return (
<Provider store={this.store}>
<ConnectedRouter history={history}>
<Page>
<Switch>
<Route path={searchPath} component={SearchTracePage} />
<Route path={traceDiffPath} component={TraceDiff} />
<Route path={tracePath} component={TracePage} />
<Route path={dependenciesPath} component={DependencyGraph} />
<Route path={deepDependenciesPath} component={DeepDependencies} />
<Route path={qualityMetricsPath} component={QualityMetrics} />
<Route path={monitorATMPath} component={MonitorATMPage} />
<ZoomContext.Provider value={this.zoomManager}>
<Page>
<Switch>
<Route path={searchPath} component={SearchTracePage} />
<Route path={traceDiffPath} component={TraceDiff} />
<Route path={tracePath} component={TracePage} />
<Route path={dependenciesPath} component={DependencyGraph} />
<Route path={deepDependenciesPath} component={DeepDependencies} />
<Route path={qualityMetricsPath} component={QualityMetrics} />
<Route path={monitorATMPath} component={MonitorATMPage} />

<Redirect exact path="/" to={searchPath} />
<Redirect exact path={prefixUrl()} to={searchPath} />
<Redirect exact path={prefixUrl('/')} to={searchPath} />
<Redirect exact path="/" to={searchPath} />
<Redirect exact path={prefixUrl()} to={searchPath} />
<Redirect exact path={prefixUrl('/')} to={searchPath} />

<Route component={NotFound} />
</Switch>
</Page>
<Route component={NotFound} />
</Switch>
</Page>
</ZoomContext.Provider>
</ConnectedRouter>
</Provider>
);
Expand Down
4 changes: 4 additions & 0 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/TracePageHeader.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,7 @@ limitations under the License.
font-size: 1.78em;
margin-right: 0.15em;
}

.TracePageHeader--zoomControls {
margin-left: 0.5em;
}
2 changes: 2 additions & 0 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/TracePageHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import { getTraceLinks } from '../../../model/link-patterns';

import './TracePageHeader.css';
import ExternalLinks from '../../common/ExternalLinks';
import ZoomControls from './ZoomControls';

type TracePageHeaderEmbedProps = {
canCollapse: boolean;
Expand Down Expand Up @@ -199,6 +200,7 @@ export function TracePageHeaderFn(props: TracePageHeaderEmbedProps & { forwarded
Archive Trace
</Button>
)}
{window.enableZoomControls && <ZoomControls className="TracePageHeader--zoomControls" />}
{showStandaloneLink && (
<Link
className="u-tx-inherit ub-nowrap ub-mx2"
Expand Down
33 changes: 33 additions & 0 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/ZoomControls.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { Button } from 'antd';
import React, { useContext } from 'react';
import ButtonGroup from 'antd/lib/button/button-group';
import { ZoomContext } from '../../../Contexts';

type ZoomControlsProps = {
className?: string;
};

const ZoomControls = (props: ZoomControlsProps) => {
const zoomManager = useContext(ZoomContext);

return (
<ButtonGroup className={props.className}>
<Button
onClick={() => {
zoomManager?.zoomOut();
}}
htmlType="button"
icon="zoom-out"
/>
<Button
onClick={() => {
zoomManager?.zoomIn();
}}
htmlType="button"
icon="zoom-in"
/>
</ButtonGroup>
);
};

export default ZoomControls;
25 changes: 25 additions & 0 deletions packages/jaeger-ui/src/utils/ZoomManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const MIN_ZOOM_LEVEL = 0.7;
const MAX_ZOOM_LEVEL = 1.5;
const ZOOM_FACTOR = 0.1;

export default class ZoomManager {
zoomLevel: number;

constructor() {
this.zoomLevel = document.body.style.zoom || 1;
}

updateStyles = () => {
document.body.style.zoom = this.zoomLevel;
};

zoomIn = () => {
this.zoomLevel = Math.min(this.zoomLevel + ZOOM_FACTOR, MAX_ZOOM_LEVEL);
this.updateStyles();
};

zoomOut = () => {
this.zoomLevel = Math.max(this.zoomLevel - ZOOM_FACTOR, MIN_ZOOM_LEVEL);
this.updateStyles();
};
}
1 change: 1 addition & 0 deletions packages/jaeger-ui/typings/custom.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ declare interface Window {
embeddedMode?: unknown;
isUserDefinedJaegerQueryURL?: unknown;
staticPath?: unknown;
enableZoomControls?: unknown
}

declare const __REACT_APP_GA_DEBUG__: string | undefined;
Expand Down