@forge/events 0.3.0-next.4 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @forge/events
 
+## 0.4.0
+
+### Minor Changes
+
+- d32350b: allow sending up to 50 events per queue.push()
+
+### Patch Changes
+
+- 8a8dccc: Update error messages
+
+## 0.4.0-next.1
+
+### Minor Changes
+
+- d32350b: allow sending up to 50 events per queue.push()
+
+## 0.3.1-next.0
+
+### Patch Changes
+
+- 8a8dccc: Update error messages
+
+## 0.3.0
+
+### Minor Changes
+
+- 9fe841c: Explicitly add uuid dependency and whitelist WHP getStats endpoint
+- 66b6648: Add errors and validations
+- 9051f1d: Add @forge/api as a dependency of @forge/events
+- 6dbedd8: Add QueueResponse in forge-events package to allow retrying an async event.
+
+### Patch Changes
+
+- afa9ee0: Update the error messages
+
 ## 0.3.0-next.4
 
 ### Patch Changes

package/out/__test__/jobProgress.test.js

@@ -29,7 +29,7 @@ describe('JobProgress methods', () => {
                 code: 404
             }, 404);
             const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
-            await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id doesn't exist for the queue test-queue-name.`));
+            await expect(jobProgress.getStats()).rejects.toThrow(new errors_1.JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`));
             utils_1.verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
                 queueName: 'test-queue-name',
                 jobId: 'test-job-id'

package/out/__test__/queue.test.js

@@ -37,7 +37,7 @@ describe('Queue methods', () => {
         it('should throw TooManyEventsError', async () => {
             const apiClientMock = utils_1.getApiClientMock();
             const queue = getQueue(apiClientMock, 'name');
-            await expect(queue.push([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])).rejects.toThrow(new errors_1.TooManyEventsError(`Maximum of 10 events allowed in a single push.`));
+            await expect(queue.push([...Array(51).keys()])).rejects.toThrow(new errors_1.TooManyEventsError(`This push contains more than the 50 events allowed.`));
             expect(apiClientMock).toHaveBeenCalledTimes(0);
         });
         it('should throw PayloadTooBigError', async () => {
@@ -49,15 +49,15 @@ describe('Queue methods', () => {
         it('should throw RateLimitError', async () => {
             const apiClientMock = utils_1.getApiClientMock({}, 429);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+            const payload = [...Array(10).keys()];
             await expect(queue.push(payload)).rejects.toThrow(new errors_1.RateLimitError(`Too many requests.`));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });
         it('should throw InvocationLimitReachedError', async () => {
             const apiClientMock = utils_1.getApiClientMock({}, 405);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5];
-            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvocationLimitReachedError());
+            const payload = [...Array(5).keys()];
+            await expect(queue.push(payload)).rejects.toThrow(new errors_1.InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });
         it('should throw PartialSuccessError when there are failed events', async () => {
@@ -156,7 +156,7 @@ describe('Queue methods', () => {
                 details: 'The request processing has failed because of an unknown error, exception or failure'
             }, 500);
             const queue = getQueue(apiClientMock, 'name');
-            const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+            const payload = [...Array(9).keys()];
             await expect(queue.push(payload)).rejects.toThrow(new errors_1.InternalServerError(`500 Status Text: AWS SQS timed out`, 500, 'The request processing has failed because of an unknown error, exception or failure'));
             utils_1.verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
         });

package/out/errors.d.ts

@@ -30,6 +30,6 @@ export declare class JobDoesNotExistError extends Error {
     constructor(message: string);
 }
 export declare class InvocationLimitReachedError extends Error {
-    constructor();
+    constructor(message: string);
 }
 //# sourceMappingURL=errors.d.ts.map

package/out/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE;IAKxD,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAMjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;;CAIrD"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,wBAAyB,SAAQ,KAAK;gBACrC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,qBAAsB,SAAQ,KAAK;gBAClC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,cAAe,SAAQ,KAAK;gBAC3B,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE;IAKxD,YAAY,EAAE,WAAW,EAAE,CAAC;CAC7B;AAED,qBAAa,mBAAoB,SAAQ,KAAK;gBAChC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAMjE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,oBAAqB,SAAQ,KAAK;gBACjC,OAAO,EAAE,MAAM;CAG5B;AAED,qBAAa,2BAA4B,SAAQ,KAAK;gBACxC,OAAO,EAAE,MAAM;CAG5B"}

package/out/errors.js

@@ -59,8 +59,8 @@ class JobDoesNotExistError extends Error {
 }
 exports.JobDoesNotExistError = JobDoesNotExistError;
 class InvocationLimitReachedError extends Error {
-    constructor() {
-        super();
+    constructor(message) {
+        super(message);
     }
 }
 exports.InvocationLimitReachedError = InvocationLimitReachedError;

package/out/text.d.ts

@@ -6,6 +6,7 @@ export declare const Text: {
         maxPayloadAllowed: (maxPayloadSize: number) => string;
         noEventsPushed: string;
         rateLimitError: string;
+        invocationLimitReachedError: string;
         jobIdEmpty: string;
         jobDoesNotExit: (jobId: string, queueName: string) => string;
     };

package/out/text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;2CAIsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;gCAI3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;2CAIsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}

package/out/text.js

@@ -5,11 +5,12 @@ exports.Text = {
     error: {
         invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
         invalidDelayInSecondsSetting: `The delayInSeconds setting must be between 0 and 900.`,
-        maxEventsAllowed: (maxEventsCount) => `Maximum of ${maxEventsCount} events allowed in a single push.`,
+        maxEventsAllowed: (maxEventsCount) => `This push contains more than the ${maxEventsCount} events allowed.`,
         maxPayloadAllowed: (maxPayloadSize) => `The maximum payload size is ${maxPayloadSize}KB.`,
         noEventsPushed: `No events pushed.`,
         rateLimitError: `Too many requests.`,
+        invocationLimitReachedError: `The limit on cyclic invocation has been reached.`,
         jobIdEmpty: `jobId cannot be empty.`,
-        jobDoesNotExit: (jobId, queueName) => `The job ${jobId} doesn't exist for the queue ${queueName}.`
+        jobDoesNotExit: (jobId, queueName) => `The job ${jobId} was not found for the queue ${queueName}.`
     }
 };

package/out/validators.js

@@ -4,7 +4,7 @@ exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.
 const errors_1 = require("./errors");
 const text_1 = require("./text");
 const VALID_QUEUE_NAME_PATTERN = /^[a-zA-Z0-9-_]+$/;
-const MAXIMUM_EVENTS = 10;
+const MAXIMUM_EVENTS = 50;
 const MAXIMUM_PAYLOAD_SIZE_KB = 200;
 exports.validateQueueKey = (queueName) => {
     if (!queueName || !VALID_QUEUE_NAME_PATTERN.test(queueName)) {
@@ -39,7 +39,7 @@ exports.validateAPIResponse = async (response, expectedSuccessStatus) => {
         throw new errors_1.RateLimitError(text_1.Text.error.rateLimitError);
     }
     if (response.status === 405) {
-        throw new errors_1.InvocationLimitReachedError();
+        throw new errors_1.InvocationLimitReachedError(text_1.Text.error.invocationLimitReachedError);
     }
     if (response.status != expectedSuccessStatus && response.status) {
         let internalServerError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "0.3.0-next.4",
+  "version": "0.4.0",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "UNLICENSED",

package/src/__test__/jobProgress.test.ts

@@ -37,7 +37,7 @@ describe('JobProgress methods', () => {
       );
       const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
       await expect(jobProgress.getStats()).rejects.toThrow(
-        new JobDoesNotExistError(`The job test-job-id doesn't exist for the queue test-queue-name.`)
+        new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
       );
       verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
         queueName: 'test-queue-name',

package/src/__test__/queue.test.ts

@@ -55,8 +55,8 @@ describe('Queue methods', () => {
     it('should throw TooManyEventsError', async () => {
       const apiClientMock = getApiClientMock();
       const queue = getQueue(apiClientMock, 'name');
-      await expect(queue.push([1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])).rejects.toThrow(
-        new TooManyEventsError(`Maximum of 10 events allowed in a single push.`)
+      await expect(queue.push([...Array(51).keys()])).rejects.toThrow(
+        new TooManyEventsError(`This push contains more than the 50 events allowed.`)
       );
       expect(apiClientMock).toHaveBeenCalledTimes(0);
     });
@@ -73,7 +73,7 @@ describe('Queue methods', () => {
     it('should throw RateLimitError', async () => {
       const apiClientMock = getApiClientMock({}, 429);
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
+      const payload = [...Array(10).keys()];
       await expect(queue.push(payload)).rejects.toThrow(new RateLimitError(`Too many requests.`));
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
@@ -81,8 +81,10 @@ describe('Queue methods', () => {
     it('should throw InvocationLimitReachedError', async () => {
       const apiClientMock = getApiClientMock({}, 405);
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5];
-      await expect(queue.push(payload)).rejects.toThrow(new InvocationLimitReachedError());
+      const payload = [...Array(5).keys()];
+      await expect(queue.push(payload)).rejects.toThrow(
+        new InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`)
+      );
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
 
@@ -203,7 +205,7 @@ describe('Queue methods', () => {
         500
       );
       const queue = getQueue(apiClientMock, 'name');
-      const payload = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+      const payload = [...Array(9).keys()];
       await expect(queue.push(payload)).rejects.toThrow(
         new InternalServerError(
           `500 Status Text: AWS SQS timed out`,

package/src/errors.ts

@@ -63,7 +63,7 @@ export class JobDoesNotExistError extends Error {
 }
 
 export class InvocationLimitReachedError extends Error {
-  constructor() {
-    super();
+  constructor(message: string) {
+    super(message);
   }
 }

package/src/text.ts

@@ -3,12 +3,13 @@ export const Text = {
     invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
     invalidDelayInSecondsSetting: `The delayInSeconds setting must be between 0 and 900.`,
     maxEventsAllowed: (maxEventsCount: number): string =>
-      `Maximum of ${maxEventsCount} events allowed in a single push.`,
+      `This push contains more than the ${maxEventsCount} events allowed.`,
     maxPayloadAllowed: (maxPayloadSize: number): string => `The maximum payload size is ${maxPayloadSize}KB.`,
     noEventsPushed: `No events pushed.`,
     rateLimitError: `Too many requests.`,
+    invocationLimitReachedError: `The limit on cyclic invocation has been reached.`,
     jobIdEmpty: `jobId cannot be empty.`,
     jobDoesNotExit: (jobId: string, queueName: string): string =>
-      `The job ${jobId} doesn't exist for the queue ${queueName}.`
+      `The job ${jobId} was not found for the queue ${queueName}.`
   }
 };

package/src/validators.ts

@@ -14,7 +14,7 @@ import { Text } from './text';
 import { APIResponse, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
 
 const VALID_QUEUE_NAME_PATTERN = /^[a-zA-Z0-9-_]+$/;
-const MAXIMUM_EVENTS = 10;
+const MAXIMUM_EVENTS = 50;
 const MAXIMUM_PAYLOAD_SIZE_KB = 200;
 
 export const validateQueueKey = (queueName: string) => {
@@ -57,7 +57,7 @@ export const validateAPIResponse = async (response: APIResponse, expectedSuccess
   }
 
   if (response.status === 405) {
-    throw new InvocationLimitReachedError();
+    throw new InvocationLimitReachedError(Text.error.invocationLimitReachedError);
   }
 
   if (response.status != expectedSuccessStatus && response.status) {

package/tsconfig.tsbuildinfo

@@ -397,8 +397,8 @@
         "affectsGlobalScope": false
       },
       "./src/errors.ts": {
-        "version": "337cdade564b6155936572ea9629417435fa23c264f0aeabafa96527f87df119",
-        "signature": "806b89b9f9cf0126cc50bdc2e5173eb1d6e4618b476c1493f6e15c66329b347a",
+        "version": "d851b9c7d9f3221bbef29df8237e3d4156ab8706950d6bdd6c4a57d8e55cc4c1",
+        "signature": "dbec5f26319c68d139585561f12341a720ab13880a4c040b438e892ae391d2c9",
         "affectsGlobalScope": false
       },
       "./src/queries.ts": {
@@ -407,12 +407,12 @@
         "affectsGlobalScope": false
       },
       "./src/text.ts": {
-        "version": "0d1a499967f9e09fc760486fb487a251855a78d05b80d249729080ec98cccd66",
-        "signature": "090fd6968168da325d9e84ff968b77f62523775fb6154a0cc1facd35a4eb6702",
+        "version": "0b4ee00634da4bf5aa2fecf99443c7a886fee5619832b35c0e10513deecd3967",
+        "signature": "4c846733296e27a117c12a9bdf0311f5790125ddf1e1e01b54869b9c487630ba",
         "affectsGlobalScope": false
       },
       "./src/validators.ts": {
-        "version": "9a88390cc1009a9bcbb46136c1984eed7abba46ce4ead9f9bb8a52a8e54740c4",
+        "version": "46c89feddc0e1906925367a2093130dbaf98798d472df95970f6715b4cd5c5d3",
         "signature": "74384a84caa4d0e5679b15f8e72bad7b657d503e3178ed8b9b87c32f36e3573b",
         "affectsGlobalScope": false
       },
@@ -452,12 +452,12 @@
         "affectsGlobalScope": false
       },
       "./src/__test__/jobProgress.test.ts": {
-        "version": "9de7b4accb652b255005f603d951c15c2443ffd568e36dae00da18c2d1b92ea8",
+        "version": "f47b1533e3fa6faf1458a83e25cd26b425e822d01988ec604b7bb2140410d708",
         "signature": "7870ceffd2c069795d2976c13017e1697f28e9a1c994dbd36dc48c21826db61b",
         "affectsGlobalScope": false
       },
       "./src/__test__/queue.test.ts": {
-        "version": "b38c9012b04685520db50576252eccc4f71d1cbdaeedfdab1b99df6323e51650",
+        "version": "23dea05f9460582f60526e93a77111cda92508c785087c54fa05995b9b6dd9df",
         "signature": "1302e8032e32981552bc73b7ef2f99ebf98990a704e26f51e70b1d96a4639fcf",
         "affectsGlobalScope": false
       },