@forge/events 0.6.1-next.0 → 0.7.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @forge/events
 
+## 0.7.0-next.0
+
+### Minor Changes
+
+- e3af95e: Fix broken test for InvocationError
+- d49508c: Fix broken test for InvocationError
+- 6529a96: Add retryData into retryOptions
+- 5062ab4: Fix broken test for InvocationError
+
+## 0.6.1
+
+### Patch Changes
+
+- 0e0a7b4: Returning object from InvocationError to make it transferrable.
+- Updated dependencies [b3ee297]
+  - @forge/api@2.7.0
+
+## 0.6.1-next.1
+
+### Patch Changes
+
+- Updated dependencies [b3ee2973]
+  - @forge/api@2.7.0-next.0
+
 ## 0.6.1-next.0
 
 ### Patch Changes

package/out/__test__/invocationError.test.js

@@ -1,21 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const retryOptions_1 = require("../retryOptions");
 const invocationError_1 = require("../invocationError");
 const invocationErrorCode_1 = require("../invocationErrorCode");
+const retryOptions_1 = require("../retryOptions");
 describe('InvocationError tests', () => {
-    const defaultRetryOption = new retryOptions_1.RetryOptions();
     let target = new invocationError_1.InvocationError();
     it('Populate invocationError with default retryOptions and expect default retry option', async () => {
-        expect(target.retryOptions.retryAfter).toEqual(defaultRetryOption.retryAfter);
+        expect(target.retryOptions.retryAfter).toEqual(retryOptions_1.DEFAULT_RETRY_OPTIONS.retryAfter);
         expect(target.retryOptions.retryReason).toEqual(invocationErrorCode_1.InvocationErrorCode.FUNCTION_RETRY_REQUEST);
         expect(target.hasOwnProperty('_retry')).toBe(true);
     });
     it('Populate InvocationError with custom RetryOptions and expect the custom value to set.', () => {
-        defaultRetryOption.retryAfter = 10;
-        defaultRetryOption.retryReason = invocationErrorCode_1.InvocationErrorCode.FUNCTION_OUT_OF_MEMORY;
-        target = new invocationError_1.InvocationError(defaultRetryOption);
-        expect(target.retryOptions).toEqual(defaultRetryOption);
+        const retryOptions = {
+            retryAfter: 10,
+            retryReason: invocationErrorCode_1.InvocationErrorCode.FUNCTION_OUT_OF_MEMORY,
+            retryData: {
+                eventsToSplit: 5
+            }
+        };
+        target = new invocationError_1.InvocationError(retryOptions);
+        expect(target.retryOptions).toEqual(retryOptions);
+        expect(target.hasOwnProperty('_retry')).toBe(true);
+    });
+    it('Use MIN_RETRY_AFTER when retryAfter <= 0', () => {
+        const retryOptions = {
+            retryAfter: 0,
+            retryReason: invocationErrorCode_1.InvocationErrorCode.FUNCTION_OUT_OF_MEMORY,
+            retryData: 'some string data'
+        };
+        target = new invocationError_1.InvocationError(retryOptions);
+        expect(target.retryOptions.retryAfter).toEqual(retryOptions_1.MIN_RETRY_AFTER);
+        expect(target.retryOptions.retryData).toEqual('some string data');
         expect(target.hasOwnProperty('_retry')).toBe(true);
     });
 });

package/out/index.js

@@ -21,5 +21,3 @@ var invocationError_1 = require("./invocationError");
 Object.defineProperty(exports, "InvocationError", { enumerable: true, get: function () { return invocationError_1.InvocationError; } });
 var invocationErrorCode_1 = require("./invocationErrorCode");
 Object.defineProperty(exports, "InvocationErrorCode", { enumerable: true, get: function () { return invocationErrorCode_1.InvocationErrorCode; } });
-var retryOptions_1 = require("./retryOptions");
-Object.defineProperty(exports, "RetryOptions", { enumerable: true, get: function () { return retryOptions_1.RetryOptions; } });

