feat: add query type support for SOQL

server/Gemfile

@@ -12,7 +12,7 @@ gem "interactor", "~> 3.0"
 
 gem "ruby-odbc", git: "https://github.com/Multiwoven/ruby-odbc.git"
 
-gem "multiwoven-integrations", "~> 0.1.52"
+gem "multiwoven-integrations", "~> 0.1.55"
 
 gem "temporal-ruby", github: "coinbase/temporal-ruby"
 

server/Gemfile.lock

@@ -111,12 +111,12 @@ GEM
       fiber-annotation
       io-event (~> 1.5, >= 1.5.1)
       timers (~> 4.1)
-    async-http (0.64.0)
+    async-http (0.64.1)
       async (>= 1.25)
       async-io (>= 1.28)
       async-pool (>= 0.2)
       protocol-http (~> 0.26.0)
-      protocol-http1 (~> 0.18.0)
+      protocol-http1 (~> 0.19.0)
       protocol-http2 (~> 0.16.0)
       traces (>= 0.10.0)
     async-io (1.42.0)
@@ -1755,7 +1755,7 @@ GEM
     gli (2.21.1)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    google-apis-bigquery_v2 (0.66.0)
+    google-apis-bigquery_v2 (0.67.0)
       google-apis-core (>= 0.14.0, < 2.a)
     google-apis-core (0.14.1)
       addressable (~> 2.5, >= 2.5.1)
@@ -1859,7 +1859,7 @@ GEM
     msgpack (1.7.2)
     multi_json (1.15.0)
     multipart-post (2.4.0)
-    multiwoven-integrations (0.1.52)
+    multiwoven-integrations (0.1.55)
       activesupport
       async-websocket
       csv
@@ -1893,7 +1893,7 @@ GEM
       net-ssh (>= 5.0.0, < 8.0.0)
     net-smtp (0.4.0.1)
       net-protocol
-    net-ssh (7.2.1)
+    net-ssh (7.2.3)
     newrelic_rpm (9.7.0)
     nio4r (2.7.0)
     nokogiri (1.16.0-aarch64-linux)
@@ -1914,20 +1914,20 @@ GEM
     pg_query (5.0.0)
       google-protobuf (>= 3.22.3)
     protocol-hpack (1.4.3)
-    protocol-http (0.26.1)
-    protocol-http1 (0.18.0)
+    protocol-http (0.26.2)
+    protocol-http1 (0.19.0)
       protocol-http (~> 0.22)
     protocol-http2 (0.16.0)
       protocol-hpack (~> 1.4)
       protocol-http (~> 0.18)
-    protocol-rack (0.4.1)
+    protocol-rack (0.5.0)
       protocol-http (~> 0.23)
       rack (>= 1.0)
     protocol-websocket (0.12.1)
       protocol-http (~> 0.2)
     psych (5.1.2)
       stringio
-    public_suffix (5.0.4)
+    public_suffix (5.0.5)
     puma (6.4.2)
       nio4r (~> 2.0)
     racc (1.7.3)
@@ -1986,7 +1986,7 @@ GEM
     responders (3.1.1)
       actionpack (>= 5.2)
       railties (>= 5.2)
-    restforce (7.3.0)
+    restforce (7.3.1)
       faraday (>= 1.1.0, < 2.10.0)
       faraday-follow_redirects (<= 0.3.0, < 1.0.0)
       faraday-multipart (>= 1.0.0, < 2.0.0)
