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

Jump to bottom

[GitHubReleaseDate] - published_at field #8543

Merged
merged 5 commits into from
Oct 20, 2022
Merged

[GitHubReleaseDate] - published_at field #8543

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fe13f60
gh release date - published at
PaulaBarszcz Oct 17, 2022
6a940a7
example correction
PaulaBarszcz Oct 17, 2022
11ab88c
Merge branch 'master' into github-release-date-published-at
PaulaBarszcz Oct 18, 2022
a892ef9
change published_at query param to display_date
PaulaBarszcz Oct 18, 2022
57753ff
simplify the statement
PaulaBarszcz Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 30 additions & 1 deletion services/github/github-release-date.service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,30 @@ import { documentation, errorMessagesFor } from './github-helpers.js'
const schema = Joi.alternatives(
Joi.object({
created_at: Joi.date().required(),
published_at: Joi.date().required(),
}).required(),
Joi.array()
.items(
Joi.object({
created_at: Joi.date().required(),
published_at: Joi.date().required(),
}).required()
)
.min(1)
)

const queryParamSchema = Joi.object({
display_date: Joi.string()
.valid('created_at', 'published_at')
.default('created_at'),
}).required()

export default class GithubReleaseDate extends GithubAuthV3Service {
static category = 'activity'
static route = {
base: 'github',
pattern: ':variant(release-date|release-date-pre)/:user/:repo',
queryParamSchema,
}

static examples = [
Expand All @@ -46,6 +55,17 @@ export default class GithubReleaseDate extends GithubAuthV3Service {
staticPreview: this.render({ date: '2017-04-13T07:50:27.000Z' }),
documentation,
},
{
title: 'GitHub Release Date - Published_At',
pattern: 'release-date/:user/:repo',
namedParams: {
user: 'microsoft',
repo: 'vscode',
},
queryParams: { display_date: 'published_at' },
staticPreview: this.render({ date: '2022-10-17T07:50:27.000Z' }),
documentation,
},
]

static defaultBadgeData = { label: 'release date' }
Expand All @@ -70,11 +90,20 @@ export default class GithubReleaseDate extends GithubAuthV3Service {
})
}

async handle({ variant, user, repo }) {
async handle({ variant, user, repo }, queryParams) {
const body = await this.fetch({ variant, user, repo })
if (Array.isArray(body)) {
if (queryParams.display_date === 'published_at') {
return this.constructor.render({ date: body[0].published_at })
}

return this.constructor.render({ date: body[0].created_at })
}

if (queryParams.display_date === 'published_at') {
return this.constructor.render({ date: body.published_at })
}

return this.constructor.render({ date: body.created_at })
}
Copy link
Member

Choose a reason for hiding this comment

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

In javascript you can address an object property defined by a variable using square brackets, so you should be able to reduce all this to just

if (Array.isArray(body)) {
  return this.constructor.render({ date: body[0][queryParams.display_date] })
}
return this.constructor.render({ date: body[queryParams.display_date] })

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Neat, thanks. Updated.

}
21 changes: 21 additions & 0 deletions services/github/github-release-date.tester.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,27 @@ t.create('Release Date. e.g release date|today')
message: isFormattedDate,
})

t.create('Release Date - display_date by `created_at` (default)')
.get('/release-date/microsoft/vscode.json?display_date=created_at')
.expectBadge({
label: 'release date',
message: isFormattedDate,
})

t.create('Release Date - display_date by `published_at`')
.get('/release-date/microsoft/vscode.json?display_date=published_at')
.expectBadge({
label: 'release date',
message: isFormattedDate,
})

t.create('Release Date - display_date by `published_at`, incorrect query param')
.get('/release-date/microsoft/vscode.json?display_date=published_attttttttt')
.expectBadge({
label: 'release date',
message: 'invalid query parameter: display_date',
})

t.create(
'Release Date - Should return `no releases or repo not found` for invalid repo'
)
Expand Down