[misc] switch from settings-sharelatex to @overleaf/settings

2025-04-17 07:37:36 +00:00 · 2021-07-12 17:47:15 +01:00 · 2021-07-12 17:47:15 +01:00 · 519dd274bf
commit 519dd274bf
parent 835dbe784b
36 changed files with 41 additions and 51 deletions
--- a/services/document-updater/app.js
+++ b/services/document-updater/app.js
@ -2,7 +2,7 @@ const Metrics = require('@overleaf/metrics')
 Metrics.initialize('doc-updater')

 const express = require('express')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const logger = require('logger-sharelatex')
 logger.initialize('document-updater')

--- a/services/document-updater/app/js/DeleteQueueManager.js
+++ b/services/document-updater/app/js/DeleteQueueManager.js
@ -13,7 +13,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let DeleteQueueManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const RedisManager = require('./RedisManager')
 const ProjectManager = require('./ProjectManager')
 const logger = require('logger-sharelatex')
--- a/services/document-updater/app/js/DispatchManager.js
+++ b/services/document-updater/app/js/DispatchManager.js
@ -15,7 +15,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let DispatchManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const logger = require('logger-sharelatex')
 const Keys = require('./UpdateKeys')
 const redis = require('@overleaf/redis-wrapper')
--- a/services/document-updater/app/js/HistoryManager.js
+++ b/services/document-updater/app/js/HistoryManager.js
@ -15,7 +15,7 @@ let HistoryManager
 const async = require('async')
 const logger = require('logger-sharelatex')
 const request = require('request')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const HistoryRedisManager = require('./HistoryRedisManager')
 const ProjectHistoryRedisManager = require('./ProjectHistoryRedisManager')
 const RedisManager = require('./RedisManager')
--- a/services/document-updater/app/js/HistoryRedisManager.js
+++ b/services/document-updater/app/js/HistoryRedisManager.js
@ -12,7 +12,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let HistoryRedisManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclient = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.history
 )
--- a/services/document-updater/app/js/HttpController.js
+++ b/services/document-updater/app/js/HttpController.js
@ -3,7 +3,7 @@ const HistoryManager = require('./HistoryManager')
 const ProjectManager = require('./ProjectManager')
 const Errors = require('./Errors')
 const logger = require('logger-sharelatex')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const Metrics = require('./Metrics')
 const ProjectFlusher = require('./ProjectFlusher')
 const DeleteQueueManager = require('./DeleteQueueManager')
--- a/services/document-updater/app/js/LockManager.js
+++ b/services/document-updater/app/js/LockManager.js
@ -13,7 +13,7 @@
 */
 let LockManager
 const metrics = require('./Metrics')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const redis = require('@overleaf/redis-wrapper')
 const rclient = redis.createClient(Settings.redis.lock)
 const keys = Settings.redis.lock.key_schema
--- a/services/document-updater/app/js/PersistenceManager.js
+++ b/services/document-updater/app/js/PersistenceManager.js
@ -15,7 +15,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let PersistenceManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const Errors = require('./Errors')
 const Metrics = require('./Metrics')
 const logger = require('logger-sharelatex')
--- a/services/document-updater/app/js/Profiler.js
+++ b/services/document-updater/app/js/Profiler.js
@ -9,7 +9,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let Profiler
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const logger = require('logger-sharelatex')

 const deltaMs = function (ta, tb) {
--- a/services/document-updater/app/js/ProjectFlusher.js
+++ b/services/document-updater/app/js/ProjectFlusher.js
@ -13,7 +13,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 const request = require('request')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const RedisManager = require('./RedisManager')
 const { rclient } = RedisManager
 const docUpdaterKeys = Settings.redis.documentupdater.key_schema
--- a/services/document-updater/app/js/ProjectHistoryRedisManager.js
+++ b/services/document-updater/app/js/ProjectHistoryRedisManager.js
@ -14,7 +14,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let ProjectHistoryRedisManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const projectHistoryKeys = __guard__(
  Settings.redis != null ? Settings.redis.project_history : undefined,
  (x) => x.key_schema
--- a/services/document-updater/app/js/RateLimitManager.js
+++ b/services/document-updater/app/js/RateLimitManager.js
@ -10,7 +10,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let RateLimiter
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const logger = require('logger-sharelatex')
 const Metrics = require('./Metrics')

--- a/services/document-updater/app/js/RealTimeRedisManager.js
+++ b/services/document-updater/app/js/RealTimeRedisManager.js
@ -12,7 +12,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let RealTimeRedisManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclient = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.documentupdater
 )
--- a/services/document-updater/app/js/RedisManager.js
+++ b/services/document-updater/app/js/RedisManager.js
@ -14,7 +14,7 @@
 * Full docs: https://github.com/decaffeinate/decaffeinate/blob/master/docs/suggestions.md
 */
 let RedisManager
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclient = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.documentupdater
 )
