Revert "[web] Migrate modules/server-ce-scripts to ESM"

GitOrigin-RevId: 61d971396b801e7bb3da1c5af7bd5ea4d91f3c9f
This commit is contained in:
Andrew Rumble 2024-10-21 16:56:13 +01:00 committed by Copybot
parent ab6ee04022
commit b5cd5bd8fa
12 changed files with 68 additions and 83 deletions

View file

@ -3,7 +3,7 @@ const tags = ['server-ce', 'server-pro']
const migrate = async () => { const migrate = async () => {
// Run-time import as SaaS does not ship with the server-ce-scripts module // Run-time import as SaaS does not ship with the server-ce-scripts module
const { default: runScript } = await import( const { default: runScript } = await import(
'../modules/server-ce-scripts/scripts/upgrade-user-features.mjs' '../modules/server-ce-scripts/scripts/upgrade-user-features.js'
) )
await runScript(false, { await runScript(false, {
gitBridge: 1, gitBridge: 1,

View file

@ -3,4 +3,4 @@
/** @type {WebModule} */ /** @type {WebModule} */
const ServerCeScriptsModule = {} const ServerCeScriptsModule = {}
export default ServerCeScriptsModule module.exports = ServerCeScriptsModule

View file

@ -1,9 +1,9 @@
import minimist from 'minimist' const minimist = require('minimist')
import { const {
db, db,
ObjectId, ObjectId,
waitForDb, waitForDb,
} from '../../../app/src/infrastructure/mongodb.js' } = require('../../../app/src/infrastructure/mongodb')
async function main() { async function main() {
await waitForDb() await waitForDb()

View file

@ -1,9 +1,6 @@
import mongodb from 'mongodb-legacy' const { ObjectId } = require('mongodb-legacy')
import { waitForDb, db } from '../../../app/src/infrastructure/mongodb.js' const { waitForDb, db } = require('../../../app/src/infrastructure/mongodb')
import mongoose from '../../../app/src/infrastructure/Mongoose.js' const { getMongoClient } = require('../../../app/src/infrastructure/Mongoose')
const { ObjectId } = mongodb
const { getMongoClient } = mongoose
const MIN_MONGO_VERSION = [5, 0] const MIN_MONGO_VERSION = [5, 0]

View file

@ -1,4 +1,4 @@
import RedisWrapper from '../../../app/src/infrastructure/RedisWrapper.js' const RedisWrapper = require('../../../app/src/infrastructure/RedisWrapper')
const rclient = RedisWrapper.client('health_check') const rclient = RedisWrapper.client('health_check')
rclient.on('error', err => { rclient.on('error', err => {
console.error('Cannot connect to redis.') console.error('Cannot connect to redis.')

View file

@ -1,4 +1,4 @@
import { waitForDb, db } from '../../../app/src/infrastructure/mongodb.js' const { waitForDb, db } = require('../../../app/src/infrastructure/mongodb')
async function readImagesInUse() { async function readImagesInUse() {
await waitForDb() await waitForDb()

View file

@ -1,6 +1,6 @@
import minimist from 'minimist' const minimist = require('minimist')
import { db, waitForDb } from '../../../app/src/infrastructure/mongodb.js' const { db, waitForDb } = require('../../../app/src/infrastructure/mongodb')
import UserRegistrationHandler from '../../../app/src/Features/User/UserRegistrationHandler.js' const UserRegistrationHandler = require('../../../app/src/Features/User/UserRegistrationHandler')
async function main() { async function main() {
await waitForDb() await waitForDb()

View file

@ -1,6 +1,6 @@
import { waitForDb } from '../../../app/src/infrastructure/mongodb.js' const { waitForDb } = require('../../../app/src/infrastructure/mongodb')
import UserGetter from '../../../app/src/Features/User/UserGetter.js' const UserGetter = require('../../../app/src/Features/User/UserGetter')
import UserDeleter from '../../../app/src/Features/User/UserDeleter.js' const UserDeleter = require('../../../app/src/Features/User/UserDeleter')
async function main() { async function main() {
await waitForDb() await waitForDb()

View file

@ -9,16 +9,16 @@
// Intended for Server Pro customers migrating user emails from one domain to // Intended for Server Pro customers migrating user emails from one domain to
// another. // another.
import minimist from 'minimist' const minimist = require('minimist')
const { waitForDb } = require('../../../app/src/infrastructure/mongodb')
import { waitForDb } from '../../../app/src/infrastructure/mongodb.js' const os = require('os')
import os from 'node:os' const fs = require('fs')
import fs from 'node:fs' const csv = require('csv/sync')
import * as csv from 'csv/sync' const { parseEmail } = require('../../../app/src/Features/Helpers/EmailHelper')
import { parseEmail } from '../../../app/src/Features/Helpers/EmailHelper.js' const UserGetter = require('../../../app/src/Features/User/UserGetter')
import UserGetter from '../../../app/src/Features/User/UserGetter.js' const UserUpdater = require('../../../app/src/Features/User/UserUpdater')
import UserUpdater from '../../../app/src/Features/User/UserUpdater.js' const UserSessionsManager = require('../../../app/src/Features/User/UserSessionsManager')
import UserSessionsManager from '../../../app/src/Features/User/UserSessionsManager.js'
const hostname = os.hostname() const hostname = os.hostname()
const scriptTimestamp = new Date().toISOString() const scriptTimestamp = new Date().toISOString()

View file

@ -1,5 +1,5 @@
import minimist from 'minimist' const minimist = require('minimist')
import { db, waitForDb } from '../../../app/src/infrastructure/mongodb.js' const { db, waitForDb } = require('../../../app/src/infrastructure/mongodb')
async function main() { async function main() {
await waitForDb() await waitForDb()

View file

@ -1,11 +1,10 @@
import { fileURLToPath } from 'node:url' const Settings = require('@overleaf/settings')
import Settings from '@overleaf/settings' const logger = require('@overleaf/logger')
import logger from '@overleaf/logger' const { db, waitForDb } = require('../../../app/src/infrastructure/mongodb')
import { db, waitForDb } from '../../../app/src/infrastructure/mongodb.js' const {
import {
mergeFeatures, mergeFeatures,
compareFeatures, compareFeatures,
} from '../../../app/src/Features/Subscription/FeaturesHelper.js' } = require('../../../app/src/Features/Subscription/FeaturesHelper')
const DRY_RUN = !process.argv.includes('--dry-run=false') const DRY_RUN = !process.argv.includes('--dry-run=false')
async function main(DRY_RUN, defaultFeatures) { async function main(DRY_RUN, defaultFeatures) {
@ -41,9 +40,9 @@ async function main(DRY_RUN, defaultFeatures) {
} }
} }
export default main module.exports = main
if (fileURLToPath(import.meta.url) === process.argv[1]) { if (require.main === module) {
if (DRY_RUN) { if (DRY_RUN) {
console.error('---') console.error('---')
console.error('Dry-run enabled, use --dry-run=false to commit changes') console.error('Dry-run enabled, use --dry-run=false to commit changes')

View file

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