RFD: Simplifying Experiments #276
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mabiede
reviewed
Dec 12, 2023
Comment on lines
+30
to
+54
| [@@deriving eq, show] | ||
|
|
||
| let id t = t.id | ||
| let title t = t.title | ||
| let public_title t = t.public_title | ||
| let description t = t.description | ||
| let cost_center t = t.cost_center | ||
| let organisational_unit t = t.organisational_unit | ||
| let filter t = t.filter | ||
| let contact_person_id t = t.contact_person_id | ||
| let smtp_auth_id t = t.smtp_auth_id | ||
| let direct_registration_disabled t = t.direct_registration_disabled | ||
| let registration_disabled t = t.registration_disabled | ||
| let allow_uninvited_signup t = t.allow_uninvited_signup | ||
| let external_data_required t = t.external_data_required | ||
| let show_external_data_id_links t = t.show_external_data_id_links | ||
| let experiment_type t = t.experiment_type | ||
| let email_session_reminder_lead_time t = t.email_session_reminder_lead_time | ||
| let invitation_reset_at t = t.invitation_reset_at | ||
| let created_at t = t.created_at | ||
| let updated_at t = t.updated_at | ||
|
|
||
| let text_message_session_reminder_lead_time t = | ||
| t.text_message_session_reminder_lead_time | ||
| ;; |
There was a problem hiding this comment.
Nice, the fields can be derived by using fields.
[@@deriving eq, show, fields]
| @@ -0,0 +1,41 @@ | |||
| (** Helper functions for creating Caqti types with custom encoder/decoders. *) | |||
There was a problem hiding this comment.
As these encoders are very general, they could be reused in other modules, right?
There was a problem hiding this comment.
Correct! The idea would be to reuse them.
| let public_title_placeholder = "###" | ||
|
|
||
| let sql_select_fragment = | ||
| [%string |
There was a problem hiding this comment.
Is this needed to evaluate the sql_select_fragments?
There was a problem hiding this comment.
Yup, a few lines below we have:
{sql|
%{ Id.sql_select_fragment ~field:"pool_experiments.contact_person_uuid" },
%{ Id.sql_select_fragment ~field:"pool_experiments.smtp_auth_uuid" },
%{ Id.sql_select_fragment ~field:"pool_experiments.uuid" },
...
|sql}where are using this ppx to compose these strings without needing to always bring Format.sprintf
| @@ -0,0 +1,25 @@ | |||
| type t = Ptime.Span.t [@@deriving eq, show] | |||
|
|
|||
| let make m = Ok m | |||
There was a problem hiding this comment.
This is basically let make = CCResult.return
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi folks 👋🏼 over the past few weeks we've had chats about the structure of the project, and some of the patterns in used in the code right now. Take this PR as an RFD (request for discussion), a little showcase of how we could simplify the codebase, cutting down on a lot of code, and make it easier to get into.
In particular, I'd like to bring attention to:
Title.topen Containers(or even opening containers by default everywhere)This version of the
experimentlibrary doesn't use any of the base models wrapped under field names and as such can fit the type definition, accessors, SQL fragments, and the SQL schema in a single module without much ceremony.I tried working around some of the limitations of Caqti (which we discussed with @timohuber), but I think the best we can do without a major framework change is to colocate the schemas with the types they represent. If we see a pattern emerge, a ppx to derive SQL fragments from the records would be ideal. Will be good to upstream that to Caqti or publish it.
I've also made sure that every module corresponds to a file, especially if its going to be referenced from outside. This helps split compilation units, allows to include individual signatures, and should help with jump-to-definitions too. This is in contrast to the inline-module heavy style used around the codebase, which plenty of times needs several module jumps to find a definition.
I'll add some more directed comments in the PR in the morning, but I'd love to get your thoughts on this. Perhaps we can agree on a direction to take, and slowly move towards a simpler, more direct coding style.