This repository was archived by the owner on Oct 4, 2022. It is now read-only.
Draft
Conversation
...and add formatting to the rotation 'description' so that it's easy -- at a glance -- to pick out the key info, e.g. I'm going onto: - the "out of hours" rota - in the "second line" role
Our `dxw-support-rota.herokuapp.com` middleware which provides support information from Opsgenie represents support periods in two differnt ways, according to the lables given to the team members' roles. The 'Support' rotation element has a different shape to the 'OOH'rotation: 'support' rotation shape: from https://dxw-support-rota.herokuapp.com/support/rota.json { start_date: '2020-01-09', end_date: '2020-01-16', developer: { name: 'Sandy', email: 'sandy@example.com' }, ops: { name: 'Frances', email: 'frances@example.com' } } 'ooh' rotation shape: from https://dxw-support-rota.herokuapp.com/out-of-hours/rota.json { start_date: '2020-01-09', end_date: '2020-01-16', first_line: { name: 'Eve', email: 'eve@example.com' }, second_line: { name: 'Trent', email: 'trent@example.com' } } Here we describe how we'd like the `UpcomingRotation` class to return consistently shaped rotation *entities* to `RotaAlerts` in order to facilitate: - handling of rotation objects via a consistent api - inclusion of additional important info (e.g. `#role` such as 'second line')
If the rotations returned by `UpcomingRotations` have a
consistent shape then consumers will be able to invoke
functions in a consistent way.
INPUT (inconsistent)
--------------------
Out-of-hours:
{
start_date: "2020-01-01",
end_date: "2020-01-08",
first_line: {
name: "Alice",
email: "alice@example.com",
},
second_line: {
name: "Bob",
email: "bob@example.com",
},
}
In-hours:
{
start_date: "2020-01-09",
end_date: "2020-01-16",
developer: {
name: "Sandy",
email: "Sandy@example.com",
},
ops: {
name: "Frances",
email: "Frances@example.com",
},
}
OUTPUT (consistent)
-------------------
Out-of-hours:
{
start_date: "2020-01-09",
end_date: "2020-01-16",
members: [
{
rota: "out-of-hours",
role: "first line",
name: "Eve",
email: "eve@example.com",
},
{
rota: "out-of-hours",
role: "second line",
name: "Trent",
email: "trent@example.com",
},
],
}
In-hours:
{
start_date: "2020-01-09",
end_date: "2020-01-16",
members: [
{
rota: "in-hours",
role: "developer",
name: "Sandy",
email: "Sandy@example.com",
},
{
rota: "in-hours",
role: "ops",
name: "Frances",
email: "Frances@example.com",
},
],
}
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Our dxw-support-rota.herokuapp.com middleware which
provides support information from Opsgenie represents
support periods in two differnt ways, according to the
lables given to the team members' roles.
The 'Support' rotation element has a different shape to the
'OOH'rotation:
'support' rotation shape:
from
https://dxw-support-rota.herokuapp.com/support/rota.json'ooh' rotation shape:
from
https://dxw-support-rota.herokuapp.com/out-of-hours/rota.jsonAt present the
RotaAlerts.run()function expects both types of rota representation to havefirst_lineandsecond_lineproperties, and so blows up when it encounters the in-hours "Support" type.