Feat(xo-web): show if NBD is used in the backup logs

vatesfr · Feb 24, 2023 · cb84cf9 · cb84cf9
1 parent cef6248
commit cb84cf9
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 13 deletions.
diff --git a/@xen-orchestra/backups/writers/DeltaBackupWriter.js b/@xen-orchestra/backups/writers/DeltaBackupWriter.js
@@ -218,7 +218,9 @@ class DeltaBackupWriter extends MixinBackupWriter(AbstractDeltaWriter) {
               $defer(() => nbdClient.disconnect())
 
               info('NBD client ready', { vdi: id, path })
+              Task.info('NBD used')
             } catch (error) {
+              Task.warning('NBD configured but unusable', { error })
               nbdClient = undefined
               warn('error connecting to NBD server', { error, vdi: id, path })
             }

diff --git a/CHANGELOG.unreleased.md b/CHANGELOG.unreleased.md
@@ -8,6 +8,7 @@
 > Users must be able to say: “Nice enhancement, I'm eager to test it”
 
 - [VM/Advanced] Warning message when enabling Windows update tools [#6627](https://github.com/vatesfr/xen-orchestra/issues/6627) (PR [#6681](https://github.com/vatesfr/xen-orchestra/issues/6681))
+- [Backup] Show if NBD is used in the backup logs (PR [#6685](https://github.com/vatesfr/xen-orchestra/issues/6685))
 
 ### Bug fixes
 
@@ -32,6 +33,7 @@
 
 <!--packages-start-->
 
+- @xen-orchestra/backups minor
 - xo-cli minor
 - xo-web minor
 

diff --git a/packages/xo-web/src/index.scss b/packages/xo-web/src/index.scss
@@ -11,18 +11,18 @@ $brand-danger: #990822;
 $brand-warning: #eca649;
 $brand-info: #044b7f;
 
-@import "../../../node_modules/bootstrap/scss/bootstrap";
+@import '../../../node_modules/bootstrap/scss/bootstrap';
 
 // imported from https://github.com/twbs/bootstrap/blob/d64466a2488bbaac9a1005db3a199a8bc6846e3e/scss/_variables.scss#L420
 .text-monospace {
-  font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+  font-family: SFMono-Regular, Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace;
 }
 
 // -------------------------------------------------------------------
 
-$fa-font-path: ".";
+$fa-font-path: '.';
 
-@import "../../../node_modules/font-awesome/scss/font-awesome";
+@import '../../../node_modules/font-awesome/scss/font-awesome';
 
 // Replace Bootstrap's glyphicons by Font Awesome.
 .glyphicon {
@@ -31,14 +31,14 @@ $fa-font-path: ".";
 
 // -------------------------------------------------------------------
 
-@import "../../../node_modules/font-mfizz/dist/font-mfizz";
+@import '../../../node_modules/font-mfizz/dist/font-mfizz';
 
 // -------------------------------------------------------------------
 
-@import "./chartist";
-@import "./meter";
-@import "./icons";
-@import "./usage";
+@import './chartist';
+@import './meter';
+@import './icons';
+@import './usage';
 
 // ROOT STYLES =================================================================
 
@@ -114,7 +114,9 @@ $select-input-height: 40px; // Bootstrap input height
   @extend .text-info;
 }
 
-.xo-status-unknown, .xo-status-paused, .xo-status-disabled {
+.xo-status-unknown,
+.xo-status-paused,
+.xo-status-disabled {
   @extend .text-muted;
 }
 
@@ -151,7 +153,8 @@ $select-input-height: 40px; // Bootstrap input height
 
 // MENU STYLE ==================================================================
 
-.xo-menu, .xo-sub-menu {
+.xo-menu,
+.xo-sub-menu {
   background: $side-menu-bg;
   color: $side-menu-color;
 }
@@ -183,7 +186,7 @@ $select-input-height: 40px; // Bootstrap input height
   opacity: 0;
   position: absolute;
   top: 0;
-  transition: opacity .3s;
+  transition: opacity 0.3s;
   visibility: hidden;
   width: max-content;
   z-index: 1000;
@@ -265,6 +268,30 @@ $select-input-height: 40px; // Bootstrap input height
   }
 }
 
+.task-info {
+  padding: 2px 10px;
+  margin: 10px 0;
+  list-style-type: none;
+  border-radius: 10px;
+  border: 1px dashed #eca649;
+
+  li {
+    margin-bottom: 10px;
+
+    &:last-child {
+      margin-bottom: 0;
+    }
+
+    strong {
+      display: block;
+      color: #eca649;
+    }
+
+    span {
+      color: grey;
+    }
+  }
+}
 .task-warning {
   padding: 2px 10px;
   margin: 10px 0;

diff --git a/packages/xo-web/src/xo-app/logs/backup-ng/log-alert-body.js b/packages/xo-web/src/xo-app/logs/backup-ng/log-alert-body.js
@@ -160,6 +160,54 @@ TaskWarnings.propTypes = {
   warnings: PropTypes.arrayOf(PropTypes.shape(TaskWarning.propTypes)),
 }
 
+class TaskInfo extends React.Component {
+  constructor(props) {
+    super(props)
+    this.state = {
+      expanded: false,
+    }
+  }
+
+  render() {
+    const className = `text-info ${this.props.data ? 'message-expandable' : ''}`
+    return (
+      <div>
+        <span className={className} onClick={() => this.setState({ expanded: !this.state.expanded })}>
+          <Icon icon='alarm' /> {this.props.message}
+        </span>
+        {this.state.expanded && this.props.data && (
+          <ul className='task-info'>
+            {Object.keys(this.props.data ?? {}).map(key => (
+              <li key={key}>
+                <strong>{key}</strong>
+                <span>{JSON.stringify(this.props.data[key])}</span>
+              </li>
+            ))}
+          </ul>
+        )}
+      </div>
+    )
+  }
+}
+
+TaskInfo.propTypes = {
+  message: PropTypes.string.isRequired,
+  data: PropTypes.object,
+}
+
+const TaskInfos = ({ infos }) =>
+  infos !== undefined ? (
+    <div>
+      {infos.map(({ message, data }, key) => (
+        <TaskInfo message={message} data={data} key={key} />
+      ))}
+    </div>
+  ) : null
+
+TaskInfos.propTypes = {
+  infos: PropTypes.arrayOf(PropTypes.shape(TaskInfo.propTypes)),
+}
+
 const VmTask = ({ children, className, restartVmJob, task }) => (
   <li className={className}>
     <Vm id={task.data.id} link newTab /> <TaskStateInfos status={task.status} />{' '}
@@ -184,6 +232,7 @@ const VmTask = ({ children, className, restartVmJob, task }) => (
       </ButtonGroup>
     )}
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     {children}
     <TaskStart task={task} />
     <TaskEnd task={task} />
@@ -211,6 +260,7 @@ const PoolTask = ({ children, className, task }) => (
   <li className={className}>
     <Pool id={task.data.id} link newTab /> <TaskStateInfos status={task.status} />
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     {children}
     <TaskStart task={task} />
     <TaskEnd task={task} />
@@ -223,6 +273,7 @@ const XoTask = ({ children, className, task }) => (
   <li className={className}>
     <Icon icon='menu-xoa' /> XO <TaskStateInfos status={task.status} />
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     {children}
     <TaskStart task={task} />
     <TaskEnd task={task} />
@@ -235,6 +286,7 @@ const SnapshotTask = ({ className, task }) => (
   <li className={className}>
     <Icon icon='task' /> {_('snapshotVmLabel')} <TaskStateInfos status={task.status} />
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     <TaskStart task={task} />
     <TaskEnd task={task} />
     <TaskError task={task} />
@@ -246,6 +298,7 @@ const CleanVmTask = ({ children, className, task }) =>
     <li className={className}>
       <Icon icon='clean-vm' /> {_('cleanVm')} <TaskStateInfos status={task.status} />
       <TaskWarnings warnings={task.warnings} />
+      <TaskInfos infos={task.infos} />
       {children}
       <TaskStart task={task} />
       <TaskEnd task={task} />
@@ -256,6 +309,7 @@ const HealthCheckTask = ({ children, className, task }) => (
   <li className={className}>
     <Icon icon='health' /> {task.message} <TaskStateInfos status={task.status} />{' '}
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     {children}
     <TaskStart task={task} />
     <TaskEnd task={task} />
@@ -287,6 +341,7 @@ const SrTask = ({ children, className, task }) => (
   <li className={className}>
     <Sr id={task.data.id} link newTab /> <TaskStateInfos status={task.status} />
     <TaskWarnings warnings={task.warnings} />
+    <TaskInfos infos={task.infos} />
     {children}
     <TaskStart task={task} />
     <TaskEnd task={task} />
@@ -315,6 +370,7 @@ const TransferMergeTask = ({ className, task }) => {
       {task.message}
       <TaskStateInfos status={task.status} />
       <TaskWarnings warnings={task.warnings} />
+      <TaskInfos infos={task.infos} />
       <TaskStart task={task} />
       <TaskEnd task={task} />
       <TaskDuration task={task} />
@@ -525,10 +581,11 @@ export default decorate([
   }),
   injectState,
   ({ state, effects }) => {
-    const { scheduleId, warnings, tasks = [] } = state.log
+    const { scheduleId, warnings, infos, tasks = [] } = state.log
     return tasks.length === 0 ? (
       <div>
         <TaskWarnings warnings={warnings} />
+        <TaskInfos infos={infos} />
         <TaskError task={state.log} />
       </div>
     ) : (
@@ -550,6 +607,7 @@ export default decorate([
           valueKey='value'
         />
         <TaskWarnings warnings={warnings} />
+        <TaskInfos infos={infos} />
         <br />
         <ul className='list-group'>
           {map(state.displayedTasks, taskLog => {