Persistence

[iloveitaly]

Initial audit log / persistence implementation.

Dependent PRs:

• Response formatting improvement #34
• Improved logging class #30
• Optionally reprocess response #25

TODO

• specs for attempts
• response includes the root keys right now. Consider if this is the best approach
• think on polljob logging
• think on logging transformation + request params in attempt

[mtylty]

@iloveitaly could you please rebase this on the master branch?

[iloveitaly]

@mtylty slammed with other work at the moment, I'll get to this within 1-2 weeks.

[bricesanchez]

@iloveitaly Is the goal of this PR to provide a Translation table to keep source and destination ids of record ?

Like my warehouse product ID is 1 and the shopify ID is 60001 and this PR will add the feature to keep id 1 and 60001 ?

[bricesanchez]

It is probably more a feature to persist an unfinished job !? Like if one integration is down, it will retry to send the response until it works?

[iloveitaly]

It is probably more a feature to persist an unfinished job !? Like if one integration is down, it will retry to send the response until it works?

Not exactly. Here's some more information about the goals here

• Persist an unfinished or finished job
• If job is unfinished or failed, response == nil
• If job is finished, response payload is persisted
• Each attempt to push job to service is logged as an Attempt
• Persisting a job with the primary key on the object enables you to determine if a payload is new or updated[0]

[0]

def perform?
  type == 'shipment' && self.payload_state == :new
end

cc @AlessioRocco

[houndci-bot]

Prefer double-quoted strings unless you need single quotes to avoid extra backslashes for escaping.

[iloveitaly]

@mtylty Rebased this PR on master, but it's dependent on the other smaller PRs I have open. Those will need to be merged before this passes.

Looking forward to hearing your thoughts!

[iloveitaly]

An example of what the Translation class allows for:

def perform?
  self.unique_state?
end

def unique_state?
  !self.
    translation.
    related_translations.
    map { |t| t.request['status'] }.
    uniq.
    include? self.payload['status']
end

[iloveitaly]

@AlessioRocco Any thoughts on this? I can rebase this PR if you have time to dig in.