Skip to content

Commit

Permalink
Merge pull request mainmatter#2873 from mainmatter/typescript-refactor
Browse files Browse the repository at this point in the history 
chore(typescript): migrate services/session to typescript
  • Loading branch information
@BobrImperator
BobrImperator authored Dec 26, 2024
2 parents 9caa96c + 551491c commit 290fb30
Show file tree
Hide file tree
Showing 5 changed files with 102 additions and 114 deletions.
4 changes: 4 additions & 0 deletions packages/ember-simple-auth/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@
"@rollup/plugin-babel": "6.0.4",
"@rollup/plugin-node-resolve": "15.3.1",
"@tsconfig/ember": "^3.0.8",
"@types/ember__application": "^4.0.11",
"@types/ember__debug": "^4.0.8",
"@types/ember__object": "^4.0.12",
"@types/ember__routing": "^4.0.22",
"@types/ember__service": "^4.0.9",
"@typescript-eslint/eslint-plugin": "^8.18.1",
"@typescript-eslint/parser": "^8.18.1",
Expand Down
125 changes: 73 additions & 52 deletions ...ember-simple-auth/src/services/session.js → ...ember-simple-auth/src/services/session.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { alias, readOnly } from '@ember/object/computed';
import Service from '@ember/service';
import { getOwner } from '@ember/application';
import { assert } from '@ember/debug';
Expand All @@ -11,10 +10,12 @@ import {
handleSessionAuthenticated,
handleSessionInvalidated,
} from '../-internals/routing';
import type Transition from '@ember/routing/transition';
import { alias } from '@ember/object/computed';

const SESSION_DATA_KEY_PREFIX = /^data\./;

