@xrengine/server-core/tests/storageprovider/storageprovider.test.ts

Shared components for XREngine server

import approot from 'app-root-path'
import assert from 'assert'
import fs from 'fs-extra'
import fetch from 'node-fetch'
import path from 'path/posix'
import { v4 as uuid } from 'uuid'

import LocalStorage from '../../src/media/storageprovider/local.storage'
import S3Provider from '../../src/media/storageprovider/s3.storage'
import { StorageProviderInterface } from '../../src/media/storageprovider/storageprovider.interface'
import { getContentType } from '../../src/util/fileUtils'
import { providerAfterTest, providerBeforeTest } from './storageproviderconfig'

const https = require('https')

describe('storageprovider', () => {
  const testFileName = 'TestFile.txt'
  const testFolderName = `TestFolder-${uuid()}`
  const testFileContent = 'content'
  const folderKeyTemp = path.join(testFolderName, 'temp')
  const folderKeyTemp2 = path.join(testFolderName, 'temp2')

  const storageProviders: StorageProviderInterface[] = []
  storageProviders.push(new LocalStorage())
  if (
    process.env.STORAGE_S3_TEST_RESOURCE_BUCKET &&
    process.env.STORAGE_AWS_ACCESS_KEY_ID &&
    process.env.STORAGE_AWS_ACCESS_KEY_SECRET
  ) {
    const s3Provider = new S3Provider()
    storageProviders.push(s3Provider as any)
  }

  storageProviders.forEach((provider) => {
    before(async function () {
      await providerBeforeTest(provider, testFolderName, folderKeyTemp, folderKeyTemp2)
    })

    it(`should put object in ${provider.constructor.name}`, async function () {
      const fileKey = path.join(testFolderName, testFileName)
      const data = Buffer.from(testFileContent)
      await provider.putObject({
        Body: data,
        Key: fileKey,
        ContentType: getContentType(fileKey)
      })
    })

    it(`should have object in ${provider.constructor.name}`, async function () {
      assert(await provider.doesExist(testFileName, testFolderName))
    })

    it(`should get object in ${provider.constructor.name}`, async function () {
      const fileKey = path.join(testFolderName, testFileName)
      const file = await provider.getObject(fileKey)
      assert.ok(file.Body.toString() === testFileContent)
    })

    it(`should list object in ${provider.constructor.name}`, async function () {
      const res = await provider.listFolderContent(testFolderName, true)

      let haveObject = false
      for (let i = 0; i < res.length; i++) {
        if (res[i].name === 'TestFile' && res[i].type === 'txt') {
          haveObject = true
          break
        }
      }
      assert.ok(haveObject)
    })

    it(`should return valid object url in ${provider.constructor.name}`, async function () {
      const fileKey = path.join('/', testFolderName, testFileName)
      const signedUrl = await provider.getSignedUrl(fileKey, 20000, [])
      const httpAgent = new https.Agent({
        rejectUnauthorized: false
      })
      let res
      try {
        res = await fetch(signedUrl.url + signedUrl.fields.Key, { agent: httpAgent })
      } catch (err) {
        console.log(err)
      }
      if (!res) console.log('Make sure server is running')
      assert.ok(res?.ok)
    })

    // Unable to perform move/copy and rename test cases because Fleek storage doesn't implemented those methods

    it(`should be able to move/copy object in ${provider.constructor.name}`, async function () {
      const newFolder1 = path.join(testFolderName, 'temp')
      const newFolder2 = path.join(testFolderName, 'temp2')

      //check copy functionality
      await provider.moveObject(testFileName, testFileName, testFolderName, newFolder1, true)
      assert(await provider.doesExist(testFileName, testFolderName))
      assert(await provider.doesExist(testFileName, newFolder1))

      //check move functionality
      await provider.moveObject(testFileName, testFileName, newFolder1, newFolder2, false)
      assert(await provider.doesExist(testFileName, newFolder2))
      assert(!(await provider.doesExist(testFileName, newFolder1)))
    })

    it(`should be able to rename object in ${provider.constructor.name}`, async function () {
      const temp2Folder = path.join(testFolderName, 'temp2')
      await provider.moveObject(testFileName, 'Renamed.txt', testFolderName, temp2Folder, false)
      const res = await provider.listFolderContent(temp2Folder, true)

      assert.equal(res[0]?.name, 'Renamed')
    })

    it(`should delete object in ${provider.constructor.name}`, async function () {
      const fileKey = path.join(testFolderName, testFileName)
      assert.ok(await provider.deleteResources([fileKey]))
    })

    it(`should put and get same data for glbs in ${provider.constructor.name}`, async function () {
      const glbTestPath = 'packages/client/public/default_assets/collisioncube.glb'
      const filePath = path.join(approot.path, glbTestPath)
      const fileData = fs.readFileSync(filePath)
      const contentType = getContentType(filePath)
      const key = path.join(testFolderName, glbTestPath)
      await provider.putObject({
        Body: fileData,
        Key: key,
        ContentType: contentType
      })
      const ret = await provider.getObject(key)
      assert.strictEqual(contentType, ret.ContentType)
      assert.deepStrictEqual(fileData, ret.Body)
    })

    it(`should put over 1000 objects in ${provider.constructor.name}`, async function () {
      const promises: any[] = []
      for (let i = 0; i < 1010; i++) {
        const fileKey = path.join(testFolderName, `${i}-${testFileName}`)
        const data = Buffer.from([])
        promises.push(
          provider.putObject({
            Body: data,
            Key: fileKey,
            ContentType: getContentType(fileKey)
          })
        )
      }
      await Promise.all(promises)
    })

    it(`should list over 1000 objects in ${provider.constructor.name}`, async function () {
      const res = await provider.listFolderContent(testFolderName, true)
      assert(res.length > 1000)
    })

    after(async function () {
      await providerAfterTest(provider, testFolderName)
    })
  })
})