app_bridge 0.8.4-x86_64-linux-musl → 2.0.0-x86_64-linux-musl

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff45e1df0003545c5af069059129da33ab80c8c4187f968f1cd64c8fd372d450
-  data.tar.gz: d2f37f3009bdd4f97534c35c77eab6bf6d90af4e3d2f80108787e5f1b85bcba3
+  metadata.gz: 2dfd7b1a3d7c0eeccfab8c0c66bd11bf2de807ddf24f2366cbc8ff28e5a34876
+  data.tar.gz: fd5d3f61590a6b15c841dc039ddad8f0d157e6b7f2e91d3015f1375981a073e3
 SHA512:
-  metadata.gz: 171c1aeb0b790f49f7eab3e3da9c3c5a4d543c049d467f691b0e42cf3a9048085df0a9b6757a99fc0944f06869f94355280acf8c5f4b7bb24068000a6dd1aaee
-  data.tar.gz: 109a40b597c143953d990b8306f30d0942ca95773045ac097afaee7f9c6c2d11d06237a95b94741da3ee098a134865cb754b4a2f286570757bda904c99a95e58
+  metadata.gz: 596181651b83501fb0c2094f534bba2bbe7060c82c5af50db4545b984385ffbfaf2c41528a3458d544e1e81b1a0d7c178958327fc4703bd8f82fee24ec896607
+  data.tar.gz: 6ae909b246ab94b923d58ed94c6fd645be2298be60cdaed9c8a33674ca1f0302237412fba845da56106e2b24c17a3e2cd7def0bf728e2345db28e804e9b39049

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.2

data/ext/app_bridge/wit/world.wit

