Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(mulesoft/exporter): status vars, perf, style, format #173

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

fix(mulesoft/exporter): status vars, perf, style, format #173

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cb27903
fix(mulesoft/exporter): status vars, perf, style, format
w-le May 24, 2021
d25cf4c
Merge branch 'master' into fix/mulesoft_exporter
w-le May 24, 2021
822368e
style(mulesoft/exporter): whitespace
w-le May 24, 2021
c8f3f18
fix(mulesoft/exporter): clone booking before transform; clearer namin…
w-le May 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions drivers/mulesoft/calendar_exporter.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ require "place_calendar"

class MuleSoft::CalendarExporter < PlaceOS::Driver
descriptive_name "MuleSoft Bookings to Calendar Events Exporter"
generic_name :Bookings
description %(Retrieves and creates bookings using the MuleSoft API)
generic_name :MulesoftExport
description %(Listens for new MuleSoft bookings and creates matching Events in a Calendar)

default_settings({
calendar_time_zone: "Australia/Sydney",
Expand Down Expand Up @@ -34,12 +34,13 @@ class MuleSoft::CalendarExporter < PlaceOS::Driver

@time_zone_string = setting?(String, :calendar_time_zone).presence
@time_zone = Time::Location.load(@time_zone_string.not_nil!) if @time_zone_string
self[:timezone] = Time.local.to_s
self[:timezone] = @time_zone.to_s

subscription = system.subscribe(:Bookings_1, :bookings) do |_subscription, mulesoft_bookings|
logger.debug { "DETECTED changed in Mulesoft Bookings.." }
logger.debug { "DETECTED change in Mulesoft Bookings..." }
@bookings = Array(Hash(String, Int64 | String | Nil)).from_json(mulesoft_bookings)
Copy link
Contributor

@caspiano caspiano Jun 2, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing something along these lines instead of the Hash would be much easier to maintain, faster, and ensures correctness

record MulesoftBooking,
  getter title : String?,
  getter recurring_master_id : Int64,
  getter event_start : Int64,
  getter event_end : Int64,
  getter body : String do

  include JSON::Serializable
  
  @[JSON::Field(ignore: true)]
  # Not sure about the efficiency of doing this pattern in a struct.
  getter resolved_title : String do
    "#{recurring_master_id} #{title.presence || body}"
  end

  def matches?(booking)
    booking = booking.as_h if booking.is_a?(JSON::Any)
    event_start == booking["event_start"]? && event_end == booking["event_end"]? && resolved_title == booking["title"]?
  end

  def to_place_calendar(
    timezone : String,
    system_email : String,
    system_name : String,
  )
    {
      title:       resolved_title,
      event_start: event_start,
      event_end:   event_end,
      timezone:    timezone,
      description: body,
      user_id:     system_email,
      location:    system_name,
      attendees:   [{email: system_email, name: system_name}],
    }
  end
end

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much, I'll grok this after some other tasks, then see if anything else should change and then test.
Yeah I was originally intending the booking hash and calendar event to be the same object but couldn't get that to work just due to my crystal inexperience. Ran out of time due to a delivery deadline so just implemented it this way.
Now that I have time it'll be great (and very educational for me) to implement it properly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@bookings = Array(Hash(String, Int64 | String | Nil)).from_json(mulesoft_bookings)
@bookings = Array(MulesoftBooking).from_json(mulesoft_bookings)

logger.debug { "#{@bookings.size} bookings in total" }
self[:total_bookings] = @bookings.size

update_events
@bookings.each { |b| export_booking(b) }
Expand All @@ -57,6 +58,7 @@ class MuleSoft::CalendarExporter < PlaceOS::Driver
logger.debug { "FETCHING existing Calendar events..." }
@existing_events = fetch_events()
logger.debug { "#{@existing_events.size} events in total" }
self[:total_events] = @existing_events.size
end

protected def fetch_events(past_span : Time::Span = 14.days, future_span : Time::Span = 14.days)
Expand All @@ -71,10 +73,11 @@ class MuleSoft::CalendarExporter < PlaceOS::Driver
).get.as_a
end

protected def export_booking(booking : Hash(String, Int64 | String | Nil))
# Mulesoft booking titles are often nil. Use the body instead in this case
booking["title"] = booking["body"] if booking["title"].nil?
booking["title"] = "#{booking["recurring_master_id"]} #{booking["title"]}"
protected def export_booking(mulesoft_booking : Hash(String, Int64 | String | Nil))
# The resulting Calendar Event is to be slightly different to the Mulesoft Booking, so clone here and transform
booking = mulesoft_booking.clone
# Add the course code to the front of the booking title/body
booking["title"] = "#{booking["recurring_master_id"]} #{booking["title"] || booking["body"]}"
w-le marked this conversation as resolved.
Show resolved Hide resolved
logger.debug { "Checking for existing events that match: #{booking}" }

unless event_already_exists?(booking, @existing_events)
Expand All @@ -88,28 +91,25 @@ class MuleSoft::CalendarExporter < PlaceOS::Driver
attendees: [@just_this_system],
location: system.name.not_nil!,
}
logger.debug { ">>> EXPORTING booking #{new_event}" }
logger.debug { ">>> EXPORTING booking as: #{new_event}" }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

protected def export_booking(booking : MulesoftBooking)
  unless event_already_exists?(booking, @existing_events)
    new_event = booking.to_place_calendar(@time_zone_string, system.email, system.name)
    logger.debug { ">>> EXPORTING booking as: #{new_event}" }
    calendar.create(**new_event)
  end
end

calendar.create_event(**new_event)
end
end

protected def event_already_exists?(new_event : Hash(String, Int64 | String | Nil), existing_events : Array(JSON::Any))
existing_events.each do |existing_event|
return true if events_match?(new_event, existing_event.as_h)
end
false
protected def event_already_exists?(booking : Hash(String, Int64 | String | Nil), existing_events : Array(JSON::Any))
existing_events.any? { |existing_event| booking_matches_event?(booking, existing_event.as_h) }
end

protected def events_match?(event_a : Hash(String, Int64 | String | Nil), event_b : Hash(String, JSON::Any))
event_a.select("event_start", "event_end", "title") == event_b.select("event_start", "event_end", "title")
protected def booking_matches_event?(booking : Hash(String, Int64 | String | Nil), event : Hash(String, JSON::Any))
booking.select("event_start", "event_end", "title") == event.select("event_start", "event_end", "title")
end
Comment on lines +99 to 105
Copy link
Contributor

@caspiano caspiano Jun 2, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

protected def event_already_exists?(booking : MulesoftBooking, existing_events : Array(JSON::Any))
  logger.debug { "Checking for existing events that match: #{booking.resolved_title}" }
  existing_events.any? { |event| booking.matches?(event) }
end


def delete_all_events(past_days : Int32 = 14, future_days : Int32 = 14)
events = fetch_events(past_span: past_days.days, future_span: future_days.days)
event_ids = events.map { |e| e["id"] }
event_ids.each do |event_id|
calendar.delete_event(calendar_id: system.email.not_nil!, event_id: event_id)
events.each do |event|
calendar.delete_event(calendar_id: system.email.not_nil!, event_id: event["id"])
end
"Deleted #{event_ids.size} events"
logger.debug { "DELETED #{events.size} events" }
events.size
end
end