@@ -2036,7 +2036,7 @@ GEM
     ruby-limiter (2.3.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    sequel (5.78.0)
+    sequel (5.79.0)
       bigdecimal
     shoulda-matchers (5.3.0)
       activesupport (>= 5.2.0)
@@ -2060,7 +2060,7 @@ GEM
       gli
       hashie
     stringio (3.1.0)
-    stripe (10.13.0)
+    stripe (10.14.0)
     thor (1.3.0)
     timecop (0.9.8)
     timeout (0.4.1)
@@ -2119,7 +2119,7 @@ DEPENDENCIES
   jwt
   kaminari
   liquid
-  multiwoven-integrations (~> 0.1.52)
+  multiwoven-integrations (~> 0.1.55)
   newrelic_rpm
   parallel
   pg (~> 1.1)

server/app/contracts/connector_contracts.rb

@@ -95,11 +95,5 @@ class QuerySource < Dry::Validation::Contract
       required(:id).filled(:integer)
       required(:query).filled(:string)
     end
-    # TODO: introduce query_type SOQL
-    rule(:query) do
-      # PgQuery.parse(value)
-    rescue PgQuery::ParseError => e
-      key.failure("contains invalid SQL syntax: #{e.message}")
-    end
   end
 end

server/app/contracts/model_contracts.rb

@@ -24,12 +24,6 @@ class Create < Dry::Validation::Contract
       end
     end
 
-    rule(model: :query) do
-      # PgQuery.parse(value)
-    rescue PgQuery::ParseError
-      key.failure("contains invalid SQL syntax")
-    end
-
     rule(model: :query_type) do
       key.failure("invalid query type") unless Multiwoven::Integrations::Protocol::ModelQueryType.include?(value)
     end
@@ -47,16 +41,6 @@ class Update < Dry::Validation::Contract
       end
     end
 
-    rule(model: :query) do
-      if key?
-        begin
-          # PgQuery.parse(value)
-        rescue PgQuery::ParseError => e
-          key.failure("contains invalid SQL syntax: #{e.message}")
-        end
-      end
-    end
-
     rule(model: :query_type) do
       unless !key? || Multiwoven::Integrations::Protocol::ModelQueryType.include?(value)
         key.failure("invalid query type")

server/app/controllers/api/v1/connectors_controller.rb

@@ -5,6 +5,7 @@ module V1
     class ConnectorsController < ApplicationController
       include Connectors
       before_action :set_connector, only: %i[show update destroy discover query_source]
+      before_action :validate_query, only: %i[query_source]
       after_action :event_logger
 
       def index
@@ -112,10 +113,19 @@ def set_connector
         )
       end
 
+      def validate_query
+        Utils::QueryValidator.validate_query(@connector.connector_query_type, params[:query])
+      rescue StandardError => e
+        render_error(
+          message: "Query validation failed: #{e.message}",
+          status: :unprocessable_entity
+        )
+      end
+
       def connector_params
         params.require(:connector).permit(:workspace_id,
                                           :connector_type,
-                                          :connector_name, :name, :description,
+                                          :connector_name, :name, :description, :query_type,
                                           configuration: {})
       end
     end

server/app/controllers/api/v1/models_controller.rb

@@ -8,6 +8,7 @@ class ModelsController < ApplicationController
 
       before_action :set_connector, only: %i[create]
       before_action :set_model, only: %i[show update destroy]
+      before_action :validate_query, only: %i[create update]
       after_action :event_logger
 
       def index
@@ -70,6 +71,16 @@ def set_model
         @model = current_workspace.models.find(params[:id])
       end
 
+      def validate_query
+        query_type = @model.present? ? @model.connector.connector_query_type : @connector.connector_query_type
+        Utils::QueryValidator.validate_query(query_type, params.dig(:model, :query))
+      rescue StandardError => e
+        render_error(
+          message: "Query validation failed: #{e.message}",
+          status: :unprocessable_entity
+        )
+      end
+
       def model_params
         params.require(:model).permit(:connector_id,
                                       :name,

server/app/models/connector.rb

@@ -76,4 +76,14 @@ def connector_client
         connector_type.to_s.camelize, connector_name.to_s.camelize
       )
   end
+
+  def connector_query_type
+    client = Multiwoven::Integrations::Service
+             .connector_class(
+               connector_type.to_s.camelize, connector_name.to_s.camelize
+             ).new
+    connector_spec = client.connector_spec
+
+    connector_spec&.connector_query_type || "raw_sql"
+  end
 end

server/app/models/model.rb

@@ -20,7 +20,7 @@ class Model < ApplicationRecord
   validates :name, presence: true
   validates :query, presence: true
   validates :primary_key, presence: true
-  enum :query_type, %i[raw_sql]
+  enum :query_type, %i[raw_sql dbt soql]
 
   belongs_to :workspace
   belongs_to :connector