@@ -1,4 +1,4 @@
-package standout:app@0.3.0;
+package standout:app@2.0.0;
 
 interface types {
   // The trigger-store is a string that is used to store data between trigger
@@ -59,30 +59,69 @@ interface types {
     // ensure that the event is only triggered once per order update.
     id: string,
 
-    // The timestamp of the event.
-    // Must be a unix timestamp in milliseconds since epoch (UTC).
-    // In JavaScript `Date.now()` can be used to get the current timestamp in
-    // milliseconds.
-    timestamp: u64,
-
     // Serialized data must be a JSON object serialized into a string
     // Note that it is important that the root is a object, not an array,
     // or another primitive type.
     serialized-data: string,
   }
+
+  /// A structured error that can be returned by for example a call to a trigger or action.
+  /// Contains a machine-readable code and a human-readable message.
+  record app-error {
+    /// The error code identifying the type of failure.
+    code: error-code,
+
+    /// A human-readable message describing the error in more detail.
+    message: string,
+  }
+
+  /// An enumeration of error codes that can be returned by a trigger implementation.
+  /// These codes help the platform and plugin developers distinguish between different types of failures.
+  variant error-code {
+    /// Authentication failed. Typically due to an invalid or expired API key or token.
+    unauthenticated,
+
+    /// Authorization failed. The account is valid but does not have the necessary permissions.
+    forbidden,
+
+    /// The trigger is misconfigured. For example, a required setting is missing or invalid.
+    misconfigured,
+
+    /// The target system does not support a required feature or endpoint.
+    unsupported,
+
+    /// The target system is rate-limiting requests. Try again later.
+    rate-limit,
+
+    /// The request timed out. The target system did not respond in time.
+    timeout,
+
+    /// The target system is currently unavailable or unreachable.
+    unavailable,
+
+    /// An unexpected internal error occurred in the plugin.
+    internal-error,
+
+    /// The response from the external system could not be parsed or was in an invalid format.
+    malformed-response,
+
+    /// A catch-all for all other types of errors. Should include a descriptive message.
+    other,
+  }
 }
 
 
 interface triggers {
-  use types.{trigger-context, trigger-event, trigger-response};
+  use types.{trigger-context, trigger-event, trigger-response, app-error};
 
-  get-triggers: func() -> list<string>;
+  trigger-ids: func() -> result<list<string>, app-error>;
 
   // Fetch events
   //
   // There are some limitations to the function:
-  // - It must return within 30 seconds
-  // - It must return less than or equal to 100 events
+  // - It must a `trigger-response` within 30 seconds
+  // - It must return less than or equal to 100 `trigger-response.events`
+  // - It must not return more than 64 kB of data in the `trigger-response.store`
   //
   // If you need to fetch more events, you can return up to 100 events and then
   // store the data needed for you to remember where you left off in the store.
@@ -98,7 +137,7 @@ interface triggers {
   // the same events. That will ensure that the user that is building an
   // integration with your trigger will not miss any events if your system is
   // down for a short period of time.
-  fetch-events: func(context: trigger-context) -> trigger-response;
+  fetch-events: func(context: trigger-context) -> result<trigger-response, app-error>;
 }
 
 interface http {

data/lib/app_bridge/app.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "timeout"
+
+module AppBridge
+  # An app that can be used to fetch events.
+  class App
+    def fetch_events(context)
+      response = request_events_with_timeout(context)
+
+      validate_number_of_events!(response.events)
+      validate_store_size!(response.store)
+
+      response
+    end
+
+    def polling_timeout
+      30 # seconds
+    end
+
+    private
+
+    def validate_number_of_events!(events)
+      return if events.size <= 100
+
+      raise TooManyEventsError, "Maximum 100 events allowed"
+    end
+
+    def validate_store_size!(store)
+      return if store.size <= 64 * 1024
+
+      raise StoreTooLargeError, "Store size exceeds 64 kB limit"
+    end
+
+    def request_events_with_timeout(context)
+      Timeout.timeout(polling_timeout, TimeoutError, "Polling exceeded #{polling_timeout} seconds") do
+        _rust_fetch_events(context)
+      end
+    end
+  end
+end

data/lib/app_bridge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AppBridge
-  VERSION = "0.8.4"
+  VERSION = "2.0.0"
 end

data/lib/app_bridge.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "app_bridge/version"
+require_relative "app_bridge/app"
+
 begin
   require "app_bridge/#{RUBY_VERSION.split(".").first(2).join(".")}/app_bridge"
 rescue LoadError
@@ -9,6 +11,9 @@ end
 
 module AppBridge
   class Error < StandardError; end
+  class TimeoutError < Error; end
+  class TooManyEventsError < Error; end
+  class StoreTooLargeError < Error; end
 
   # Represents a trigger event that is recieved from the app.
   class TriggerEvent

data/tasks/fixtures.rake

@@ -2,36 +2,43 @@
 
 require "English"
 
-namespace :fixtures do
+namespace :fixtures do # rubocop:disable Metrics/BlockLength
   namespace :apps do
     desc "Clean up build artifacts"
     task :clean do
-      # In context of the path spec/fixtures/components/example.
+      # In context of the path spec/fixtures/components/rust_app.
       # Execute cargo clean.
       #
-      pwd = "spec/fixtures/components/example"
+      pwd = "spec/fixtures/components/rust_app"
       pid = Process.spawn("cargo clean", chdir: pwd)
       Process.wait(pid)
       raise "Failed to clean build artifacts" unless $CHILD_STATUS.success?
 
       # Remove the built wasm artifact.
-      pid = Process.spawn("rm example.wasm", chdir: "spec/fixtures/components")
+      pid = Process.spawn("rm rust_app.wasm", chdir: "spec/fixtures/components")
       Process.wait(pid)
     end
 
     desc "Compile the fixture apps"
-    task :compile do
-      pwd = "spec/fixtures/components/example"
+    task :compile_rust do
+      pwd = "spec/fixtures/components/rust_app"
       compile_pid = Process.spawn("cargo clean && cargo build --release --target wasm32-wasip2",
                                   chdir: pwd)
       Process.wait(compile_pid)
       raise "Failed to build artifacts" unless $CHILD_STATUS.success?
 
-      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/example.wasm #{pwd}/../example.wasm")
+      move_pid = Process.spawn("mv #{pwd}/target/wasm32-wasip2/release/rust_app.wasm #{pwd}/../rust_app.wasm")
       Process.wait(move_pid)
     end
+
+    task :compile_js do
+      pwd = "spec/fixtures/components/js_app"
+      pid = Process.spawn("npm run build", chdir: pwd)
+      Process.wait(pid)
+      raise "Failed to build artifacts" unless $CHILD_STATUS.success?
+    end
   end
 end
 
 desc "Build all fixtures"
-task fixtures: %i[fixtures:apps:clean fixtures:apps:compile]
+task fixtures: %i[fixtures:apps:clean fixtures:apps:compile_rust fixtures:apps:compile_js]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_bridge
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 2.0.0
 platform: x86_64-linux-musl
 authors:
 - Alexander Ross
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies: []
 description: The app_bridge gem is designed to enable seamless interaction with WebAssembly
   components that adhere to the WIT specification `standout:app`. It is developed
@@ -21,14 +21,15 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - README.md
 - Rakefile
 - ext/app_bridge/wit/world.wit
 - lib/app_bridge.rb
-- lib/app_bridge/3.1/app_bridge.so
 - lib/app_bridge/3.2/app_bridge.so
 - lib/app_bridge/3.4/app_bridge.so
+- lib/app_bridge/app.rb
 - lib/app_bridge/version.rb
 - sig/app_bridge.rbs
 - tasks/fixtures.rake
@@ -49,7 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
   - - "<"
     - !ruby/object:Gem::Version
       version: 3.5.dev