Add prefer-node-protocol ESLint rule (#21532)

* Add `unicorn/prefer-node-protocol`

* Fix `unicorn/prefer-node-protocol` ESLint errors

* Run `npm run format:fix`

* Add sandboxed-module sourceTransformers in mocha setups

Fix `no such file or directory, open 'node:fs'` in `sandboxed-module`

* Remove `node:` in the SandboxedModule requires

* Fix new linting errors with `node:`

GitOrigin-RevId: 68f6e31e2191fcff4cb8058dd0a6914c14f59926

services/filestore/app.js

@@ -1,7 +1,7 @@
 // Metrics must be initialized before importing anything else
 require('@overleaf/metrics/initialize')
 
-const Events = require('events')
+const Events = require('node:events')
 const Metrics = require('@overleaf/metrics')
 
 const logger = require('@overleaf/logger')

services/filestore/app/js/FileController.js

@@ -2,7 +2,7 @@ const FileHandler = require('./FileHandler')
 const metrics = require('@overleaf/metrics')
 const parseRange = require('range-parser')
 const Errors = require('./Errors')
-const { pipeline } = require('stream')
+const { pipeline } = require('node:stream')
 
 const maxSizeInBytes = 1024 * 1024 * 1024 // 1GB
 

services/filestore/app/js/FileConverter.js

@@ -1,6 +1,6 @@
 const metrics = require('@overleaf/metrics')
 const Settings = require('@overleaf/settings')
-const { callbackify } = require('util')
+const { callbackify } = require('node:util')
 
 const safeExec = require('./SafeExec').promises
 const { ConversionError } = require('./Errors')

services/filestore/app/js/FileHandler.js

@@ -1,6 +1,6 @@
 const Settings = require('@overleaf/settings')
-const { callbackify } = require('util')
-const fs = require('fs')
+const { callbackify } = require('node:util')
+const fs = require('node:fs')
 let PersistorManager = require('./PersistorManager')
 const LocalFileWriter = require('./LocalFileWriter')
 const FileConverter = require('./FileConverter')

services/filestore/app/js/HealthCheckController.js

@@ -1,9 +1,9 @@
-const fs = require('fs')
-const path = require('path')
+const fs = require('node:fs')
+const path = require('node:path')
 const Settings = require('@overleaf/settings')
 const { WritableBuffer } = require('@overleaf/stream-utils')
-const { promisify } = require('util')
-const Stream = require('stream')
+const { promisify } = require('node:util')
+const Stream = require('node:stream')
 
 const pipeline = promisify(Stream.pipeline)
 const fsCopy = promisify(fs.copyFile)

services/filestore/app/js/ImageOptimiser.js

@@ -1,6 +1,6 @@
 const logger = require('@overleaf/logger')
 const metrics = require('@overleaf/metrics')
-const { callbackify } = require('util')
+const { callbackify } = require('node:util')
 const safeExec = require('./SafeExec').promises
 
 module.exports = {

services/filestore/app/js/LocalFileWriter.js

@@ -1,8 +1,8 @@
-const fs = require('fs')
-const crypto = require('crypto')
-const path = require('path')
-const Stream = require('stream')
-const { callbackify, promisify } = require('util')
+const fs = require('node:fs')
+const crypto = require('node:crypto')
+const path = require('node:path')
+const Stream = require('node:stream')
+const { callbackify, promisify } = require('node:util')
 const metrics = require('@overleaf/metrics')
 const Settings = require('@overleaf/settings')
 const { WriteError } = require('./Errors')

services/filestore/app/js/SafeExec.js

@@ -1,5 +1,5 @@
 const lodashOnce = require('lodash.once')
-const childProcess = require('child_process')
+const childProcess = require('node:child_process')
 const Settings = require('@overleaf/settings')
 const { ConversionsDisabledError, FailedCommandError } = require('./Errors')
 

services/filestore/config/settings.defaults.js

@@ -1,4 +1,4 @@
-const Path = require('path')
+const Path = require('node:path')
 
 // environment variables renamed for consistency
 // use AWS_ACCESS_KEY_ID-style going forward

services/filestore/test/acceptance/js/FilestoreApp.js

@@ -1,7 +1,7 @@
 const logger = require('@overleaf/logger')
 const ObjectPersistor = require('@overleaf/object-persistor')
 const Settings = require('@overleaf/settings')
-const { promisify } = require('util')
+const { promisify } = require('node:util')
 const App = require('../../../app')
 const FileHandler = require('../../../app/js/FileHandler')
 

services/filestore/test/acceptance/js/FilestoreTests.js

@@ -1,18 +1,18 @@
 const chai = require('chai')
 const { expect } = chai
-const fs = require('fs')
-const Stream = require('stream')
+const fs = require('node:fs')
+const Stream = require('node:stream')
 const Settings = require('@overleaf/settings')
-const Path = require('path')
+const Path = require('node:path')
 const FilestoreApp = require('./FilestoreApp')
 const TestHelper = require('./TestHelper')
 const fetch = require('node-fetch')
-const { promisify } = require('util')
+const { promisify } = require('node:util')
 const { Storage } = require('@google-cloud/storage')
 const streamifier = require('streamifier')
 chai.use(require('chai-as-promised'))
 const { ObjectId } = require('mongodb')
-const ChildProcess = require('child_process')
+const ChildProcess = require('node:child_process')
 
 const fsWriteFile = promisify(fs.writeFile)
 const fsStat = promisify(fs.stat)
@@ -43,7 +43,7 @@ const {
   RootKeyEncryptionKey,
 } = require('@overleaf/object-persistor/src/PerProjectEncryptedS3Persistor')
 const { S3Persistor } = require('@overleaf/object-persistor/src/S3Persistor')
-const crypto = require('crypto')
+const crypto = require('node:crypto')
 
 describe('Filestore', function () {
   this.timeout(1000 * 10)

services/filestore/test/acceptance/js/TestConfig.js

@@ -1,6 +1,6 @@
-const fs = require('fs')
-const Path = require('path')
-const crypto = require('crypto')
+const fs = require('node:fs')
+const Path = require('node:path')
+const crypto = require('node:crypto')
 const {
   RootKeyEncryptionKey,
 } = require('@overleaf/object-persistor/src/PerProjectEncryptedS3Persistor')

services/filestore/test/setup.js

@@ -21,6 +21,11 @@ SandboxedModule.configure({
   requires: {
     '@overleaf/logger': stubs.logger,
   },
+  sourceTransformers: {
+    removeNodePrefix: function (source) {
+      return source.replace(/require\(['"]node:/g, "require('")
+    },
+  },
 })
 
 exports.mochaHooks = {