feat: Enable editing and recalling from history in CLI (#523)

Summary:
Pull Request resolved: #523

Integrate CLI with Readline library to allow editing SQL while typing and recalling previously used SQL commands using up arrow.

Readline library - https://tiswww.case.edu/php/chet/readline/rltop.html

Part of #522

Reviewed By: kgpai, xiaoxmeng

Differential Revision: D84913703

fbshipit-source-id: b24db159da4acc828e350e81d175d24d333e61fa

Author: mbasmanova

.github/workflows/build_and_test.yml

@@ -41,7 +41,7 @@ jobs:
       matrix:
         build_type: [debug, release]
     name: Build Axiom
-    runs-on: 16-core-ubuntu
+    runs-on: 32-core-ubuntu
     container:
       image: ghcr.io/facebookincubator/velox-dev:centos9
     env:
@@ -89,6 +89,10 @@ jobs:
         run: |
           ccache -sz
 
+      - name: Install Readline
+        run: |
+          dnf install -y readline-devel
+
       - name: Build Axiom ${{ matrix.build_type }}
         env:
           MAKEFLAGS: NUM_THREADS=4 MAX_HIGH_MEM_JOBS=4 MAX_LINK_JOBS=2

CMakeLists.txt

@@ -153,6 +153,35 @@ velox_resolve_dependency(antlr4-runtime)
 
 message(STATUS "Using ANTLR4 runtime from ${ANTLR4_INCLUDE_DIR}")
 
+# Add Readline dependency
+find_path(
+  READLINE_INCLUDE_DIR
+  readline/readline.h
+  HINTS ${READLINE_ROOT_DIR}
+  PATH_SUFFIXES include
+  REQUIRED
+)
+find_library(READLINE_LIBRARY readline HINTS ${READLINE_ROOT_DIR} PATH_SUFFIXES lib REQUIRED)
+find_library(NCURSES_LIBRARY ncurses REQUIRED) # readline depends on libncurses
+
+mark_as_advanced(READLINE_INCLUDE_DIR READLINE_LIBRARY NCURSES_LIBRARY)
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(
+  Readline
+  DEFAULT_MSG
+  READLINE_LIBRARY
+  NCURSES_LIBRARY
+  READLINE_INCLUDE_DIR
+)
+
+set(READLINE_INCLUDE_DIRS ${READLINE_INCLUDE_DIR})
+set(READLINE_LIBRARIES ${READLINE_LIBRARY} ${NCURSES_LIBRARY})
+
+message(STATUS "Found Readline: ${READLINE_LIBRARIES}")
+
+include_directories(${READLINE_INCLUDE_DIR})
+
 # Use xxhash and xsimd from Velox for now.
 include_directories(.)
 include_directories(${CMAKE_BINARY_DIR})

axiom/optimizer/tests/AxiomSql.cpp

@@ -18,6 +18,8 @@
 #include <folly/executors/IOThreadPoolExecutor.h>
 #include <folly/init/Init.h>
 #include <gflags/gflags.h>
+#include <readline/history.h>
+#include <readline/readline.h>
 #include <sys/resource.h>
 #include <sys/time.h>
 #include <iostream>
@@ -647,14 +649,21 @@ class VeloxRunner {
 // more whitespaces.
 // @return Command text with leading and trailing whitespaces as well as
 // trailing ';' removed.
-std::string readCommand(std::istream& in, bool& end) {
+std::string readCommand(bool& atEnd) {
   std::stringstream command;
-  end = false;
+  atEnd = false;
 
   bool stripLeadingSpaces = true;
 
-  std::string line;
-  while (std::getline(in, line)) {
+  while (char* rawLine = readline("")) {
+    SCOPE_EXIT {
+      if (rawLine != nullptr) {
+        free(rawLine);
+      }
+    };
+
+    std::string line(rawLine);
+
     int64_t startPos = 0;
     if (stripLeadingSpaces) {
       for (; startPos < line.size(); ++startPos) {
@@ -677,6 +686,7 @@ std::string readCommand(std::istream& in, bool& end) {
 
       if (line[i] == ';') {
         command << line.substr(startPos, i - startPos);
+        add_history(fmt::format("{};", command.str()).c_str());
         return command.str();
       }
 
@@ -686,19 +696,16 @@ std::string readCommand(std::istream& in, bool& end) {
     stripLeadingSpaces = false;
     command << line.substr(startPos) << std::endl;
   }
-  end = true;
+  atEnd = true;
   return "";
 }
 
-void readCommands(
-    VeloxRunner& runner,
-    std::string_view prompt,
-    std::istream& in) {
+void readCommands(VeloxRunner& runner, std::string_view prompt) {
   for (;;) {
     std::cout << prompt;
-    bool end;
-    std::string command = readCommand(in, end);
-    if (end) {
+    bool atEnd;
+    std::string command = readCommand(atEnd);
+    if (atEnd) {
       break;
     }
 
@@ -803,7 +810,7 @@ int main(int argc, char** argv) {
                    "flag name = value; sets a gflag.\n"
                    "help; prints help text."
                 << std::endl;
-      readCommands(runner, "SQL> ", std::cin);
+      readCommands(runner, "SQL> ");
     }
   } catch (std::exception& e) {
     std::cerr << "Error: " << e.what() << std::endl;

axiom/optimizer/tests/CMakeLists.txt

@@ -133,6 +133,7 @@ target_link_libraries(
   axiom_hive_connector_metadata
   axiom_tpch_connector_metadata
   axiom_sql_presto_parser
+  ${READLINE_LIBRARIES}
   velox_query_benchmark
   velox_exec_test_lib
   velox_dwio_common