use enum for bucket notification type

nitrictech · May 15, 2023 · ff9c003 · ff9c003
1 parent b08c027
commit ff9c003
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 25 deletions.
diff --git a/package.json b/package.json
@@ -6,7 +6,6 @@
   "repository": "https://github.com/nitrictech/node-sdk",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "version": "0.0.1",
   "scripts": {
     "bump": "standard-version",
     "build": "tsup src/index.ts --dts --outDir lib",

diff --git a/src/api/storage/v0/storage.test.ts b/src/api/storage/v0/storage.test.ts
@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-import { FileMode, Storage } from './storage';
+import { Bucket, FileMode, Storage } from './storage';
 import { StorageServiceClient as GrpcStorageClient } from '@nitric/api/proto/storage/v1/storage_grpc_pb';
 import {
   StorageWriteResponse,
@@ -24,6 +24,7 @@ import {
 } from '@nitric/api/proto/storage/v1/storage_pb';
 import { UnimplementedError } from '../../errors';
 import {
+  BucketNotificationType,
   BucketNotificationWorkerOptions,
   FileNotificationWorkerOptions,
   bucket,
@@ -449,7 +450,11 @@ describe('bucket notification', () => {
     });
 
     beforeAll(async () => {
-      await bucket('test-bucket').on('write', 'test.png', mockFn);
+      await bucket('test-bucket').on(
+        BucketNotificationType.Write,
+        'test.png',
+        mockFn
+      );
     });
 
     it('should create a new FaasClient', () => {
@@ -459,7 +464,7 @@ describe('bucket notification', () => {
     it('should provide Faas with BucketNotificationWorkerOptions', () => {
       const expectedOpts = new BucketNotificationWorkerOptions(
         'test-bucket',
-        'write',
+        BucketNotificationType.Write,
         'test.png'
       );
       expect(faas.Faas).toBeCalledWith(expectedOpts);
@@ -476,7 +481,11 @@ describe('bucket notification', () => {
     });
 
     beforeAll(async () => {
-      await bucket('test-bucket').on('delete', 'test.png', mockFn);
+      await bucket('test-bucket').on(
+        BucketNotificationType.Delete,
+        'test.png',
+        mockFn
+      );
     });
 
     it('should create a new FaasClient', () => {
@@ -486,7 +495,7 @@ describe('bucket notification', () => {
     it('should provide Faas with BucketNotificationWorkerOptions', () => {
       const expectedOpts = new BucketNotificationWorkerOptions(
         'test-bucket',
-        'delete',
+        BucketNotificationType.Delete,
         'test.png'
       );
       expect(faas.Faas).toBeCalledWith(expectedOpts);
@@ -514,10 +523,10 @@ describe('file notification', () => {
   const mockFn = jest.fn();
 
   describe('When registering a file notification for creating', () => {
-    let bucketResource;
+    let bucketResource: Bucket;
     beforeAll(async () => {
       bucketResource = bucket('test-bucket-create').for('reading');
-      await bucketResource.on('write', 'test.png', mockFn);
+      await bucketResource.on(BucketNotificationType.Write, 'test.png', mockFn);
     });
 
     afterAll(() => {
@@ -535,7 +544,7 @@ describe('file notification', () => {
     it('should provide Faas with FileNotificationWorkerOptions', () => {
       const expectedOpts = new FileNotificationWorkerOptions(
         bucketResource,
-        'write',
+        BucketNotificationType.Write,
         'test.png'
       );
       expect(faas.Faas).toBeCalledWith(expectedOpts);
@@ -547,10 +556,14 @@ describe('file notification', () => {
   });
 
   describe('When registering a file notification for deleting', () => {
-    let bucketResource;
+    let bucketResource: Bucket;
     beforeAll(async () => {
       bucketResource = bucket('test-bucket-delete').for('reading');
-      await bucketResource.on('delete', 'test.png', mockFn);
+      await bucketResource.on(
+        BucketNotificationType.Delete,
+        'test.png',
+        mockFn
+      );
     });
 
     afterAll(() => {
@@ -568,7 +581,7 @@ describe('file notification', () => {
     it('should provide Faas with FileNotificationWorkerOptions', () => {
       const expectedOpts = new FileNotificationWorkerOptions(
         bucketResource,
-        'delete',
+        BucketNotificationType.Delete,
         'test.png'
       );
       expect(faas.Faas).toBeCalledWith(expectedOpts);

diff --git a/src/api/storage/v0/storage.ts b/src/api/storage/v0/storage.ts
@@ -26,7 +26,11 @@ import {
   BucketNotificationMiddleware,
   FileNotificationMiddleware,
 } from '@nitric/sdk/faas';
-import { BucketNotification, FileNotification } from '@nitric/sdk/resources';
+import {
+  BucketNotification,
+  BucketNotificationType,
+  FileNotification,
+} from '@nitric/sdk/resources';
 
 /**
  * Nitric storage client, facilitates writing and reading from blob storage (buckets).
@@ -112,7 +116,7 @@ export class Bucket {
    * @returns Promise which resolves when the handler server terminates
    */
   on(
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter: string,
     ...middleware: FileNotificationMiddleware[]
   ): Promise<void> {

diff --git a/src/resources/bucket.ts b/src/resources/bucket.ts
@@ -28,20 +28,25 @@ import {
   BucketNotificationMiddleware,
   FileNotificationMiddleware,
 } from '../faas';
-import { BucketNotificationType } from '../gen/proto/faas/v1/faas_pb';
+import { BucketNotificationType as ProtoBucketNotificationType } from '../gen/proto/faas/v1/faas_pb';
 
 type BucketPermission = 'reading' | 'writing' | 'deleting';
 
 const everything: BucketPermission[] = ['reading', 'writing', 'deleting'];
 
+export enum BucketNotificationType {
+  Write,
+  Delete,
+}
+
 export class BucketNotificationWorkerOptions {
   public readonly bucket: string;
   public readonly notificationType: 0 | 1 | 2;
   public readonly notificationPrefixFilter: string;
 
   constructor(
     bucket: string,
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter: string
   ) {
     this.bucket = bucket;
@@ -50,12 +55,12 @@ export class BucketNotificationWorkerOptions {
     this.notificationPrefixFilter = notificationPrefixFilter;
   }
 
-  static toGrpcEvent(notificationType: string): 0 | 1 | 2 {
+  static toGrpcEvent(notificationType: BucketNotificationType): 0 | 1 | 2 {
     switch (notificationType) {
-      case 'write':
-        return BucketNotificationType.CREATED;
-      case 'delete':
-        return BucketNotificationType.DELETED;
+      case BucketNotificationType.Write:
+        return ProtoBucketNotificationType.CREATED;
+      case BucketNotificationType.Delete:
+        return ProtoBucketNotificationType.DELETED;
       default:
         throw new Error(`notification type ${notificationType} is unsupported`);
     }
@@ -67,7 +72,7 @@ export class FileNotificationWorkerOptions extends BucketNotificationWorkerOptio
 
   constructor(
     bucketRef: Bucket,
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter: string
   ) {
     super(bucketRef.name, notificationType, notificationPrefixFilter);
@@ -81,7 +86,7 @@ export class BucketNotification {
 
   constructor(
     bucket: string,
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter,
     ...middleware: BucketNotificationMiddleware[]
   ) {
@@ -105,7 +110,7 @@ export class FileNotification {
 
   constructor(
     bucket: Bucket,
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter,
     ...middleware: FileNotificationMiddleware[]
   ) {
@@ -161,7 +166,7 @@ export class BucketResource extends SecureResource<BucketPermission> {
    * @returns Promise which resolves when the handler server terminates
    */
   on(
-    notificationType: string,
+    notificationType: BucketNotificationType,
     notificationPrefixFilter: string,
     ...middleware: BucketNotificationMiddleware[]
   ): Promise<void> {