PP-12395: Create API key functionality #4394
Merged
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
Creating an API key consists of two pages: the "API key name" and "New API key" pages. Validation of the name/description and cypress test will be done in the next PRs.
oswaldquek
force-pushed
the
PP-12395-create-api-key
branch
from
585e1bd to
c2a8d0c
Compare
DomBelcher
reviewed
Dec 20, 2024
app/services/api-keys.service.js
Outdated
| * @param {string} description | ||
| * @param {string} email - the user email | ||
| * @param {'API' | 'PRODUCTS'} tokenSource - The type of the token (must match one of TOKEN_TYPE values). | ||
| * @returns {string} the new api key |
There was a problem hiding this comment.
a tad pedantic but this returns a Promise<String> as it's async
| response(req, res, 'simplified-account/settings/api-keys/new-api-key-details', { | ||
| description, | ||
| apiKey: newApiKey, | ||
| backToApiKeysLink: formatSimplifiedAccountPathsFor(paths.simplifiedAccount.settings.apiKeys.index, req.service.externalId, req.account.type) |
There was a problem hiding this comment.
I wonder if it's better or worse to allow for customising the back link text, e.g. if a backLinkText variable is provided in the context then it will override the text. I'll leave that up to you, just a thought
There was a problem hiding this comment.
I think it's worth doing if I encounter more back links that don't have the text "Back". Going to leave this for now.
| }) | ||
|
|
||
| it('should pass context data to the response method', () => { | ||
| expect(mockResponse.args[0][3]).to.have.property('backLink').to.equal( |
There was a problem hiding this comment.
some nice stuff you can do with sinon-chai
Suggested change
| expect(mockResponse.args[0][3]).to.have.property('backLink').to.equal( | |
| expect(mockResponse).to.have.been.calledWith(sinon.match.any, sinon.match.any, sinon.match.any, { | |
| backLink: '...' | |
| }) |
but again just a suggestion, up to you which you prefer
There was a problem hiding this comment.
I might as well delete this test and amend the one above it:
it('should pass req, res, template path and context to the response method', () => {
expect(mockResponse).to.have.been.calledWith(req, res, 'simplified-account/settings/api-keys/api-key-name',
{ backLink: formatSimplifiedAccountPathsFor(paths.simplifiedAccount.settings.apiKeys.index, SERVICE_ID, ACCOUNT_TYPE) })
})
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.
Creating an API key consists of two pages: the "API key name" and "New API key" pages.
Validation of the name/description and cypress test will be done in the next PRs.
API key name page:
New API key page: