GH Issue 1718: Lookup to a query in a parent folder contaminates the request's query environment container (#8177)

Author: XingY

query/src/org/labkey/query/QueryTestCase.jsp

@@ -1625,6 +1625,98 @@ d,seven,twelve,day,month,date,duration,guid
         assertEquals(2, StringUtils.countMatches(debugSql, "CONTAINERFILTER"));
     }
 
+    // GH Issue 1718: a lookup resolves its target query against the folder the field is defined in, so compiling a query
+    // in a folder other than the request's must not move the environment container there.
+    @Test
+    public void testCompileLeavesEnvironmentContainer() throws Exception
+    {
+        User user = TestContext.get().getUser();
+        Container c = JunitUtil.getTestContainer();
+        Container sub = getSubfolder();
+
+        Object savedContainer = QueryService.get().getEnvironment(QueryService.Environment.CONTAINER);
+        try
+        {
+            QueryDefinition q = QueryService.get().createQueryDef(user, c, SchemaKey.fromString("core"), "QEnvContainer");
+            q.setSql("SELECT Name, ID FROM core.Containers");
+            q.save(user, c);
+
+            QueryService.get().setEnvironment(QueryService.Environment.CONTAINER, sub);
+
+            // compile in c, the way a lookup resolves its target in the folder the field is defined in
+            UserSchema coreInC = QueryService.get().getUserSchema(user, c, "core");
+            assertNotNull(coreInC.getTable("QEnvContainer"));
+
+            assertEquals(sub, QueryService.get().getEnvironment(QueryService.Environment.CONTAINER));
+        }
+        finally
+        {
+            QueryService.get().setEnvironment(QueryService.Environment.CONTAINER, savedContainer);
+            deleteQueryDef(user, c, "QEnvContainer");
+        }
+    }
+
+    // GH Issue 1718: folderPath() reports the folder its own query is compiled in. It used to read the same environment
+    // container that cross-folder compilation moves, so a sub-query from another folder could answer for its parent.
+    @Test
+    public void testFolderPathAcrossContainers() throws Exception
+    {
+        User user = TestContext.get().getUser();
+        Container c = JunitUtil.getTestContainer();
+        Container sub = getSubfolder();
+
+        Object savedContainer = QueryService.get().getEnvironment(QueryService.Environment.CONTAINER);
+        try
+        {
+            saveQueryDef(user, c, "QFolderPathInherited", "SELECT folderPath() AS p FROM core.Containers", true);
+            saveQueryDef(user, sub, "QFolderPathInner", "SELECT Name, ID FROM core.Containers", false);
+
+            QueryService.get().setEnvironment(QueryService.Environment.CONTAINER, c);
+
+            // an inherited query answers for the folder it runs in, not the one it is defined in
+            assertEquals(c.getPath(), selectFolderPath(user, c, "SELECT p FROM QFolderPathInherited"));
+            assertEquals(sub.getPath(), selectFolderPath(user, sub, "SELECT p FROM QFolderPathInherited"));
+
+            // compiling a sub-query from another folder must not answer for that folder
+            assertEquals(c.getPath(), selectFolderPath(user, c,
+                    "SELECT folderPath() AS p FROM Folder.qtest.core.QFolderPathInner"));
+
+            assertEquals(c, QueryService.get().getEnvironment(QueryService.Environment.CONTAINER));
+        }
+        finally
+        {
+            QueryService.get().setEnvironment(QueryService.Environment.CONTAINER, savedContainer);
+            deleteQueryDef(user, c, "QFolderPathInherited");
+            deleteQueryDef(user, sub, "QFolderPathInner");
+        }
+    }
+
+    private void saveQueryDef(User user, Container container, String name, String sql, boolean canInherit)
+    {
+        deleteQueryDef(user, container, name);
+        QueryDefinition q = QueryService.get().createQueryDef(user, container, SchemaKey.fromString("core"), name);
+        q.setSql(sql);
+        q.setCanInherit(canInherit);
+        q.save(user, container);
+    }
+
+    private void deleteQueryDef(User user, Container container, String name)
+    {
+        QueryDefinition q = QueryService.get().getQueryDef(user, container, "core", name);
+        if (null != q)
+            q.delete(user);
+    }
+
+    private String selectFolderPath(User user, Container container, String sql) throws Exception
+    {
+        QuerySchema schema = QueryService.get().getUserSchema(user, container, "core");
+        try (Results rs = QueryService.get().getSelectBuilder(schema, sql, true).select(true))
+        {
+            assertTrue(sql, rs.next());
+            return rs.getString("p");
+        }
+    }
+
     @Test
     public void testJSONDataLoader() throws Exception
     {

query/src/org/labkey/query/sql/Method.java

@@ -1604,17 +1604,19 @@ public static String toSimpleString(SQLFragment f)
     }
 
 
+    // GH Issue 1718: the query's own schema, not the thread-local, is authoritative for which query is being compiled.
+    // A lookup to a query in another folder compiles against that folder's schema, and reading the environment first
+    // made folder() report whichever query the thread compiled last.
     static Container getCompileTimeContainer(Query query)
     {
-        Container cCompile = (Container) QueryServiceImpl.get().getEnvironment(QueryService.Environment.CONTAINER);
-        if (null == cCompile && null != query)
+        if (null != query)
         {
             // Issue 53355: A column may be erroneously constructed (e.g. invalid calculated column) which can result in the schema being null
             QuerySchema querySchema = query.getSchema();
             if (querySchema != null)
-                cCompile = querySchema.getContainer();
+                return querySchema.getContainer();
         }
-        return cCompile;
+        return (Container) QueryServiceImpl.get().getEnvironment(QueryService.Environment.CONTAINER);
     }
 
 

query/src/org/labkey/query/sql/Query.java

@@ -608,8 +608,6 @@ public TableInfo getTableInfo()
             if (!_parseErrors.isEmpty())
                 return null;
 
-            QueryService.get().setEnvironment(QueryService.Environment.CONTAINER, getSchema().getContainer());
-
             TableInfo tinfo = _queryRoot.getTableInfo();
 
             if (!_parseErrors.isEmpty())