jitterted/ensembler

Ensembler: the Remote Ensemble Registration System

Ensembler - The Remote Ensemble Programming Registration System

I wrote this tool to help me manage public (and private) remote ensemble (aka mob) programming sessions, where participants are not part of an existing team, but are individuals joining to learn a skill, or to help develop a product. Since folks can come and go, managing who is participating in which mob programming session (known as an "ensemble") can get tedious. Managing their access to the GitHub repository, knowing if they're new to mobbing, and making sure no more than 5 people are part of each ensemble, etc., pushed me over the edge into creating this tool.

This is currently a Work In Progress, being built almost 100% in public, live on Twitch.

Questions?

Join me on my Discord in the dedicated #ensembler channel: https://discord.gg/FYSkuufDSH.

Environment Variables

To run this project, you will need to add the following environment variables or update the application.properties file directly.

(to update...)

github.oauth2.clientId

github.oauth2.clientSecret

Installation & Deployment

Requires Java 18 (or later) and uses Maven for building.

Since it uses GitHub OAuth2 for authentication, you'll need to register this application with your GitHub account if you want to run it yourself.

Development Setup

Docker

Docker is needed for running the TestContainer-based database tests. If you don't have docker running, those tests will be skipped.

See PostgresTestcontainerBase for information on the reusable Testcontainer setup.

Tailwind CSS

We're using Tailwind CSS 3.x with the platform-specific command-line tool (CLI). You'll need to install that separately from https://tailwindcss.com/blog/standalone-cli#get-started. You can keep it running in the background when working on HTML files (templates):

tailwindcss -i ./src/main/resources/static/ensembler.css -o ./src/main/resources/static/tailwind.css --watch

ensembler's Issues

Constrain Existing Editing of Ensembles

Name: may not allow edits after Completed

Start Date/Time changes not allowed:

• New Date/Time in the past
• For events that are in the past -- must use Reschedule
• For Completed

Upgrade to Java 17 and Spring Boot 2.6.1

Also, prepare for testing with 3.0.0 snapshots!

Edit existing Huddles

Edit Name and Date/Time only.

Send group emails using BCC not TO

For notifications such as the "new ensemble", put recipients in the BCC list, not the TO list, so we don't unintentionally expose emails to others.

Fix Ensemble's "startDateTime" Primitive Obsession

The start date/time-related behavior needs to move to a new class.

Send full Ensemble to Notifier

Instead of pieces:

int ensembleScheduled(String description, URI registrationLink);

send the whole Huddle so we can get other info, such as date/time, to add to notifications. Use the Member's Time Zone to convert.

Don't put Ensemble into "pending complete" until it is OVER

Instead of using start date/time, use start date/time + duration.

Don't show Accept/Decline after the start date/time

When the Ensemble has started, should only show the Ensemble to those who have Accepted. And then only show the Zoom link, not the Decline button.

Disable SendGrid emailer when running locally

Need another config option

Connect to Discord from User Profile page

OAuth2 'em all!

Test Failure: Precision of LocalDateTime comparison with PostgreSQL

Can't reproduce locally.

Error: Failures:
Error: PostgresqlEntityTest.huddleEntityStoredViaJdbcIsRetrievedWithMembers:63
Expecting:
com.jitterted.mobreg.adapter.out.jdbc.HuddleEntity@feb57b4
to be equal to:
com.jitterted.mobreg.adapter.out.jdbc.HuddleEntity@7893b8c
when recursively comparing field by field, but found the following difference:

field/property 'dateTimeUtc' differ:

• actual value : 2021-10-27T23:22:14.995996 (java.time.LocalDateTime)
• expected value : 2021-10-27T23:22:14.995996225 (java.time.LocalDateTime)

Add Time Zone 😭 to the Member's Profile

Initially for sending emails, need to localize the date/time included in "registration confirmation" and "new huddle created" emails.

Editable on the profile edit page.

Get initial value from the browser when registering.

Accepted Member Notification of Ensemble Completed (Recording Available)

After the recent fix for #11, all emails now get sent with recipients emails in BCC. For direct email notifications, such as registration confirmation, there's only one recipient.

These are group notifications: New Ensemble Scheduled, and Ensemble Recording Available.

This is an individual notification: Registration Confirmation

Use Email templates, or at least better formatting

SendGrid templates or just a bit of styling?

Provide single status with Accept/Decline options for Huddles

Instead of putting logic in the UI template, have a single enum for the options available to the member.

Delete Zoom meeting when Ensemble is Canceled

Carried over from issue #22: when cancelling:

• Delete Zoom meeting

Cancel Ensemble

See #61

Change Ensemble Date/Time rendering to use Member's Time Zone in profile

This would mean we could get rid of the JavaScript on-the-fly conversion.

Update TestContainers dependency

Latest is 1.16.2

Completed huddles still show register button?

Use API to add Zoom link when scheduling Ensemble

Have a button to pre-fill the Zoom link input field on the Schedule New Ensemble form.

Admin: Show declined members

Show the number of declined members on the dashboard. Show the list of declined members on the detail page.

Ensemble should not return its Set<MemberId>

Either use Stream<MemberId>, since the callers always use .stream(), or use Immutables.

Return version/app info from Actuator /info endpoint

Grab from the maven properties

Zoom API: Use new API to replace deprecated JWT

See https://developers.zoom.us/docs/internal-apps/jwt-app-migration/

Allow manual entry/editing of Meeting ID for Conference Details

Currently only the meeting link (URI) can be edited for an Ensemble. Need to allow the rest of the Conference Details to be edited.

Implement Notification Service to handle email, etc., notifications