function assertSetupHasBeenCalled(isSetupCalled) {
function assertSetupHasBeenCalled(isSetupCalled: boolean) {
if (!isSetupCalled) {
assert(
"Ember Simple Auth: session#setup wasn't called. Make sure to call session#setup in your application route's beforeModel hook.",
Expand All @@ -23,6 +24,22 @@ function assertSetupHasBeenCalled(isSetupCalled) {
}
}

type RouteOrCallback = string | (() => void);

type InternalSessionMock = {
isAuthenticated: boolean;
content: { authenticated: Record<string, string> };
store: unknown;
attemptedTransition: null;
on: (event: 'authenticationSucceeded' | 'invalidationSucceeded', cb: () => void) => void;
authenticate: (authenticator: string, ...args: any[]) => void;
invalidate: (...args: any[]) => void;
requireAuthentication: (transition: Transition, routeOrCallback: RouteOrCallback) => boolean;
prohibitAuthentication: (routeOrCallback: RouteOrCallback) => boolean;
restore: () => Promise<void>;
set(key: string, value: any): void;
};

/**
__The session service provides access to the current session as well as
methods to authenticate it, invalidate it, etc.__ It is the main interface for
Expand All @@ -42,7 +59,20 @@ function assertSetupHasBeenCalled(isSetupCalled) {
@extends Service
@public
*/
export default Service.extend({
export default class EmberSimpleAuthSessionService extends Service {
session: InternalSessionMock;

constructor(owner: any) {
super(owner);

this.session = owner.lookup('session:main') as InternalSessionMock;
}

/**
* Says whether the service was correctly initialized by the {#linkplain SessionService.setup}
*/
_setupIsCalled = false;

/**
Returns whether the session is currently authenticated.
Expand All @@ -53,7 +83,9 @@ export default Service.extend({
@default false
@public
*/
isAuthenticated: readOnly('session.isAuthenticated'),
get isAuthenticated() {
return this.session.isAuthenticated;
}

/**
The current session data as a plain object. The
Expand All @@ -70,7 +102,9 @@ export default Service.extend({
@default { authenticated: {} }
@public
*/
data: readOnly('session.content'),
get data() {
return this.session.content;
}

/**
The session store.
Expand All @@ -82,7 +116,9 @@ export default Service.extend({
@default null
@public
*/
store: readOnly('session.store'),
get store() {
return this.session.store;
}

/**
A previously attempted but intercepted transition (e.g. by the
Expand All @@ -95,34 +131,25 @@ export default Service.extend({
@default null
@public
*/
attemptedTransition: alias('session.attemptedTransition'),

session: null,

init() {
this._super(...arguments);

this.set('session', getOwner(this).lookup('session:main'));
},
@alias('session.attemptedTransition')
attemptedTransition: null | Transition = null;

set(key, value) {
set(key: any, value: any) {
const setsSessionData = SESSION_DATA_KEY_PREFIX.test(key);
if (setsSessionData) {
const sessionDataKey = `session.${key.replace(SESSION_DATA_KEY_PREFIX, '')}`;
return this._super(sessionDataKey, value);
return super.set(sessionDataKey, value);
} else {
return this._super(...arguments);
return super.set(key, value);
}
},
}

_setupHandlers() {
this.get('session').on('authenticationSucceeded', () =>
this.session.on('authenticationSucceeded', () =>
this.handleAuthentication(Configuration.routeAfterAuthentication)
);
this.get('session').on('invalidationSucceeded', () =>
this.handleInvalidation(Configuration.rootURL)
);
},
this.session.on('invalidationSucceeded', () => this.handleInvalidation(Configuration.rootURL));
}

/**
__Authenticates the session with an `authenticator`__ and appropriate
Expand Down Expand Up @@ -153,11 +180,9 @@ export default Service.extend({
@return {Promise} A promise that resolves when the session was authenticated successfully and rejects otherwise
@public
*/
authenticate() {
const session = this.get('session');

return session.authenticate(...arguments);
},
authenticate(authenticator: string, ...args: any[]) {
return this.session.authenticate(authenticator, ...args);
}

/**
__Invalidates the session with the authenticator it is currently
Expand Down Expand Up @@ -187,11 +212,9 @@ export default Service.extend({
@return {Promise} A promise that resolves when the session was invalidated successfully and rejects otherwise
@public
*/
invalidate() {
const session = this.get('session');

return session.invalidate(...arguments);
},
invalidate(...args: any[]) {
return this.session.invalidate(...args);
}

/**
Checks whether the session is authenticated and if it is not, transitions
Expand All @@ -212,24 +235,23 @@ export default Service.extend({
@return {Boolean} true when the session is authenticated, false otherwise
@public
*/
requireAuthentication(transition, routeOrCallback) {
requireAuthentication(transition: Transition, routeOrCallback: RouteOrCallback) {
assertSetupHasBeenCalled(this._setupIsCalled);
let isAuthenticated = requireAuthentication(getOwner(this), transition);
if (!isAuthenticated) {
let argType = typeof routeOrCallback;
if (argType === 'string') {
if (typeof routeOrCallback === 'string') {
triggerAuthentication(getOwner(this), routeOrCallback);
} else if (argType === 'function') {
} else if (typeof routeOrCallback === 'function') {
routeOrCallback();
} else {
assert(
`The second argument to requireAuthentication must be a String or Function, got "${argType}"!`,
`The second argument to requireAuthentication must be a String or Function, got "${typeof routeOrCallback}"!`,
false
);
}
}
return isAuthenticated;
},
}

/**
Checks whether the session is authenticated and if it is, transitions
Expand All @@ -241,24 +263,23 @@ export default Service.extend({
@return {Boolean} true when the session is not authenticated, false otherwise
@public
*/
prohibitAuthentication(routeOrCallback) {
prohibitAuthentication(routeOrCallback: RouteOrCallback) {
assertSetupHasBeenCalled(this._setupIsCalled);
let isAuthenticated = this.get('isAuthenticated');
if (isAuthenticated) {
let argType = typeof routeOrCallback;
if (argType === 'string') {
if (typeof routeOrCallback === 'string') {
prohibitAuthentication(getOwner(this), routeOrCallback);
} else if (argType === 'function') {
} else if (typeof routeOrCallback === 'function') {
routeOrCallback();
} else {
assert(
`The first argument to prohibitAuthentication must be a String or Function, got "${argType}"!`,
`The first argument to prohibitAuthentication must be a String or Function, got "${typeof routeOrCallback}"!`,
false
);
}
}
return !isAuthenticated;
},
}

/**
This method is called whenever the session goes from being unauthenticated
Expand All @@ -276,9 +297,9 @@ export default Service.extend({
@param {String} routeAfterAuthentication The route to transition to
@public
*/
handleAuthentication(routeAfterAuthentication) {
handleAuthentication(routeAfterAuthentication: string) {
handleSessionAuthenticated(getOwner(this), routeAfterAuthentication);
},
}

/**
This method is called whenever the session goes from being authenticated to
Expand All @@ -296,9 +317,9 @@ export default Service.extend({
@param {String} routeAfterInvalidation The route to transition to
@public
*/
handleInvalidation(routeAfterInvalidation) {
handleInvalidation(routeAfterInvalidation: string) {
handleSessionInvalidated(getOwner(this), routeAfterInvalidation);
},
}

/**
Sets up the session service.
Expand All @@ -318,5 +339,5 @@ export default Service.extend({
return this.session.restore().catch(() => {
// If it raises an error then it means that restore didn't find any restorable state.
});
},
});
}
}
3 changes: 1 addition & 2 deletions packages/ember-simple-auth/tsconfig.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@
can do the proper transformations on those files.
*/
"allowImportingTsExtensions": true,

"types": ["ember-source/types"]
"types": ["ember-source/types", "types"]
}
}
30 changes: 0 additions & 30 deletions packages/test-esa/tests/unit/services/session-test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,6 @@ module('SessionService', function (hooks) {

assert.ok(sessionService.get('isAuthenticated'));
});

test('is read-only', function (assert) {
assert.expect(1);
try {
sessionService.set('isAuthenticated', false);
assert.ok(false);
} catch (e) {
assert.ok(true);
}
});
});

module('store', function () {
Expand All @@ -52,16 +42,6 @@ module('SessionService', function (hooks) {

assert.equal(sessionService.get('store'), 'some store');
});

test('is read-only', function (assert) {
assert.expect(1);
try {
sessionService.set('store', 'some other store');
assert.ok(false);
} catch (e) {
assert.ok(true);
}
});
});

module('attemptedTransition', function () {
Expand Down Expand Up @@ -96,16 +76,6 @@ module('SessionService', function (hooks) {

assert.deepEqual(session.content, { emberSet: 'ember-set-data', authenticated: {} });
});

test('is read-only', function (assert) {
assert.expect(1);
try {
sessionService.set('data', false);
assert.ok(false);
} catch (e) {
assert.ok(true);
}
});
});

module('authenticate', function (hooks) {
Expand Down
Loading

0 comments on commit 290fb30

Please sign in to comment.