Skip to content

Commit 2fa2d3f

Browse files
pix-service-auto-mergepix-service-auto-merge
authored
[TECH] Créer un script pour importer la date de dernière connexion (lastLoggedAt) (PIX-10728)
 #11814
2 parents fd5d0ae + cea4b19 commit 2fa2d3f

File tree

7 files changed

+373
-0
lines changed

7 files changed

+373
-0
lines changed

‎api/src/identity-access-management/domain/usecases/import-user-last-logged-at.usecase.js

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import { UserLogin } from '../models/UserLogin.js';
2+
3+
/**
4+
* @typedef {function} importUserLastLoggedAt
5+
* @param {Object} params
6+
* @param {boolean} params.dryRun
7+
* @param {string} params.userId
8+
* @param {Date} params.lastActivity
9+
* @param {UserRepository} params.userRepository
10+
* @param {UserLoginRepository} params.userLoginRepository
11+
* @return {Promise<boolean>}
12+
*/
13+
export const importUserLastLoggedAt = async function ({
14+
dryRun,
15+
userId,
16+
lastActivity,
17+
userRepository,
18+
userLoginRepository,
19+
}) {
20+
const user = await userRepository.findById(userId);
21+
if (!user || user.hasBeenAnonymised) {
22+
return false;
23+
}
24+
25+
const userLogin = await userLoginRepository.findByUserId(userId);
26+
if (!userLogin) {
27+
const newUserLogin = new UserLogin({ userId, lastLoggedAt: lastActivity });
28+
if (!dryRun) await userLoginRepository.create(newUserLogin);
29+
return true;
30+
}
31+
32+
if (userLogin.lastLoggedAt) {
33+
return false;
34+
}
35+
36+
userLogin.lastLoggedAt = lastActivity;
37+
if (!dryRun) await userLoginRepository.update(userLogin, { preventUpdatedAt: true });
38+
return true;
39+
};

‎api/src/identity-access-management/infrastructure/repositories/user.repository.js

+11
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,15 @@ const findAnotherUserByUsername = async function (userId, username) {
405405
return anotherUsers.map((anotherUser) => new User(anotherUser));
406406
};
407407