package/out/invocationError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invocationError.d.ts","sourceRoot":"","sources":["../src/invocationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,qBAAa,eAAgB,SAAQ,QAAQ;IACxB,YAAY,EAAE,YAAY;gBAA1B,YAAY,GAAE,YAAiC;IAQ3D,MAAM,IAAI;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,YAAY,CAAA;KAAE;CAMjE"}
+{"version":3,"file":"invocationError.d.ts","sourceRoot":"","sources":["../src/invocationError.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,qBAAa,eAAgB,SAAQ,QAAQ;IACxB,YAAY,EAAE,YAAY;gBAA1B,YAAY,GAAE,YAAoC;IAW9D,MAAM,IAAI;QAAE,MAAM,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,YAAY,CAAA;KAAE;CAMjE"}

package/out/invocationError.js

@@ -4,9 +4,12 @@ exports.InvocationError = void 0;
 const retryOptions_1 = require("./retryOptions");
 const queueResponse_1 = require("./queueResponse");
 class InvocationError extends queueResponse_1.Response {
-    constructor(retryOptions = new retryOptions_1.RetryOptions()) {
+    constructor(retryOptions = retryOptions_1.DEFAULT_RETRY_OPTIONS) {
         super(true);
         this.retryOptions = retryOptions;
+        if (this.retryOptions.retryAfter !== undefined && this.retryOptions.retryAfter <= 0) {
+            this.retryOptions.retryAfter = retryOptions_1.MIN_RETRY_AFTER;
+        }
         return this.toJSON();
     }
     toJSON() {

package/out/retryOptions.d.ts

@@ -1,9 +1,12 @@
 import { InvocationErrorCode } from './invocationErrorCode';
-export declare class RetryOptions {
-    static readonly MIN_RETRY_AFTER = 1;
-    private _retryAfter;
+export declare const MIN_RETRY_AFTER = 1;
+export declare const DEFAULT_RETRY_OPTIONS: {
+    retryAfter: number;
     retryReason: InvocationErrorCode;
-    set retryAfter(valueInSeconds: number);
-    get retryAfter(): number;
+};
+export interface RetryOptions {
+    retryAfter: number;
+    retryReason: InvocationErrorCode;
+    retryData?: any;
 }
 //# sourceMappingURL=retryOptions.d.ts.map

package/out/retryOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retryOptions.d.ts","sourceRoot":"","sources":["../src/retryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,qBAAa,YAAY;IACvB,MAAM,CAAC,QAAQ,CAAC,eAAe,KAAK;IAEpC,OAAO,CAAC,WAAW,CAAwC;IAEpD,WAAW,EAAE,mBAAmB,CAA8C;IAMrF,IAAI,UAAU,CAAC,cAAc,EAAE,MAAM,EAIpC;IAKD,IAAI,UAAU,IAAI,MAAM,CAEvB;CACF"}
+{"version":3,"file":"retryOptions.d.ts","sourceRoot":"","sources":["../src/retryOptions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,eAAO,MAAM,eAAe,IAAI,CAAC;AAEjC,eAAO,MAAM,qBAAqB;;;CAGjC,CAAC;AAEF,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,mBAAmB,CAAC;IACjC,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB"}

package/out/retryOptions.js

@@ -1,20 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RetryOptions = void 0;
+exports.DEFAULT_RETRY_OPTIONS = exports.MIN_RETRY_AFTER = void 0;
 const invocationErrorCode_1 = require("./invocationErrorCode");
-class RetryOptions {
-    constructor() {
-        this._retryAfter = RetryOptions.MIN_RETRY_AFTER;
-        this.retryReason = invocationErrorCode_1.InvocationErrorCode.FUNCTION_RETRY_REQUEST;
-    }
-    set retryAfter(valueInSeconds) {
-        if (valueInSeconds >= RetryOptions.MIN_RETRY_AFTER) {
-            this._retryAfter = valueInSeconds;
-        }
-    }
-    get retryAfter() {
-        return this._retryAfter;
-    }
-}
-exports.RetryOptions = RetryOptions;
-RetryOptions.MIN_RETRY_AFTER = 1;
+exports.MIN_RETRY_AFTER = 1;
+exports.DEFAULT_RETRY_OPTIONS = {
+    retryAfter: exports.MIN_RETRY_AFTER,
+    retryReason: invocationErrorCode_1.InvocationErrorCode.FUNCTION_RETRY_REQUEST
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "0.6.1-next.0",
+  "version": "0.7.0-next.0",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -16,7 +16,7 @@
     "@types/uuid": "^3.4.7"
   },
   "dependencies": {
-    "@forge/api": "^2.6.1",
+    "@forge/api": "^2.7.0",
     "uuid": "^3.4.0"
   }
 }

package/src/__test__/invocationError.test.ts

@@ -1,23 +1,40 @@
-import { RetryOptions } from '../retryOptions';
 import { InvocationError } from '../invocationError';
 import { InvocationErrorCode } from '../invocationErrorCode';
+import { DEFAULT_RETRY_OPTIONS, MIN_RETRY_AFTER, RetryOptions } from '../retryOptions';
 
 describe('InvocationError tests', () => {
-  const defaultRetryOption = new RetryOptions();
   let target = new InvocationError();
 
   it('Populate invocationError with default retryOptions and expect default retry option', async () => {
-    expect(target.retryOptions.retryAfter).toEqual(defaultRetryOption.retryAfter);
+    expect(target.retryOptions.retryAfter).toEqual(DEFAULT_RETRY_OPTIONS.retryAfter);
     expect(target.retryOptions.retryReason).toEqual(InvocationErrorCode.FUNCTION_RETRY_REQUEST);
     expect((target as any).hasOwnProperty('_retry')).toBe(true);
   });
 
   it('Populate InvocationError with custom RetryOptions and expect the custom value to set.', () => {
-    defaultRetryOption.retryAfter = 10;
-    defaultRetryOption.retryReason = InvocationErrorCode.FUNCTION_OUT_OF_MEMORY;
-    target = new InvocationError(defaultRetryOption);
+    const retryOptions: RetryOptions = {
+      retryAfter: 10,
+      retryReason: InvocationErrorCode.FUNCTION_OUT_OF_MEMORY,
+      retryData: {
+        eventsToSplit: 5
+      }
+    };
+    target = new InvocationError(retryOptions);
 
-    expect(target.retryOptions).toEqual(defaultRetryOption);
+    expect(target.retryOptions).toEqual(retryOptions);
+    expect((target as any).hasOwnProperty('_retry')).toBe(true);
+  });
+
+  it('Use MIN_RETRY_AFTER when retryAfter <= 0', () => {
+    const retryOptions: RetryOptions = {
+      retryAfter: 0,
+      retryReason: InvocationErrorCode.FUNCTION_OUT_OF_MEMORY,
+      retryData: 'some string data'
+    };
+    target = new InvocationError(retryOptions);
+
+    expect(target.retryOptions.retryAfter).toEqual(MIN_RETRY_AFTER);
+    expect(target.retryOptions.retryData).toEqual('some string data');
     expect((target as any).hasOwnProperty('_retry')).toBe(true);
   });
 });

package/src/invocationError.ts

@@ -1,9 +1,12 @@
-import { RetryOptions } from './retryOptions';
+import { DEFAULT_RETRY_OPTIONS, MIN_RETRY_AFTER, RetryOptions } from './retryOptions';
 import { Response } from './queueResponse';
 
 export class InvocationError extends Response {
-  constructor(public retryOptions: RetryOptions = new RetryOptions()) {
+  constructor(public retryOptions: RetryOptions = DEFAULT_RETRY_OPTIONS) {
     super(true);
+    if (this.retryOptions.retryAfter !== undefined && this.retryOptions.retryAfter <= 0) {
+      this.retryOptions.retryAfter = MIN_RETRY_AFTER;
+    }
     return (this.toJSON() as unknown) as InvocationError;
   }
 

package/src/retryOptions.ts

@@ -1,26 +1,14 @@
 import { InvocationErrorCode } from './invocationErrorCode';
 
-export class RetryOptions {
-  static readonly MIN_RETRY_AFTER = 1;
+export const MIN_RETRY_AFTER = 1;
 
-  private _retryAfter: number = RetryOptions.MIN_RETRY_AFTER;
+export const DEFAULT_RETRY_OPTIONS = {
+  retryAfter: MIN_RETRY_AFTER,
+  retryReason: InvocationErrorCode.FUNCTION_RETRY_REQUEST
+};
 
-  public retryReason: InvocationErrorCode = InvocationErrorCode.FUNCTION_RETRY_REQUEST;
-
-  /**
-   * Sets the retryAfter option to indicate seconds to wait before attempting a retry.
-   * @param valueInSeconds new value in seconds
-   */
-  set retryAfter(valueInSeconds: number) {
-    if (valueInSeconds >= RetryOptions.MIN_RETRY_AFTER) {
-      this._retryAfter = valueInSeconds;
-    }
-  }
-
-  /**
-   * Returns value of retryAfter to indicate seconds to wait before attempting a retry.
-   */
-  get retryAfter(): number {
-    return this._retryAfter;
-  }
+export interface RetryOptions {
+  retryAfter: number;
+  retryReason: InvocationErrorCode;
+  retryData?: any;
 }

package/tsconfig.tsbuildinfo

@@ -432,12 +432,12 @@
         "affectsGlobalScope": false
       },
       "./src/retryOptions.ts": {
-        "version": "2c9f4810016ebb36a28391a317e9ae307fae04d4f429ed323dd035ba641f8feb",
-        "signature": "0c043c863577fc64428a434e533664717c766333835e158a7233cae151284a08",
+        "version": "01d4546f1cd03fe04db3e66de04d74f2951538c3118ff44db7a088c533f03ee2",
+        "signature": "0e928ac60deda4d06973e71ee68e6562231c8a646a9022beb87ce1e081c2a930",
         "affectsGlobalScope": false
       },
       "./src/invocationError.ts": {
-        "version": "468b98a442a97ea1818dc84b75567fc1c699fa7b3506e4ea45e1d9e3c366350e",
+        "version": "7ac55847fd7c10a9cf3f95d58608a448d7e8cd034a0f0ab3a939f0bde8ec2347",
         "signature": "d7309083ef29642d7470e78711fa421b98950f4015bef373dcbce9284d1c6643",
         "affectsGlobalScope": false
       },
@@ -447,7 +447,7 @@
         "affectsGlobalScope": false
       },
       "./src/__test__/invocationError.test.ts": {
-        "version": "6e697d96c2b7439993589c615b122022bf711f8a4c62f4c01e2579cc13595f24",
+        "version": "096668440e76648563b9766369e205cd15640660b37ca4dfcb50947036e10087",
         "signature": "2828661aedf167d345a46c084fd93db1749c61793ee4b7b627276a16c91f732f",
         "affectsGlobalScope": false
       },
@@ -471,11 +471,6 @@
         "signature": "7bc819d10bb62166250f5efeffe176508b3d870807ac87f9fd987e3a552a9b64",
         "affectsGlobalScope": false
       },
-      "./src/__test__/retryOptions.test.ts": {
-        "version": "bbbaf4c9a1497332be34be622de1b1c1b6266393f822173fc05eff9ddf714352",
-        "signature": "c06fea4edbea8d8367d828cf8d04f164a1c2f8f45265d63be53e757266c0b3f7",
-        "affectsGlobalScope": false
-      },
       "../../node_modules/jest-diff/build/cleanupSemantic.d.ts": {
         "version": "d8aab31ba8e618cc3eea10b0945de81cb93b7e8150a013a482332263b9305322",
         "signature": "d8aab31ba8e618cc3eea10b0945de81cb93b7e8150a013a482332263b9305322",
@@ -743,9 +738,6 @@
       "./src/__test__/queueResponse.test.ts": [
         "./src/queueResponse.ts"
       ],
-      "./src/__test__/retryOptions.test.ts": [
-        "./src/retryOptions.ts"
-      ],
       "./src/__test__/utils.ts": [
         "./src/types.ts"
       ],
@@ -1098,7 +1090,6 @@
       "./src/__test__/jobProgress.test.ts",
       "./src/__test__/queue.test.ts",
       "./src/__test__/queueResponse.test.ts",
-      "./src/__test__/retryOptions.test.ts",
       "./src/__test__/utils.ts",
       "./src/errors.ts",
       "./src/index.ts",

package/out/__test__/retryOptions.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=retryOptions.test.d.ts.map

package/out/__test__/retryOptions.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"retryOptions.test.d.ts","sourceRoot":"","sources":["../../src/__test__/retryOptions.test.ts"],"names":[],"mappings":""}

package/out/__test__/retryOptions.test.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const retryOptions_1 = require("../retryOptions");
-describe('RetryOptions tests', () => {
-    const target = new retryOptions_1.RetryOptions();
-    it.each([
-        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER, retryOptions_1.RetryOptions.MIN_RETRY_AFTER],
-        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER - 1, retryOptions_1.RetryOptions.MIN_RETRY_AFTER],
-        [retryOptions_1.RetryOptions.MIN_RETRY_AFTER + 1, retryOptions_1.RetryOptions.MIN_RETRY_AFTER + 1]
-    ])('try to set retryAfter to %p, expect retryAfter to be %p', (value, result) => {
-        target.retryAfter = value;
-        expect(target.retryAfter).toEqual(result);
-    });
-});

package/src/__test__/retryOptions.test.ts

@@ -1,14 +0,0 @@
-import { RetryOptions } from '../retryOptions';
-
-describe('RetryOptions tests', () => {
-  const target = new RetryOptions();
-
-  it.each([
-    [RetryOptions.MIN_RETRY_AFTER, RetryOptions.MIN_RETRY_AFTER],
-    [RetryOptions.MIN_RETRY_AFTER - 1, RetryOptions.MIN_RETRY_AFTER],
-    [RetryOptions.MIN_RETRY_AFTER + 1, RetryOptions.MIN_RETRY_AFTER + 1]
-  ])('try to set retryAfter to %p, expect retryAfter to be %p', (value: number, result: number) => {
-    target.retryAfter = value;
-    expect(target.retryAfter).toEqual(result);
-  });
-});