mirror of
https://github.com/overleaf/overleaf.git
synced 2024-09-23 02:55:13 -04:00
255 lines
8.2 KiB
CoffeeScript
255 lines
8.2 KiB
CoffeeScript
SandboxedModule = require('sandboxed-module')
|
|
sinon = require('sinon')
|
|
should = require('chai').should()
|
|
modulePath = require('path').join __dirname, '../../../app/js/ResourceWriter'
|
|
path = require "path"
|
|
|
|
describe "ResourceWriter", ->
|
|
beforeEach ->
|
|
@ResourceWriter = SandboxedModule.require modulePath, requires:
|
|
"fs": @fs =
|
|
mkdir: sinon.stub().callsArg(1)
|
|
unlink: sinon.stub().callsArg(1)
|
|
"./ResourceStateManager": @ResourceStateManager = {}
|
|
"wrench": @wrench = {}
|
|
"./UrlCache" : @UrlCache = {}
|
|
"mkdirp" : @mkdirp = sinon.stub().callsArg(1)
|
|
"./OutputFileFinder": @OutputFileFinder = {}
|
|
"logger-sharelatex": {log: sinon.stub(), err: sinon.stub()}
|
|
"./Metrics": @Metrics =
|
|
Timer: class Timer
|
|
done: sinon.stub()
|
|
@project_id = "project-id-123"
|
|
@basePath = "/path/to/write/files/to"
|
|
@callback = sinon.stub()
|
|
|
|
describe "syncResourcesToDisk on a full request", ->
|
|
beforeEach ->
|
|
@resources = [
|
|
"resource-1-mock"
|
|
"resource-2-mock"
|
|
"resource-3-mock"
|
|
]
|
|
@ResourceWriter._writeResourceToDisk = sinon.stub().callsArg(3)
|
|
@ResourceWriter._removeExtraneousFiles = sinon.stub().callsArg(2)
|
|
@ResourceStateManager.checkProjectStateHashMatches = sinon.stub().callsArg(2)
|
|
@ResourceStateManager.saveProjectStateHash = sinon.stub().callsArg(3)
|
|
@ResourceWriter.syncResourcesToDisk({
|
|
project_id: @project_id
|
|
syncState: @syncState = "0123456789abcdef"
|
|
resources: @resources
|
|
}, @basePath, @callback)
|
|
|
|
it "should remove old files", ->
|
|
@ResourceWriter._removeExtraneousFiles
|
|
.calledWith(@resources, @basePath)
|
|
.should.equal true
|
|
|
|
it "should write each resource to disk", ->
|
|
for resource in @resources
|
|
@ResourceWriter._writeResourceToDisk
|
|
.calledWith(@project_id, resource, @basePath)
|
|
.should.equal true
|
|
|
|
it "should store the sync state and resource list", ->
|
|
@ResourceStateManager.saveProjectStateHash
|
|
.calledWith(@syncState, @resources, @basePath)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "syncResourcesToDisk on an incremental update", ->
|
|
beforeEach ->
|
|
@resources = [
|
|
"resource-1-mock"
|
|
]
|
|
@ResourceWriter._writeResourceToDisk = sinon.stub().callsArg(3)
|
|
@ResourceWriter._removeExtraneousFiles = sinon.stub().callsArg(2)
|
|
@ResourceStateManager.checkProjectStateHashMatches = sinon.stub().callsArgWith(2, null, @resources)
|
|
@ResourceStateManager.saveProjectStateHash = sinon.stub().callsArg(3)
|
|
@ResourceWriter.syncResourcesToDisk({
|
|
project_id: @project_id,
|
|
syncType: "incremental",
|
|
syncState: @syncState = "1234567890abcdef",
|
|
resources: @resources
|
|
}, @basePath, @callback)
|
|
|
|
it "should check the sync state matches", ->
|
|
@ResourceStateManager.checkProjectStateHashMatches
|
|
.calledWith(@syncState, @basePath)
|
|
.should.equal true
|
|
|
|
it "should remove old files", ->
|
|
@ResourceWriter._removeExtraneousFiles
|
|
.calledWith(@resources, @basePath)
|
|
.should.equal true
|
|
|
|
it "should write each resource to disk", ->
|
|
for resource in @resources
|
|
@ResourceWriter._writeResourceToDisk
|
|
.calledWith(@project_id, resource, @basePath)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "syncResourcesToDisk on an incremental update when the state does not match", ->
|
|
beforeEach ->
|
|
@resources = [
|
|
"resource-1-mock"
|
|
]
|
|
@ResourceStateManager.checkProjectStateHashMatches = sinon.stub().callsArgWith(2, @error = new Error())
|
|
@ResourceWriter.syncResourcesToDisk({
|
|
project_id: @project_id,
|
|
syncType: "incremental",
|
|
syncState: @syncState = "1234567890abcdef",
|
|
resources: @resources
|
|
}, @basePath, @callback)
|
|
|
|
it "should check whether the sync state matches", ->
|
|
@ResourceStateManager.checkProjectStateHashMatches
|
|
.calledWith(@syncState, @basePath)
|
|
.should.equal true
|
|
|
|
it "should call the callback with an error", ->
|
|
@callback.calledWith(@error).should.equal true
|
|
|
|
|
|
describe "_removeExtraneousFiles", ->
|
|
beforeEach ->
|
|
@output_files = [{
|
|
path: "output.pdf"
|
|
type: "pdf"
|
|
}, {
|
|
path: "extra/file.tex"
|
|
type: "tex"
|
|
}, {
|
|
path: "extra.aux"
|
|
type: "aux"
|
|
}, {
|
|
path: "cache/_chunk1"
|
|
}]
|
|
@resources = "mock-resources"
|
|
@OutputFileFinder.findOutputFiles = sinon.stub().callsArgWith(2, null, @output_files)
|
|
@ResourceWriter._deleteFileIfNotDirectory = sinon.stub().callsArg(1)
|
|
@ResourceWriter._removeExtraneousFiles(@resources, @basePath, @callback)
|
|
|
|
it "should find the existing output files", ->
|
|
@OutputFileFinder.findOutputFiles
|
|
.calledWith(@resources, @basePath)
|
|
.should.equal true
|
|
|
|
it "should delete the output files", ->
|
|
@ResourceWriter._deleteFileIfNotDirectory
|
|
.calledWith(path.join(@basePath, "output.pdf"))
|
|
.should.equal true
|
|
|
|
it "should delete the extra files", ->
|
|
@ResourceWriter._deleteFileIfNotDirectory
|
|
.calledWith(path.join(@basePath, "extra/file.tex"))
|
|
.should.equal true
|
|
|
|
it "should not delete the extra aux files", ->
|
|
@ResourceWriter._deleteFileIfNotDirectory
|
|
.calledWith(path.join(@basePath, "extra.aux"))
|
|
.should.equal false
|
|
|
|
it "should not delete the knitr cache file", ->
|
|
@ResourceWriter._deleteFileIfNotDirectory
|
|
.calledWith(path.join(@basePath, "cache/_chunk1"))
|
|
.should.equal false
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
it "should time the request", ->
|
|
@Metrics.Timer::done.called.should.equal true
|
|
|
|
describe "_writeResourceToDisk", ->
|
|
describe "with a url based resource", ->
|
|
beforeEach ->
|
|
@resource =
|
|
path: "main.tex"
|
|
url: "http://www.example.com/main.tex"
|
|
modified: Date.now()
|
|
@UrlCache.downloadUrlToFile = sinon.stub().callsArgWith(4, "fake error downloading file")
|
|
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
|
|
|
|
it "should ensure the directory exists", ->
|
|
@mkdirp
|
|
.calledWith(path.dirname(path.join(@basePath, @resource.path)))
|
|
.should.equal true
|
|
|
|
it "should write the URL from the cache", ->
|
|
@UrlCache.downloadUrlToFile
|
|
.calledWith(@project_id, @resource.url, path.join(@basePath, @resource.path), @resource.modified)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
it "should not return an error if the resource writer errored", ->
|
|
should.not.exist @callback.args[0][0]
|
|
|
|
describe "with a content based resource", ->
|
|
beforeEach ->
|
|
@resource =
|
|
path: "main.tex"
|
|
content: "Hello world"
|
|
@fs.writeFile = sinon.stub().callsArg(2)
|
|
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
|
|
|
|
it "should ensure the directory exists", ->
|
|
@mkdirp
|
|
.calledWith(path.dirname(path.join(@basePath, @resource.path)))
|
|
.should.equal true
|
|
|
|
it "should write the contents to disk", ->
|
|
@fs.writeFile
|
|
.calledWith(path.join(@basePath, @resource.path), @resource.content)
|
|
.should.equal true
|
|
|
|
it "should call the callback", ->
|
|
@callback.called.should.equal true
|
|
|
|
describe "with a file path that breaks out of the root folder", ->
|
|
beforeEach ->
|
|
@resource =
|
|
path: "../../main.tex"
|
|
content: "Hello world"
|
|
@fs.writeFile = sinon.stub().callsArg(2)
|
|
@ResourceWriter._writeResourceToDisk(@project_id, @resource, @basePath, @callback)
|
|
|
|
it "should not write to disk", ->
|
|
@fs.writeFile.called.should.equal false
|
|
|
|
it "should return an error", ->
|
|
@callback
|
|
.calledWith(new Error("resource path is outside root directory"))
|
|
.should.equal true
|
|
|
|
describe "checkPath", ->
|
|
describe "with a valid path", ->
|
|
beforeEach ->
|
|
@ResourceWriter.checkPath("foo", "bar", @callback)
|
|
|
|
it "should return the joined path", ->
|
|
@callback.calledWith(null, "foo/bar")
|
|
.should.equal true
|
|
|
|
describe "with an invalid path", ->
|
|
beforeEach ->
|
|
@ResourceWriter.checkPath("foo", "baz/../../bar", @callback)
|
|
|
|
it "should return an error", ->
|
|
@callback.calledWith(new Error("resource path is outside root directory"))
|
|
.should.equal true
|
|
|
|
describe "with another invalid path matching on a prefix", ->
|
|
beforeEach ->
|
|
@ResourceWriter.checkPath("foo", "../foobar/baz", @callback)
|
|
|
|
it "should return an error", ->
|
|
@callback.calledWith(new Error("resource path is outside root directory"))
|
|
.should.equal true
|