408+
/**
409+
* @param {string} userId
410+
* @return {Promise<User>}
411+
*/
412+
const findById = async function (userId) {
413+
const user = await knex('users').where({ id: userId }).first();
414+
return user ? new User(user) : null;
415+
};
416+
408417
/**
409418
* @param {{
410419
* userId: string
@@ -429,6 +438,7 @@ const updateLastDataProtectionPolicySeenAt = async function ({ userId }) {
429438
* @property {function} findAnotherUserByEmail
430439
* @property {function} findAnotherUserByUsername
431440
* @property {function} findByExternalIdentifier
441+
* @property {function} findById
432442
* @property {function} findPaginatedFiltered
433443
* @property {function} get
434444
* @property {function} getByEmail
@@ -461,6 +471,7 @@ export {
461471
findAnotherUserByEmail,
462472
findAnotherUserByUsername,
463473
findByExternalIdentifier,
474+
findById,
464475
findPaginatedFiltered,
465476
get,
466477
getByEmail,

‎api/src/identity-access-management/scripts/import-user-last-logged-at.script.js

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
import Joi from 'joi';
2+
3+
import { csvFileParser } from '../../shared/application/scripts/parsers.js';
4+
import { Script } from '../../shared/application/scripts/script.js';
5+
import { ScriptRunner } from '../../shared/application/scripts/script-runner.js';
6+
import { usecases } from '../domain/usecases/index.js';
7+
8+
export const csvSchemas = [
9+
{ name: 'userId', schema: Joi.number().required() },
10+
{ name: 'last_activity', schema: Joi.date().required() },
11+
];
12+
13+
export class ImportUserLastLogeedAtScript extends Script {
14+
constructor() {
15+
super({
16+
description: 'This script allows to update user last logged at',
17+
permanent: false,
18+
options: {
19+
file: {
20+
type: 'string',
21+
describe: 'CSV file path',
22+
demandOption: true,
23+
coerce: csvFileParser(csvSchemas),
24+
},
25+
dryRun: {
26+
type: 'boolean',
27+
describe: 'Executes the script in dry run mode',
28+
default: false,
29+
},
30+
},
31+
});
32+
}
33+
async handle({ options, logger, importUserLastLoggedAt = usecases.importUserLastLoggedAt }) {
34+
const { file, dryRun } = options;
35+
36+
const total = file.length;
37+
38+
if (dryRun) logger.info('DRY RUN mode enabled - data updates are not effective');
39+
40+
logger.info(`${total} users must be processed for last logged date update.`);
41+
let count = 0;
42+
let updatedCount = 0;
43+
let notUpdatedCount = 0;
44+
45+
for (const row of file) {
46+
const { userId, last_activity } = row;
47+
count += 1;
48+
const result = await importUserLastLoggedAt({ dryRun, userId, lastActivity: last_activity });
49+
if (result) {
50+
logger.info(`${count}/${total} - user updated`);
51+
updatedCount += 1;
52+
} else {
53+
logger.info(`${count}/${total} - user not updated`);
54+
notUpdatedCount += 1;
55+
}
56+
}
57+
58+
logger.info(`${count} users processed.`);
59+
logger.info(`${updatedCount} users with last logged at updated.`);
60+
logger.info(`${notUpdatedCount} users with last logged at NOT updated.`);
61+
}
62+
}
63+
64+
await ScriptRunner.execute(import.meta.url, ImportUserLastLogeedAtScript);

‎api/tests/identity-access-management/integration/domain/usecases/import-user-last-logged-at.usecase.test.js

+164
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
import { usecases } from '../../../../../src/identity-access-management/domain/usecases/index.js';
2+
import { databaseBuilder, expect, sinon } from '../../../../test-helper.js';
3+
4+
describe('Integration | Identity Access Management | Domain | UseCase | import user last logged at', function () {
5+
let clock;
6+
const now = new Date('2025-01-01');
7+
8+
beforeEach(function () {
9+
clock = sinon.useFakeTimers({ now, toFake: ['Date'] });
10+
});
11+
12+
afterEach(function () {
13+
clock.restore();
14+
});
15+
16+
context('when dryRun is false', function () {
17+
let dryRun;
18+
19+
beforeEach(function () {
20+
dryRun = false;
21+
});
22+
23+
context('when the user exists', function () {
24+
context('when the user has not been anonymized', function () {
25+
context('when the user login has no lastloggedAt', function () {
26+
it('updates the user login lastLoggedAt', async function () {
27+
// given
28+
const userId = databaseBuilder.factory.buildUser({
29+
hasBeenAnonymised: false,
30+
}).id;
31+
databaseBuilder.factory.buildUserLogin({
32+
userId,
33+
lastLoggedAt: null,
34+
});
35+
36+
await databaseBuilder.commit();
37+
38+
// when
39+
await usecases.importUserLastLoggedAt({
40+
dryRun,
41+
userId,
42+
lastActivity: new Date(),
43+
});
44+
45+
// then
46+
const userLoginUpdated = await databaseBuilder.knex('user-logins').where({ userId }).first();
47+
expect(userLoginUpdated.lastLoggedAt).to.deep.equal(now);
48+
});
49+
});
50+
});
51+
52+
context('when there is no user login', function () {
53+
it('creates a new user login', async function () {
54+
// given
55+
const userId = databaseBuilder.factory.buildUser({
56+
hasBeenAnonymised: false,
57+
}).id;
58+
59+
await databaseBuilder.commit();
60+
61+
// when
62+
await usecases.importUserLastLoggedAt({
63+
dryRun,
64+
userId,
65+
lastActivity: new Date(),
66+
});
67+
68+
// then
69+
const userLoginCreated = await databaseBuilder.knex('user-logins').where({ userId }).first();
70+
expect(userLoginCreated.lastLoggedAt).to.deep.equal(now);
71+
});
72+
});
73+
74+
context('when the user login has a lastLoggedAt', function () {
75+
it('does nothing', async function () {
76+
// given
77+
const userId = databaseBuilder.factory.buildUser({
78+
hasBeenAnonymised: false,
79+
}).id;
80+
databaseBuilder.factory.buildUserLogin({
81+
userId,
82+
lastLoggedAt: new Date('2020-01-01'),
83+
});
84+
await databaseBuilder.commit();
85+
86+
// when
87+
const result = await usecases.importUserLastLoggedAt({
88+
dryRun,
89+
userId,
90+
lastActivity: new Date(),
91+
});
92+
93+
// then
94+
const userLoginUpdated = await databaseBuilder.knex('user-logins').where({ userId }).first();
95+
expect(userLoginUpdated.lastLoggedAt).to.deep.equal(new Date('2020-01-01'));
96+
expect(result).to.be.false;
97+
});
98+
});
99+
});
100+
101+
context('when the user has been anonymized', function () {
102+
it('does nothing', async function () {
103+
// given
104+
const userId = databaseBuilder.factory.buildUser({
105+
hasBeenAnonymised: true,
106+
}).id;
107+
databaseBuilder.factory.buildUserLogin({
108+
userId,
109+
lastLoggedAt: null,
110+
});
111+
await databaseBuilder.commit();
112+
113+
// when
114+
const result = await usecases.importUserLastLoggedAt({
115+
dryRun,
116+
userId,
117+
lastActivity: new Date(),
118+
});
119+
120+
// then
121+
const userLoginUpdated = await databaseBuilder.knex('user-logins').where({ userId }).first();
122+
expect(userLoginUpdated.lastLoggedAt).to.be.null;
123+
expect(result).to.be.false;
124+
});
125+
});
126+
127+
context('when the user does not exist', function () {
128+
it('does nothing', async function () {
129+
// when
130+
const result = await usecases.importUserLastLoggedAt({
131+
dryRun,
132+
userId: 789,
133+
lastActivity: new Date(),
134+
});
135+
136+
// then
137+
expect(result).to.be.false;
138+
});
139+
});
140+
});
141+
142+
context('when dryRun is true', function () {
143+
it('does nothing', async function () {
144+
// given
145+
const userId = databaseBuilder.factory.buildUser().id;
146+
databaseBuilder.factory.buildUserLogin({
147+
userId,
148+
lastLoggedAt: null,
149+
});
150+
await databaseBuilder.commit();
151+
152+
// when
153+
await usecases.importUserLastLoggedAt({
154+
dryRun: true,
155+
userId,
156+
lastActivity: new Date(),
157+
});
158+
159+
// then
160+
const userLoginUpdated = await databaseBuilder.knex('user-logins').where({ userId }).first();
161+
expect(userLoginUpdated.lastLoggedAt).to.be.null;
162+
});
163+
});
164+
});

‎api/tests/identity-access-management/integration/infrastructure/repositories/user.repository.test.js

+29
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,35 @@ describe('Integration | Identity Access Management | Infrastructure | Repository
184184
});
185185
});
186186

187+
describe('#findById', function () {
188+
describe('when user exists', function () {
189+
it('returns the user', async function () {
190+
// given
191+
const userInDB = databaseBuilder.factory.buildUser();
192+
await databaseBuilder.commit();
193+
194+
// when
195+
const foundUser = await userRepository.findById(userInDB.id);
196+
197+
// then
198+
expect(foundUser).to.deepEqualInstance(new User(userInDB));
199+
});
200+
});
201+
202+
describe('when user does not exist', function () {
203+
it('returns null', async function () {
204+
// given
205+
const userId = 123456;
206+
207+
// when
208+
const foundUser = await userRepository.findById(userId);
209+
210+
// then
211+
expect(foundUser).to.be.null;
212+
});
213+
});
214+
});
215+
187216
describe('#findPaginatedFiltered', function () {
188217
context('when there are users in the database', function () {
189218
it('returns an array of users', async function () {

‎api/tests/identity-access-management/unit/scripts/files/new-update-last-logged-at.csv

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
userId,last_activity
2+
1234,2017-09-05 14:00:08+0000
3+
4567,2018-03-02 15:26:16+0000

0 commit comments

Comments
 (0)