asyncapi-server 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2cd757bb2567503b5ba9d8ce6e83ca056a199305
-  data.tar.gz: 57cf7ac80d344addd357356b8949e3fdd3bc4fae
+SHA256:
+  metadata.gz: d20ce991b75b2d975140fb6ec3d1a9dffb14116167bbcd072007ad7d3b15b9af
+  data.tar.gz: e64c1c4061e6b85b320258d995636a402858f96dfe5b66e59b32541296f798c9
 SHA512:
-  metadata.gz: 4e9f48b45f660abbed76f254fd0c93ed330c071c816c38f2a0ff7c761ab0110498837594fee02408bc8d906a128478861dbdde68933bd33512c623242fe265dc
-  data.tar.gz: c0292eab80325a33914f37997f7d7bf79a175c3090ab5f8c2ae7881e86d3315d8bcfe57b71343ad9115ff583b2b08e6e653ed39e5987f767971f1a0cfc262272
+  metadata.gz: 77bfca4c01e794d67678f942d89df08afa0f82f8c2b84ae08806e2e00f3cf3cdd67e02f36166952eddc5d6fbeb279fd36659d1df7f43e126713e020f7dbefe1d
+  data.tar.gz: 9ef0745fcf8bcd1922f1bd997c6470b2ae05ab1f072e6a8f73e4b4df3d6f906394a2d9c5b464e016b2589370d2f7b3ab536ef2979f0bba3a4fbc5cf1993ac4ff

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 G5
+Copyright 2016 G5
 
 MIT License
 

data/README.md

@@ -54,6 +54,37 @@ If you use `protected_attributes`, in an initializer:
 Asyncapi::Server::Job.attr_accessible :status, :callback_url, :class_name, :params, :secret
 ```
 
+## Usage without Asyncapi::Client
+
+If you want to use this without asyncapi client, you need to prepare two things: the endpoint that asyncapi-server will reply to.
+
+Create the job by POSTing the following to CreateSomething above:
+
+```json
+{
+  "job": {
+    "callback_url": "https://myclient.com/jobs_callback",
+    "params": {
+      "name": "Something's name",
+      "approved": true
+    },
+    "secret": "A secret unique to this job, so that you know what job the server is referring to"
+  }
+}
+```
+
+When the server is done processing, it will post something to your client. Your endpoint must accept the following json as the body:
+
+```
+{
+  "job": {
+    "status": "success",
+    "message": "The output of the Runner class (i.e. `CreateSomething`)",
+    "secret": "The secret you had sent earlier (this is how you can be sure it's not someone else updating your endpoint)",
+  }
+}
+```
+
 ### RSpec
 
 If you want to create an integration spec for you Asyncapi server endpoint, make sure you require the helper:
@@ -65,14 +96,20 @@ require "asyncapi/server/rspec"
 When you make a request, instead of `post`, use `asyncapi_post`. Ex:
 
 ```ruby
