Update to singlestoredb-dev-image, fix devcontainer, readme improvements (#27)

* Update to singlestoredb-dev-image
* fix devcontainer
* readme improvements

Author: Carl Sverre

.devcontainer/Dockerfile

@@ -8,6 +8,12 @@ FROM mcr.microsoft.com/vscode/devcontainers/php:0-${VARIANT}
 ARG NODE_VERSION="none"
 RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
 
+ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
+RUN chmod +x /usr/local/bin/install-php-extensions && \
+    install-php-extensions gd xdebug
+
+RUN install-php-extensions pdo_mysql
+
 # [Optional] Uncomment this section to install additional OS packages.
 # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
 #     && apt-get -y install --no-install-recommends <your-package-list-here>

.github/workflows/tests.yml

@@ -6,10 +6,10 @@ on:
       - main
 
   pull_request:
-    types: [ opened, synchronize, reopened ]
+    types: [opened, synchronize, reopened]
 
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   test:
@@ -18,9 +18,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ 7.3, 7.4, 8.0, 8.1 ]
-        laravel: [ 8.*, 9.* ]
-        dependency-version: [ prefer-lowest, prefer-stable ]
+        php: [7.3, 7.4, 8.0, 8.1]
+        laravel: [8.*, 9.*]
+        dependency-version: [prefer-lowest, prefer-stable]
         include:
           - laravel: 8.*
             testbench: 6.*
@@ -45,14 +45,13 @@ jobs:
 
     services:
       singlestore:
-        # check for new versions at https://hub.docker.com/r/singlestore/cluster-in-a-box/tags
-        image: singlestore/cluster-in-a-box:alma-7.8.6-4f052c9b50-4.0.7-1.13.8
+        # check for new versions at https://github.com/singlestore-labs/singlestoredb-dev-image/pkgs/container/singlestoredb-dev/versions
+        image: ghcr.io/singlestore-labs/singlestoredb-dev:0.0.8
         ports:
           - "3306:3306"
         env:
-          LICENSE_KEY: ${{ secrets.SINGLESTORE_LICENSE }}
+          SINGLESTORE_LICENSE: ${{ secrets.SINGLESTORE_LICENSE }}
           ROOT_PASSWORD: "test"
-          START_AFTER_INIT: "Y"
 
     steps:
       - name: Checkout code
@@ -80,24 +79,12 @@ jobs:
       - name: Execute Unit Tests
         run: vendor/bin/phpunit
 
-      - name: Wait for SingleStore to start
-        run: |
-          attempts=0
-          until mysql -h 127.0.0.1 -u root -ptest -e "select 1"; do
-            echo "waiting for mysql..."
-            ((attempts=attempts+1))
-            if [[ $attempts -gt 5 ]]; then
-              docker logs $(docker ps -ql)
-            fi
-            sleep 1
-          done
-
       - name: SingleStore Container Logs
         run: docker logs $(docker ps -ql)
 
       - name: Create Test Database
         run: |
-          mysql -h 127.0.0.1 -u root -ptest -e "create database test"        
+          mysql -h 127.0.0.1 -u root -ptest -e "create database test"
 
       - name: Execute Integration Tests
         run: vendor/bin/phpunit

README.md

@@ -1,7 +1,27 @@
-# SingleStore Driver for Laravel
+# SingleStore Driver for Laravel <!-- omit in toc -->
 
 This repository contains a SingleStore Driver for Laravel.
 
+This package is currently in a pre-release beta, please use with caution and open any issues that you run into.
+
+- [Install](#install)
+- [Usage](#usage)
+- [PHP Versions before 8.1](#php-versions-before-81)
+- [Migrations](#migrations)
+  - [Rowstore Tables](#rowstore-tables)
+  - [Reference Tables](#reference-tables)
+  - [Global Temporary Tables](#global-temporary-tables)
+  - [Sparse Columns](#sparse-columns)
+  - [Sparse Tables](#sparse-tables)
+  - [Shard Keys](#shard-keys)
+  - [Sort Keys](#sort-keys)
+  - [Series Timestamps](#series-timestamps)
+  - [Computed Columns](#computed-columns)
+- [Testing](#testing)
+- [License](#license)
+- [Resources](#resources)
+- [User agreement](#user-agreement)
+
 ## Install
 
 You can install the package via composer:
@@ -10,6 +30,8 @@ You can install the package via composer:
 composer require singlestoredb/singlestoredb-laravel
 ```
 
+**This package requires pdo_mysql** to be installed. If you aren't sure check to see if `pdo_mysql` is listed when you run `php -i`.
+
 ## Usage
 
 To enable the driver, head to your `config/database.php` file and create a new entry for SingleStore in your `connections`, and update your `default` to point to that new connection:

tests/BaseTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev|https://twitter.com/aarondfrancis>
  */

tests/Hybrid/Json/JsonContainsTest.php

@@ -35,7 +35,7 @@ public function json_contains_strings()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([
+        [$id1] = $this->insertJsonData([
             ['array' => ['en', 1, true, ['a' => 'b']]],
             ['array' => ['es', 2, false, ['c' => 'd']]],
         ]);
@@ -60,7 +60,7 @@ public function json_contains_double()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([
+        [$id1] = $this->insertJsonData([
             ['array' => ['en', 1.5, true, ['a' => 'b']]],
             ['array' => ['es', 2.5, false, ['c' => 'd']]],
         ]);
@@ -85,7 +85,7 @@ public function json_contains_int()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([
+        [$id1] = $this->insertJsonData([
             ['array' => ['en', 1, true, ['a' => 'b']]],
             ['array' => ['es', 2, false, ['c' => 'd']]],
         ]);
@@ -110,7 +110,7 @@ public function json_contains_bool()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([
+        [$id1] = $this->insertJsonData([
             ['array' => ['en', 1, true, ['a' => 'b']]],
             ['array' => ['es', 2, false, ['c' => 'd']]],
         ]);
@@ -135,7 +135,7 @@ public function json_contains_json()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([
+        [$id1] = $this->insertJsonData([
             ['array' => ['en', 1, true, ['a' => 'b']]],
             ['array' => ['es', 2, false, ['c' => 'd']]],
         ]);

tests/Hybrid/Json/JsonKeypathsTest.php

@@ -27,7 +27,7 @@ public function it_compiles_column_only_without_path()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([[
+        [$id1] = $this->insertJsonData([[
             //
         ], [
             1,
@@ -51,7 +51,7 @@ public function it_compiles_nested_json_path()
             return;
         }
 
-        [, $id2,] = $this->insertJsonData([[
+        [, $id2] = $this->insertJsonData([[
             'value1' => ['value2' => ['value3' => ['value4' => 1]]],
         ], [
             'value1' => ['value2' => ['value3' => ['value4' => 2]]],
@@ -77,7 +77,7 @@ public function it_compiles_nested_json_path_with_array_access()
             return;
         }
 
-        [$id1,] = $this->insertJsonData([[
+        [$id1] = $this->insertJsonData([[
             'value1' => [['value2' => [[], [], [1]]]],
         ], [
             'value1' => [['value2' => [[], [], [2]]]],