--- a/services/document-updater/app/js/ShareJsUpdateManager.js
+++ b/services/document-updater/app/js/ShareJsUpdateManager.js
@ -16,7 +16,7 @@ let ShareJsUpdateManager
 const ShareJsModel = require('./sharejs/server/model')
 const ShareJsDB = require('./ShareJsDB')
 const logger = require('logger-sharelatex')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const Keys = require('./UpdateKeys')
 const { EventEmitter } = require('events')
 const util = require('util')
--- a/services/document-updater/app/js/UpdateManager.js
+++ b/services/document-updater/app/js/UpdateManager.js
@ -20,7 +20,7 @@ const RedisManager = require('./RedisManager')
 const RealTimeRedisManager = require('./RealTimeRedisManager')
 const ShareJsUpdateManager = require('./ShareJsUpdateManager')
 const HistoryManager = require('./HistoryManager')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const _ = require('lodash')
 const async = require('async')
 const logger = require('logger-sharelatex')
--- a/services/document-updater/app/js/mongodb.js
+++ b/services/document-updater/app/js/mongodb.js
@ -1,4 +1,4 @@
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const { MongoClient, ObjectId } = require('mongodb')

 const clientPromise = MongoClient.connect(
--- a/services/document-updater/expire_docops.js
+++ b/services/document-updater/expire_docops.js
@ -1,4 +1,4 @@
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclient = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.documentupdater
 )
--- a/services/document-updater/package-lock.json
+++ b/services/document-updater/package-lock.json
@ -926,6 +926,11 @@
        "ioredis": "~4.27.1"
      }
    },
+    "@overleaf/settings": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/@overleaf/settings/-/settings-2.1.1.tgz",
+      "integrity": "sha512-vcJwqCGFKmQxTP/syUqCeMaSRjHmBcQgKOACR9He2uJcErg2GZPa1go+nGvszMbkElM4HfRKm/MfxvqHhoN4TQ=="
+    },
    "@protobufjs/aspromise": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/@protobufjs/aspromise/-/aspromise-1.1.2.tgz",
@ -6239,21 +6244,6 @@
      "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.1.1.tgz",
      "integrity": "sha512-JvdAWfbXeIGaZ9cILp38HntZSFSo3mWg6xGcJJsd+d4aRMOqauag1C63dJfDw7OaMYwEbHMOxEZ1lqVRYP2OAw=="
    },
-    "settings-sharelatex": {
-      "version": "1.3.0",
-      "resolved": "https://registry.npmjs.org/settings-sharelatex/-/settings-sharelatex-1.3.0.tgz",
-      "integrity": "sha512-AWSeCiY1eHi+z6DF4bmTyC3tusOc6EF5zDkC28aAOhEAbgVEIuY034kx1X7a4j9HE0iVs0sVOlZrQMWJBVk3oQ==",
-      "requires": {
-        "coffee-script": "1.6.0"
-      },
-      "dependencies": {
-        "coffee-script": {
-          "version": "1.6.0",
-          "resolved": "https://registry.npmjs.org/coffee-script/-/coffee-script-1.6.0.tgz",
-          "integrity": "sha1-gIs5bhEPU9AhoZpO8fZb4OjjX6M="
-        }
-      }
-    },
    "shebang-command": {
      "version": "1.2.0",
      "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz",
--- a/services/document-updater/package.json
+++ b/services/document-updater/package.json
@ -21,6 +21,7 @@
    "@overleaf/metrics": "^3.5.1",
    "@overleaf/o-error": "^3.3.1",
    "@overleaf/redis-wrapper": "^2.0.1",
+    "@overleaf/settings": "^2.1.1",
    "async": "^2.5.0",
    "body-parser": "^1.19.0",
    "bunyan": "^1.8.15",
@ -30,8 +31,7 @@
    "logger-sharelatex": "^2.2.0",
    "mongodb": "^3.6.6",
    "request": "^2.88.2",
-    "requestretry": "^4.1.2",
-    "settings-sharelatex": "^1.3.0"
+    "requestretry": "^4.1.2"
  },
  "devDependencies": {
    "babel-eslint": "^10.1.0",
--- a/services/document-updater/test/acceptance/js/ApplyingUpdatesToADocTests.js
+++ b/services/document-updater/test/acceptance/js/ApplyingUpdatesToADocTests.js
@ -14,7 +14,7 @@
 const sinon = require('sinon')
 const { expect } = require('chai')
 const async = require('async')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclient_history = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.history
 ) // note: this is track changes, not project-history
