Skip to content

Commit

Permalink
pools: JSON mover info timeInSeconds should be timeInMilliseconds
Browse files Browse the repository at this point in the history
Motivation:

Misnamed JSON object field, getter and setter.

Modification:

In order to preserve backward compatibility and allow for
update only on the frontend, a clone of the MoverData
object is provided on the frontend with the correctly
named field and methods.

With the next Golden Release, the code should be revisited.

Result:

Value is not misleading (seconds where it should be milliseconds).

Target: master
Request: 5.0
Request: 4.2
Request: 4.1
Requires-notes: yes
Requires-book: no
Acked-by: Dmitry
Acked-by: Paul
  • Loading branch information
alrossi committed Apr 3, 2019
1 parent 0d9963b commit b2dc124
Show file tree
Hide file tree
Showing 4 changed files with 215 additions and 8 deletions.
@@ -0,0 +1,195 @@
/*
COPYRIGHT STATUS:
Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
software are sponsored by the U.S. Department of Energy under Contract No.
DE-AC02-76CH03000. Therefore, the U.S. Government retains a world-wide
non-exclusive, royalty-free license to publish or reproduce these documents
and software for U.S. Government purposes. All documents and software
available from this server are protected under the U.S. and Foreign
Copyright Laws, and FNAL reserves all rights.
Distribution of the software available from this server is free of
charge subject to the user following the terms of the Fermitools
Software Legal Information.
Redistribution and/or modification of the software shall be accompanied
by the Fermitools Software Legal Information (including the copyright
notice).
The user is asked to feed back problems, benefits, and/or suggestions
about the software to the Fermilab Software Providers.
Neither the name of Fermilab, the URA, nor the names of the contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
DISCLAIMER OF LIABILITY (BSD):
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB,
OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Liabilities of the Government:
This software is provided by URA, independent from its Prime Contract
with the U.S. Department of Energy. URA is acting independently from
the Government and in its own private capacity and is not acting on
behalf of the U.S. Government, nor as its contractor nor its agent.
Correspondingly, it is understood and agreed that the U.S. Government
has no connection to this software and in no manner whatsoever shall
be liable for nor assume any responsibility or obligation for any claim,
cost, or damages arising out of or resulting from the use of the software
available from this server.
Export Control:
All documents and software available from this server are subject to U.S.
export control laws. Anyone downloading information from this server is
obligated to secure any necessary Government licenses before exporting
documents or software obtained from this server.
*/
package org.dcache.restful.providers.pool;

import java.io.Serializable;

/**
* <p>A frontend wrapper for the pool-side object</p>
*/
public class MoverData
implements Serializable {
private static final long serialVersionUID = 8037942643623452040L;
private String pnfsId;
private String queue;
private String mode;
private String door;
private String storageClass;
private String state;
private Long bytes;
private Long timeInMilliseconds;
private Long startTime;
private Long submitTime;
private Long lastModified;
private Integer moverId;

public MoverData() {}

public MoverData(org.dcache.pool.movers.json.MoverData moverData) {
pnfsId = moverData.getPnfsId();
queue = moverData.getQueue();
mode = moverData.getMode();
door = moverData.getDoor();
storageClass = moverData.getStorageClass();
state = moverData.getState();
bytes = moverData.getBytes();
timeInMilliseconds = moverData.getTimeInSeconds();
startTime = moverData.getStartTime();
submitTime = moverData.getSubmitTime();
lastModified = moverData.getLastModified();
moverId = moverData.getMoverId();
}

public Long getBytes() {
return bytes;
}

public String getDoor() {
return door;
}

public Long getLastModified() {
return lastModified;
}

public String getMode() {
return mode;
}

public Integer getMoverId() {
return moverId;
}

public String getPnfsId() {
return pnfsId;
}

public String getQueue() {
return queue;
}

public Long getStartTime() {
return startTime;
}

public String getState() {
return state;
}

public String getStorageClass() {
return storageClass;
}

public Long getSubmitTime() {
return submitTime;
}

public Long getTimeInMilliseconds() {
return timeInMilliseconds;
}

public void setBytes(Long bytes) {
this.bytes = bytes;
}

public void setDoor(String door) {
this.door = door;
}

public void setLastModified(Long lastModified) {
this.lastModified = lastModified;
}

public void setMode(String mode) {
this.mode = mode;
}

public void setMoverId(Integer moverId) {
this.moverId = moverId;
}

public void setPnfsId(String pnfsId) {
this.pnfsId = pnfsId;
}

public void setQueue(String queue) {
this.queue = queue;
}

public void setStartTime(Long startTime) {
this.startTime = startTime;
}

public void setState(String state) {
this.state = state;
}

public void setStorageClass(String storageClass) {
this.storageClass = storageClass;
}

public void setSubmitTime(Long submitTime) {
this.submitTime = submitTime;
}

public void setTimeInMilliseconds(Long timeInMilliseconds) {
this.timeInMilliseconds = timeInMilliseconds;
}
}
Expand Up @@ -112,10 +112,10 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
import dmg.cells.nucleus.NoRouteToCellException;

import org.dcache.cells.CellStub;
import org.dcache.pool.movers.json.MoverData;
import org.dcache.pool.nearline.json.NearlineData;
import org.dcache.poolmanager.PoolMonitor;
import org.dcache.restful.providers.PagedList;
import org.dcache.restful.providers.pool.MoverData;
import org.dcache.restful.providers.pool.PoolInfo;
import org.dcache.restful.providers.pool.PoolModeUpdate;
import org.dcache.restful.providers.selection.Pool;
Expand Down
Expand Up @@ -59,14 +59,14 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
*/
package org.dcache.restful.services.pool;

import dmg.cells.nucleus.NoRouteToCellException;

import diskCacheV111.util.CacheException;
import diskCacheV111.util.PnfsId;

import org.dcache.pool.movers.json.MoverData;
import dmg.cells.nucleus.NoRouteToCellException;

import org.dcache.pool.nearline.json.NearlineData;
import org.dcache.restful.providers.PagedList;
import org.dcache.restful.providers.pool.MoverData;
import org.dcache.restful.providers.pool.PoolGroupInfo;
import org.dcache.restful.providers.pool.PoolInfo;
import org.dcache.services.history.pools.PoolListingService;
Expand Down
Expand Up @@ -85,10 +85,10 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
import org.dcache.pool.json.PoolData;
import org.dcache.pool.json.PoolDataDetails;
import org.dcache.pool.json.PoolInfoWrapper;
import org.dcache.pool.movers.json.MoverData;
import org.dcache.pool.nearline.json.NearlineData;
import org.dcache.poolmanager.PoolMonitor;
import org.dcache.restful.providers.PagedList;
import org.dcache.restful.providers.pool.MoverData;
import org.dcache.restful.providers.pool.PoolGroupInfo;
import org.dcache.restful.providers.pool.PoolInfo;
import org.dcache.restful.util.admin.ReadWriteData;
Expand Down Expand Up @@ -133,11 +133,12 @@ public class PoolInfoServiceImpl extends
return new PagedList<>(data, total);
}

private static <M extends PoolMoverListingMessage> PagedList<MoverData>
private static <M extends PoolMoverListingMessage>
PagedList<MoverData>
getMoverData(String pool, ListenableFutureWrapper<M> wrapper)
throws InterruptedException, NoRouteToCellException,
CacheException {
List<MoverData> data = null;
List<org.dcache.pool.movers.json.MoverData> data = null;
int total = 0;

try {
Expand All @@ -148,7 +149,10 @@ public class PoolInfoServiceImpl extends
handleExecutionException(e);
}

return new PagedList<>(data, total);
return new PagedList<>(data.stream()
.map(org.dcache.restful.providers.pool.MoverData::new)
.collect(Collectors.toList()),
total);
}

private static RuntimeException handleExecutionException(ExecutionException e)
Expand Down Expand Up @@ -383,6 +387,10 @@ public PagedList<MoverData> getMovers(String pool,
NoRouteToCellException, CacheException {
if (Strings.isNullOrEmpty(sort)) {
sort = "door,startTime";
} else {
//REVISIT this is a hack to maintain backward compatibility; eliminate when pool object is modified
sort = sort.replace("timeInMilliseconds",
"timeInSeconds");
}

PoolMoverListingMessage message
Expand Down Expand Up @@ -415,6 +423,10 @@ public PagedList<MoverData> getP2p(String pool,
NoRouteToCellException, CacheException {
if (Strings.isNullOrEmpty(sort)) {
sort = "door,startTime";
} else {
//REVISIT this is a hack to maintain backward compatibility; eliminate when pool object is modified
sort = sort.replace("timeInMilliseconds",
"timeInSeconds");
}

PoolP2PListingMessage message
Expand Down

0 comments on commit b2dc124

Please sign in to comment.