AMBARI-14212. Changes in Instance Definition does not get reflects in pig and hive view due to caching in UserLocal.java (Gaurav Nagar via yusaku)

ambari-server/src/main/java/org/apache/ambari/server/controller/internal/ViewInstanceResourceProvider.java

@@ -414,6 +414,7 @@ public class ViewInstanceResourceProvider extends AbstractResourceProvider {
         if (includeInstance(view.getCommonName(), view.getVersion(), instance.getInstanceName(), false)) {
           try {
             ViewRegistry.getInstance().updateViewInstance(instance);
+            ViewRegistry.getInstance().updateView(instance);
           } catch (org.apache.ambari.view.SystemException e) {
             throw new AmbariException("Caught exception trying to update view instance.", e);
           } catch (ValidationException e) {

ambari-server/src/main/java/org/apache/ambari/server/view/ViewRegistry.java

@@ -568,6 +568,18 @@ public class ViewRegistry {
     }
   }
 
+  /**
+   * Calls onUpdate hook on View class
+   *
+   * @param instanceEntity
+   */
+  public void updateView(ViewInstanceEntity instanceEntity){
+    ViewEntity viewEntity = getDefinition(instanceEntity.getViewName());
+    if(null != viewEntity && null != viewEntity.getView()){
+      viewEntity.getView().onUpdate(instanceEntity);
+    }
+  }
+
   /**
    * Get a view instance entity for the given view name and instance name.
    *

ambari-views/src/main/java/org/apache/ambari/view/View.java

@@ -43,4 +43,11 @@ public interface View {
    * @param definition  the view instance definition
    */
   public void onDestroy(ViewInstanceDefinition definition);
+
+  /**
+   * Called by the view framework when the given instance is being updated
+   *
+   * @param definition
+   */
+  public void onUpdate(ViewInstanceDefinition definition);
 }

contrib/views/hive/src/main/resources/view.xml

@@ -23,6 +23,7 @@
     <min-ambari-version>2.0.*</min-ambari-version>
 
     <validator-class>org.apache.ambari.view.hive.PropertyValidator</validator-class>
+    <view-class>org.apache.ambari.view.utils.ViewImpl</view-class>
 
     <!-- Hive Configs -->
     <parameter>

contrib/views/pig/src/main/java/org/apache/ambari/view/pig/utils/UserLocalObjects.java

@@ -21,7 +21,7 @@ package org.apache.ambari.view.pig.utils;
 import org.apache.ambari.view.ViewContext;
 import org.apache.ambari.view.pig.templeton.client.TempletonApi;
 import org.apache.ambari.view.pig.templeton.client.TempletonApiFactory;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.apache.ambari.view.utils.hdfs.HdfsApiException;
 import org.apache.ambari.view.utils.hdfs.HdfsUtil;
@@ -35,15 +35,15 @@ public class UserLocalObjects {
   /**
    * HdfsApi user-local instance
    */
-  private static ViewUserLocal<HdfsApi> hdfsApi;
+  private static UserLocal<HdfsApi> hdfsApi;
 
   /**
    * TempletonApi user-local instance
    */
-  private static ViewUserLocal<TempletonApi> templetonApi;
+  private static UserLocal<TempletonApi> templetonApi;
 
   static {
-    templetonApi = new ViewUserLocal<TempletonApi>(TempletonApi.class) {
+    templetonApi = new UserLocal<TempletonApi>(TempletonApi.class) {
       @Override
       protected synchronized TempletonApi initialValue(ViewContext context) {
         TempletonApiFactory templetonApiFactory = new TempletonApiFactory(context);
@@ -51,7 +51,7 @@ public class UserLocalObjects {
       }
     };
 
-    hdfsApi = new ViewUserLocal<HdfsApi>(HdfsApi.class) {
+    hdfsApi = new UserLocal<HdfsApi>(HdfsApi.class) {
       @Override
       protected synchronized HdfsApi initialValue(ViewContext context) {
         try {

contrib/views/pig/src/main/resources/view.xml

@@ -23,6 +23,7 @@
     <min-ambari-version>2.0.*</min-ambari-version>
 
     <validator-class>org.apache.ambari.view.pig.PropertyValidator</validator-class>
+    <view-class>org.apache.ambari.view.utils.ViewImpl</view-class>
 
     <!-- HDFS Configs -->
     <parameter>

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/FileTest.java

@@ -22,7 +22,7 @@ import org.apache.ambari.view.pig.HDFSTest;
 import org.apache.ambari.view.pig.resources.files.FileResource;
 import org.apache.ambari.view.pig.resources.files.FileService;
 import org.apache.ambari.view.pig.utils.*;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.json.simple.JSONObject;
 import org.junit.*;
@@ -60,7 +60,7 @@ public class FileTest extends HDFSTest {
   @AfterClass
   public static void shutDown() throws Exception {
     HDFSTest.shutDown(); // super
-    ViewUserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
+    UserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
   }
 
   private Response doCreateFile() throws IOException, InterruptedException {

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/HelpTest.java

@@ -20,7 +20,7 @@ package org.apache.ambari.view.pig.test;
 
 import org.apache.ambari.view.pig.HDFSTest;
 import org.apache.ambari.view.pig.services.HelpService;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.json.simple.JSONObject;
 import org.junit.*;
@@ -45,7 +45,7 @@ public class HelpTest extends HDFSTest {
   @AfterClass
   public static void shutDown() throws Exception {
     HDFSTest.shutDown(); // super
-    ViewUserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
+    UserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
   }
 
   @Test

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/IntegrationalTest.java

@@ -26,7 +26,7 @@ import org.apache.ambari.view.pig.resources.jobs.JobService;
 import org.apache.ambari.view.pig.resources.scripts.ScriptService;
 import org.apache.ambari.view.pig.templeton.client.TempletonApi;
 import org.apache.ambari.view.pig.utils.UserLocalObjects;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.junit.*;
 
@@ -48,7 +48,7 @@ public class IntegrationalTest extends HDFSTest {
   @AfterClass
   public static void shutDown() throws Exception {
     HDFSTest.shutDown(); // super
-    ViewUserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
+    UserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
   }
 
   @Override
@@ -63,13 +63,13 @@ public class IntegrationalTest extends HDFSTest {
   @After
   public void tearDown() throws Exception {
     super.tearDown();
-    ViewUserLocal.dropAllConnections(TempletonApi.class);
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(TempletonApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
   }
 
   @Test
   public void testHdfsApiDependsOnInstance() throws Exception {
-    ViewUserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
+    UserLocal.dropAllConnections(HdfsApi.class); //cleanup API connection
 
     ViewContext context1 = createNiceMock(ViewContext.class);
     ViewContext context2 = createNiceMock(ViewContext.class);

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/JobTest.java

@@ -27,7 +27,7 @@ import org.apache.ambari.view.pig.utils.BadRequestFormattedException;
 import org.apache.ambari.view.pig.utils.NotFoundFormattedException;
 import org.apache.ambari.view.pig.utils.ServiceFormattedException;
 import org.apache.ambari.view.pig.utils.UserLocalObjects;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.apache.ambari.view.utils.hdfs.HdfsApiException;
 import org.apache.hadoop.fs.FSDataOutputStream;
@@ -72,8 +72,8 @@ public class JobTest extends BasePigTest {
   @After
   public void tearDown() throws Exception {
     super.tearDown();
-    ViewUserLocal.dropAllConnections(TempletonApi.class);
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(TempletonApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
   }
 
   public static Response doCreateJob(String title, String pigScript, String templetonArguments, JobService jobService) {

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/ScriptTest.java

@@ -22,7 +22,7 @@ import org.apache.ambari.view.pig.HDFSTest;
 import org.apache.ambari.view.pig.resources.scripts.ScriptService;
 import org.apache.ambari.view.pig.resources.scripts.models.PigScript;
 import org.apache.ambari.view.pig.utils.NotFoundFormattedException;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.json.simple.JSONObject;
 import org.junit.*;
@@ -51,7 +51,7 @@ public class ScriptTest extends HDFSTest {
   @AfterClass
   public static void shutDown() throws Exception {
     HDFSTest.shutDown(); // super
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
   }
 
   @Override

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/ScriptTestHDFSUnmanaged.java

@@ -28,7 +28,7 @@ import org.apache.ambari.view.pig.resources.scripts.ScriptService;
 import org.apache.ambari.view.pig.persistence.utils.StorageUtil;
 import org.apache.ambari.view.pig.resources.scripts.models.PigScript;
 import org.apache.ambari.view.pig.utils.MisconfigurationFormattedException;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.apache.ambari.view.utils.hdfs.HdfsUtil;
 import org.json.simple.JSONObject;
@@ -56,7 +56,7 @@ public class ScriptTestHDFSUnmanaged extends HDFSTest {
   @AfterClass
   public static void shutDown() throws Exception {
     HDFSTest.shutDown(); // super
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
   }
 
   @Override
@@ -65,7 +65,7 @@ public class ScriptTestHDFSUnmanaged extends HDFSTest {
     super.setUp();
     handler = createNiceMock(ViewResourceHandler.class);
     context = createNiceMock(ViewContext.class);
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
     StorageUtil.dropAllConnections();
   }
 

contrib/views/pig/src/test/java/org/apache/ambari/view/pig/test/ScriptTestUnmanaged.java

@@ -22,7 +22,7 @@ import org.apache.ambari.view.ViewContext;
 import org.apache.ambari.view.ViewResourceHandler;
 import org.apache.ambari.view.pig.BasePigTest;
 import org.apache.ambari.view.pig.resources.scripts.ScriptService;
-import org.apache.ambari.view.utils.ViewUserLocal;
+import org.apache.ambari.view.utils.UserLocal;
 import org.apache.ambari.view.utils.hdfs.HdfsApi;
 import org.apache.ambari.view.utils.hdfs.HdfsApiException;
 import org.junit.*;
@@ -46,7 +46,7 @@ public class ScriptTestUnmanaged extends BasePigTest {
 
   @AfterClass
   public static void shutDown() throws Exception {
-    ViewUserLocal.dropAllConnections(HdfsApi.class);
+    UserLocal.dropAllConnections(HdfsApi.class);
   }
 
   @Before

contrib/views/utils/src/main/java/org/apache/ambari/view/utils/UserLocal.java

@@ -21,6 +21,7 @@ package org.apache.ambari.view.utils;
 import org.apache.ambari.view.ViewContext;
 
 import java.util.HashMap;
+import java.util.Iterator;
 import java.util.Map;
 
 /**
@@ -124,6 +125,23 @@ public class UserLocal<T> {
    * Method should not normally be called from production code.
    */
   public static void dropAllConnections() {
-    viewSingletonObjects.clear();
+      viewSingletonObjects.clear();
+  }
+
+  /**
+   *
+   * Drops all objects for give instance name.
+   *
+   * @param instanceName
+   */
+  public static void dropInstanceConnection(String instanceName){
+    for(Map<String,Object> cache : viewSingletonObjects.values()){
+      for(Iterator<Map.Entry<String, Object>> it = cache.entrySet().iterator();it.hasNext();){
+        Map.Entry<String, Object> entry = it.next();
+        if(entry.getKey().startsWith(instanceName+":")){
+          it.remove();
+        }
+      }
+    }
   }
 }

contrib/views/utils/src/main/java/org/apache/ambari/view/utils/ViewImpl.java

@@ -0,0 +1,50 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.ambari.view.utils;
+
+import org.apache.ambari.view.View;
+import org.apache.ambari.view.ViewDefinition;
+import org.apache.ambari.view.ViewInstanceDefinition;
+
+/**
+ * Default implementation that drop cached objects onUpdate
+ *
+ */
+public class ViewImpl implements View {
+  @Override
+  public void onDeploy(ViewDefinition definition) {
+
+  }
+
+  @Override
+  public void onCreate(ViewInstanceDefinition definition) {
+
+  }
+
+  @Override
+  public void onDestroy(ViewInstanceDefinition definition) {
+
+  }
+
+  @Override
+  public void onUpdate(ViewInstanceDefinition definition) {
+    //refresh all cached connection
+    UserLocal.dropInstanceConnection(definition.getInstanceName());
+  }
+}

contrib/views/utils/src/main/java/org/apache/ambari/view/utils/ViewUserLocal.java

@@ -1,116 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.ambari.view.utils;
-
-import org.apache.ambari.view.ViewContext;
-
-import java.util.HashMap;
-import java.util.Map;
-
-/**
- * Manages end user specific objects.
- * Ensures that the instance of specific class is exists only in one instance for
- * specific user of specific instance.
- * @param <T> user-local class
- */
-public class ViewUserLocal<T> {
-  private static Map<Class, Map<String, Object>> viewSingletonObjects = new HashMap<Class, Map<String, Object>>();
-  private final Class<T> tClass;
-
-  public ViewUserLocal(Class<T> tClass) {
-    this.tClass = tClass;
-  }
-
-  /**
-   * Initial value of user-local class. Value can be set either by initialValue() on first get() call,
-   * or directly by calling set() method. Default initial value is null, it can be changed by overriding
-   * this method.
-   * @param context initial value usually based on user properties provided by View Context
-   * @return initial value of user-local variable
-   */
-  protected synchronized T initialValue(ViewContext context) {
-    return null;
-  }
-
-  /**
-   * Returns user-local instance.
-   * If instance of class is not present yet for user, calls initialValue to create it.
-   * @param context View context that provides instance and user names.
-   * @return instance
-   */
-  public T get(ViewContext context) {
-    if (!viewSingletonObjects.containsKey(tClass)) {
-      viewSingletonObjects.put(tClass, new HashMap<String, Object>());
-    }
-
-    Map<String, Object> instances = viewSingletonObjects.get(tClass);
-
-    if (!instances.containsKey(getTagName(context))) {
-      instances.put(getTagName(context), initialValue(context));
-    }
-    return (T) instances.get(getTagName(context));
-  }
-
-  /**
-   * Method for directly setting user-local singleton instances.
-   * @param obj new variable value for current user
-   * @param context ViewContext that provides username and instance name
-   */
-  public void set(T obj, ViewContext context) {
-    if (!viewSingletonObjects.containsKey(tClass)) {
-      viewSingletonObjects.put(tClass, new HashMap<String, Object>());
-    }
-
-    Map<String, Object> instances = viewSingletonObjects.get(tClass);
-    instances.put(getTagName(context), obj);
-  }
-
-  /**
-   * Returns unique key for Map to store a user-local variable.
-   * @param context ViewContext
-   * @return Unique identifier of pair instance-user.
-   */
-  private String getTagName(ViewContext context) {
-    if (context == null) {
-      return "<null>";
-    }
-    return String.format("%s:%s", context.getInstanceName(), context.getUsername());
-  }
-
-  /**
-   * Method for testing purposes, intended to clear the cached user-local instances.
-   * Method should not normally be called from production code.
-   * @param tClass classname instances of which should be dropped
-   */
-  public static void dropAllConnections(Class tClass) {
-    Map<String, Object> instances = viewSingletonObjects.get(tClass);
-    if (instances != null) {
-      viewSingletonObjects.get(tClass).clear();
-    }
-  }
-
-  /**
-   * Method for testing purposes, intended to clear the cached user-local instances.
-   * Drops all classes of user-local variables.
-   * Method should not normally be called from production code.
-   */
-  public static void dropAllConnections() {
-    viewSingletonObjects.clear();
-  }
-}