Class: FolioClient::JobStatus

Inherits:
Object
  • Object
show all
Defined in:
lib/folio_client/job_status.rb

Overview

Wraps operations waiting for results from jobs

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, job_execution_id:) ⇒ JobStatus

Returns a new instance of JobStatus.

Parameters:

  • client (FolioClient) —

    the configured client

  • job_execution_id (String) —

    ID of the job to be checked on



15
16
17
18
 
# File 'lib/folio_client/job_status.rb', line 15

def initialize(client, job_execution_id:)
  @client = client
  @job_execution_id = job_execution_id
end

Instance Attribute Details

#job_execution_id ⇒ Object (readonly)

Returns the value of attribute job_execution_id.



11
12
13
 
# File 'lib/folio_client/job_status.rb', line 11

def job_execution_id
  @job_execution_id
end

Instance Method Details

#instance_hrids ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/folio_client/job_status.rb', line 42

def instance_hrids
  current_status = status
  return current_status unless current_status.success?

  @instance_hrids ||= wait_with_timeout do
    response = client
      .get("/metadata-provider/journalRecords/#{job_execution_id}")
      .fetch("journalRecords", [])
      .select { |journal_record| journal_record["entityType"] == "INSTANCE" && journal_record["actionStatus"] == "COMPLETED" }
      .filter_map { |instance_record| instance_record["entityHrId"] }

    response.empty? ? Failure() : Success(response)
  end
end

#status ⇒ Dry::Monads::Result

TODO:

An “ERROR” approach means one or more records failed, but it does not mean they all fail. We will likely need a more nuanced way to handle this eventually.

Returns Success() if job is complete, Failure(:pending) if job is still running, Failure(:not_found) if job is not found.

Returns:

  • (Dry::Monads::Result) —

    Success() if job is complete, Failure(:pending) if job is still running, Failure(:not_found) if job is not found



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/folio_client/job_status.rb', line 27

def status
  response_hash = client.get("/change-manager/jobExecutions/#{job_execution_id}")

  return Failure(:pending) if !["COMMITTED", "ERROR"].include?(response_hash["status"])

  Success()
rescue ResourceNotFound
  # Checking the status immediately after starting the import may result in a 404.
  Failure(:not_found)
end

#wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks) ⇒ Object 



38
39
40
 
# File 'lib/folio_client/job_status.rb', line 38

def wait_until_complete(wait_secs: default_wait_secs, timeout_secs: default_timeout_secs, max_checks: default_max_checks)
  wait_with_timeout(wait_secs: wait_secs, timeout_secs: timeout_secs, max_checks: max_checks) { status }
end