Skip to content

Commit

Permalink
fix(deletion): delete objects batch by batch EE-7084 (#11833)
Browse files Browse the repository at this point in the history
  • Loading branch information
cmenginnz committed May 16, 2024
1 parent 00ab9e9 commit 3924d0f
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 64 deletions.
19 changes: 8 additions & 11 deletions app/docker/views/images/imagesController.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { PorImageRegistryModel } from 'Docker/models/porImageRegistry';
import { confirmImageExport } from '@/react/docker/images/common/ConfirmExportModal';
import { confirmDestructive } from '@@/modals/confirm';
import { buildConfirmButton } from '@@/modals/utils';
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.docker').controller('ImagesController', [
'$scope',
Expand Down Expand Up @@ -157,24 +158,20 @@ angular.module('portainer.docker').controller('ImagesController', [
* @param {Array<import('@/react/docker/images/queries/useImages').ImagesListResponse>} selectedItems
* @param {boolean} force
*/
function removeAction(selectedItems, force) {
var actionCount = selectedItems.length;
angular.forEach(selectedItems, function (image) {
async function removeAction(selectedItems, force) {
async function doRemove(image) {
HttpRequestHelper.setPortainerAgentTargetHeader(image.nodeName);
ImageService.deleteImage(image.id, force)
return ImageService.deleteImage(image.id, force)
.then(function success() {
Notifications.success('Image successfully removed', image.id);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove image');
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}

await processItemsInBatches(selectedItems, doRemove);
$state.reload();
}

$scope.setPullImageValidity = setPullImageValidity;
Expand Down
17 changes: 7 additions & 10 deletions app/docker/views/networks/networksController.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import _ from 'lodash-es';
import DockerNetworkHelper from '@/docker/helpers/networkHelper';
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.docker').controller('NetworksController', [
'$q',
Expand All @@ -12,25 +13,21 @@ angular.module('portainer.docker').controller('NetworksController', [
'AgentService',
function ($q, $scope, $state, NetworkService, Notifications, HttpRequestHelper, endpoint, AgentService) {
$scope.removeAction = async function (selectedItems) {
var actionCount = selectedItems.length;
angular.forEach(selectedItems, function (network) {
async function doRemove(network) {
HttpRequestHelper.setPortainerAgentTargetHeader(network.NodeName);
NetworkService.remove(network.Id)
return NetworkService.remove(network.Id)
.then(function success() {
Notifications.success('Network successfully removed', network.Name);
var index = $scope.networks.indexOf(network);
$scope.networks.splice(index, 1);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove network');
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}

await processItemsInBatches(selectedItems, doRemove);
$state.reload();
};

$scope.getNetworks = getNetworks;
Expand Down
18 changes: 8 additions & 10 deletions app/docker/views/secrets/secretsController.js
Original file line number Diff line number Diff line change
@@ -1,28 +1,26 @@
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.docker').controller('SecretsController', [
'$scope',
'$state',
'SecretService',
'Notifications',
function ($scope, $state, SecretService, Notifications) {
$scope.removeAction = async function (selectedItems) {
var actionCount = selectedItems.length;
angular.forEach(selectedItems, function (secret) {
SecretService.remove(secret.Id)
async function doRemove(secret) {
return SecretService.remove(secret.Id)
.then(function success() {
Notifications.success('Secret successfully removed', secret.Name);
var index = $scope.secrets.indexOf(secret);
$scope.secrets.splice(index, 1);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove secret');
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}

await processItemsInBatches(selectedItems, doRemove);
$state.reload();
};

$scope.getSecrets = getSecrets;
Expand Down
20 changes: 9 additions & 11 deletions app/docker/views/volumes/volumesController.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.docker').controller('VolumesController', [
'$q',
'$scope',
Expand All @@ -10,26 +12,22 @@ angular.module('portainer.docker').controller('VolumesController', [
'Authentication',
'endpoint',
function ($q, $scope, $state, VolumeService, ServiceService, VolumeHelper, Notifications, HttpRequestHelper, Authentication, endpoint) {
$scope.removeAction = function (selectedItems) {
var actionCount = selectedItems.length;
angular.forEach(selectedItems, function (volume) {
$scope.removeAction = async function (selectedItems) {
async function doRemove(volume) {
HttpRequestHelper.setPortainerAgentTargetHeader(volume.NodeName);
VolumeService.remove(volume)
return VolumeService.remove(volume)
.then(function success() {
Notifications.success('Volume successfully removed', volume.Id);
var index = $scope.volumes.indexOf(volume);
$scope.volumes.splice(index, 1);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove volume');
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}

await processItemsInBatches(selectedItems, doRemove);
$state.reload();
};

$scope.getVolumes = getVolumes;
Expand Down
21 changes: 10 additions & 11 deletions app/portainer/views/stacks/stacksController.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.app').controller('StacksController', StacksController);

/* @ngInject */
Expand All @@ -6,26 +8,23 @@ function StacksController($scope, $state, Notifications, StackService, Authentic
return deleteSelectedStacks(selectedItems);
};

function deleteSelectedStacks(stacks) {
async function deleteSelectedStacks(selectedItems) {
const endpointId = endpoint.Id;
let actionCount = stacks.length;
angular.forEach(stacks, function (stack) {
StackService.remove(stack, stack.External, endpointId)

async function doRemove(stack) {
return StackService.remove(stack, stack.External, endpointId)
.then(function success() {
Notifications.success('Stack successfully removed', stack.Name);
var index = $scope.stacks.indexOf(stack);
$scope.stacks.splice(index, 1);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove stack ' + stack.Name);
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}

await processItemsInBatches(selectedItems, doRemove);
$state.reload();
}

$scope.createEnabled = false;
Expand Down
18 changes: 7 additions & 11 deletions app/portainer/views/users/usersController.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import _ from 'lodash-es';
import { AuthenticationMethod } from '@/react/portainer/settings/types';
import { processItemsInBatches } from '@/react/common/processItemsInBatches';

angular.module('portainer.app').controller('UsersController', [
'$q',
Expand Down Expand Up @@ -69,25 +70,20 @@ angular.module('portainer.app').controller('UsersController', [
});
};

function deleteSelectedUsers(selectedItems) {
var actionCount = selectedItems.length;
angular.forEach(selectedItems, function (user) {
UserService.deleteUser(user.Id)
async function deleteSelectedUsers(selectedItems) {
async function doRemove(user) {
return UserService.deleteUser(user.Id)
.then(function success() {
Notifications.success('User successfully removed', user.Username);
var index = $scope.users.indexOf(user);
$scope.users.splice(index, 1);
})
.catch(function error(err) {
Notifications.error('Failure', err, 'Unable to remove user');
})
.finally(function final() {
--actionCount;
if (actionCount === 0) {
$state.reload();
}
});
});
}
await processItemsInBatches(selectedItems, doRemove);
$state.reload();
}

$scope.removeAction = function (selectedItems) {
Expand Down
30 changes: 30 additions & 0 deletions app/react/common/processItemsInBatches.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/**
* Type definition for the callback function used in processItemsInBatches.
* It should accept an item from the array as its first argument
* and additional arguments (if any) as its second argument, and should return a Promise.
*/
type ProcessItemsCallback<T, Args extends never[]> = (
item: T,
...args: Args
) => Promise<void>;

/**
* Asynchronously processes an array of items in batches.
* @param items An array of items to be processed.
* @param processor A callback function of type ProcessItemsCallback that will be called for each item in the array.
* @param batchSize The maximum number of items to process in each batch. Defaults to 100 if not provided.
* @param args Additional arguments to be passed to the callback function for each item.
*/
export async function processItemsInBatches<T, Args extends never[]>(
items: T[],
processor: ProcessItemsCallback<T, Args>,
batchSize = 100,
...args: Args
): Promise<void> {
while (items.length) {
const batch = items.splice(0, batchSize);
const batchPromises = batch.map((item) => processor(item, ...args));

await Promise.all(batchPromises);
}
}

0 comments on commit 3924d0f

Please sign in to comment.