From 2ec38068aa6542bf66b37a8a771e7af9383c9fb7 Mon Sep 17 00:00:00 2001 From: Brian Gough Date: Fri, 6 Dec 2019 14:35:13 +0000 Subject: [PATCH] add comments about aws-sdk and s3 backends --- services/filestore/app/coffee/AWSSDKPersistorManager.coffee | 5 +++++ services/filestore/app/coffee/S3PersistorManager.coffee | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/services/filestore/app/coffee/AWSSDKPersistorManager.coffee b/services/filestore/app/coffee/AWSSDKPersistorManager.coffee index 5be80506f5..168fc68d54 100644 --- a/services/filestore/app/coffee/AWSSDKPersistorManager.coffee +++ b/services/filestore/app/coffee/AWSSDKPersistorManager.coffee @@ -1,3 +1,8 @@ +# This module is not used in production, which currently uses +# S3PersistorManager. The intention is to migrate S3PersistorManager to use the +# latest aws-sdk and delete this module so that PersistorManager would load the +# same backend for both the 's3' and 'aws-sdk' options. + logger = require "logger-sharelatex" aws = require "aws-sdk" _ = require "underscore" diff --git a/services/filestore/app/coffee/S3PersistorManager.coffee b/services/filestore/app/coffee/S3PersistorManager.coffee index 8f1b080efd..ca74bdb013 100644 --- a/services/filestore/app/coffee/S3PersistorManager.coffee +++ b/services/filestore/app/coffee/S3PersistorManager.coffee @@ -1,3 +1,7 @@ +# This module is the one which is used in production. It needs to be migrated +# to use aws-sdk throughout, see the comments in AWSSDKPersistorManager for +# details. The knox library is unmaintained and has bugs. + http = require('http') http.globalAgent.maxSockets = 300 https = require('https')