This comes from the fact that the HuddleService takes a MemberRepository as a dependency, and I'm not happy about that -- will need a NotifierService instead so it can coordinate between the Huddle and Member repositories.

Use Maven Release to update version number

So we can get the version number from the Actuator Info endpoint.

See https://github.com/qcastel/github-actions-maven-release

Constraints for scheduling new Ensemble

Must be scheduled for a date/time in the Future, perhaps some amount of time in the future.
Possibly within 8am-6pm local time zone?

Constrain Editing of existing Ensembles

For future ensembles: only allow editing of Name, Zoom link, and date/time.

For past (but not completed) ensembles: only allow editing of Name

For completed ensembles: edit only video recording link

Reschedule Ensemble

Sends notification

This is really a Cancel + Create shortcut as those who registered for the original date/time should not already be registered.

Later: prioritize those who already registered to be able to register for the rescheduled one.

Create New Huddle Form: Want ENTER to submit from any input field

Right now hitting ENTER from the Date or Time input field doesn't submit the form. Can we fix that, i.e., have ENTER work from those fields? If not, move the Zoom link field to the end so can hit ENTER in that field, which will submit the form.

Zoom API: Handle auth failure

If (when) the JWT expires, or if it's revoked, we'll get a 401. Handle that properly.

Member Register page shows Register button when Huddle is Full

See Ensemble #30 in production.

This is because the UI is implementing the behavior, when it should be done by the back-end.

Rename Huddle to Ensemble - Everywhere

Rename all code and text and database references of "Huddle" to "Ensemble".

Add Mutation Testing

Zoom API: Use Passcode and not Waiting Room

When using the API to create a Zoom meeting, apparently I'm using "waiting room" as the security measure and I should be using the "passcode" option. Set the default_password setting to true.

Some unit tests fail for non-english locale

The following unit tests fail on my local machine (which is located in Austria):

• membersInDifferentTimeZonesGetCustomizedEnsembleScheduledEmail
• memberWithEmailWhenEnsembleScheduledThenCustomEmailSentToMember
• memberWithEmailAcceptsThenEmailSentToMemberWithEnsembleDetails

Here's an example of one of the assertion errors:

java.lang.AssertionError: 
Expecting actual:
  ["Ensembler: New Ensemble Scheduled for 2021-12-17 at 1:00pm (GMT-08:00)",
    "Ensembler: New Ensemble Scheduled for 2021-12-17 at 4:00pm (GMT-05:00)"]
to contain exactly (and in same order):
  ["Ensembler: New Ensemble Scheduled for 2021-12-17 at 1:00PM (PST)",
    "Ensembler: New Ensemble Scheduled for 2021-12-17 at 4:00PM (EST)"]
but some elements were not found:
  ["Ensembler: New Ensemble Scheduled for 2021-12-17 at 1:00PM (PST)",
    "Ensembler: New Ensemble Scheduled for 2021-12-17 at 4:00PM (EST)"]
and others were not expected:
  ["Ensembler: New Ensemble Scheduled for 2021-12-17 at 1:00pm (GMT-08:00)",
    "Ensembler: New Ensemble Scheduled for 2021-12-17 at 4:00pm (GMT-05:00)"]


	at com.jitterted.mobreg.adapter.out.email.EmailToSendEnsembleScheduledNotifierTest.membersInDifferentTimeZonesGetCustomizedEnsembleScheduledEmail

Possible fix

The tests pass if I change the DateTimeFormatter setup in EmailNotifier to contain a specific locale:

private static final DateTimeFormatter LONG_DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("LLLL d, uuuu 'at' h:mma (zzz)", Locale.ENGLISH);
private static final DateTimeFormatter SHORT_DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd 'at' h:mma (zzz)", Locale.ENGLISH);

However, I don't know how you would like to approach this. I suppose, you might want to hard-code English for now?

Allow editing of Zoom link

Should allow fetching new link from Zoom API.

Send "scheduled" notification even when video conference creation fails

Right now, if the EnsembleService gets a FailedToScheduleMeeting exception, it never sends notifications that the Ensemble was scheduled. Even if the video conference is created later (via the changeTo), no notification is sent.

• 1. send notification regardless of whether the Zoom is created or not.
• 2. send notification about change in information for those who Accepted (so they get the right Zoom link)

Create notification/event mechanism for showing failures

Such as a failure to schedule a Zoom meeting during scheduling of an Ensemble.

Design: Multiple groups, priority for accepting, etc.

Question: do I need anything more than the current Set<String> roles? Or can this support:

1. Priority for registration: higher "tiers" can Accept before lower tiers
2. Define which Ensemble groups Member is eligible to see
3. Wait list priority

Allow Duration to be specified/changed for an Ensemble

Right now it's hard-coded for 1 hour and 55 minutes.

Send notification to those registered when Ensemble is canceled

Carried over from #61.

Add ArchUnit to enforce layering/dependency

Fix bad UI for a completed huddle

Should not show the (disabled) Register button when a Huddle is Completed.

Member: Highlight the upcoming Ensemble

When many ensembles are scheduled in the future, it can be a bit confusing not to see the upcoming one (e.g., today's) at the top of the list.

Create Test Data Builders

Especially see AdminDashboardControllerTest.

Create Title: Add the ability to either automagically or manually add ensemble name

After an ensemble is completed it should be either automatically named or generally named from a summary of what happened.

Examples:
"created multiplayer player object out of game"
"used recursion to solve interesting problem"
"discovered method to limit number of constructors code smell"

Send New Ensemble Notifications with Start Date/Time in Member's Time Zone

Relied on Member's having time zone specified.