@tus/gcs-store: allow user to pass bucket instance to GCSStore

packages/gcs-store/README.md

@@ -29,12 +29,14 @@ npm install @tus/gcs-store
 const {Server} = require('@tus/server')
 const {GCSStore} = require('@tus/gcs-store')
 
+const {Storage} = require('@google-cloud/storage');
+
+const storage = new Storage({keyFilename: 'key.json'})
+
 const server = new Server({
   path: '/files',
   datastore: new GCSStore({
-    projectId: 'id',
-    keyFilename: path.resolve('./some-path', 'keyfile.json'),
-    bucket: 'tus-node-server-ci',
+    bucket: storage.bucket('tus-node-server-ci'),
   }),
 })
 // ...
@@ -46,19 +48,11 @@ This package exports `GCSStore`. There is no default export.
 
 ### `new GCSStore(options)`
 
-Creates a new Google Cloud Storage store with options.
-
-#### `options.projectId`
-
-The GCS project ID (`string`).
-
-#### `options.keyFilename`
-
-Path to the keyfile with credentials (`string`).
+Creates a new Google Cloud Storage store by passing a GCS bucket instance.
 
 #### `options.bucket`
 
-The bucket name.
+The bucket instance
 
 ## Extensions
 

packages/gcs-store/index.ts

@@ -1,23 +1,17 @@
-import {Storage, Bucket} from '@google-cloud/storage'
+import {Bucket} from '@google-cloud/storage'
 import stream from 'node:stream'
 import http from 'node:http'
 import debug from 'debug'
 
 import {ERRORS, TUS_RESUMABLE} from '@tus/server'
 import {Upload, DataStore} from '@tus/server'
 
-type Options = {
-  bucket: string
-  projectId: string
-  keyFilename: string
-}
-
 const log = debug('tus-node-server:stores:gcsstore')
 
+type Options = {bucket: Bucket}
+
 export class GCSStore extends DataStore {
   bucket: Bucket
-  bucket_name: string
-  gcs: Storage
 
   constructor(options: Options) {
     super()
@@ -26,13 +20,9 @@ export class GCSStore extends DataStore {
       throw new Error('GCSDataStore must have a bucket')
     }
 
+    this.bucket = options.bucket
+
     this.extensions = ['creation', 'creation-with-upload', 'creation-defer-length']
-    this.bucket_name = options.bucket
-    this.gcs = new Storage({
-      projectId: options.projectId,
-      keyFilename: options.keyFilename,
-    })
-    this.bucket = this.gcs.bucket(this.bucket_name)
   }
 
   create(file: Upload): Promise<Upload> {

packages/gcs-store/package.json

@@ -21,10 +21,10 @@
     "test": "mocha test.ts --timeout 30000 --exit --extension ts --require ts-node/register"
   },
   "dependencies": {
-    "@google-cloud/storage": "^6.9.3",
     "debug": "^4.3.3"
   },
   "devDependencies": {
+    "@google-cloud/storage": "^6.9.3",
     "@tus/server": "workspace:^",
     "@types/debug": "^4.1.7",
     "@types/mocha": "^10.0.1",
@@ -35,7 +35,8 @@
     "should": "^13.2.3",
     "typescript": "latest"
   },
-  "peerdependencies": {
+  "peerDependencies": {
+    "@google-cloud/storage": "*",
     "@tus/server": "workspace:^"
   },
   "engines": {

packages/gcs-store/test.ts

@@ -4,6 +4,8 @@ import {GCSStore} from './'
 
 import * as shared from '../../test/stores.test'
 
+import {Storage} from '@google-cloud/storage'
+
 const fixturesPath = path.resolve('../', '../', 'test', 'fixtures')
 const storePath = path.resolve('../', '../', 'test', 'output')
 
@@ -16,10 +18,13 @@ describe('GCSStore', () => {
   })
 
   beforeEach(function () {
-    this.datastore = new GCSStore({
+    const storage = new Storage({
       projectId: 'tus-node-server',
       keyFilename: path.resolve('../', '../', 'keyfile.json'),
-      bucket: 'tus-node-server-ci',
+    })
+
+    this.datastore = new GCSStore({
+      bucket: storage.bucket('tus-node-server-ci'),
     })
   })
 

test/e2e.test.ts

@@ -443,12 +443,15 @@ describe('EndToEnd', () => {
     const files_created: string[] = []
 
     before(() => {
+      const storage = new Storage({
+        projectId: PROJECT_ID,
+        keyFilename: KEYFILE,
+      })
+
       server = new Server({
         path: STORE_PATH,
         datastore: new GCSStore({
-          projectId: PROJECT_ID,
-          keyFilename: KEYFILE,
-          bucket: BUCKET,
+          bucket: storage.bucket(BUCKET),
         }),
       })
       listener = server.listen()

yarn.lock

@@ -308,6 +308,9 @@ __metadata:
     mocha: ^10.1.0
     should: ^13.2.3
     typescript: latest
+  peerDependencies:
+    "@google-cloud/storage": "*"
+    "@tus/server": "workspace:^"
   languageName: unknown
   linkType: soft