Merge pull request #33 from Automattic/upgrade/thrift-libs

ThriftSQL v0.3.0

- Added - Ability to send Impala queries with usernames
- Added - Default usernames to help limit invalid configurations
- Added - Automatically closing query handles after all results are read
- Added - Canceling queries on the server when timeouts are reached
- Upgraded - Libraries to `Thrift@0.12.0`, `Hive@1.1.0`, `Impala@2.12.0`
- Improved - Switched to a different classmap generator to get rid of a needless monkey patch of Beeswax service interface
- Improved - Better wrapping of underlying exceptions to ease debugging (Props @Napas / #15)
- Improved - Reduced size of PHP namespace and reorder them to better avoid collisions
- Improved - Strip down the distribution PHAR and removed extraneous artifacts from Packagist
- Improved - A better build and contribution process

Author: xyu

.editorconfig

@@ -0,0 +1,23 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2
+
+# Tab indentation (no size specified)
+[Makefile]
+indent_style = tab
+
+#
+# Auto generated files
+#
+[src/**.json]
+indent_size = 4
+
+[src/{Thrift,ThriftGenerated}/**.php]
+indent_size = 4

.gitattributes

@@ -1,3 +1,11 @@
 src                 export-ignore
+src-thrift          export-ignore
+.editorconfig       export-ignore
+.gitattributes      export-ignore
+.gitignore          export-ignore
+.gitmodules         export-ignore
 build.php           export-ignore
 example.php         export-ignore
+LICENSE             export-ignore
+Makefile            export-ignore
+README.md           export-ignore

.gitignore

@@ -1,2 +1,6 @@
+/composer.lock
+/build/
+/src/autoload.php
+/src/Thrift/
+/src/ThriftGenerated/
 /vendor/
-.php-autoload-generator-cache.json

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "src-thrift/thrift"]
+	path = src-thrift/thrift
+	url = https://github.com/apache/thrift.git
+[submodule "src-thrift/hive"]
+	path = src-thrift/hive
+	url = https://github.com/apache/hive.git
+[submodule "src-thrift/impala"]
+	path = src-thrift/impala
+	url = https://github.com/apache/impala.git

Makefile

@@ -0,0 +1,89 @@
+
+#
+# Startup Checks / Utils
+#
+
+# Check for prerequisites exist in our PATH
+EXECUTABLES = php thrift composer
+EXECUTABLES_OK := $(foreach EXEC, $(EXECUTABLES), \
+	$(if $(shell which $(EXEC)),some string, \
+		$(error Could not find '$(EXEC)') \
+	) \
+)
+
+# Detect multithread limit
+PLATFORM=$(shell uname -s)
+ifeq ($(PLATFORM),Darwin)
+THREADS := $(shell sysctl -n hw.ncpu)
+else ifeq ($(PLATFORM),Linux)
+THREADS := $(shell nproc)
+else
+THREADS := 2
+endif
+
+#
+# Make Targets
+#
+
+default: impala hive thrift
+	# Lint generated files
+	find build/gen-php/ThriftGenerated -type f -name "*.php" -print0 | \
+		xargs -0L1 -P ${THREADS} \
+		php -l
+
+impala: submodules
+	# Build error codes thrift file
+	src-thrift/impala/common/thrift/generate_error_codes.py
+	mv ErrorCodes.thrift build/
+	# Remap some dirs to fix file inclusion
+	@rm -f build/share
+	ln -s ../src-thrift/thrift/contrib build/share
+	# Build Impala
+	thrift --gen php:nsglobal=ThriftGenerated \
+		-o build \
+		-I build \
+		-I src-thrift/hive/metastore/if \
+		-I src-thrift/hive/service/if \
+		src-thrift/impala/common/thrift/ImpalaService.thrift
+	thrift --gen php:nsglobal=ThriftGenerated \
+		-o build \
+		-I build \
+		-I src-thrift/hive/metastore/if \
+		src-thrift/impala/common/thrift/beeswax.thrift
+
+hive: submodules
+	thrift --gen php:nsglobal=ThriftGenerated \
+		-o build \
+		-I src-thrift/hive \
+		src-thrift/hive/service/if/TCLIService.thrift
+
+thrift: submodules
+
+submodules:
+	git submodule update
+	@mkdir -p build
+
+install: default
+	@rm -rf src/Thrift
+	cp -a src-thrift/thrift/lib/php/lib src/Thrift
+	@rm -rf src/ThriftGenerated
+	mv build/gen-php/ThriftGenerated src/ThriftGenerated
+
+phar: install composer.lock
+	vendor/bin/phpab --nolower --output src/autoload.php --basedir src src
+	php -d phar.readonly=0 build.php
+
+clean-dev: clean
+	rm -rf vendor
+	rm -f composer.lock
+
+clean:
+	rm -rf build
+	rm -rf src/Thrift
+	rm -rf src/ThriftGenerated
+	rm -f src/autoload.php
+
+composer.lock: composer.json
+	composer install
+
+.PHONY: default impala hive thrift submodules install phar clean-dev clean

README.md

@@ -8,6 +8,18 @@ Currently the following engines are supported:
 * *Hive* -- Over the HiveServer2 Thrift interface, SASL is enabled by default so username and password must be provided however this can be turned off with the `setSasl()` method before calling `connect()`.
 * *Impala* -- Over the Impala Service Thrift interface which extends the Beeswax protocol.
 
+Version Compatibility
+---------------------
+
+This library is currently compiled against the Thrift definitions of the following database versions:
+
+- Apache Hive `1.1.0` ([Mar 2015](https://github.com/apache/hive/tree/release-1.1.0))
+- Apache Impala `2.12.0` ([Apr 2018](https://github.com/apache/impala/tree/2.12.0))
+
+Using the compiler and base PHP classes of:
+
+- Apache Thrift `0.12.0` ([Oct 2018](https://github.com/apache/thrift/tree/v0.12.0))
+
 Usage Example
 -------------
 
@@ -105,14 +117,10 @@ print_r( $impalaTables );
 Developing & Contributing
 -------------------------
 
-In order to rebuild this library you will need [Composer](https://getcomposer.org/) to install dev dependencies:
-
-```
-$ composer install
-```
+In order to rebuild this library you will need [Composer](https://getcomposer.org/) to install dev dependencies and [Apache Thrift](https://thrift.apache.org/) to compile client libraries from the Thrift interface definition files.
 
-Once dev tools are installed the phar can be rebuilt using the build script:
+Once dev tools are installed the phar can be rebuilt using `make`:
 
 ```
-$ php -d phar.readonly=0 build.php
+$ make clean && make phar
 ```

ThriftSQL.phar

@@ -1,24 +1,18 @@
 <?php
 
-  // Check we have dev tools
-  if ( !file_exists( __DIR__ . '/vendor/bin/php-generate-autoload' ) ) {
-    echo "Please install dev tools with:\n";
-    echo "$ composer install\n";
-    exit(1);
-  }
-
   // Check we can write phar
   if ( !Phar::canWrite() ) {
     echo "Can not write phar please run build script with:\n";
     echo "$ php -d phar.readonly=0 {$argv[0]}\n";
     exit(1);
   }
 
-  // Update autoload file
-  echo "Updating 'src/autoload.php'\n";
-  echo "\t" . preg_replace( '/\n/', "\n\t", shell_exec(
-    './vendor/bin/php-generate-autoload src/autoload.php'
-  ) ) . "\n";
+  // Check for autoload file
+  if ( ! file_exists( 'src/autoload.php' ) ) {
+    echo "Could not find generated autoload file, please use make tool:\n";
+    echo "$ make phar\n";
+    exit(1);
+  }
 
   // Create Stub
   echo "Updating 'ThriftSQL.phar'... ";
@@ -29,8 +23,14 @@
 EOF;
 
   // Create Phar
-  $phar = new Phar( 'ThriftSQL.phar', null, 'ThriftSQL.phar' );
+  $pharFilename = "ThriftSQL.phar";
+  if ( file_exists( $pharFilename ) ) {
+    unlink( $pharFilename );
+  }
+  $phar = new Phar( $pharFilename );
   $phar->buildFromDirectory( __DIR__ . '/src' );
   $phar->setStub( $stub );
+  $phar->setSignatureAlgorithm( Phar::SHA256 );
+  $phar->compressFiles( Phar::GZ );
 
   echo "Built!\n";

build.php

@@ -14,7 +14,7 @@
     }
   ],
   "require": {
-    "php": ">=5.3.0"
+    "php": ">=5.5.0"
   },
   "autoload": {
     "files": [ "ThriftSQL.phar" ]
@@ -26,6 +26,6 @@
     }
   ],
   "require-dev": {
-    "jesseschalken/autoload-generator": "^0.2.3"
+    "theseer/autoload": "1.*"
   }
 }