feat(orders): expose order execution record on the api

Author: toommz

app/graphql/types/orders/execution_record.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Types
+  module Orders
+    class ExecutionRecord < Types::BaseObject
+      graphql_name "OrderExecutionRecord"
+
+      field :errors, [String], null: false
+      field :executed_at, String, null: true
+      field :execution_mode, Types::Orders::ExecutionModeEnum, null: true
+      field :invoice_id, ID, null: true
+
+      def errors
+        object["errors"] || []
+      end
+    end
+  end
+end

app/graphql/types/orders/object.rb

@@ -15,6 +15,7 @@ class Object < Types::BaseObject
       field :currency, String, null: true
       field :execute_at, GraphQL::Types::ISO8601DateTime, null: true
       field :executed_at, GraphQL::Types::ISO8601DateTime, null: true
+      field :execution_record, Types::Orders::ExecutionRecord, null: false
 
       field :customer, Types::Customers::Object, null: false
       field :order_form, Types::OrderForms::Object, null: false

app/serializers/v1/order_serializer.rb

@@ -12,6 +12,7 @@ def serialize
         billing_snapshot: model.billing_snapshot,
         currency: model.currency,
         executed_at: model.executed_at&.iso8601,
+        execution_record: model.execution_record,
         lago_organization_id: model.organization_id,
         lago_customer_id: model.customer_id,
         lago_order_form_id: model.order_form_id,

schema.graphql

@@ -15,6 +15,7 @@
           orderType
           createdAt
           updatedAt
+          executionRecord { errors executionMode invoiceId executedAt }
         }
       }
     GQL
@@ -48,6 +49,30 @@
     expect(data["number"]).to eq(order.number)
     expect(data["status"]).to eq("created")
     expect(data["orderType"]).to eq("subscription_creation")
+    expect(data["executionRecord"]).to eq(
+      "errors" => [], "executionMode" => nil, "invoiceId" => nil, "executedAt" => nil
+    )
+  end
+
+  context "when the order failed" do
+    let(:order) { create(:order, :failed, organization:, customer:, order_form:) }
+
+    it "resolves the execution record trace" do
+      result = execute_graphql(
+        current_user: membership.user,
+        current_organization: organization,
+        permissions: required_permission,
+        query:,
+        variables: {id: order.id}
+      )
+
+      record = result["data"]["order"]["executionRecord"]
+
+      expect(record["errors"]).to eq(["currencies_does_not_match"])
+      expect(record["executionMode"]).to eq("execute_in_lago")
+      expect(record["invoiceId"]).to be_nil
+      expect(record["executedAt"]).to be_nil
+    end
   end
 
   context "when order is not found" do

schema.json

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Types::Orders::ExecutionRecord do
+  subject { described_class }
+
+  it do
+    expect(subject).to have_field(:errors).of_type("[String!]!")
+    expect(subject).to have_field(:executed_at).of_type("String")
+    expect(subject).to have_field(:execution_mode).of_type("OrderExecutionModeEnum")
+    expect(subject).to have_field(:invoice_id).of_type("ID")
+  end
+end

spec/graphql/resolvers/order_resolver_spec.rb

@@ -16,6 +16,7 @@
     expect(subject).to have_field(:currency).of_type("String")
     expect(subject).to have_field(:execute_at).of_type("ISO8601DateTime")
     expect(subject).to have_field(:executed_at).of_type("ISO8601DateTime")
+    expect(subject).to have_field(:execution_record).of_type("OrderExecutionRecord!")
 
     expect(subject).to have_field(:customer).of_type("Customer!")
     expect(subject).to have_field(:order_form).of_type("OrderForm!")

spec/graphql/types/orders/execution_record_spec.rb

@@ -24,11 +24,28 @@
       "billing_snapshot" => order.billing_snapshot,
       "currency" => "EUR",
       "executed_at" => nil,
+      "execution_record" => order.execution_record,
       "lago_organization_id" => order.organization_id,
       "lago_customer_id" => order.customer_id,
       "lago_order_form_id" => order.order_form_id,
       "created_at" => order.created_at.iso8601,
       "updated_at" => order.updated_at.iso8601
     )
   end
+
+  context "when the order failed" do
+    let(:order) { create(:order, :failed, organization:, customer:, order_form:) }
+
+    it "serializes the execution record trace" do
+      result = JSON.parse(serializer.to_json)
+
+      expect(result["order"]["status"]).to eq("failed")
+      expect(result["order"]["execution_record"]).to eq(
+        "executed_at" => nil,
+        "execution_mode" => "execute_in_lago",
+        "invoice_id" => nil,
+        "errors" => ["currencies_does_not_match"]
+      )
+    end
+  end
 end