refactor(docker/swarm): migrate nodes table to react [EE-4672] (#10184)

pull/8726/head^2
Chaim Lev-Ari 2023-09-13 10:51:33 +01:00 committed by GitHub
parent fbdbd277f7
commit bf85a8861d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 210 additions and 255 deletions

View File

@ -1,188 +0,0 @@
<div class="datatable">
<rd-widget>
<rd-widget-body classes="no-padding">
<div class="toolBar">
<div class="toolBarTitle vertical-center">
<div class="widget-icon space-right">
<pr-icon icon="$ctrl.titleIcon"></pr-icon>
</div>
{{ $ctrl.titleText }}
</div>
<div class="searchBar vertical-center">
<pr-icon icon="'search'" class-name="'searchIcon'"></pr-icon>
<input
type="text"
class="searchInput"
ng-model="$ctrl.state.textFilter"
ng-change="$ctrl.onTextFilterChange()"
placeholder="Search for a node..."
auto-focus
ng-model-options="{ debounce: 300 }"
data-cy="node-searchInput"
/>
</div>
<div class="settings">
<span class="setting" ng-class="{ 'setting-active': $ctrl.settings.open }" uib-dropdown dropdown-append-to-body auto-close="disabled" is-open="$ctrl.settings.open">
<span uib-dropdown-toggle aria-label="Settings">
<pr-icon icon="'more-vertical'"></pr-icon>
</span>
<div class="dropdown-menu dropdown-menu-right" uib-dropdown-menu>
<div class="tableMenu">
<div class="menuHeader"> Table settings </div>
<div class="menuContent">
<div>
<div class="md-checkbox">
<input id="setting_auto_refresh" type="checkbox" ng-model="$ctrl.settings.repeater.autoRefresh" ng-change="$ctrl.onSettingsRepeaterChange()" />
<label for="setting_auto_refresh">Auto refresh</label>
</div>
<div ng-if="$ctrl.settings.repeater.autoRefresh">
<label for="settings_refresh_rate"> Refresh rate </label>
<select id="settings_refresh_rate" ng-model="$ctrl.settings.repeater.refreshRate" ng-change="$ctrl.onSettingsRepeaterChange()" class="small-select">
<option value="10">10s</option>
<option value="30">30s</option>
<option value="60">1min</option>
<option value="120">2min</option>
<option value="300">5min</option>
</select>
<span>
<pr-icon id="refreshRateChange" icon="'check'" mode="'success'" style="display: none"></pr-icon>
</span>
</div>
</div>
</div>
<div>
<a type="button" class="btn btn-default btn-sm" ng-click="$ctrl.settings.open = false;">Close</a>
</div>
</div>
</div>
</span>
</div>
</div>
<div class="table-responsive">
<table class="table-hover nowrap-cells table">
<thead>
<tr>
<th>
<table-column-header
col-title="'Name'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Hostname'"
is-sorted-desc="$ctrl.state.orderBy === 'Hostname' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Hostname')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'Role'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Role'"
is-sorted-desc="$ctrl.state.orderBy === 'Role' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Role')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'CPU'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'CPUs'"
is-sorted-desc="$ctrl.state.orderBy === 'CPUs' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('CPUs')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'Memory'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Memory'"
is-sorted-desc="$ctrl.state.orderBy === 'Memory' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Memory')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'Engine'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'EngineVersion'"
is-sorted-desc="$ctrl.state.orderBy === 'EngineVersion' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('EngineVersion')"
></table-column-header>
</th>
<th ng-if="$ctrl.showIpAddressColumn">
<table-column-header
col-title="'IP Address'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Addr'"
is-sorted-desc="$ctrl.state.orderBy === 'Addr' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Addr')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'Status'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Status'"
is-sorted-desc="$ctrl.state.orderBy === 'Status' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Status')"
></table-column-header>
</th>
<th>
<table-column-header
col-title="'Availability'"
can-sort="true"
is-sorted="$ctrl.state.orderBy === 'Availability'"
is-sorted-desc="$ctrl.state.orderBy === 'Availability' && $ctrl.state.reverseOrder"
ng-click="$ctrl.changeOrderBy('Availability')"
></table-column-header>
</th>
</tr>
</thead>
<tbody>
<tr
dir-paginate="item in ($ctrl.state.filteredDataSet = ($ctrl.dataset | filter:$ctrl.state.textFilter | orderBy:$ctrl.state.orderBy:$ctrl.state.reverseOrder | itemsPerPage: $ctrl.state.paginatedItemLimit))"
ng-class="{ active: item.Checked }"
>
<td>
<a ui-sref="docker.nodes.node({id: item.Id})" ng-if="$ctrl.accessToNodeDetails">{{ item.Name || item.Hostname }}</a>
<span ng-if="!$ctrl.accessToNodeDetails">{{ item.Name || item.Hostname }}</span>
</td>
<td>{{ item.Role }}</td>
<td>{{ item.CPUs / 1000000000 }}</td>
<td>{{ item.Memory | humansize }}</td>
<td>{{ item.EngineVersion }}</td>
<td ng-if="$ctrl.showIpAddressColumn">{{ item.Addr }}</td>
<td
><span class="label label-{{ item.Status | nodestatusbadge }}">{{ item.Status }}</span></td
>
<td
><span class="label label-{{ item.Availability | dockerNodeAvailabilityBadge }}">{{ item.Availability }}</span></td
>
</tr>
<tr ng-if="!$ctrl.dataset">
<td colspan="7" class="text-muted text-center">Loading...</td>
</tr>
<tr ng-if="$ctrl.state.filteredDataSet.length === 0">
<td colspan="7" class="text-muted text-center">No node available.</td>
</tr>
</tbody>
</table>
</div>
<div class="footer" ng-if="$ctrl.dataset">
<div class="paginationControls">
<form class="form-inline vertical-center">
<span class="limitSelector">
<span style="margin-right: 5px"> Items per page </span>
<select class="form-control" ng-model="$ctrl.state.paginatedItemLimit" ng-change="$ctrl.changePaginationLimit()" data-cy="component-paginationSelect">
<option value="0">All</option>
<option value="10">10</option>
<option value="25">25</option>
<option value="50">50</option>
<option value="100">100</option>
</select>
</span>
<dir-pagination-controls max-size="5"></dir-pagination-controls>
</form>
</div>
</div>
</rd-widget-body>
</rd-widget>
</div>

View File

@ -1,15 +0,0 @@
angular.module('portainer.docker').component('nodesDatatable', {
templateUrl: './nodesDatatable.html',
controller: 'GenericDatatableController',
bindings: {
titleText: '@',
titleIcon: '@',
dataset: '<',
tableKey: '@',
orderBy: '@',
reverseOrder: '<',
showIpAddressColumn: '<',
accessToNodeDetails: '<',
refreshCallback: '<',
},
});

View File

@ -1,5 +1,5 @@
import _ from 'lodash-es';
import { joinCommand, taskStatusBadge, nodeStatusBadge, trimSHA } from './utils';
import { joinCommand, taskStatusBadge, nodeStatusBadge, trimSHA, dockerNodeAvailabilityBadge } from './utils';
function includeString(text, values) {
return values.some(function (val) {
@ -76,17 +76,7 @@ angular
};
})
.filter('nodestatusbadge', () => nodeStatusBadge)
.filter('dockerNodeAvailabilityBadge', function () {
'use strict';
return function (text) {
if (text === 'pause') {
return 'warning';
} else if (text === 'drain') {
return 'danger';
}
return 'success';
};
})
.filter('dockerNodeAvailabilityBadge', () => dockerNodeAvailabilityBadge)
.filter('trimcontainername', function () {
'use strict';
return function (name) {

View File

@ -1,4 +1,4 @@
import { NodeStatus, TaskState } from 'docker-types/generated/1.41';
import { NodeStatus, TaskState, NodeSpec } from 'docker-types/generated/1.41';
import _ from 'lodash';
export function trimSHA(imageName: string) {
@ -61,3 +61,15 @@ export function nodeStatusBadge(text: NodeStatus['State']) {
return 'success';
}
export function dockerNodeAvailabilityBadge(text: NodeSpec['Availability']) {
if (text === 'pause') {
return 'warning';
}
if (text === 'drain') {
return 'danger';
}
return 'success';
}

View File

@ -28,12 +28,14 @@ import { StacksDatatable } from '@/react/docker/stacks/ListView/StacksDatatable'
import { containersModule } from './containers';
import { servicesModule } from './services';
import { networksModule } from './networks';
import { swarmModule } from './swarm';
const ngModule = angular
.module('portainer.docker.react.components', [
containersModule,
servicesModule,
networksModule,
swarmModule,
])
.component('dockerfileDetails', r2a(DockerfileDetails, ['image']))
.component('dockerHealthStatus', r2a(HealthStatus, ['health']))

View File

@ -0,0 +1,17 @@
import angular from 'angular';
import { r2a } from '@/react-tools/react2angular';
import { withUIRouter } from '@/react-tools/withUIRouter';
import { NodesDatatable } from '@/react/docker/swarm/SwarmView/NodesDatatable';
export const swarmModule = angular
.module('portainer.docker.react.components.swarm', [])
.component(
'nodesDatatable',
r2a(withUIRouter(NodesDatatable), [
'dataset',
'isIpColumnVisible',
'haveAccessToNode',
'onRefresh',
])
).name;

View File

@ -37,17 +37,4 @@
</div>
</div>
<div class="row">
<div class="col-sm-12">
<nodes-datatable
title-text="Nodes"
title-icon="trello"
dataset="nodes"
table-key="nodes"
order-by="Hostname"
show-ip-address-column="applicationState.endpoint.apiVersion >= 1.25"
access-to-node-details="isAdmin"
refresh-callback="getNodes"
></nodes-datatable>
</div>
</div>
<nodes-datatable dataset="nodes" is-ip-column-visible="applicationState.endpoint.apiVersion >= 1.25" have-access-to-node="isAdmin" on-refresh="(getNodes)"></nodes-datatable>

View File

@ -9,7 +9,7 @@ import { mergeOptions } from '@@/datatables/extend-options/mergeOptions';
import { withMeta } from '@@/datatables/extend-options/withMeta';
import { withControlledSelected } from '@@/datatables/extend-options/withControlledSelected';
import { useColumns } from './columns';
import { useColumns } from './useColumns';
const tableKey = 'macvlan-nodes-selector';
const store = createPersistedStore(tableKey);
@ -41,7 +41,7 @@ export function MacvlanNodesSelector({
settingsManager={tableState}
extendTableOptions={mergeOptions(
withMeta({
table: 'macvlan-nodes',
table: 'nodes',
haveAccessToNode,
}),
withControlledSelected(

View File

@ -1,20 +0,0 @@
import _ from 'lodash';
import { columnHelper } from './column-helper';
import { name } from './name';
import { status } from './status';
export function useColumns(isIpColumnVisible: boolean) {
return _.compact([
name,
columnHelper.accessor('Role', {}),
columnHelper.accessor('EngineVersion', {
header: 'Engine',
}),
isIpColumnVisible &&
columnHelper.accessor('Addr', {
header: 'IP Address',
}),
status,
]);
}

View File

@ -0,0 +1,17 @@
import { useMemo } from 'react';
import _ from 'lodash';
import {
engine,
ip,
role,
name,
status,
} from '@/react/docker/swarm/SwarmView/NodesDatatable/columns';
export function useColumns(isIpColumnVisible: boolean) {
return useMemo(
() => _.compact([name, role, engine, isIpColumnVisible && ip, status]),
[isIpColumnVisible]
);
}

View File

@ -0,0 +1,70 @@
import { Trello } from 'lucide-react';
import { NodeViewModel } from '@/docker/models/node';
import { Datatable, TableSettingsMenu } from '@@/datatables';
import {
BasicTableSettings,
RefreshableTableSettings,
createPersistedStore,
refreshableSettings,
} from '@@/datatables/types';
import { useTableState } from '@@/datatables/useTableState';
import { useRepeater } from '@@/datatables/useRepeater';
import { TableSettingsMenuAutoRefresh } from '@@/datatables/TableSettingsMenuAutoRefresh';
import { withMeta } from '@@/datatables/extend-options/withMeta';
import { useColumns } from './columns';
const tableKey = 'nodes';
interface TableSettings extends BasicTableSettings, RefreshableTableSettings {}
const store = createPersistedStore<TableSettings>(
tableKey,
undefined,
(set) => ({
...refreshableSettings(set),
})
);
export function NodesDatatable({
dataset,
isIpColumnVisible,
haveAccessToNode,
onRefresh,
}: {
dataset?: Array<NodeViewModel>;
isIpColumnVisible: boolean;
haveAccessToNode: boolean;
onRefresh(): Promise<void>;
}) {
const columns = useColumns(isIpColumnVisible);
const tableState = useTableState(store, tableKey);
useRepeater(tableState.autoRefreshRate, onRefresh);
return (
<Datatable<NodeViewModel>
disableSelect
title="Nodes"
titleIcon={Trello}
columns={columns}
dataset={dataset || []}
isLoading={!dataset}
emptyContentLabel="No node available"
settingsManager={tableState}
extendTableOptions={withMeta({
table: 'nodes',
haveAccessToNode,
})}
renderTableSettings={() => (
<TableSettingsMenu>
<TableSettingsMenuAutoRefresh
value={tableState.autoRefreshRate}
onChange={(value) => tableState.setAutoRefreshRate(value)}
/>
</TableSettingsMenu>
)}
/>
);
}

View File

@ -0,0 +1,29 @@
import clsx from 'clsx';
import { NodeViewModel } from '@/docker/models/node';
import { columnHelper } from './column-helper';
export const availability = columnHelper.accessor('Availability', {
header: 'Availability',
cell({ getValue }) {
const value = getValue();
return (
<span className={clsx('label', `label-${badgeClass(value)}`)}>
{value}
</span>
);
},
});
export function badgeClass(text: NodeViewModel['Availability']) {
if (text === 'pause') {
return 'warning';
}
if (text === 'drain') {
return 'danger';
}
return 'success';
}

View File

@ -0,0 +1,53 @@
import _ from 'lodash';
import { useMemo } from 'react';
import { humanize } from '@/portainer/filters/filters';
import { columnHelper } from './column-helper';
import { name } from './name';
import { status } from './status';
import { availability } from './availability';
export { name, status };
export const role = columnHelper.accessor('Role', {});
export const engine = columnHelper.accessor('EngineVersion', {
header: 'Engine',
});
export const ip = columnHelper.accessor('Addr', {
header: 'IP Address',
});
export const cpu = columnHelper.accessor(
(item) => (item.CPUs ? item.CPUs / 1000000000 : 0),
{
header: 'CPU',
}
);
export const memory = columnHelper.accessor('Memory', {
header: 'Memory',
cell({ getValue }) {
const value = getValue();
return humanize(value);
},
});
export function useColumns(isIpColumnVisible: boolean) {
return useMemo(
() =>
_.compact([
name,
role,
cpu,
memory,
engine,
isIpColumnVisible && ip,
status,
availability,
]),
[isIpColumnVisible]
);
}

View File

@ -5,7 +5,7 @@ import { nodeStatusBadge } from '@/docker/filters/utils';
import { columnHelper } from './column-helper';
export const status = columnHelper.accessor('Status', {
cell: ({ getValue }) => {
cell({ getValue }) {
const value = getValue();
return (
<span className={clsx('label', `label-${nodeStatusBadge(value)}`)}>

View File

@ -0,0 +1 @@
export { NodesDatatable } from './NodesDatatable';

View File

@ -3,12 +3,12 @@ import { TableMeta as BaseTableMeta } from '@tanstack/react-table';
import { NodeViewModel } from '@/docker/models/node';
export type TableMeta = BaseTableMeta<NodeViewModel> & {
table: 'macvlan-nodes';
table: 'nodes';
haveAccessToNode: boolean;
};
export function isTableMeta(
meta?: BaseTableMeta<NodeViewModel>
): meta is TableMeta {
return !!meta && meta.table === 'macvlan-nodes';
return !!meta && meta.table === 'nodes';
}