Skip to content

server: add support for sorting zones in UI/API #3242

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
yadvr merged 7 commits into from
Jun 19, 2019
Merged

server: add support for sorting zones in UI/API #3242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6e899b7
server: add support for sorting zones in UI/api
Mar 13, 2019
c46466b
db changes for the schema
yadvr Mar 28, 2019
360d642
Fix typo in parameter description
Apr 12, 2019
e1f0dcf
server: add support for sorting zones in UI/api
Mar 13, 2019
889e1ba
db changes for the schema
yadvr Mar 28, 2019
ee426cd
Make config key description more clear
Apr 12, 2019
20f0ebe
Declare selection filter with sortkey and algo when listing zones
Jun 6, 2019
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
7 changes: 5 additions & 2 deletions api/src/main/java/com/cloud/dc/DataCenter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
// under the License.
package com.cloud.dc;

import com.cloud.org.Grouping;
import java.util.Map;

import org.apache.cloudstack.acl.InfrastructureEntity;
import org.apache.cloudstack.kernel.Partition;

import java.util.Map;
import com.cloud.org.Grouping;

/**
*
Expand Down Expand Up @@ -80,4 +81,6 @@ public enum NetworkType {
String getZoneToken();

boolean isLocalStorageEnabled();

int getSortKey();
}
7 changes: 7 additions & 0 deletions api/src/main/java/org/apache/cloudstack/api/command/admin/zone/UpdateZoneCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ public class UpdateZoneCmd extends BaseCmd {
@Parameter(name = ApiConstants.LOCAL_STORAGE_ENABLED, type = CommandType.BOOLEAN, description = "true if local storage offering enabled, false otherwise")
private Boolean localStorageEnabled;

@Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the zone, integer")
private Integer sortKey;

/////////////////////////////////////////////////////
/////////////////// Accessors ///////////////////////
/////////////////////////////////////////////////////
Expand Down Expand Up @@ -163,6 +166,10 @@ public Boolean getLocalStorageEnabled() {
return localStorageEnabled;
}

public Integer getSortKey() {
return sortKey;
}

/////////////////////////////////////////////////////
/////////////// API Implementation///////////////////
/////////////////////////////////////////////////////
Expand Down
7 changes: 6 additions & 1 deletion api/src/main/java/org/apache/cloudstack/query/QueryService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
public interface QueryService {

// Config keys
static final ConfigKey<Boolean> AllowUserViewDestroyedVM = new ConfigKey<Boolean>("Advanced", Boolean.class, "allow.user.view.destroyed.vm", "false",
ConfigKey<Boolean> AllowUserViewDestroyedVM = new ConfigKey<>("Advanced", Boolean.class, "allow.user.view.destroyed.vm", "false",
"Determines whether users can view their destroyed or expunging vm ", true, ConfigKey.Scope.Account);

static final ConfigKey<String> UserVMBlacklistedDetails = new ConfigKey<String>("Advanced", String.class,
Expand All @@ -96,6 +96,11 @@ public interface QueryService {
"user.vm.readonly.ui.details", "dataDiskController, rootDiskController",
"List of UI read-only VM settings/details as comma separated string", true);

ConfigKey<Boolean> SortKeyAscending = new ConfigKey<>("Advanced", Boolean.class, "sortkey.algorithm", "true",
Copy link
Contributor

@DaanHoogland DaanHoogland Apr 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so true means that all lists for all users are sorted ascending? (if one of template, disk offering, service offering, network offering or zone)

Copy link
Contributor

@anuragaw anuragaw Apr 10, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes @DaanHoogland . That's how global config seems to have been designed and used.

Copy link
Member Author

@yadvr yadvr Apr 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you rectify the description to reflect the general use-case of the config key @anuragaw ?

Copy link
Contributor

@anuragaw anuragaw Apr 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing @rhtyd

"Sort algorithm - ascending or descending - to use. For entities that use sort key(template, disk offering, service offering, " +
"network offering, zones), we use the flag to determine if the entities should be sorted ascending (when flag is true) " +
"or descending (when flag is false). Within the scope of the config all users see the same result.", true, ConfigKey.Scope.Global);

ListResponse<UserResponse> searchForUsers(ListUsersCmd cmd) throws PermissionDeniedException;

ListResponse<EventResponse> searchForEvents(ListEventsCmd cmd);
Expand Down
31 changes: 20 additions & 11 deletions ...c/main/java/org/apache/cloudstack/engine/datacenter/entity/api/db/EngineDataCenterVO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,9 @@
// under the License.
package org.apache.cloudstack.engine.datacenter.entity.api.db;

import com.cloud.network.Network.Provider;
import com.cloud.org.Grouping;
import com.cloud.utils.NumbersUtil;
import com.cloud.utils.db.GenericDao;
import com.cloud.utils.db.StateMachine;
import org.apache.cloudstack.api.Identity;
import org.apache.cloudstack.engine.datacenter.entity.api.DataCenterResourceEntity.State;
import org.apache.cloudstack.engine.datacenter.entity.api.DataCenterResourceEntity.State.Event;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

import javax.persistence.Column;
import javax.persistence.Entity;
Expand All @@ -37,9 +32,16 @@
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

import org.apache.cloudstack.api.Identity;
import org.apache.cloudstack.engine.datacenter.entity.api.DataCenterResourceEntity.State;
import org.apache.cloudstack.engine.datacenter.entity.api.DataCenterResourceEntity.State.Event;

import com.cloud.network.Network.Provider;
import com.cloud.org.Grouping;
import com.cloud.utils.NumbersUtil;
import com.cloud.utils.db.GenericDao;
import com.cloud.utils.db.StateMachine;

@Entity
@Table(name = "data_center")
Expand Down Expand Up @@ -140,6 +142,9 @@ public class EngineDataCenterVO implements EngineDataCenter, Identity {
@Column(name = "is_local_storage_enabled")
boolean localStorageEnabled;

@Column(name = "sort_key")
int sortKey;

//orchestration
@Column(name = "owner")
private String owner = null;
Expand Down Expand Up @@ -389,6 +394,10 @@ public void setLocalStorageEnabled(boolean enabled) {
this.localStorageEnabled = enabled;
}

public int getSortKey() {
return sortKey;
}

@Override
public Map<String, String> getDetails() {
return details;
Expand Down
27 changes: 20 additions & 7 deletions engine/schema/src/main/java/com/cloud/dc/DataCenterVO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@
// under the License.
package com.cloud.dc;

import com.cloud.network.Network.Provider;
import com.cloud.org.Grouping;
import com.cloud.utils.NumbersUtil;
import com.cloud.utils.db.GenericDao;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

import javax.persistence.Column;
import javax.persistence.Entity;
Expand All @@ -31,9 +30,11 @@
import javax.persistence.Table;
import javax.persistence.TableGenerator;
import javax.persistence.Transient;
import java.util.Date;
import java.util.Map;
import java.util.UUID;

import com.cloud.network.Network.Provider;
import com.cloud.org.Grouping;
import com.cloud.utils.NumbersUtil;
import com.cloud.utils.db.GenericDao;

@Entity
@Table(name = "data_center")
Expand Down Expand Up @@ -134,6 +135,9 @@ public class DataCenterVO implements DataCenter {
@Column(name = "is_local_storage_enabled")
boolean localStorageEnabled;

@Column(name = "sort_key")
int sortKey;

@Override
public String getDnsProvider() {
return dnsProvider;
Expand Down Expand Up @@ -363,6 +367,15 @@ public void setLocalStorageEnabled(boolean enabled) {
this.localStorageEnabled = enabled;
}

@Override
public int getSortKey() {
return sortKey;
}

public void setSortKey(int newSortKey) {
sortKey = newSortKey;
}

@Override
public Map<String, String> getDetails() {
return details;
Expand Down
43 changes: 43 additions & 0 deletions engine/schema/src/main/resources/META-INF/db/schema-41200to41300.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,46 @@

-- DPDK client and server mode support
ALTER TABLE `cloud`.`service_offering_details` CHANGE COLUMN `value` `value` TEXT NOT NULL;

-- Add `sort_key` column to data_center
ALTER TABLE `cloud`.`data_center` ADD COLUMN `sort_key` INT(32) NOT NULL DEFAULT 0;

-- Recreate data_center_view
DROP VIEW IF EXISTS `cloud`.`data_center_view`;
CREATE VIEW `cloud`.`data_center_view` AS
select
data_center.id,
data_center.uuid,
data_center.name,
data_center.is_security_group_enabled,
data_center.is_local_storage_enabled,
data_center.description,
data_center.dns1,
data_center.dns2,
data_center.ip6_dns1,
data_center.ip6_dns2,
data_center.internal_dns1,
data_center.internal_dns2,
data_center.guest_network_cidr,
data_center.domain,
data_center.networktype,
data_center.allocation_state,
data_center.zone_token,
data_center.dhcp_provider,
data_center.removed,
data_center.sort_key,
domain.id domain_id,
domain.uuid domain_uuid,
domain.name domain_name,
domain.path domain_path,
dedicated_resources.affinity_group_id,
dedicated_resources.account_id,
affinity_group.uuid affinity_group_uuid
from
`cloud`.`data_center`
left join
`cloud`.`domain` ON data_center.domain_id = domain.id
left join
`cloud`.`dedicated_resources` ON data_center.id = dedicated_resources.data_center_id
left join
`cloud`.`affinity_group` ON dedicated_resources.affinity_group_id = affinity_group.id;
18 changes: 6 additions & 12 deletions server/src/main/java/com/cloud/api/query/QueryManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2508,9 +2508,7 @@ private Pair<List<DiskOfferingJoinVO>, Integer> searchForDiskOfferingsInternal(L
// till
// root

Boolean isAscending = Boolean.parseBoolean(_configDao.getValue("sortkey.algorithm"));
isAscending = (isAscending == null ? true : isAscending);
Filter searchFilter = new Filter(DiskOfferingJoinVO.class, "sortKey", isAscending, cmd.getStartIndex(), cmd.getPageSizeVal());
Filter searchFilter = new Filter(DiskOfferingJoinVO.class, "sortKey", SortKeyAscending.value(), cmd.getStartIndex(), cmd.getPageSizeVal());
SearchCriteria<DiskOfferingJoinVO> sc = _diskOfferingJoinDao.createSearchCriteria();
sc.addAnd("type", Op.EQ, DiskOfferingVO.Type.Disk);

Expand Down Expand Up @@ -2650,9 +2648,7 @@ private Pair<List<ServiceOfferingJoinVO>, Integer> searchForServiceOfferingsInte
// their domains+parent domains ... all the way
// till
// root
Boolean isAscending = Boolean.parseBoolean(_configDao.getValue("sortkey.algorithm"));
isAscending = (isAscending == null ? true : isAscending);
Filter searchFilter = new Filter(ServiceOfferingJoinVO.class, "sortKey", isAscending, cmd.getStartIndex(), cmd.getPageSizeVal());
Filter searchFilter = new Filter(ServiceOfferingJoinVO.class, "sortKey", SortKeyAscending.value(), cmd.getStartIndex(), cmd.getPageSizeVal());

Account caller = CallContext.current().getCallingAccount();
Object name = cmd.getServiceOfferingName();
Expand Down Expand Up @@ -2826,7 +2822,7 @@ private Pair<List<DataCenterJoinVO>, Integer> listDataCentersInternal(ListZonesC
sb.join("tagSearch", tagSearch, sb.entity().getId(), tagSearch.entity().getResourceId(), JoinBuilder.JoinType.INNER);
}

Filter searchFilter = new Filter(DataCenterJoinVO.class, null, false, cmd.getStartIndex(), cmd.getPageSizeVal());
Filter searchFilter = new Filter(DataCenterJoinVO.class, "sortKey", SortKeyAscending.value(), cmd.getStartIndex(), cmd.getPageSizeVal());
SearchCriteria<DataCenterJoinVO> sc = sb.create();

if (networkType != null) {
Expand Down Expand Up @@ -3086,10 +3082,8 @@ private Pair<List<TemplateJoinVO>, Integer> searchForTemplatesInternal(Long temp

VMTemplateVO template = null;

Boolean isAscending = Boolean.parseBoolean(_configDao.getValue("sortkey.algorithm"));
isAscending = (isAscending == null ? Boolean.TRUE : isAscending);
Filter searchFilter = new Filter(TemplateJoinVO.class, "sortKey", isAscending, startIndex, pageSize);
searchFilter.addOrderBy(TemplateJoinVO.class, "tempZonePair", isAscending);
Filter searchFilter = new Filter(TemplateJoinVO.class, "sortKey", SortKeyAscending.value(), startIndex, pageSize);
searchFilter.addOrderBy(TemplateJoinVO.class, "tempZonePair", SortKeyAscending.value());

SearchBuilder<TemplateJoinVO> sb = _templateJoinDao.createSearchBuilder();
sb.select(null, Func.DISTINCT, sb.entity().getTempZonePair()); // select distinct (templateId, zoneId) pair
Expand Down Expand Up @@ -3714,6 +3708,6 @@ public String getConfigComponentName() {

@Override
public ConfigKey<?>[] getConfigKeys() {
return new ConfigKey<?>[] {AllowUserViewDestroyedVM, UserVMBlacklistedDetails, UserVMReadOnlyUIDetails};
return new ConfigKey<?>[] {AllowUserViewDestroyedVM, UserVMBlacklistedDetails, UserVMReadOnlyUIDetails, SortKeyAscending};
}
}
7 changes: 7 additions & 0 deletions server/src/main/java/com/cloud/api/query/vo/DataCenterJoinVO.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,9 @@ public class DataCenterJoinVO extends BaseViewVO implements InternalIdentity, Id
@Column(name = "account_id")
private long accountId;

@Column(name = "sort_key")
private int sortKey;

public DataCenterJoinVO() {
}

Expand Down Expand Up @@ -221,4 +224,8 @@ public String getAffinityGroupUuid() {
public long getAccountId() {
return accountId;
}

public int getSortKey() {
return sortKey;
}
}
8 changes: 0 additions & 8 deletions server/src/main/java/com/cloud/configuration/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -995,14 +995,6 @@ public enum Config {
"30",
"Garbage collection interval to destroy unused ELB vms in minutes. Minimum of 5",
null),
SortKeyAlgorithm(
"Advanced",
ManagementServer.class,
Boolean.class,
"sortkey.algorithm",
"false",
"Sort algorithm for those who use sort key(template, disk offering, service offering, network offering), true means ascending sort while false means descending sort",
null),
EnableEC2API("Advanced", ManagementServer.class, Boolean.class, "enable.ec2.api", "false", "enable EC2 API on CloudStack", null),
EnableS3API("Advanced", ManagementServer.class, Boolean.class, "enable.s3.api", "false", "enable Amazon S3 API on CloudStack", null),
RecreateSystemVmEnabled(
Expand Down
3 changes: 3 additions & 0 deletions server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1922,6 +1922,8 @@ public DataCenter editZone(final UpdateZoneCmd cmd) {
guestCidr = zone.getGuestNetworkCidr();
}

int sortKey = cmd.getSortKey() != null ? cmd.getSortKey() : zone.getSortKey();

// validate network domain
if (networkDomain != null && !networkDomain.isEmpty()) {
if (!NetUtils.verifyDomainName(networkDomain)) {
Expand All @@ -1944,6 +1946,7 @@ public DataCenter editZone(final UpdateZoneCmd cmd) {
zone.setInternalDns1(internalDns1);
zone.setInternalDns2(internalDns2);
zone.setGuestNetworkCidr(guestCidr);
zone.setSortKey(sortKey);
if (localStorageEnabled != null) {
zone.setLocalStorageEnabled(localStorageEnabled.booleanValue());
}
Expand Down
18 changes: 18 additions & 0 deletions ui/scripts/cloudStack.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,24 @@
}
});

// Update global pagesize for sort key in UI
$.ajax({
type: 'GET',
url: createURL('listConfigurations'),
data: {name: 'sortkey.algorithm'},
dataType: 'json',
async: false,
success: function(data, textStatus, xhr) {
if (data && data.listconfigurationsresponse && data.listconfigurationsresponse.configuration) {
var config = data.listconfigurationsresponse.configuration[0];
if (config && config.name == 'sortkey.algorithm') {
g_sortKeyIsAscending = config.value == 'true';
}
}
},
error: function(xhr) { // ignore any errors, fallback to the default
}
});

// Populate IDP list
$.ajax({
Expand Down
3 changes: 2 additions & 1 deletion ui/scripts/sharedFunctions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ var g_cloudstackversion = null;
var g_queryAsyncJobResultInterval = 3000;
var g_idpList = null;
var g_appendIdpDomain = false;
var g_sortKeyIsAscending = false;

//keyboard keycode
var keycode_Enter = 13;
Expand Down Expand Up @@ -2405,7 +2406,7 @@ cloudStack.api = {
url: createURL(updateCommand),
data: {
id: args.context[objType].id,
sortKey: args.index
sortKey: g_sortKeyIsAscending ? (-1 * args.index) : args.index
},
success: function(json) {
args.response.success();
Expand Down
2 changes: 2 additions & 0 deletions ui/scripts/system.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7641,6 +7641,8 @@
}
},

reorder: cloudStack.api.actions.sort('updateZone', 'physicalResources'),

dataProvider: function (args) {
var array1 =[];
if (args.filterBy != null) {
Expand Down