--- a/services/document-updater/test/acceptance/js/ApplyingUpdatesToProjectStructureTests.js
+++ b/services/document-updater/test/acceptance/js/ApplyingUpdatesToProjectStructureTests.js
@ -1,5 +1,5 @@
 const sinon = require('sinon')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const rclientProjectHistory = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.project_history
 )
--- a/services/document-updater/test/acceptance/js/SettingADocumentTests.js
+++ b/services/document-updater/test/acceptance/js/SettingADocumentTests.js
@ -1,6 +1,6 @@
 const sinon = require('sinon')
 const { expect } = require('chai')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const docUpdaterRedis = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.documentupdater
 )
--- a/services/document-updater/test/acceptance/js/SizeCheckTests.js
+++ b/services/document-updater/test/acceptance/js/SizeCheckTests.js
@ -1,5 +1,5 @@
 const { expect } = require('chai')
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')

 const MockWebApi = require('./helpers/MockWebApi')
 const DocUpdaterClient = require('./helpers/DocUpdaterClient')
--- a/services/document-updater/test/acceptance/js/helpers/DocUpdaterClient.js
+++ b/services/document-updater/test/acceptance/js/helpers/DocUpdaterClient.js
@ -1,5 +1,5 @@
 let DocUpdaterClient
-const Settings = require('settings-sharelatex')
+const Settings = require('@overleaf/settings')
 const _ = require('lodash')
 const rclient = require('@overleaf/redis-wrapper').createClient(
  Settings.redis.documentupdater
--- a/services/document-updater/test/unit/js/DispatchManager/DispatchManagerTests.js
+++ b/services/document-updater/test/unit/js/DispatchManager/DispatchManagerTests.js
@ -23,7 +23,7 @@ describe('DispatchManager', function () {
    this.DispatchManager = SandboxedModule.require(modulePath, {
      requires: {
        './UpdateManager': (this.UpdateManager = {}),
-        'settings-sharelatex': (this.settings = {
+        '@overleaf/settings': (this.settings = {
          redis: {
            documentupdater: {}
          }
--- a/services/document-updater/test/unit/js/HistoryManager/HistoryManagerTests.js
+++ b/services/document-updater/test/unit/js/HistoryManager/HistoryManagerTests.js
@ -21,7 +21,7 @@ describe('HistoryManager', function () {
    this.HistoryManager = SandboxedModule.require(modulePath, {
      requires: {
        request: (this.request = {}),
-        'settings-sharelatex': (this.Settings = {
+        '@overleaf/settings': (this.Settings = {
          apis: {
            project_history: {
              enabled: true,
--- a/services/document-updater/test/unit/js/HistoryRedisManager/HistoryRedisManagerTests.js
+++ b/services/document-updater/test/unit/js/HistoryRedisManager/HistoryRedisManagerTests.js
@ -26,7 +26,7 @@ describe('HistoryRedisManager', function () {
    this.HistoryRedisManager = SandboxedModule.require(modulePath, {
      requires: {
        '@overleaf/redis-wrapper': { createClient: () => this.rclient },
-        'settings-sharelatex': {
+        '@overleaf/settings': {
          redis: {
            history: (this.settings = {
              key_schema: {
--- a/services/document-updater/test/unit/js/LockManager/ReleasingTheLock.js
+++ b/services/document-updater/test/unit/js/LockManager/ReleasingTheLock.js
@ -30,7 +30,7 @@ describe('LockManager - releasing the lock', function () {
      '@overleaf/redis-wrapper': {
        createClient: () => this.client
      },
-      'settings-sharelatex': {
+      '@overleaf/settings': {
        redis: {
          lock: {
            key_schema: {
--- a/services/document-updater/test/unit/js/LockManager/tryLockTests.js
+++ b/services/document-updater/test/unit/js/LockManager/tryLockTests.js
@ -29,7 +29,7 @@ describe('LockManager - trying the lock', function () {
          }
        },
        './Metrics': { inc() {} },
-        'settings-sharelatex': {
+        '@overleaf/settings': {
          redis: {
            lock: {
              key_schema: {
--- a/services/document-updater/test/unit/js/PersistenceManager/PersistenceManagerTests.js
+++ b/services/document-updater/test/unit/js/PersistenceManager/PersistenceManagerTests.js
@ -23,7 +23,7 @@ describe('PersistenceManager', function () {
    this.PersistenceManager = SandboxedModule.require(modulePath, {
      requires: {
        requestretry: this.request,
-        'settings-sharelatex': (this.Settings = {}),
+        '@overleaf/settings': (this.Settings = {}),
        './Metrics': (this.Metrics = {
          Timer: (Timer = (function () {
            Timer = class Timer {
--- a/services/document-updater/test/unit/js/ProjectHistoryRedisManager/ProjectHistoryRedisManagerTests.js
+++ b/services/document-updater/test/unit/js/ProjectHistoryRedisManager/ProjectHistoryRedisManagerTests.js
@ -28,7 +28,7 @@ describe('ProjectHistoryRedisManager', function () {
      modulePath,
      {
        requires: {
-          'settings-sharelatex': (this.settings = {
+          '@overleaf/settings': (this.settings = {
            redis: {
              project_history: {
                key_schema: {
--- a/services/document-updater/test/unit/js/RateLimitManager/RateLimitManager.js
+++ b/services/document-updater/test/unit/js/RateLimitManager/RateLimitManager.js
@ -20,7 +20,7 @@ describe('RateLimitManager', function () {
    let Timer
    this.RateLimitManager = SandboxedModule.require(modulePath, {
      requires: {
-        'settings-sharelatex': (this.settings = {}),
+        '@overleaf/settings': (this.settings = {}),
        './Metrics': (this.Metrics = {
          Timer: (Timer = (function () {
            Timer = class Timer {
--- a/services/document-updater/test/unit/js/RealTimeRedisManager/RealTimeRedisManagerTests.js
+++ b/services/document-updater/test/unit/js/RealTimeRedisManager/RealTimeRedisManagerTests.js
@ -29,7 +29,7 @@ describe('RealTimeRedisManager', function () {
          createClient: (config) =>
            config.name === 'pubsub' ? this.pubsubClient : this.rclient
        },
-        'settings-sharelatex': {
+        '@overleaf/settings': {
          redis: {
            documentupdater: (this.settings = {
              key_schema: {
--- a/services/document-updater/test/unit/js/RedisManager/RedisManagerTests.js
+++ b/services/document-updater/test/unit/js/RedisManager/RedisManagerTests.js
@ -27,7 +27,7 @@ describe('RedisManager', function () {
    this.RedisManager = SandboxedModule.require(modulePath, {
      requires: {
        './ProjectHistoryRedisManager': (this.ProjectHistoryRedisManager = {}),
-        'settings-sharelatex': (this.settings = {
+        '@overleaf/settings': (this.settings = {
          documentupdater: { logHashErrors: { write: true, read: true } },
          apis: {
            project_history: { enabled: true }
--- a/services/document-updater/test/unit/js/UpdateManager/UpdateManagerTests.js
+++ b/services/document-updater/test/unit/js/UpdateManager/UpdateManagerTests.js
@ -40,7 +40,7 @@ describe('UpdateManager', function () {
            return Timer
          })())
        }),
-        'settings-sharelatex': (this.Settings = {}),
+        '@overleaf/settings': (this.Settings = {}),
        './DocumentManager': (this.DocumentManager = {}),
        './RangesManager': (this.RangesManager = {}),
        './SnapshotManager': (this.SnapshotManager = {}),