agw/overleaf-cep
1
0
Fork 0
mirror of https://github.com/yu-i-i/overleaf-cep.git synced 2026-06-10 22:50:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #22580 from overleaf/ar-migrate-server-ce-scripts

Browse Source 
Convert server-ce-scripts module to ES modules

GitOrigin-RevId: 516247b25b5bdbfd89fee4b99a88431097c827de
This commit is contained in:
Andrew Rumble
2025-01-08 16:35:00 +00:00
committed by Copybot
parent d6e763bc57
commit 813946a693
15 changed files with 153 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files
services/web/modules/server-ce-scripts/test/acceptance/src/ServerCEScriptsTests.js → services/web/modules/server-ce-scripts/test/acceptance/src/ServerCEScriptsTests.mjs
+45 -34
View File
@@ -1,9 +1,11 @@
const { execSync } = require('child_process')
const fs = require('fs')
const Settings = require('@overleaf/settings')
const { expect } = require('chai')
const { db } = require('../../../../../app/src/infrastructure/mongodb')
const User = require('../../../../../test/acceptance/src/helpers/User').promises
import { execSync } from 'node:child_process'
import fs from 'node:fs'
import Settings from '@overleaf/settings'
import { expect } from 'chai'
import { db } from '../../../../../app/src/infrastructure/mongodb.js'
import UserHelper from '../../../../../test/acceptance/src/helpers/User.js'
const { promises: User } = UserHelper
/**
* @param {string} cmd
@@ -42,7 +44,7 @@ async function getUser(email) {
describe('ServerCEScripts', function () {
describe('check-mongodb', function () {
it('should exit with code 0 on success', function () {
run('node modules/server-ce-scripts/scripts/check-mongodb')
run('node modules/server-ce-scripts/scripts/check-mongodb.mjs')
})
it('should exit with code 1 on error', function () {
@@ -50,7 +52,7 @@ describe('ServerCEScripts', function () {
run(
'MONGO_SERVER_SELECTION_TIMEOUT=1' +
'MONGO_CONNECTION_STRING=mongodb://127.0.0.1:4242 ' +
'node modules/server-ce-scripts/scripts/check-mongodb'
'node modules/server-ce-scripts/scripts/check-mongodb.mjs'
)
} catch (e) {
expect(e.status).to.equal(1)
@@ -62,12 +64,14 @@ describe('ServerCEScripts', function () {
describe('check-redis', function () {
it('should exit with code 0 on success', function () {
run('node modules/server-ce-scripts/scripts/check-redis')
run('node modules/server-ce-scripts/scripts/check-redis.mjs')
})
it('should exit with code 1 on error', function () {
try {
run('REDIS_PORT=42 node modules/server-ce-scripts/scripts/check-redis')
run(
'REDIS_PORT=42 node modules/server-ce-scripts/scripts/check-redis.mjs'
)
} catch (e) {
expect(e.status).to.equal(1)
return
@@ -79,28 +83,28 @@ describe('ServerCEScripts', function () {
describe('create-user', function () {
it('should exit with code 0 on success', function () {
const out = run(
'node modules/server-ce-scripts/scripts/create-user --email=foo@bar.com'
'node modules/server-ce-scripts/scripts/create-user.js --email=foo@bar.com'
)
expect(out).to.include('/user/activate?token=')
})
it('should create a regular user by default', async function () {
run(
'node modules/server-ce-scripts/scripts/create-user --email=foo@bar.com'
'node modules/server-ce-scripts/scripts/create-user.js --email=foo@bar.com'
)
expect(await getUser('foo@bar.com')).to.deep.equal({ isAdmin: false })
})
it('should create an admin user with --admin flag', async function () {
run(
'node modules/server-ce-scripts/scripts/create-user --admin --email=foo@bar.com'
'node modules/server-ce-scripts/scripts/create-user.js --admin --email=foo@bar.com'
)
expect(await getUser('foo@bar.com')).to.deep.equal({ isAdmin: true })
})
it('should exit with code 1 on missing email', function () {
try {
run('node modules/server-ce-scripts/scripts/create-user')
run('node modules/server-ce-scripts/scripts/create-user.js')
} catch (e) {
expect(e.status).to.equal(1)
return
@@ -119,19 +123,26 @@ describe('ServerCEScripts', function () {
it('should log missing user', function () {
const email = 'does-not-exist@example.com'
const out = run(
'node modules/server-ce-scripts/scripts/delete-user --email=' + email
'node modules/server-ce-scripts/scripts/delete-user.mjs --email=' +
email
)
expect(out).to.include('not in database, potentially already deleted')
})
it('should exit with code 0 on success', function () {
const email = user.email
run('node modules/server-ce-scripts/scripts/delete-user --email=' + email)
run(
'node modules/server-ce-scripts/scripts/delete-user.mjs --email=' +
email
)
})
it('should have deleted the user on success', async function () {
const email = user.email
run('node modules/server-ce-scripts/scripts/delete-user --email=' + email)
run(
'node modules/server-ce-scripts/scripts/delete-user.mjs --email=' +
email
)
const dbEntry = await user.get()
expect(dbEntry).to.not.exist
const softDeletedEntry = await db.deletedUsers.findOne({
@@ -143,7 +154,7 @@ describe('ServerCEScripts', function () {
it('should exit with code 1 on missing email', function () {
try {
run('node modules/server-ce-scripts/scripts/delete-user')
run('node modules/server-ce-scripts/scripts/delete-user.mjs')
} catch (e) {
expect(e.status).to.equal(1)
return
@@ -199,7 +210,7 @@ describe('ServerCEScripts', function () {
it('should do a dry run by default', async function () {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js ${csv}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs ${csv}`
)
for (const user of usersToMigrate) {
const dbEntry = await user.get()
@@ -213,13 +224,13 @@ describe('ServerCEScripts', function () {
it('should exit with code 0 when successfully migrating user emails', function () {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit ${csv}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit ${csv}`
)
})
it('should migrate the user emails with the --commit option', async function () {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit ${csv}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit ${csv}`
)
for (const user of usersToMigrate) {
const dbEntry = await user.get()
@@ -233,7 +244,7 @@ describe('ServerCEScripts', function () {
it('should leave other user emails unchanged', async function () {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit ${csv}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit ${csv}`
)
for (const user of otherUsers) {
const dbEntry = await user.get()
@@ -244,7 +255,7 @@ describe('ServerCEScripts', function () {
it('should exit with code 1 when there are failures migrating user emails', function () {
try {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit ${csvfail}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit ${csvfail}`
)
} catch (e) {
expect(e.status).to.equal(1)
@@ -256,12 +267,12 @@ describe('ServerCEScripts', function () {
it('should migrate other users when there are failures with the --continue option', async function () {
try {
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit ${csvfail}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit ${csvfail}`
)
} catch (e) {
expect(e.status).to.equal(1)
run(
`node modules/server-ce-scripts/scripts/migrate-user-emails.js --commit --continue ${csvfail}`
`node modules/server-ce-scripts/scripts/migrate-user-emails.mjs --commit --continue ${csvfail}`
)
for (const user of usersToMigrate) {
const dbEntry = await user.get()
@@ -301,7 +312,7 @@ describe('ServerCEScripts', function () {
expect(await getTagNames()).to.deep.equal([oldName])
run(
`node modules/server-ce-scripts/scripts/rename-tag --user-id=${user.id} --old-name=${oldName} --new-name=${newName}`
`node modules/server-ce-scripts/scripts/rename-tag.mjs --user-id=${user.id} --old-name=${oldName} --new-name=${newName}`
)
expect(await getTagNames()).to.deep.equal([newName])
@@ -334,7 +345,7 @@ describe('ServerCEScripts', function () {
beforeEach('run script on user a', function () {
newUserATimeout = userATimeout - 1
run(
`node modules/server-ce-scripts/scripts/change-compile-timeout --user-id=${userA.id} --compile-timeout=${newUserATimeout}`
`node modules/server-ce-scripts/scripts/change-compile-timeout.mjs --user-id=${userA.id} --compile-timeout=${newUserATimeout}`
)
})
@@ -353,7 +364,7 @@ describe('ServerCEScripts', function () {
it('should reject zero timeout', async function () {
try {
run(
`node modules/server-ce-scripts/scripts/change-compile-timeout --user-id=${userA.id} --compile-timeout=0`
`node modules/server-ce-scripts/scripts/change-compile-timeout.mjs --user-id=${userA.id} --compile-timeout=0`
)
expect.fail('should error out')
} catch (err) {
@@ -366,7 +377,7 @@ describe('ServerCEScripts', function () {
it('should reject a 20min timeout', async function () {
try {
run(
`node modules/server-ce-scripts/scripts/change-compile-timeout --user-id=${userA.id} --compile-timeout=1200`
`node modules/server-ce-scripts/scripts/change-compile-timeout.mjs --user-id=${userA.id} --compile-timeout=1200`
)
expect.fail('should error out')
} catch (err) {
@@ -410,13 +421,13 @@ describe('ServerCEScripts', function () {
beforeEach('downgrade userCustomTimeoutLower', async function () {
run(
`node modules/server-ce-scripts/scripts/change-compile-timeout --user-id=${userCustomTimeoutLower.id} --compile-timeout=42`
`node modules/server-ce-scripts/scripts/change-compile-timeout.mjs --user-id=${userCustomTimeoutLower.id} --compile-timeout=42`
)
})
beforeEach('upgrade userCustomTimeoutHigher', async function () {
run(
`node modules/server-ce-scripts/scripts/change-compile-timeout --user-id=${userCustomTimeoutHigher.id} --compile-timeout=360`
`node modules/server-ce-scripts/scripts/change-compile-timeout.mjs --user-id=${userCustomTimeoutHigher.id} --compile-timeout=360`
)
})
@@ -451,7 +462,7 @@ describe('ServerCEScripts', function () {
let output
beforeEach('run script', function () {
output = run(
`node modules/server-ce-scripts/scripts/upgrade-user-features`
`node modules/server-ce-scripts/scripts/upgrade-user-features.mjs`
)
})
@@ -480,7 +491,7 @@ describe('ServerCEScripts', function () {
let output
beforeEach('run script', function () {
output = run(
`node modules/server-ce-scripts/scripts/upgrade-user-features --dry-run=false`
`node modules/server-ce-scripts/scripts/upgrade-user-features.mjs --dry-run=false`
)
})
@@ -537,7 +548,7 @@ describe('ServerCEScripts', function () {
cmd += ` OVERLEAF_IS_SERVER_PRO=${OVERLEAF_IS_SERVER_PRO}`
}
return (
cmd + ' node modules/server-ce-scripts/scripts/check-texlive-images'
cmd + ' node modules/server-ce-scripts/scripts/check-texlive-images.mjs'
)
}