feat: add ignoreNotFound to service-object#delete (#634)

AVaksman · Benjamin E. Coe · sofisl · web-flow · commit 3248e27c3776 · 2020-11-11T13:13:55.000-08:00
* feat: add ignoreNotFound to service-object#delete

* chore: lint

Co-authored-by: Benjamin E. Coe &lt;bencoe@google.com&gt;
Co-authored-by: sofisl &lt;55454395+sofisl@users.noreply.github.com&gt;
diff --git a/src/service-object.ts b/src/service-object.ts
@@ -115,7 +115,7 @@ export interface CreateCallback<T> {
   (err: ApiError | null, instance?: T | null, ...args: any[]): void;
 }
 
-export type DeleteOptions = object;
+export type DeleteOptions = {ignoreNotFound?: boolean} & object;
 export interface DeleteCallback {
   (err: Error | null, apiResponse?: r.Response): void;
 }
@@ -270,14 +270,17 @@ class ServiceObject<T = any> extends EventEmitter {
   delete(options: DeleteOptions, callback: DeleteCallback): void;
   delete(callback: DeleteCallback): void;
   delete(
-    optionsOrCallback: DeleteOptions | DeleteCallback,
+    optionsOrCallback?: DeleteOptions | DeleteCallback,
     cb?: DeleteCallback
   ): Promise<[r.Response]> | void {
     const [options, callback] = util.maybeOptionsOrCallback<
       DeleteOptions,
       DeleteCallback
     >(optionsOrCallback, cb);
 
+    const ignoreNotFound = options.ignoreNotFound!;
+    delete options.ignoreNotFound;
+
     const methodConfig =
       (typeof this.methods.delete === 'object' && this.methods.delete) || {};
 
@@ -295,7 +298,18 @@ class ServiceObject<T = any> extends EventEmitter {
 
     // The `request` method may have been overridden to hold any special
     // behavior. Ensure we call the original `request` method.
-    ServiceObject.prototype.request.call(this, reqOpts, callback);
+    ServiceObject.prototype.request.call(
+      this,
+      reqOpts,
+      (err: ApiError | null, ...args) => {
+        if (err) {
+          if (err.code === 404 && ignoreNotFound) {
+            err = null;
+          }
+        }
+        callback(err, ...(args as any));
+      }
+    );
   }
 
   /**
diff --git a/test/service-object.ts b/test/service-object.ts
@@ -318,6 +318,40 @@ describe('ServiceObject', () => {
       serviceObject.delete();
     });
 
+    it('should respect ignoreNotFound opion', done => {
+      const options = {ignoreNotFound: true};
+      const error = new ApiError({code: 404, response: {} as r.Response});
+      sandbox.stub(ServiceObject.prototype, 'request').callsArgWith(1, error);
+      serviceObject.delete(options, (err, apiResponse_) => {
+        assert.ifError(err);
+        assert.strictEqual(apiResponse_, undefined);
+        done();
+      });
+    });
+
+    it('should propagate other then 404 error', done => {
+      const options = {ignoreNotFound: true};
+      const error = new ApiError({code: 406, response: {} as r.Response});
+      sandbox.stub(ServiceObject.prototype, 'request').callsArgWith(1, error);
+      serviceObject.delete(options, (err, apiResponse_) => {
+        assert.strictEqual(err, error);
+        assert.strictEqual(apiResponse_, undefined);
+        done();
+      });
+    });
+
+    it('should not pass ignoreNotFound to request', done => {
+      const options = {ignoreNotFound: true};
+      sandbox
+        .stub(ServiceObject.prototype, 'request')
+        .callsFake((reqOpts, callback) => {
+          assert.strictEqual(reqOpts.qs.ignoreNotFound, undefined);
+          done();
+          callback(null, null, {} as r.Response);
+        });
+      serviceObject.delete(options, assert.ifError);
+    });
+
     it('should extend the defaults with request options', done => {
       const methodConfig = {
         reqOpts: {
