Skip to content

C
coopwire-hypothesis
Commit 78c7f624 authored by Robert Knight's avatar Robert Knight
Browse files
Options

Convert `auth` service to an ES class 

Refactor this class to new conventions as part of
https://github.com/hypothesis/client/issues/3298.

 - Convert the `auth` service to an ES class
 - Replace the internal `emitter` variable with inheritance
 - Rename the module from `oauth-auth.js` to just `auth.js`. The
   previous name is a vestige from when authorization was migrated from
   cookie-based to OAuth-based
parent 5616b2c3
Hide whitespace changes
Inline Side-by-side
Showing with 316 additions and 321 deletions
src/sidebar/index.js
View file @ 78c7f624
...@@ -98,7 +98,7 @@ import bridgeService from '../shared/bridge'; ...@@ -98,7 +98,7 @@ import bridgeService from '../shared/bridge';
import { AnnotationsService } from './services/annotations'; import { AnnotationsService } from './services/annotations';
import apiService from './services/api'; import apiService from './services/api';
import { APIRoutesService } from './services/api-routes'; import { APIRoutesService } from './services/api-routes';
import authService from './services/oauth-auth'; import { AuthService } from './services/auth';
import { AutosaveService } from './services/autosave'; import { AutosaveService } from './services/autosave';
import { FeaturesService } from './services/features'; import { FeaturesService } from './services/features';
import frameSyncService from './services/frame-sync'; import frameSyncService from './services/frame-sync';
...@@ -135,7 +135,7 @@ function startApp(config, appEl) { ...@@ -135,7 +135,7 @@ function startApp(config, appEl) {
.register('annotationsService', AnnotationsService) .register('annotationsService', AnnotationsService)
.register('api', apiService) .register('api', apiService)
.register('apiRoutes', APIRoutesService) .register('apiRoutes', APIRoutesService)
.register('auth', authService) .register('auth', AuthService)
.register('autosaveService', AutosaveService) .register('autosaveService', AutosaveService)
.register('bridge', bridgeService) .register('bridge', bridgeService)
.register('features', FeaturesService) .register('features', FeaturesService)
......
src/sidebar/services/auth.js 0 → 100644
View file @ 78c7f624
import { TinyEmitter } from 'tiny-emitter';
import serviceConfig from '../config/service-config';
import OAuthClient from '../util/oauth-client';
import { resolve } from '../util/url';
/**
* @typedef {import('../util/oauth-client').TokenInfo} TokenInfo
*
* @typedef RefreshOptions
* @property {boolean} persist - True if access tokens should be persisted for
* use in future sessions.
*/
/**
* Authorization service.
*
* This service is responsible for acquiring access tokens for making API
* requests and making them available via the `tokenGetter()` method.
*
* Access tokens are acquired via the OAuth authorization flow, loading valid
* tokens from a previous session or, on some websites, by exchanging a grant
* token provided by the host page.
*
* Interaction with OAuth endpoints in the annotation service is delegated to
* the `OAuthClient` class.
*
* @inject
*/
export class AuthService extends TinyEmitter {
/**
* @param {Window} $window
* @param {import('./api-routes').APIRoutesService} apiRoutes
* @param {import('./local-storage').LocalStorageService} localStorage
* @param {import('./toast-messenger').ToastMessengerService} toastMessenger
*/
constructor($window, apiRoutes, localStorage, settings, toastMessenger) {
super();
/**
* Authorization code from auth popup window.
* @type {string|null}
*/
let authCode;
/**
* Token info retrieved via `POST /api/token` endpoint.
*
* Resolves to `null` if the user is not logged in.
*
* @type {Promise<TokenInfo|null>|null}
*/
let tokenInfoPromise;
/** @type {OAuthClient} */
let client;
/**
* Absolute URL of the `/api/token` endpoint.
*/
const tokenUrl = resolve('token', settings.apiUrl);
/**
* Show an error message telling the user that the access token has expired.
*/
function showAccessTokenExpiredErrorMessage(message) {
toastMessenger.error(`Hypothesis login lost: ${message}`, {
autoDismiss: false,
});
}
/**
* Return the storage key used for storing access/refresh token data for a given
* annotation service.
*/
function storageKey() {
// Use a unique key per annotation service. Currently OAuth tokens are only
// persisted for the default annotation service. If in future we support
// logging into other services from the client, this function will need to
// take the API URL as an argument.
let apiDomain = new URL(settings.apiUrl).hostname;
// Percent-encode periods to avoid conflict with section delimeters.
apiDomain = apiDomain.replace(/\./g, '%2E');
return `hypothesis.oauth.${apiDomain}.token`;
}
/**
* Fetch the last-saved access/refresh tokens for `authority` from local
* storage.
*/
function loadToken() {
const token = localStorage.getObject(storageKey());
if (
!token ||
typeof token.accessToken !== 'string' ||
typeof token.refreshToken !== 'string' ||
typeof token.expiresAt !== 'number'
) {
return null;
}
return {
accessToken: token.accessToken,
refreshToken: token.refreshToken,
expiresAt: token.expiresAt,
};
}
/**
* Persist access & refresh tokens for future use.
*/
function saveToken(token) {
localStorage.setObject(storageKey(), token);
}
/**
* Exchange the refresh token for a new access token and refresh token pair.
*
* @param {string} refreshToken
* @param {RefreshOptions} options
* @return {Promise<TokenInfo>} Promise for the new access token
*/
function refreshAccessToken(refreshToken, options) {
return oauthClient()
.then(client => client.refreshToken(refreshToken))
.then(tokenInfo => {
if (options.persist) {
saveToken(tokenInfo);
}
return tokenInfo;
});
}
/**
* Listen for updated access & refresh tokens saved by other instances of the
* client.
*/
const listenForTokenStorageEvents = () => {
$window.addEventListener('storage', ({ key }) => {
if (key === storageKey()) {
// Reset cached token information. Tokens will be reloaded from storage
// on the next call to `tokenGetter()`.
tokenInfoPromise = null;
this.emit('oauthTokensChanged');
}
});
};
function oauthClient() {
if (client) {
return Promise.resolve(client);
}
return apiRoutes.links().then(links => {
client = new OAuthClient({
clientId: settings.oauthClientId,
authorizationEndpoint: links['oauth.authorize'],
revokeEndpoint: links['oauth.revoke'],
tokenEndpoint: tokenUrl,
});
return client;
});
}
/**
* Retrieve an access token for the API.
*
* @return {Promise<string|null>} The API access token or `null` if not logged in.
*/
function tokenGetter() {
if (!tokenInfoPromise) {
const cfg = serviceConfig(settings);
// Check if automatic login is being used, indicated by the presence of
// the 'grantToken' property in the service configuration.
if (cfg && typeof cfg.grantToken !== 'undefined') {
if (cfg.grantToken) {
// User is logged-in on the publisher's website.
// Exchange the grant token for a new access token.
tokenInfoPromise = oauthClient()
.then(client => client.exchangeGrantToken(cfg.grantToken))
.catch(err => {
showAccessTokenExpiredErrorMessage(
'You must reload the page to annotate.'
);
throw err;
});
} else {
// User is anonymous on the publisher's website.
tokenInfoPromise = Promise.resolve(null);
}
} else if (authCode) {
// Exchange authorization code retrieved from login popup for a new
// access token.
const code = authCode;
authCode = null; // Auth codes can only be used once.
tokenInfoPromise = oauthClient()
.then(client => client.exchangeAuthCode(code))
.then(tokenInfo => {
saveToken(tokenInfo);
return tokenInfo;
});
} else {
// Attempt to load the tokens from the previous session.
tokenInfoPromise = Promise.resolve(loadToken());
}
}
const origToken = tokenInfoPromise;
return /** @type {Promise<TokenInfo|null>} */ (tokenInfoPromise).then(
token => {
if (!token) {
// No token available. User will need to log in.
return null;
}
if (origToken !== tokenInfoPromise) {
// A token refresh has been initiated via a call to `refreshAccessToken`
// below since `tokenGetter()` was called.
return tokenGetter();
}
if (Date.now() > token.expiresAt) {
let shouldPersist = true;
// If we are using automatic login via a grant token, do not persist the
// initial access token or refreshed tokens.
const cfg = serviceConfig(settings);
if (cfg && typeof cfg.grantToken !== 'undefined') {
shouldPersist = false;
}
// Token expired. Attempt to refresh.
tokenInfoPromise = refreshAccessToken(token.refreshToken, {
persist: shouldPersist,
})
.then(token => {
// Sanity check that prevents an infinite loop. Mostly useful in
// tests.
if (Date.now() > token.expiresAt) {
throw new Error('Refreshed token expired in the past');
}
return token;
})
.catch(() => {
// If refreshing the token fails, the user is simply logged out.
return null;
});
return tokenGetter();
} else {
return token.accessToken;
}
}
);
}
/**
* Login to the annotation service using OAuth.
*
* This displays a popup window which allows the user to login to the service
* (if necessary) and then responds with an auth code which the client can
* then exchange for access and refresh tokens.
*/
function login() {
const authWindow = OAuthClient.openAuthPopupWindow($window);
return oauthClient()
.then(client => {
return client.authorize($window, authWindow);
})
.then(code => {
// Save the auth code. It will be exchanged for an access token when the
// next API request is made.
authCode = code;
tokenInfoPromise = null;
});
}
/**
* Log out of the service (in the client only).
*
* This revokes and then forgets any OAuth credentials that the user has.
*/
async function logout() {
const [token, client] = await Promise.all([
tokenInfoPromise,
oauthClient(),
]);
if (token) {
await client.revokeToken(token.accessToken);
}
// eslint-disable-next-line require-atomic-updates
tokenInfoPromise = Promise.resolve(null);
localStorage.removeItem(storageKey());
}
listenForTokenStorageEvents();
// TODO - Convert these to ordinary class methods.
this.login = login;
this.logout = logout;
this.tokenGetter = tokenGetter;
}
}
src/sidebar/services/oauth-auth.js deleted 100644 → 0
View file @ 5616b2c3
import { TinyEmitter } from 'tiny-emitter';
import serviceConfig from '../config/service-config';
import OAuthClient from '../util/oauth-client';
import { resolve } from '../util/url';
/**
* @typedef {import('../util/oauth-client').TokenInfo} TokenInfo
*
* @typedef RefreshOptions
* @property {boolean} persist - True if access tokens should be persisted for
* use in future sessions.
*/
/**
* Authorization service.
*
* This service is responsible for acquiring access tokens for making API
* requests and making them available via the `tokenGetter()` method.
*
* Access tokens are acquired via the OAuth authorization flow, loading valid
* tokens from a previous session or, on some websites, by exchanging a grant
* token provided by the host page.
*
* Interaction with OAuth endpoints in the annotation service is delegated to
* the `OAuthClient` class.
*
* @param {Window} $window
* @param {import('./api-routes').APIRoutesService} apiRoutes
* @param {import('./local-storage').LocalStorageService} localStorage
* @param {import('./toast-messenger').ToastMessengerService} toastMessenger
* @inject
*/
export default function auth(
$window,
apiRoutes,
localStorage,
settings,
toastMessenger
) {
/**
* Authorization code from auth popup window.
* @type {string|null}
*/
let authCode;
/**
* Token info retrieved via `POST /api/token` endpoint.
*
* Resolves to `null` if the user is not logged in.
*
* @type {Promise<TokenInfo|null>|null}
*/
let tokenInfoPromise;
/** @type {OAuthClient} */
let client;
/**
* Absolute URL of the `/api/token` endpoint.
*/
const tokenUrl = resolve('token', settings.apiUrl);
/**
* Show an error message telling the user that the access token has expired.
*/
function showAccessTokenExpiredErrorMessage(message) {
toastMessenger.error(`Hypothesis login lost: ${message}`, {
autoDismiss: false,
});
}
/**
* Return the storage key used for storing access/refresh token data for a given
* annotation service.
*/
function storageKey() {
// Use a unique key per annotation service. Currently OAuth tokens are only
// persisted for the default annotation service. If in future we support
// logging into other services from the client, this function will need to
// take the API URL as an argument.
let apiDomain = new URL(settings.apiUrl).hostname;
// Percent-encode periods to avoid conflict with section delimeters.
apiDomain = apiDomain.replace(/\./g, '%2E');
return `hypothesis.oauth.${apiDomain}.token`;
}
/**
* Fetch the last-saved access/refresh tokens for `authority` from local
* storage.
*/
function loadToken() {
const token = localStorage.getObject(storageKey());
if (
!token ||
typeof token.accessToken !== 'string' ||
typeof token.refreshToken !== 'string' ||
typeof token.expiresAt !== 'number'
) {
return null;
}
return {
accessToken: token.accessToken,
refreshToken: token.refreshToken,
expiresAt: token.expiresAt,
};
}
/**
* Persist access & refresh tokens for future use.
*/
function saveToken(token) {
localStorage.setObject(storageKey(), token);
}
/**
* Exchange the refresh token for a new access token and refresh token pair.
*
* @param {string} refreshToken
* @param {RefreshOptions} options
* @return {Promise<TokenInfo>} Promise for the new access token
*/
function refreshAccessToken(refreshToken, options) {
return oauthClient()
.then(client => client.refreshToken(refreshToken))
.then(tokenInfo => {
if (options.persist) {
saveToken(tokenInfo);
}
return tokenInfo;
});
}
const emitter = new TinyEmitter();
/**
* Listen for updated access & refresh tokens saved by other instances of the
* client.
*/
function listenForTokenStorageEvents() {
$window.addEventListener('storage', ({ key }) => {
if (key === storageKey()) {
// Reset cached token information. Tokens will be reloaded from storage
// on the next call to `tokenGetter()`.
tokenInfoPromise = null;
emitter.emit('oauthTokensChanged');
}
});
}
function oauthClient() {
if (client) {
return Promise.resolve(client);
}
return apiRoutes.links().then(links => {
client = new OAuthClient({
clientId: settings.oauthClientId,
authorizationEndpoint: links['oauth.authorize'],
revokeEndpoint: links['oauth.revoke'],
tokenEndpoint: tokenUrl,
});
return client;
});
}
/**
* Retrieve an access token for the API.
*
* @return {Promise<string|null>} The API access token or `null` if not logged in.
*/
function tokenGetter() {
if (!tokenInfoPromise) {
const cfg = serviceConfig(settings);
// Check if automatic login is being used, indicated by the presence of
// the 'grantToken' property in the service configuration.
if (cfg && typeof cfg.grantToken !== 'undefined') {
if (cfg.grantToken) {
// User is logged-in on the publisher's website.
// Exchange the grant token for a new access token.
tokenInfoPromise = oauthClient()
.then(client => client.exchangeGrantToken(cfg.grantToken))
.catch(err => {
showAccessTokenExpiredErrorMessage(
'You must reload the page to annotate.'
);
throw err;
});
} else {
// User is anonymous on the publisher's website.
tokenInfoPromise = Promise.resolve(null);
}
} else if (authCode) {
// Exchange authorization code retrieved from login popup for a new
// access token.
const code = authCode;
authCode = null; // Auth codes can only be used once.
tokenInfoPromise = oauthClient()
.then(client => client.exchangeAuthCode(code))
.then(tokenInfo => {
saveToken(tokenInfo);
return tokenInfo;
});
} else {
// Attempt to load the tokens from the previous session.
tokenInfoPromise = Promise.resolve(loadToken());
}
}
const origToken = tokenInfoPromise;
return /** @type {Promise<TokenInfo|null>} */ (tokenInfoPromise).then(
token => {
if (!token) {
// No token available. User will need to log in.
return null;
}
if (origToken !== tokenInfoPromise) {
// A token refresh has been initiated via a call to `refreshAccessToken`
// below since `tokenGetter()` was called.
return tokenGetter();
}
if (Date.now() > token.expiresAt) {
let shouldPersist = true;
// If we are using automatic login via a grant token, do not persist the
// initial access token or refreshed tokens.
const cfg = serviceConfig(settings);
if (cfg && typeof cfg.grantToken !== 'undefined') {
shouldPersist = false;
}
// Token expired. Attempt to refresh.
tokenInfoPromise = refreshAccessToken(token.refreshToken, {
persist: shouldPersist,
})
.then(token => {
// Sanity check that prevents an infinite loop. Mostly useful in
// tests.
if (Date.now() > token.expiresAt) {
throw new Error('Refreshed token expired in the past');
}
return token;
})
.catch(() => {
// If refreshing the token fails, the user is simply logged out.
return null;
});
return tokenGetter();
} else {
return token.accessToken;
}
}
);
}
/**
* Login to the annotation service using OAuth.
*
* This displays a popup window which allows the user to login to the service
* (if necessary) and then responds with an auth code which the client can
* then exchange for access and refresh tokens.
*/
function login() {
const authWindow = OAuthClient.openAuthPopupWindow($window);
return oauthClient()
.then(client => {
return client.authorize($window, authWindow);
})
.then(code => {
// Save the auth code. It will be exchanged for an access token when the
// next API request is made.
authCode = code;
tokenInfoPromise = null;
});
}
/**
* Log out of the service (in the client only).
*
* This revokes and then forgets any OAuth credentials that the user has.
*/
async function logout() {
const [token, client] = await Promise.all([
tokenInfoPromise,
oauthClient(),
]);
if (token) {
await client.revokeToken(token.accessToken);
}
// eslint-disable-next-line require-atomic-updates
tokenInfoPromise = Promise.resolve(null);
localStorage.removeItem(storageKey());
}
listenForTokenStorageEvents();
// The returned object `extends` the emitter. We could rework this
// service to be a class in future to do this more explicitly.
return Object.assign(emitter, {
login,
logout,
tokenGetter,
});
}
src/sidebar/services/streamer.js
View file @ 78c7f624
...@@ -11,7 +11,7 @@ import { watch } from '../util/watch'; ...@@ -11,7 +11,7 @@ import { watch } from '../util/watch';
* closed. * closed.
* *
* @param {import('../store').SidebarStore} store * @param {import('../store').SidebarStore} store
* @param {ReturnType<import('./oauth-auth').default>} auth * @param {import('./auth').AuthService} auth
* @param {ReturnType<import('./groups').default>} groups * @param {ReturnType<import('./groups').default>} groups
* @param {ReturnType<import('./session').default>} session * @param {ReturnType<import('./session').default>} session
* @param {Record<string, any>} settings * @param {Record<string, any>} settings
......
src/sidebar/services/test/oauth-auth-test.js → src/sidebar/services/test/auth-test.js
View file @ 78c7f624
import { Injector } from '../../../shared/injector'; import { Injector } from '../../../shared/injector';
import FakeWindow from '../../test/fake-window'; import FakeWindow from '../../test/fake-window';
import authFactory, { $imports } from '../oauth-auth'; import { AuthService, $imports } from '../auth';
const DEFAULT_TOKEN_EXPIRES_IN_SECS = 1000; const DEFAULT_TOKEN_EXPIRES_IN_SECS = 1000;
const TOKEN_KEY = 'hypothesis.oauth.hypothes%2Eis.token'; const TOKEN_KEY = 'hypothesis.oauth.hypothes%2Eis.token';
describe('sidebar/services/oauth-auth', function () { describe('AuthService', function () {
let FakeOAuthClient; let FakeOAuthClient;
let auth; let auth;
let nowStub; let nowStub;
...@@ -96,7 +96,7 @@ describe('sidebar/services/oauth-auth', function () { ...@@ -96,7 +96,7 @@ describe('sidebar/services/oauth-auth', function () {
.register('localStorage', { value: fakeLocalStorage }) .register('localStorage', { value: fakeLocalStorage })
.register('settings', { value: fakeSettings }) .register('settings', { value: fakeSettings })
.register('toastMessenger', { value: fakeToastMessenger }) .register('toastMessenger', { value: fakeToastMessenger })
.register('auth', authFactory) .register('auth', AuthService)
.get('auth'); .get('auth');
}); });
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment