Skip to content

Commit

Permalink
Suppressing the double render problem on error (#2725)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tulinkry
tulinkry authored and Vladimir Kotal committed Mar 20, 2019
1 parent 1161ac1 commit 06573a2
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 60 deletions.
57 changes: 11 additions & 46 deletions opengrok-indexer/src/main/java/org/opengrok/indexer/web/Scripts.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@
*/
package org.opengrok.indexer.web;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NavigableSet;
import java.util.TreeMap;
import java.util.TreeSet;

/**
* A list-like container for javascripts in the page.
Expand Down Expand Up @@ -111,11 +111,14 @@ public String toHtml() {
SCRIPTS.put("jquery-caret", new FileScript("js/jquery.caret-1.5.2.min.js", 25));
}

private static final Comparator<Script> SCRIPTS_COMPARATOR = Comparator
.comparingInt(Script::getPriority)
.thenComparing(Script::getScriptData);

/**
* Scripts which will be written to the page. We assume that the length
* could be the same as for {@link #SCRIPTS}.
* Scripts which will be written to the page.
*/
private final List<Script> outputScripts = new ArrayList<>(SCRIPTS.size());
private final NavigableSet<Script> outputScripts = new TreeSet<>(SCRIPTS_COMPARATOR);

/**
* Convert the page scripts into HTML.
Expand All @@ -134,7 +137,6 @@ public String toHtml() {
* Return the HTML representation of the page scripts.
*
* @return the HTML
*
* @see #toHtml()
*/
@Override
Expand All @@ -146,7 +148,6 @@ public String toString() {
* Return the size of the page scripts.
*
* @return the size
*
* @see List#size()
*/
public int size() {
Expand All @@ -157,7 +158,6 @@ public int size() {
* Check if there is any script for this page.
*
* @return true if there is not; false otherwise
*
* @see List#isEmpty()
*/
public boolean isEmpty() {
Expand All @@ -179,7 +179,7 @@ public Iterator<Script> iterator() {
* Add a script which is identified by the name.
*
* @param contextPath given context path for the used URL
* @param scriptName name of the script
* @param scriptName name of the script
* @return true if script was added; false otherwise
*/
public boolean addScript(String contextPath, String scriptName) {
Expand All @@ -195,46 +195,11 @@ public boolean addScript(String contextPath, String scriptName) {
}

/**
* Add a script to the page, taking the script priority into account. The
* position is determined as the upper bound for the given priority.
* Add a script to the page, taking the script priority into account.
*
* @param script the script
*/
public void addScript(Script script) {
int index = Collections.binarySearch(outputScripts, script, new Comparator<Script>() {
@Override
public int compare(Script a, Script b) {
return a.getPriority() - b.getPriority();
}
});
if (index < 0) {
/**
* Key is not found in the list the index<br>
* equals to -(insertion index) - 1.
*/
this.outputScripts.add(Math.abs(index + 1), script);
} else {
/**
* Key found in the list, append it after the last element with the
* same priority => insert it at the upper bound index.
*/
while (index < this.outputScripts.size()
&& this.outputScripts.get(index).getPriority() == script.getPriority()) {
index++;
}
this.outputScripts.add(index, script);
}
}

/**
* Get the page script by the index
*
* @param index index of the script
* @return the script
*
* @see List#get(int)
*/
public Script get(int index) {
return outputScripts.get(index);
this.outputScripts.add(script);
}
}
35 changes: 21 additions & 14 deletions opengrok-indexer/src/test/java/org/opengrok/indexer/web/ScriptsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,17 @@
*/

/*
* Copyright (c) 2017, 2018 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2017, 2019 Oracle and/or its affiliates. All rights reserved.
*/
package org.opengrok.indexer.web;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.util.ArrayList;
import java.util.List;
import java.util.Map.Entry;

import org.junit.Before;
import org.junit.Test;
import org.opengrok.indexer.web.Scripts.Script;
Expand All @@ -53,12 +54,15 @@ public void testInstance() {

assertEquals(3, scripts.size());

assertEquals(scripts.get(0).getScriptData(), "http://example.com/main1.js");
assertEquals(scripts.get(0).getPriority(), 0);
assertEquals(scripts.get(1).getScriptData(), "http://example.com/main2.js");
assertEquals(scripts.get(1).getPriority(), 0);
assertEquals(scripts.get(2).getScriptData(), "http://example.com/main3.js");
assertEquals(scripts.get(2).getPriority(), 0);
List<Script> listScripts = new ArrayList<>();
scripts.forEach(listScripts::add);

assertEquals(listScripts.get(0).getScriptData(), "http://example.com/main1.js");
assertEquals(listScripts.get(0).getPriority(), 0);
assertEquals(listScripts.get(1).getScriptData(), "http://example.com/main2.js");
assertEquals(listScripts.get(1).getPriority(), 0);
assertEquals(listScripts.get(2).getScriptData(), "http://example.com/main3.js");
assertEquals(listScripts.get(2).getPriority(), 0);
}

@Test
Expand All @@ -69,12 +73,15 @@ public void testSorted() {

assertEquals(3, scripts.size());

assertEquals(scripts.get(0).getScriptData(), "http://example.com/main2.js");
assertEquals(scripts.get(0).getPriority(), 1);
assertEquals(scripts.get(1).getScriptData(), "http://example.com/main3.js");
assertEquals(scripts.get(1).getPriority(), 2);
assertEquals(scripts.get(2).getScriptData(), "http://example.com/main1.js");
assertEquals(scripts.get(2).getPriority(), 3);
List<Script> listScripts = new ArrayList<>();
scripts.forEach(listScripts::add);

assertEquals(listScripts.get(0).getScriptData(), "http://example.com/main2.js");
assertEquals(listScripts.get(0).getPriority(), 1);
assertEquals(listScripts.get(1).getScriptData(), "http://example.com/main3.js");
assertEquals(listScripts.get(1).getPriority(), 2);
assertEquals(listScripts.get(2).getScriptData(), "http://example.com/main1.js");
assertEquals(listScripts.get(2).getPriority(), 3);
}

@Test
Expand Down

0 comments on commit 06573a2

Please sign in to comment.