Banana Framework Pull Request

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,51 @@
+name: "Code scanning - action"
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 4'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.gitignore

@@ -6,9 +6,13 @@ tmp/
 build.number
 build/
 target/
+dist
 *.iml
 .vscode
 .idea
+package-lock.json
+*.ipr
+*.iws
 .classpath
 .project
 .settings

CONTRIBUTING.md

@@ -4,7 +4,7 @@ LucidWorks is the commercial entity behind the long-standing and popular Open So
 
 Collaboration space (issues, wiki, etc.) for Banana will be setup soon.
 
-##Guidelines for Contribution
+## Guidelines for Contribution
 
 NOTE: All development on Banana proceeds on the develop branch. Periodically, we push releases to the release branch.
 

README.md

@@ -8,66 +8,67 @@ including new panels that leverage [D3.js](http://d3js.org).
 The goal is to create a rich and flexible UI, enabling users to rapidly develop end-to-end applications that leverage
 the power of Apache Solr. Data can be ingested into Solr through a variety of ways, including
 [Logstash](https://www.elastic.co/products/logstash), [Flume](https://flume.apache.org) and other connectors.
-
-## To Release a New Version for Fusion
-
-When you are ready to do a new release for Lucidworks Fusion. Do the following steps:
-
-1. Edit `package.json` by increasing the version number. 
-1. Edit `dasheditor.html` to use the new version number. (This is the version number in Dashboard Settings page)
-1. Update README 
-1. Run `grunt build`
-1. Push your commit to Github.
-1. Run `npm publish`
 
 ## IMPORTANT
 
 Pull the repo from the `release` branch for production deployment; version x.y.z will be tagged as x.y.z
 
 `develop` branch is used for active development and cutting edge features.
-
 `fusion` branch is used for Lucidworks Fusion release. The code base and features are the same as `develop`. The main difference
 is in the configuration. 
 
-## Banana 1.6.23
+## Banana 1.6.26
+
+This release includes the following bug fixes and improvement:
 
-This release includes minor fixes for the default dashboards in Fusion 4.2:
-* Change to use `query` field instead of `query_s` field in the Metrics dashboard (`lucidworks-metrics.json`).
-* For the Signals dashboard (`lucidworks-signals.json`):
-  * Change from `query_s` to `query` field.
-  * Change from `type_s` to `type` field.
-  * Change from `doc_id_s` to `doc_ids_s` field.
-  * Remove `count_i` and `weight_d` fields.
+1. Enhance heatmap
+    * Add axis and axis labels
+    * Add axis grid and ticks
+    * Add gradient legend and ranges
+    * Fix heatmap transpose icon
+    * Enhance positioning and padding of panel elements
+    * Fix bettermap tooltip and hint text
+1. Enhance hits panel
+    * Add panel horizontal and vertical direction option
+    * Fix metrics text and label overlap and margins
+1. Fix bettermap render issue when resized
+1. Fix jshint warnings
 
 ## Older Release Notes
 
 You can find all previous [Release Notes](https://github.com/LucidWorks/banana/wiki/Release-Notes) on our wiki page.
 
-### Changes to your dashboards
-If you created dashboards for Banana 1.0.0, you did not have a global filtering panel. In some cases, these filter
-values can be implicitly set to defaults that may lead to strange search results. We recommend updating your old
-dashboards by adding a filtering panel. A good way to do it visually is to put the filtering panel on its own row and
-hide it when it is not needed.
-
 ## Installation and Quick Start
 ### Requirements
 * A modern web browser. The latest version of [Chrome](http://www.google.com/chrome/) and
 [Firefox](https://www.mozilla.org/en-US/firefox/new/) have been tested to work. [Safari](http://www.apple.com/safari/)
 also works, except for the "Export to File" feature for saving dashboards. We recommend that you use Chrome or Firefox
 while building dashboards.
-* Solr 5 or 4.4+ (Solr server's endpoint must be open, or a proxy configured to allow access to it).
+* Solr 6.x or at least 4.4+ (Solr server's endpoint must be open, or a proxy configured to allow access to it).
 * A webserver (optional).
 
 ### Installation Options
 #### Option 1: Run Banana webapp within your existing Solr instance
-##### Solr 5 Instructions
-1. Run Solr at least once to create the webapp directory:
+##### Solr 5+ Instructions
+1. Run Solr at least once to create the webapp directory (this step might be unnecessary for Solr 6):
 
-        cd $SOLR_HOME/bin/
+        cd $SOLR_HOME/bin
         ./solr start
 
-2. Copy banana folder to $SOLR_HOME/server/solr-webapp/webapp/
-3. Browse to [http://localhost:8983/solr/banana/src/index.html](http://localhost:8983/solr/banana/src/index.html)
+2. Copy banana folder to `$SOLR_HOME/server/solr-webapp/webapp/`
+
+        cd $SOLR_HOME/server/solr-webapp/webapp
+        cp -R $BANANA_HOME/src ./banana
+
+    NOTES: For production, you should run `grunt build` command to generate the optimized code in `dist` directory. And then copy the `dist` directory to the production web server. For example:
+
+        cd $BANANA_HOME
+        npm install
+        bower install
+        grunt build
+        cp -R ./dist $SOLR_HOME/server/solr-webapp/webapp/banana
+
+3. Browse to [http://localhost:8983/solr/banana/index.html](http://localhost:8983/solr/banana/index.html)
 
 ##### Solr 4 Instructions
 1. Run Solr at least once to create the webapp directories:
@@ -94,29 +95,30 @@ example collections and dashboards in order to rapidly enable proof-of-concepts
 See [http://www.lucidworks.com/lucidworks-silk/](http://www.lucidworks.com/lucidworks-silk/).
 
 #### Option 3: Building and installing from a WAR file
+_NOTES: This option is only applicable to Solr 5 or 4. Solr 6 has a different architecture._
 1. Pull the source code of Banana version that you want from the
 [release](https://github.com/LucidWorks/banana/tree/release) branch in the repo;
 For example, version *x.y.z* will be tagged as `x.y.z`.
 
-2. Run a command line "ant" from within the banana directory to build the war file:
+2. Run a command line `ant` from within the banana directory to build the war file:
 
     ```bash
-        cd $BANANA_REPO_HOME
+        cd $BANANA_HOME
         ant
     ```
-3. The war file will be called *banana-\<buildnumber\>.war* and will be located in $BANANA\_REPO\_HOME/build.
+3. The war file will be called *banana-\<buildnumber\>.war* and will be located in $BANANA_HOME/build.
 Copy the war file and banana's jetty context file to Solr directories:
   * For Solr 5:
 
     ```bash
-        cp $BANANA_REPO_HOME/build/banana-<buildnumber>.war $SOLR_HOME/server/webapps/banana.war
-        cp $BANANA_REPO_HOME/jetty-contexts/banana-context.xml $SOLR_HOME/server/contexts/
+        cp $BANANA_HOME/build/banana-<buildnumber>.war $SOLR_HOME/server/webapps/banana.war
+        cp $BANANA_HOME/jetty-contexts/banana-context.xml $SOLR_HOME/server/contexts/
     ```
   * For Solr 4:
 
     ```bash
-        cp $BANANA_REPO_HOME/build/banana-<buildnumber>.war $SOLR_HOME/example/webapps/banana.war
-        cp $BANANA_REPO_HOME/jetty-contexts/banana-context.xml $SOLR_HOME/example/contexts/
+        cp $BANANA_HOME/build/banana-<buildnumber>.war $SOLR_HOME/example/webapps/banana.war
+        cp $BANANA_HOME/jetty-contexts/banana-context.xml $SOLR_HOME/example/contexts/
     ```
 4. Run Solr:
   * For Solr 5:
@@ -139,9 +141,13 @@ You will need to enable [CORS](https://en.wikipedia.org/wiki/Cross-origin_resour
 you query, or configure a proxy that makes requests to banana and Solr as same-origin. We typically recommend the
 latter approach.
 
-#### Storing Dashboards in Solr
+### Storing Dashboards in Solr
+If you want to save and load dashboards from Solr, then you need to create a collection called `banana-int` first. For Solr 6, here are the steps:
+
+        cd $SOLR_HOME/bin
+        ./solr create -c banana-int
 
-If you want to save and load dashboards from Solr, create a collection using the configuration files provided in either
+For Solr 5 and 4, you have to create the `banana-int` collection using the configuration files provided in either
 the _resources/banana-int-solr-5.0_ (for Solr 5) directory or the _resources/banana-int-solr-4.5_ directory
 (for Solr 4.5). If you are using SolrCloud, you will need to upload the configuration into
 [ZooKeeper](https://zookeeper.apache.org) and then create the collection using that configuration.
@@ -150,6 +156,12 @@ The Solr server configured in config.js will serve as the default node for each
 dashboard to point to a different Solr endpoint as long as your webserver and Solr put out the correct CORS headers.
 See the README file under the  _resources/enable-cors_ directory for a guide.
 
+### Changes to your dashboards
+If you created dashboards for Banana 1.0.0, you did not have a global filtering panel. In some cases, these filter
+values can be implicitly set to defaults that may lead to strange search results. We recommend updating your old
+dashboards by adding a filtering panel. A good way to do it visually is to put the filtering panel on its own row and
+hide it when it is not needed.
+
 ## FAQ
 
 __Q__: How do I secure my Solr endpoint so that users do not have access to it?  

default.properties

@@ -1,7 +1,7 @@
 name=banana
-version=1.6.16
+version=1.6.17
 final.name=${name}-${version}
-year=2016
+year=2017
 
 basedir = ./
 src.dir = ./src