-asyncapi_post("/api/v1/long_running_job", name: "Compute")
+asyncapi_post("/api/v1/long_running_job", params: { name: "Compute" })
 ```
 
 This helper calls `post` underneath but builds the request in a way that Asyncapi server understands.
 
+## Development
+
+- Run `rake db:migrate && rake db:migrate RAILS_ENV=test`
+- Make changes
+- `rspec`
+
 ## License
 
-Copyright (c) 2015 G5
+Copyright (c) 2016 G5
 
 MIT License
 

data/app/controllers/asyncapi/server/v1/jobs_controller.rb

@@ -2,6 +2,7 @@ module Asyncapi
   module Server
     module V1
       class JobsController < ApplicationController # TODO: Asyncapi::Server.parent_controller
+        include Rails::Pagination
 
         protect_from_forgery with: :null_session
         respond_to :json
@@ -24,7 +25,7 @@ module Asyncapi
             job.destroy
             respond_with job
           else
-            render nothing: true, status: 404
+            head :not_found
           end
         end
 

data/app/serializers/asyncapi/server/job_serializer.rb

@@ -2,7 +2,7 @@ module Asyncapi
   module Server
     class JobSerializer < ActiveModel::Serializer
 
-      attributes :id, :url, :secret
+      attributes :id, :status, :url, :secret
 
     end
   end

data/app/workers/asyncapi/server/job_status_notifier_worker.rb

@@ -0,0 +1,51 @@
+module Asyncapi::Server
+  class JobStatusNotifierWorker
+
+    include Sidekiq::Worker
+    sidekiq_options retry: false
+    MAX_RETRIES = 2
+
+    def perform(job_id, job_message, retries=0)
+      @job = Job.find(job_id)
+
+      report_job_status(job_message)
+
+      unless @response.code == 200
+        if retries <= MAX_RETRIES
+          @jid = JobStatusNotifierWorker.perform_async(job_id, job_message, retries+1)
+        else
+          raise format_error("Something went wrong while poking #{@job.callback_url}")
+        end
+      end
+    end
+
+    private
+
+    def report_job_status(job_message)
+      @response ||= Typhoeus.put(
+        @job.callback_url,
+        body: {
+          job: {
+            status: @job.status,
+            message: @job_message,
+            secret: @job.secret,
+          }
+        }.to_json,
+        headers: {
+          "Content-Type" => "application/json",
+          Accept: "application/json"
+        }
+      )
+    end
+
+    def format_error(error)
+      [
+        error,
+        "JobID: #{@job.id}",
+        "Next Attempt: #{@jid}",
+        "HTTP Status: #{@response.code}",
+        "HTTP Response: #{@response.inspect}",
+      ].join("\n")
+    end
+  end
+end

data/app/workers/asyncapi/server/job_worker.rb

@@ -3,8 +3,9 @@ module Asyncapi::Server
 
     include Sidekiq::Worker
     sidekiq_options retry: false
+    MAX_RETRIES = 2
 
-    def perform(job_id)
+    def perform(job_id, retries=0)
       job = Job.find(job_id)
       runner_class = job.class_name.constantize
 
@@ -15,28 +16,25 @@ module Asyncapi::Server
       job_message = [e.message, e.backtrace].flatten.join("\n")
       raise e
     ensure
-      job.update_attributes(status: job_status)
-      report_job_status(job, job_message)
+      if job
+        job.update_attributes(status: job_status)
+        report_job_status(job, job_message)
+      else
+        # For some reason "ActiveRecord::Base.after_transaction",
+        # ":after_commit" and ":after_create" does not prevent
+        # the ActiveRecord-Sidekiq race condition. In order to
+        # prevent this just retry running JobWorker until it finds
+        # the job by job_id.
+        if retries <= MAX_RETRIES
+          JobWorker.perform_async(job_id, retries+1)
+        end
+      end
     end
 
     private
 
     def report_job_status(job, job_message)
-      Typhoeus.put(
-        job.callback_url,
-        body: {
-          job: {
-            status: job.status,
-            message: job_message,
-            secret: job.secret,
-          }
-        }.to_json,
-        headers: {
-          "Content-Type" => "application/json",
-          Accept: "application/json"
-        }
-      )
+      JobStatusNotifierWorker.perform_async(job.id, job_message)
     end
-
   end
 end

data/db/migrate/20141112034324_create_asyncapi_server_jobs.rb

@@ -1,4 +1,4 @@
-class CreateAsyncapiServerJobs < ActiveRecord::Migration
+class CreateAsyncapiServerJobs < ActiveRecord::Migration[4.2]
   def change
     create_table :asyncapi_server_jobs do |t|
       t.integer :status

data/db/migrate/20141212064931_add_secret_to_asyncapi_server_job.rb

@@ -1,4 +1,4 @@
-class AddSecretToAsyncapiServerJob < ActiveRecord::Migration
+class AddSecretToAsyncapiServerJob < ActiveRecord::Migration[4.2]
   def change
     add_column :asyncapi_server_jobs, :secret, :string
   end

data/db/migrate/20150130062520_add_expired_at_to_asyncapi_server_job.rb

@@ -1,4 +1,4 @@
-class AddExpiredAtToAsyncapiServerJob < ActiveRecord::Migration
+class AddExpiredAtToAsyncapiServerJob < ActiveRecord::Migration[4.2]
   def change
     add_column :asyncapi_server_jobs, :expired_at, :datetime
 

data/db/migrate/20150201231018_drop_expired_at_from_asyncapi_server_jobs.rb

@@ -1,4 +1,4 @@
-class DropExpiredAtFromAsyncapiServerJobs < ActiveRecord::Migration
+class DropExpiredAtFromAsyncapiServerJobs < ActiveRecord::Migration[4.2]
   def up
     remove_column :asyncapi_server_jobs, :expired_at
   end

data/lib/asyncapi/server.rb

@@ -1,3 +1,6 @@
+require 'active_model_serializers'
+require 'responders'
+require 'ar_after_transaction'
 require "asyncapi/server/engine"
 
 module Asyncapi

data/lib/asyncapi/server/rails_ext/controller.rb

@@ -9,8 +9,10 @@ module Asyncapi
           def async(method_name, klass)
             define_method(method_name) do
               job = Job.create(job_params_with(klass.name))
+              ActiveRecord::Base.after_transaction do
+                JobWorker.perform_async(job.id)
+              end
               serializer = JobSerializer.new(job)
-              JobWorker.perform_async(job.id)
               render json: serializer
             end
           end

data/lib/asyncapi/server/rspec.rb

@@ -3,15 +3,28 @@ module Asyncapi
     module RSpec
 
       def asyncapi_post(url, params)
-        post(url, {
-          job: {
-            callback_url: "callback_url",
-            params: params,
-            secret: "sekret",
-          }
-        })
+        formatted_params = format_params(params)
+        post(url, formatted_params)
       end
 
+      private
+
+      def format_params(params)
+        if params.is_a?(Hash) && params.has_key?(:params)
+          params = params[:params]
+          return { params: base_params(params) }
+        else
+          return base_params(params)
+        end
+      end
+
+      def base_params(params)
+        return { job: {
+          callback_url: "callback_url",
+          params: params,
+          secret: "sekret",
+        }}
+      end
     end
   end
 end

data/lib/asyncapi/server/version.rb

@@ -1,5 +1,5 @@
 module Asyncapi
   module Server
-    VERSION = "1.1.0"
+    VERSION = "1.3.0"
   end
 end

data/spec/controllers/asyncapi/server/v1/jobs_controller_spec.rb

@@ -10,7 +10,7 @@ module Asyncapi
           it "returns all jobs" do
             job_1 = create(:asyncapi_server_job)
             job_2 = create(:asyncapi_server_job)
-            get :index, format: :json, page: 2, per_page: 1
+            get :index, format: :json, params: { page: 2, per_page: 1 }
             expect(response).to be_successful
             parsed_result = indifferent_hash(response.body)
             expect(parsed_result.first[:id]).to eq job_2.id
@@ -21,7 +21,7 @@ module Asyncapi
         describe "GET show" do
           it "returns the job with the given id" do
             job = create(:asyncapi_server_job)
-            get :show, format: :json, id: job.id
+            get :show, format: :json, params: { id: job.id }
             expect(response).to be_successful
             parsed_result = indifferent_hash(response.body)[:job]
             expect(parsed_result[:id]).to eq job.id
@@ -32,14 +32,14 @@ module Asyncapi
         describe "DELETE destroy" do
           it "finds the job by id and secret and deletes it" do
             job = create(:asyncapi_server_job, secret: "12312")
-            delete :destroy, format: :json, id: job.id, secret: "12312"
+            delete :destroy, format: :json, params: { id: job.id, secret: "12312" }
             expect(response).to be_successful
           end
 
           context "secret does not match" do
             it "does not delete the job" do
               job = create(:asyncapi_server_job, secret: "12312")
-              delete :destroy, format: :json, id: job.id, secret: "12315"
+              delete :destroy, format: :json, params: { id: job.id, secret: "12315" }
               expect(response.status).to eq 404
             end
           end

data/spec/dummy/db/schema.rb

@@ -11,9 +11,9 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150201231329) do
+ActiveRecord::Schema.define(version: 20150201231018) do
 
-  create_table "asyncapi_server_jobs", force: true do |t|
+  create_table "asyncapi_server_jobs", force: :cascade do |t|
     t.integer "status"
     t.string  "callback_url"
     t.string  "class_name"

data/spec/dummy/log/development.log

@@ -0,0 +1,81 @@
+   (1.8ms)  SELECT sqlite_version(*)
+   (1.6ms)  SELECT sqlite_version(*)
+   (1.3ms)  SELECT sqlite_version(*)
+   (1.3ms)  SELECT sqlite_version(*)
+   (1.7ms)  SELECT sqlite_version(*)
+   (1.7ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY)
+   (1.2ms)  CREATE TABLE "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL)
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+Migrating to CreateAsyncapiServerJobs (20141112034324)
+  TRANSACTION (0.1ms)  begin transaction
+   (0.6ms)  CREATE TABLE "asyncapi_server_jobs" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "status" integer, "callback_url" varchar, "class_name" varchar, "params" text)
+  ActiveRecord::SchemaMigration Create (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20141112034324"]]
+  TRANSACTION (0.8ms)  commit transaction
+Migrating to AddSecretToAsyncapiServerJob (20141212064931)
+  TRANSACTION (0.1ms)  begin transaction
+   (0.6ms)  ALTER TABLE "asyncapi_server_jobs" ADD "secret" varchar
+  ActiveRecord::SchemaMigration Create (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20141212064931"]]
+  TRANSACTION (1.3ms)  commit transaction
+Migrating to AddExpiredAtToAsyncapiServerJob (20150130062520)
+  TRANSACTION (0.1ms)  begin transaction
+   (0.6ms)  ALTER TABLE "asyncapi_server_jobs" ADD "expired_at" datetime
+  Asyncapi::Server::Job Update All (0.2ms)  UPDATE "asyncapi_server_jobs" SET "expired_at" = ? WHERE "asyncapi_server_jobs"."expired_at" IS NULL  [["expired_at", "2021-03-19 08:45:14.167931"]]
+  ActiveRecord::SchemaMigration Create (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20150130062520"]]
+  TRANSACTION (0.8ms)  commit transaction
+Migrating to DropExpiredAtFromAsyncapiServerJobs (20150201231018)
+  TRANSACTION (0.1ms)  begin transaction
+   (0.1ms)  PRAGMA foreign_keys
+   (0.1ms)  PRAGMA defer_foreign_keys
+   (0.1ms)  PRAGMA defer_foreign_keys = ON
+   (0.1ms)  PRAGMA foreign_keys = OFF
+   (1.3ms)  CREATE TEMPORARY TABLE "aasyncapi_server_jobs" ("id" integer NOT NULL PRIMARY KEY, "status" integer DEFAULT NULL, "callback_url" varchar DEFAULT NULL, "class_name" varchar DEFAULT NULL, "params" text DEFAULT NULL, "secret" varchar DEFAULT NULL, "expired_at" datetime DEFAULT NULL)
+   (0.1ms)  INSERT INTO "aasyncapi_server_jobs" ("id","status","callback_url","class_name","params","secret","expired_at")
+                     SELECT "id","status","callback_url","class_name","params","secret","expired_at" FROM "asyncapi_server_jobs"
+   (0.5ms)  DROP TABLE "asyncapi_server_jobs"
+   (0.1ms)  CREATE TABLE "asyncapi_server_jobs" ("id" integer NOT NULL PRIMARY KEY, "status" integer DEFAULT NULL, "callback_url" varchar DEFAULT NULL, "class_name" varchar DEFAULT NULL, "params" text DEFAULT NULL, "secret" varchar DEFAULT NULL)
+   (0.1ms)  INSERT INTO "asyncapi_server_jobs" ("id","status","callback_url","class_name","params","secret")
+                     SELECT "id","status","callback_url","class_name","params","secret" FROM "aasyncapi_server_jobs"
+   (0.1ms)  DROP TABLE "aasyncapi_server_jobs"
+   (0.0ms)  PRAGMA defer_foreign_keys = 0
+   (0.0ms)  PRAGMA foreign_keys = 1
+  ActiveRecord::SchemaMigration Create (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20150201231018"]]
+  TRANSACTION (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.2ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+  TRANSACTION (0.1ms)  begin transaction
+  ActiveRecord::InternalMetadata Create (0.4ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "environment"], ["value", "development"], ["created_at", "2021-03-09 08:45:14.199202"], ["updated_at", "2021-03-09 08:45:14.199202"]]
+  TRANSACTION (0.7ms)  commit transaction
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.2ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (1.8ms)  SELECT sqlite_version(*)
+   (0.4ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.6ms)  SELECT "ar_internal_metadata"."value" FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ?  [["key", "environment"]]
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.1ms)  SELECT "ar_internal_metadata"."value" FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ?  [["key", "environment"]]
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (0.1ms)  SELECT "ar_internal_metadata"."value" FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ?  [["key", "environment"]]
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  SELECT sqlite_version(*)
+   (0.1ms)  DROP TABLE IF EXISTS "asyncapi_server_jobs"
+   (1.2ms)  CREATE TABLE "asyncapi_server_jobs" ("id" integer PRIMARY KEY AUTOINCREMENT NOT NULL, "status" integer, "callback_url" varchar, "class_name" varchar, "params" text, "secret" varchar)
+   (1.1ms)  CREATE TABLE "schema_migrations" ("version" varchar NOT NULL PRIMARY KEY)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC
+   (1.0ms)  INSERT INTO "schema_migrations" (version) VALUES (20150201231018)
+   (1.2ms)  INSERT INTO "schema_migrations" (version) VALUES
+(20141112034324),
+(20141212064931),
+(20150130062520);
+
+
+   (1.2ms)  CREATE TABLE "ar_internal_metadata" ("key" varchar NOT NULL PRIMARY KEY, "value" varchar, "created_at" datetime(6) NOT NULL, "updated_at" datetime(6) NOT NULL)
+  ActiveRecord::InternalMetadata Load (0.2ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+  TRANSACTION (0.1ms)  begin transaction
+  ActiveRecord::InternalMetadata Create (0.4ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "environment"], ["value", "development"], ["created_at", "2021-03-09 08:46:17.185916"], ["updated_at", "2021-03-09 08:46:17.185916"]]
+  TRANSACTION (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "environment"], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  ActiveRecord::InternalMetadata Update (0.3ms)  UPDATE "ar_internal_metadata" SET "value" = ?, "updated_at" = ? WHERE "ar_internal_metadata"."key" = ?  [["value", "test"], ["updated_at", "2021-03-09 08:46:17.189623"], ["key", "environment"]]
+  TRANSACTION (0.7ms)  commit transaction
+  ActiveRecord::InternalMetadata Load (0.1ms)  SELECT "ar_internal_metadata".* FROM "ar_internal_metadata" WHERE "ar_internal_metadata"."key" = ? LIMIT ?  [["key", "schema_sha1"], ["LIMIT", 1]]
+  TRANSACTION (0.0ms)  begin transaction
+  ActiveRecord::InternalMetadata Create (0.3ms)  INSERT INTO "ar_internal_metadata" ("key", "value", "created_at", "updated_at") VALUES (?, ?, ?, ?)  [["key", "schema_sha1"], ["value", "b156e6c6d273062fcb56e7a3782b664b02612fc5"], ["created_at", "2021-03-09 08:46:17.192636"], ["updated_at", "2021-03-09 08:46:17.192636"]]
+  TRANSACTION (0.6ms)  commit transaction