feat(log): add new log service
This commit is contained in:
1 parent
6480389778
commit
14d6454eaf
16 files changed
+276
-36
No files matched your search
@@ -63,10 +63,15 @@ export class HotkeysManager {
|
||||
|
||||
definitions.forEach(definition => this.registerHotkeys(definition));
|
||||
} catch (error) {
|
||||
const { UINotificationService } = this._servicesManager.services;
|
||||
const {
|
||||
UINotificationService,
|
||||
LoggerService,
|
||||
} = this._servicesManager.services;
|
||||
const message = 'Erro while setting hotkeys';
|
||||
LoggerService.error({ error, message });
|
||||
UINotificationService.show({
|
||||
title: 'Hotkeys Manager',
|
||||
message: 'Erro while setting hotkeys',
|
||||
message,
|
||||
type: 'error',
|
||||
});
|
||||
}
|
||||
|
||||
@@ -26,6 +26,7 @@ import {
|
||||
UIModalService,
|
||||
UIDialogService,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
} from './services';
|
||||
|
||||
const OHIF = {
|
||||
@@ -60,6 +61,7 @@ const OHIF = {
|
||||
UIModalService,
|
||||
UIDialogService,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
};
|
||||
|
||||
export {
|
||||
@@ -93,6 +95,7 @@ export {
|
||||
UIModalService,
|
||||
UIDialogService,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
};
|
||||
|
||||
export { OHIF };
|
||||
|
||||
@@ -0,0 +1,67 @@
|
||||
const name = 'LoggerService';
|
||||
|
||||
const publicAPI = {
|
||||
name,
|
||||
info: _info,
|
||||
error: _error,
|
||||
setServiceImplementation,
|
||||
};
|
||||
|
||||
const serviceImplementation = {
|
||||
_info: () => console.warn('info() NOT IMPLEMENTED'),
|
||||
_error: () => console.warn('error() NOT IMPLEMENTED'),
|
||||
};
|
||||
|
||||
/**
|
||||
* Logs an info
|
||||
*
|
||||
* @param {object} props { message, displayOnConsole }
|
||||
*/
|
||||
function _info({ message, displayOnConsole }) {
|
||||
return serviceImplementation._info({
|
||||
message,
|
||||
displayOnConsole,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Logs an error
|
||||
*
|
||||
* @param {object} props { error, stack, message, displayOnConsole }
|
||||
* @returns void
|
||||
*/
|
||||
function _error({ error, stack, message, displayOnConsole }) {
|
||||
return serviceImplementation._error({
|
||||
error,
|
||||
stack,
|
||||
message,
|
||||
displayOnConsole,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param {*} {
|
||||
* info: infoImplementation,
|
||||
* error: errorImplementation,
|
||||
* }
|
||||
*/
|
||||
function setServiceImplementation({
|
||||
info: infoImplementation,
|
||||
error: errorImplementation,
|
||||
}) {
|
||||
if (infoImplementation) {
|
||||
serviceImplementation._info = infoImplementation;
|
||||
}
|
||||
if (errorImplementation) {
|
||||
serviceImplementation._error = errorImplementation;
|
||||
}
|
||||
}
|
||||
|
||||
export default {
|
||||
name,
|
||||
create: ({ configuration = {} }) => {
|
||||
return publicAPI;
|
||||
},
|
||||
};
|
||||
@@ -3,6 +3,7 @@ import UINotificationService from './UINotificationService';
|
||||
import UIModalService from './UIModalService';
|
||||
import UIDialogService from './UIDialogService';
|
||||
import MeasurementService from './MeasurementService';
|
||||
import LoggerService from './LoggerService';
|
||||
|
||||
export {
|
||||
UINotificationService,
|
||||
@@ -10,4 +11,5 @@ export {
|
||||
UIDialogService,
|
||||
ServicesManager,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
};
|
||||
@@ -0,0 +1,94 @@
|
||||
import React, { useState, createContext, useContext, useEffect } from 'react';
|
||||
import PropTypes from 'prop-types';
|
||||
|
||||
const LoggerContext = createContext(null);
|
||||
const { Provider } = LoggerContext;
|
||||
|
||||
export const useLogger = () => useContext(LoggerContext);
|
||||
|
||||
const LoggerProvider = ({ children, service }) => {
|
||||
const [state, setState] = useState({
|
||||
errors: [],
|
||||
infos: [],
|
||||
});
|
||||
|
||||
/**
|
||||
* Logs an error
|
||||
*
|
||||
* @param {object} props { error, stack, message, displayOnConsole }
|
||||
* @returns void
|
||||
*/
|
||||
const error = ({
|
||||
error = {},
|
||||
stack = '',
|
||||
message = '',
|
||||
displayOnConsole = true,
|
||||
}) => {
|
||||
const errorObject = { error, stack, message, displayOnConsole };
|
||||
setState(state => ({ ...state, errors: [...state.errors, errorObject] }));
|
||||
|
||||
if (displayOnConsole) {
|
||||
console.error(error);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Logs an info
|
||||
*
|
||||
* @param {object} props { message, displayOnConsole }
|
||||
* @returns void
|
||||
*/
|
||||
const info = ({ message = '', displayOnConsole = true }) => {
|
||||
setState(state => ({
|
||||
...state,
|
||||
infos: state.infos.push({ message, displayOnConsole }),
|
||||
}));
|
||||
|
||||
if (displayOnConsole) {
|
||||
console.info(message);
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Sets the implementation of a log service that can be used by extensions.
|
||||
*
|
||||
* @returns void
|
||||
*/
|
||||
useEffect(() => {
|
||||
if (service) {
|
||||
service.setServiceImplementation({ error, info });
|
||||
}
|
||||
}, [error, service, info]);
|
||||
|
||||
return <Provider value={{ info, error, state }}>{children}</Provider>;
|
||||
};
|
||||
|
||||
/**
|
||||
* Higher Order Component to use the log methods through a Class Component.
|
||||
*
|
||||
* @returns
|
||||
*/
|
||||
export const withLogger = Component => {
|
||||
return function WrappedComponent(props) {
|
||||
const { error, info, state } = useLogger();
|
||||
return <Component {...props} logger={{ error, info, state }} />;
|
||||
};
|
||||
};
|
||||
|
||||
LoggerProvider.defaultProps = {
|
||||
service: null,
|
||||
};
|
||||
|
||||
LoggerProvider.propTypes = {
|
||||
children: PropTypes.oneOfType([
|
||||
PropTypes.arrayOf(PropTypes.node),
|
||||
PropTypes.node,
|
||||
]).isRequired,
|
||||
service: PropTypes.shape({
|
||||
setServiceImplementation: PropTypes.func,
|
||||
}),
|
||||
};
|
||||
|
||||
export default LoggerProvider;
|
||||
|
||||
export const LogConsumer = LoggerContext.Consumer;
|
||||
@@ -18,3 +18,8 @@ export {
|
||||
withDialog,
|
||||
useDialog,
|
||||
} from './DialogProvider.js';
|
||||
export {
|
||||
default as LoggerProvider,
|
||||
withLogger,
|
||||
useLogger,
|
||||
} from './LoggerProvider.js';
|
||||
@@ -30,7 +30,7 @@ import {
|
||||
AboutContent,
|
||||
OHIFModal,
|
||||
ErrorBoundary,
|
||||
ErrorPage
|
||||
ErrorPage,
|
||||
} from './components';
|
||||
import { useDebounce, useMedia } from './hooks';
|
||||
|
||||
@@ -66,6 +66,9 @@ import {
|
||||
ModalConsumer,
|
||||
useModal,
|
||||
withModal,
|
||||
LoggerProvider,
|
||||
withLogger,
|
||||
useLogger,
|
||||
} from './contextProviders';
|
||||
|
||||
export {
|
||||
@@ -127,11 +130,14 @@ export {
|
||||
useDialog,
|
||||
ErrorBoundary,
|
||||
ErrorPage,
|
||||
LoggerProvider,
|
||||
withLogger,
|
||||
useLogger,
|
||||
// Hooks
|
||||
useDebounce,
|
||||
useMedia,
|
||||
// Utils
|
||||
ViewerbaseDragDropContext,
|
||||
asyncComponent,
|
||||
retryImport
|
||||
retryImport,
|
||||
};
|
||||
+30
-19
@@ -13,6 +13,7 @@ import {
|
||||
ModalProvider,
|
||||
DialogProvider,
|
||||
OHIFModal,
|
||||
LoggerProvider,
|
||||
ErrorBoundary,
|
||||
} from '@ohif/ui';
|
||||
|
||||
@@ -24,6 +25,7 @@ import {
|
||||
UINotificationService,
|
||||
UIModalService,
|
||||
UIDialogService,
|
||||
LoggerService,
|
||||
MeasurementService,
|
||||
utils,
|
||||
redux as reduxOHIF,
|
||||
@@ -141,6 +143,7 @@ class App extends Component {
|
||||
UIModalService,
|
||||
UIDialogService,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
]);
|
||||
_initExtensions(
|
||||
[...defaultExtensions, ...extensions],
|
||||
@@ -164,6 +167,7 @@ class App extends Component {
|
||||
UIDialogService,
|
||||
UIModalService,
|
||||
MeasurementService,
|
||||
LoggerService,
|
||||
} = servicesManager.services;
|
||||
|
||||
if (this._userManager) {
|
||||
@@ -176,18 +180,20 @@ class App extends Component {
|
||||
<UserManagerContext.Provider value={this._userManager}>
|
||||
<Router basename={routerBasename}>
|
||||
<WhiteLabelingContext.Provider value={whiteLabeling}>
|
||||
<SnackbarProvider service={UINotificationService}>
|
||||
<DialogProvider service={UIDialogService}>
|
||||
<ModalProvider
|
||||
modal={OHIFModal}
|
||||
service={UIModalService}
|
||||
>
|
||||
<OHIFStandaloneViewer
|
||||
userManager={this._userManager}
|
||||
/>
|
||||
</ModalProvider>
|
||||
</DialogProvider>
|
||||
</SnackbarProvider>
|
||||
<LoggerProvider service={LoggerService}>
|
||||
<SnackbarProvider service={UINotificationService}>
|
||||
<DialogProvider service={UIDialogService}>
|
||||
<ModalProvider
|
||||
modal={OHIFModal}
|
||||
service={UIModalService}
|
||||
>
|
||||
<OHIFStandaloneViewer
|
||||
userManager={this._userManager}
|
||||
/>
|
||||
</ModalProvider>
|
||||
</DialogProvider>
|
||||
</SnackbarProvider>
|
||||
</LoggerProvider>
|
||||
</WhiteLabelingContext.Provider>
|
||||
</Router>
|
||||
</UserManagerContext.Provider>
|
||||
@@ -206,13 +212,18 @@ class App extends Component {
|
||||
<I18nextProvider i18n={i18n}>
|
||||
<Router basename={routerBasename}>
|
||||
<WhiteLabelingContext.Provider value={whiteLabeling}>
|
||||
<SnackbarProvider service={UINotificationService}>
|
||||
<DialogProvider service={UIDialogService}>
|
||||
<ModalProvider modal={OHIFModal} service={UIModalService}>
|
||||
<OHIFStandaloneViewer />
|
||||
</ModalProvider>
|
||||
</DialogProvider>
|
||||
</SnackbarProvider>
|
||||
<LoggerProvider service={LoggerService}>
|
||||
<SnackbarProvider service={UINotificationService}>
|
||||
<DialogProvider service={UIDialogService}>
|
||||
<ModalProvider
|
||||
modal={OHIFModal}
|
||||
service={UIModalService}
|
||||
>
|
||||
<OHIFStandaloneViewer />
|
||||
</ModalProvider>
|
||||
</DialogProvider>
|
||||
</SnackbarProvider>
|
||||
</LoggerProvider>
|
||||
</WhiteLabelingContext.Provider>
|
||||
</Router>
|
||||
</I18nextProvider>
|
||||
|
||||
Reference in new issue
Block a user