server/lib/utils/query_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Utils
+  module QueryValidator
+    def self.validate_query(query_type, query)
+      case query_type.to_sym
+      when :raw_sql
+        begin
+          PgQuery.parse(query)
+        rescue PgQuery::ParseError => e
+          raise StandardError, "Query contains invalid SQL syntax: #{e.message}"
+        end
+      when :soql
+        begin
+          # TODO: SOQL
+        rescue StandardError => e
+          raise StandardError, "Query contains invalid SOQL syntax: #{e.message}"
+        end
+      else
+        raise StandardError, "Unsupported query_type"
+      end
+    end
+  end
+end

server/spec/contracts/connector_contracts_spec.rb

@@ -51,15 +51,6 @@
       expect(contract.call(valid_inputs)).to be_success
     end
   end
-
-  context "when query contains invalid SQL syntax" do
-    let(:invalid_inputs) { { id: 1, query: "SELECT FROM table;" } }
-
-    it "fails validation" do
-      # result = contract.call(invalid_inputs)
-      # expect(result.errors[:query]).to include(a_string_matching("contains invalid SQL syntax"))
-    end
-  end
 end
 
 describe ConnectorContracts::Discover do

server/spec/contracts/model_contracts_spec.rb

@@ -62,28 +62,22 @@
       end
     end
 
-    context "with invalid SQL syntax in query" do
+    context "with invalid query_type" do
       let(:invalid_inputs) do
         {
           model: {
             connector_id: 1,
             name: "Model Name",
             query: "SELECT FROM table;",
-            query_type: "raw_sql",
+            query_type: "test",
             primary_key: "id"
           }
         }
       end
 
       it "fails validation due to invalid SQL syntax" do
-        allow(PgQuery).to receive(:parse).with("SELECT FROM table;").and_raise(
-          PgQuery::ParseError.new(
-            "invalid syntax",
-            __FILE__, __LINE__, -1
-          )
-        )
-        # result = contract.call(invalid_inputs)
-        # expect(result.errors[:model][:query]).to include("contains invalid SQL syntax")
+        result = contract.call(invalid_inputs)
+        expect(result.errors[:model][:query_type]).to include("invalid query type")
       end
     end
   end
@@ -98,17 +92,35 @@
           model: {
             name: "Updated Model Name",
             query: "SELECT * FROM updated_table;",
-            query_type: "raw_sql",
+            query_type: "soql",
             primary_key: "updated_id"
           }
         }
       end
 
       it "passes validation" do
-        allow(PgQuery).to receive(:parse).with("SELECT * FROM updated_table;").and_return(true)
         expect(contract.call(valid_inputs)).to be_success
       end
     end
+
+    context "with invalid query_type" do
+      let(:invalid_inputs) do
+        {
+          model: {
+            connector_id: 1,
+            name: "Model Name",
+            query: "SELECT FROM table;",
+            query_type: "test",
+            primary_key: "id"
+          }
+        }
+      end
+
+      it "fails validation due to invalid SQL syntax" do
+        result = contract.call(invalid_inputs)
+        expect(result.errors[:model][:query_type]).to include("invalid query type")
+      end
+    end
   end
 
   describe ModelContracts::Destroy do

server/spec/lib/utils/query_validator_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Utils::QueryValidator do
+  describe ".validate_query" do
+    context "with valid SQL query" do
+      let(:query_type) { :raw_sql }
+      let(:query) { "SELECT * FROM users;" }
+
+      it "does not raise an error" do
+        expect { described_class.validate_query(query_type, query) }.not_to raise_error
+      end
+    end
+
+    context "with invalid SQL query" do
+      let(:query_type) { :raw_sql }
+      let(:query) { "INVALID SQL QUERY;" }
+
+      it "raises a StandardError with error message" do
+        expect do
+          described_class.validate_query(query_type, query)
+        end.to raise_error(StandardError, /contains invalid SQL syntax/)
+      end
+    end
+
+    context "with unsupported query type" do
+      let(:query_type) { :unsupported }
+      let(:query) { "SELECT * FROM users;" }
+
+      it "raises a StandardError with error message" do
+        expect do
+          described_class.validate_query(query_type, query)
+        end.to raise_error(StandardError, /Unsupported query_type/)
+      end
+    end
+  end
+end