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.

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

Setup custom listing processors #86

Closed
wants to merge 10 commits into from

Conversation

ahmedwalid05
Copy link

Hello there,
I am sending a draft of this PR to get early feedback. Happy to iterate as needed.

My end goal is to be able to configure Fredy to calculate the distance and travel time between a predefined address(es) and the listing address, and add this information to the notifications. The user should be able to configure all the required information for the Google Maps API (Or another API provider if implemented), the destination information and mode of transport through the UI.

This PR only includes setting up a "processor" construct. Processors are files that add info or transform the listings. I have only added a static processor for now, as a proof of concept. Will continue once/if the approach is accepted.

Remaining work before PR can be merged:

  • Add Google map distance and travel time processor.
  • Add distance & travel time to existing notifiers.
  • Add UI for processors.
  • Add tests for processors and update old tests for the new fredy runtime parameters.
  • Update README, docs and architecture diagram.
  • Update CONTRIBUTING guide to add a section for new processors.

Please let me know if I missed anything.

Not part of this PR:

Future improvements to this design could add a similarity check as a "filter" processor. i.e.:
image

@orangecoding
Copy link
Owner

Hey.

Sorry it took so long, I was on a business trip. In general, I like the idea :) What is your plan about processors in general, would you:

  • let every processor run for every job?
  • if so, some processors might be only needed for a very small fraction of Fredy's users (e.g. travel time), how do you make sure, it's opt in rather than on by default?
  • I like the idea of having the similary check as a processor.

The custom processors will allow customers to append extra information to the listing or transform listing information to better match their expected result
Use google maps distance matrix API to add information about distance to location
To allow processors to add context to the text message being sent to a notifier.
@ahmedwalid05
Copy link
Author

Hi there,

To answer your questions, my plan was to let users configure it using the UI just like notifications.
Sadly, since this PR was started, I have gotten busy and just don't have time to continue working on this.
Please feel free to use any of my ideas/code.

Apologies!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants