@forge/events 0.0.0-experimental-e05f7a2 → 0.0.0-experimental-64caa5a

package/out/jobProgress.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobProgress = void 0;
+const queries_1 = require("./queries");
+const validators_1 = require("./validators");
+class JobProgress {
+    constructor(id, apiClient) {
+        this.id = id;
+        this.apiClient = apiClient || global.api.asApp().__requestAtlassian;
+    }
+    async getStats() {
+        const [queueName, jobId] = this.id.split('#');
+        const getStatsRequest = {
+            queueName: queueName,
+            jobId: jobId,
+            time: new Date().toISOString()
+        };
+        validators_1.validateGetStatsPayload(getStatsRequest);
+        const response = await queries_1.post(queries_1.GET_STATS_PATH, getStatsRequest, this.apiClient);
+        await validators_1.validateGetStatsAPIResponse(response, getStatsRequest);
+        return response;
+    }
+    async cancel() {
+        const [queueName, jobId] = this.id.split('#');
+        const cancelJobRequest = {
+            queueName: queueName,
+            jobId: jobId,
+            time: new Date().toISOString()
+        };
+        validators_1.validateCancelJobRequest(cancelJobRequest);
+        const response = await queries_1.post(queries_1.CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
+        await validators_1.validateCancelJobAPIResponse(response, cancelJobRequest);
+        return response;
+    }
+}
+exports.JobProgress = JobProgress;

package/out/queries.d.ts

@@ -1,4 +1,6 @@
-import { PushBodyParams, APIRequest } from './types';
-export declare const getPushBody: (params: PushBodyParams) => APIRequest;
+import { APIRequest, APIResponse, FetchMethod } from './types';
 export declare const PUSH_PATH = "/webhook/queue/publish/{cloudId}/{environmentId}/{appId}/{appVersion}";
+export declare const GET_STATS_PATH = "/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}";
+export declare const CANCEL_JOB_PATH = "/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}";
+export declare const post: (endpoint: string, body: APIRequest, apiClient: FetchMethod) => Promise<APIResponse>;
 //# sourceMappingURL=queries.d.ts.map

package/out/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErD,eAAO,MAAM,WAAW,WAAY,cAAc,KAAG,UAMnD,CAAC;AAEH,eAAO,MAAM,SAAS,0EAA0E,CAAC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../src/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE/D,eAAO,MAAM,SAAS,0EAA0E,CAAC;AACjG,eAAO,MAAM,cAAc,wEAAwE,CAAC;AACpG,eAAO,MAAM,eAAe,yEAAyE,CAAC;AAEtG,eAAO,MAAM,IAAI,aAAoB,MAAM,QAAQ,UAAU,aAAa,WAAW,KAAG,OAAO,CAAC,WAAW,CAU1G,CAAC"}

package/out/queries.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PUSH_PATH = exports.getPushBody = void 0;
-exports.getPushBody = (params) => ({
-    queueName: params.queueName,
-    type: params.type,
-    schema: params.schema,
-    payload: params.payload,
-    time: new Date().toISOString()
-});
+exports.post = exports.CANCEL_JOB_PATH = exports.GET_STATS_PATH = exports.PUSH_PATH = void 0;
 exports.PUSH_PATH = '/webhook/queue/publish/{cloudId}/{environmentId}/{appId}/{appVersion}';
+exports.GET_STATS_PATH = '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}';
+exports.CANCEL_JOB_PATH = '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}';
+exports.post = async (endpoint, body, apiClient) => {
+    const request = {
+        method: 'POST',
+        body: JSON.stringify(body),
+        headers: {
+            'content-type': 'application/json'
+        }
+    };
+    return await apiClient(endpoint, request);
+};

package/out/queue.d.ts

@@ -1,10 +1,10 @@
-import { APIResponse, FetchMethod, Payload, QueueParams } from './types';
+import { FetchMethod, Payload, QueueParams, PushSettings } from './types';
+import { JobProgress } from './jobProgress';
 export declare class Queue {
     private readonly apiClient;
     private queueParams;
     constructor(queueParams: QueueParams, apiClient?: FetchMethod);
-    push(payloads: Payload | Payload[]): Promise<APIResponse>;
-    private query;
-    private buildRequest;
+    push(payloads: Payload | Payload[], pushSettings?: PushSettings): Promise<string>;
+    getJob(jobId: string): JobProgress;
 }
 //# sourceMappingURL=queue.d.ts.map

package/out/queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAkB,WAAW,EAAc,MAAM,SAAS,CAAC;AAOrG,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,WAAW,CAAc;gBAErB,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,WAAW;IAMvD,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC;YAajD,KAAK;IAKnB,OAAO,CAAC,YAAY;CASrB"}
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAe,MAAM,SAAS,CAAC;AAEvF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAc;IACxC,OAAO,CAAC,WAAW,CAAc;gBAErB,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,EAAE,WAAW;IAMvD,IAAI,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,EAAE,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BvF,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;CAGnC"}

package/out/queue.js

@@ -1,41 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Queue = void 0;
+const tslib_1 = require("tslib");
 const queries_1 = require("./queries");
 const validators_1 = require("./validators");
-async function getResponseBody(response, body) {
-    await validators_1.validateAPIResponse(response, body);
-    return response;
-}
+const v4_1 = tslib_1.__importDefault(require("uuid/v4"));
+const jobProgress_1 = require("./jobProgress");
 class Queue {
     constructor(queueParams, apiClient) {
-        validators_1.validateQueueName(queueParams.queueName);
+        validators_1.validateQueueKey(queueParams.key);
         this.queueParams = queueParams;
         this.apiClient = apiClient || global.api.asApp().__requestAtlassian;
     }
-    async push(payloads) {
-        validators_1.validatePayloads(payloads);
-        const queryParams = {
-            payload: Array.isArray(payloads) ? payloads : [payloads],
-            queueName: this.queueParams.queueName,
+    async push(payloads, pushSettings) {
+        validators_1.validatePushPayloads(payloads);
+        const queueName = this.queueParams.key;
+        const jobId = v4_1.default();
+        const pushRequest = {
+            queueName: queueName,
+            jobId: jobId,
+            type: 'avi:forge:app:event',
             schema: 'ari:cloud:ecosystem::forge/app-event',
-            type: 'avi:forge:app:event'
+            payload: Array.isArray(payloads) ? payloads : [payloads],
+            time: new Date().toISOString()
         };
-        const requestBody = queries_1.getPushBody(queryParams);
-        return this.query(queries_1.PUSH_PATH, requestBody);
-    }
-    async query(endpoint, body) {
-        const response = await this.apiClient(endpoint, this.buildRequest(body));
-        return await getResponseBody(response, body);
-    }
-    buildRequest(requestBody) {
-        return {
-            method: 'POST',
-            body: JSON.stringify(requestBody),
-            headers: {
-                'content-type': 'application/json'
+        if (pushSettings) {
+            validators_1.validatePushSettings(pushSettings);
+            if (pushSettings.delayInSeconds) {
+                pushRequest.delayInSeconds = pushSettings.delayInSeconds;
             }
-        };
+        }
+        const response = await queries_1.post(queries_1.PUSH_PATH, pushRequest, this.apiClient);
+        await validators_1.validatePushAPIResponse(response, pushRequest);
+        return `${queueName}#${jobId}`;
+    }
+    getJob(jobId) {
+        return new jobProgress_1.JobProgress(jobId, this.apiClient);
     }
 }
 exports.Queue = Queue;

package/out/queueResponse.d.ts

@@ -0,0 +1,5 @@
+export declare class QueueResponse {
+    protected _retry: boolean;
+    retry(): void;
+}
+//# sourceMappingURL=queueResponse.d.ts.map

package/out/queueResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"queueResponse.d.ts","sourceRoot":"","sources":["../src/queueResponse.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAa;IACxB,SAAS,CAAC,MAAM,UAAS;IAEzB,KAAK,IAAI,IAAI;CAGd"}

package/out/queueResponse.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueueResponse = void 0;
+class QueueResponse {
+    constructor() {
+        this._retry = false;
+    }
+    retry() {
+        this._retry = true;
+    }
+}
+exports.QueueResponse = QueueResponse;

package/out/text.d.ts

@@ -0,0 +1,14 @@
+export declare const Text: {
+    error: {
+        invalidQueueName: string;
+        invalidDelayInSecondsSetting: string;
+        maxEventsAllowed: (maxEventsCount: number) => string;
+        maxPayloadAllowed: (maxPayloadSize: number) => string;
+        noEventsPushed: string;
+        rateLimitError: string;
+        invocationLimitReachedError: string;
+        jobIdEmpty: string;
+        jobDoesNotExit: (jobId: string, queueName: string) => string;
+    };
+};
+//# sourceMappingURL=text.d.ts.map

package/out/text.d.ts.map

@@ -0,0 +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;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}

package/out/text.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Text = void 0;
+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) => `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} was not found for the queue ${queueName}.`
+    }
+};

package/out/types.d.ts

@@ -4,20 +4,27 @@ export declare type FetchMethod = (url: string, init: RequestInit) => Promise<AP
 export declare type Payload = string | number | boolean | {
     [key: string]: Payload;
 };
+export interface PushSettings {
+    delayInSeconds: number;
+}
 export interface QueueParams {
-    queueName: string;
+    key: string;
 }
-export interface PushBodyParams {
+export interface PushRequest extends APIRequest {
     payload: Payload[];
-    queueName: string;
     schema: string;
     type: string;
+    delayInSeconds?: number;
 }
-export interface APIRequest extends PushBodyParams {
+export interface APIRequest {
+    queueName: string;
+    jobId: string;
     time: string;
 }
 export interface FailedEvent {
     errorMessage: string;
     payload: Payload;
 }
+export declare type GetStatsRequest = APIRequest;
+export declare type CancelJobRequest = APIRequest;
 //# sourceMappingURL=types.d.ts.map

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACnF,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAW,SAAQ,cAAc;IAChD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEnD,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;AAC3G,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACnF,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAE7E,MAAM,WAAW,YAAY;IAC3B,cAAc,EAAE,MAAM,CAAC;CACxB;AACD,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC;AACzC,oBAAY,gBAAgB,GAAG,UAAU,CAAC"}

package/out/validators.d.ts

@@ -1,5 +1,11 @@
-import { APIResponse, Payload, APIRequest } from './types';
-export declare const validateQueueName: (queueName: string) => void;
-export declare const validatePayloads: (payloads: Payload | Payload[]) => void;
-export declare const validateAPIResponse: (response: APIResponse, requestBody: APIRequest) => Promise<void>;
+import { APIResponse, CancelJobRequest, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
+export declare const validateQueueKey: (queueName: string) => void;
+export declare const validatePushSettings: (settings: PushSettings) => void;
+export declare const validatePushPayloads: (payloads: Payload | Payload[]) => void;
+export declare const validateGetStatsPayload: (getStatsRequest: GetStatsRequest) => void;
+export declare const validateCancelJobRequest: (cancelJobRequest: CancelJobRequest) => void;
+export declare const validateAPIResponse: (response: APIResponse, expectedSuccessStatus: number) => Promise<void>;
+export declare const validatePushAPIResponse: (response: APIResponse, requestBody: PushRequest) => Promise<void>;
+export declare const validateGetStatsAPIResponse: (response: APIResponse, getStatsRequest: GetStatsRequest) => Promise<void>;
+export declare const validateCancelJobAPIResponse: (response: APIResponse, cancelJobRequest: GetStatsRequest) => Promise<void>;
 //# sourceMappingURL=validators.d.ts.map

package/out/validators.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAM3D,eAAO,MAAM,iBAAiB,cAAe,MAAM,SAIlD,CAAC;AAEF,eAAO,MAAM,gBAAgB,aAAc,OAAO,GAAG,OAAO,EAAE,SAa7D,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,eAAe,UAAU,kBAsCvF,CAAC"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAM7G,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,YAAY,SAI1D,CAAC;AAEF,eAAO,MAAM,oBAAoB,aAAc,OAAO,GAAG,OAAO,EAAE,SAajE,CAAC;AAEF,eAAO,MAAM,uBAAuB,oBAAqB,eAAe,SAKvE,CAAC;AAEF,eAAO,MAAM,wBAAwB,qBAAsB,gBAAgB,SAK1E,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAoB,WAAW,yBAAyB,MAAM,kBA6B7F,CAAC;AAEF,eAAO,MAAM,uBAAuB,aAAoB,WAAW,eAAe,WAAW,kBAkC5F,CAAC;AAEF,eAAO,MAAM,2BAA2B,aAAoB,WAAW,mBAAmB,eAAe,kBAMxG,CAAC;AAEF,eAAO,MAAM,4BAA4B,aAAoB,WAAW,oBAAoB,eAAe,kBAM1G,CAAC"}

package/out/validators.js

@@ -1,52 +1,103 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateAPIResponse = exports.validatePayloads = exports.validateQueueName = void 0;
+exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushPayloads = exports.validatePushSettings = exports.validateQueueKey = void 0;
 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.validateQueueName = (queueName) => {
+exports.validateQueueKey = (queueName) => {
     if (!queueName || !VALID_QUEUE_NAME_PATTERN.test(queueName)) {
-        throw new errors_1.InvalidQueueNameError('Queue name can only contain alphanumeric, dash and underscore characters');
+        throw new errors_1.InvalidQueueNameError(text_1.Text.error.invalidQueueName);
     }
 };
-exports.validatePayloads = (payloads) => {
+exports.validatePushSettings = (settings) => {
+    if ((settings.delayInSeconds && settings.delayInSeconds > 900) || settings.delayInSeconds < 0) {
+        throw new errors_1.InvalidPushSettingsError(text_1.Text.error.invalidDelayInSecondsSetting);
+    }
+};
+exports.validatePushPayloads = (payloads) => {
     if (!payloads || (Array.isArray(payloads) && payloads.length === 0)) {
-        throw new errors_1.NoEventsToPushError(`No events pushed`);
+        throw new errors_1.NoEventsToPushError(text_1.Text.error.noEventsPushed);
     }
     if (Array.isArray(payloads) && payloads.length > MAXIMUM_EVENTS) {
-        throw new errors_1.TooManyEventsError(`Maximum of ${MAXIMUM_EVENTS} events allowed in a single push`);
+        throw new errors_1.TooManyEventsError(text_1.Text.error.maxEventsAllowed(MAXIMUM_EVENTS));
     }
     const payloadSizeKB = Buffer.byteLength(JSON.stringify(payloads)) / 1024;
     if (payloadSizeKB > MAXIMUM_PAYLOAD_SIZE_KB) {
-        throw new errors_1.PayloadTooBigError(`The maximum payload size allowed is ${MAXIMUM_PAYLOAD_SIZE_KB}KB`);
+        throw new errors_1.PayloadTooBigError(text_1.Text.error.maxPayloadAllowed(MAXIMUM_PAYLOAD_SIZE_KB));
+    }
+};
+exports.validateGetStatsPayload = (getStatsRequest) => {
+    if (!getStatsRequest.jobId) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobIdEmpty);
     }
+    exports.validateQueueKey(getStatsRequest.queueName);
 };
-exports.validateAPIResponse = async (response, requestBody) => {
+exports.validateCancelJobRequest = (cancelJobRequest) => {
+    if (!cancelJobRequest.jobId) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobIdEmpty);
+    }
+    exports.validateQueueKey(cancelJobRequest.queueName);
+};
+exports.validateAPIResponse = async (response, expectedSuccessStatus) => {
     if (response.status === 429) {
-        throw new errors_1.RateLimitError(`Too many requests`);
+        throw new errors_1.RateLimitError(text_1.Text.error.rateLimitError);
     }
+    if (response.status === 405) {
+        throw new errors_1.InvocationLimitReachedError(text_1.Text.error.invocationLimitReachedError);
+    }
+    if (response.status != expectedSuccessStatus && response.status) {
+        let internalServerError;
+        try {
+            const responseBody = await response.json();
+            const errorMessage = responseBody.message ? `: ${responseBody.message}` : '';
+            const errors = responseBody.errors ? `: ${responseBody.errors.join(', ')}` : '';
+            internalServerError = new errors_1.InternalServerError(`${response.status} ${response.statusText}${errorMessage}${errors}`, responseBody.code, responseBody.details);
+        }
+        catch (ignore) {
+            internalServerError = new errors_1.InternalServerError(`${response.status} ${response.statusText}`, response.status);
+        }
+        throw internalServerError;
+    }
+};
+exports.validatePushAPIResponse = async (response, requestBody) => {
     if (response.status === 413) {
         const responseBody = await response.json();
         throw new errors_1.PayloadTooBigError(responseBody.errorMessage);
     }
     if (response.status === 202) {
         const responseBody = await response.json();
+        const defaultErrorMessage = 'Failed to process some events.';
+        const partialSuccessError = new errors_1.PartialSuccessError(defaultErrorMessage, []);
         if (responseBody.failedEvents && responseBody.failedEvents.length > 0) {
-            throw new errors_1.PartialSuccessError(`Failed to process ${responseBody.failedEvents.length} events`, responseBody.failedEvents.map((failedEvent) => {
+            partialSuccessError.message = `Failed to process ${responseBody.failedEvents.length} event(s).`;
+            partialSuccessError.failedEvents = responseBody.failedEvents.map((failedEvent) => {
                 return {
                     errorMessage: failedEvent.errorMessage,
                     payload: requestBody.payload[+failedEvent.index]
                 };
-            }));
+            });
         }
-        else {
-            throw new errors_1.PartialSuccessError(`Failed to process events`, []);
+        if (responseBody.errorMessage) {
+            partialSuccessError.message =
+                partialSuccessError.message !== defaultErrorMessage
+                    ? `${partialSuccessError.message} ${responseBody.errorMessage}`
+                    : responseBody.errorMessage;
         }
+        throw partialSuccessError;
     }
-    if (response.status != 201 && response.status) {
-        const responseBody = await response.json();
-        const errorMessage = responseBody.message ? `: ${responseBody.message}` : '';
-        throw new errors_1.InternalServerError(`${response.status} ${response.statusText}${errorMessage}`, responseBody.code, responseBody.details);
+    await exports.validateAPIResponse(response, 201);
+};
+exports.validateGetStatsAPIResponse = async (response, getStatsRequest) => {
+    if (response.status === 404) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobDoesNotExit(getStatsRequest.jobId, getStatsRequest.queueName));
+    }
+    await exports.validateAPIResponse(response, 200);
+};
+exports.validateCancelJobAPIResponse = async (response, cancelJobRequest) => {
+    if (response.status === 404) {
+        throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobDoesNotExit(cancelJobRequest.jobId, cancelJobRequest.queueName));
     }
+    await exports.validateAPIResponse(response, 204);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "0.0.0-experimental-e05f7a2",
+  "version": "0.0.0-experimental-64caa5a",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,6 +12,11 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
-    "@types/node": "^12.12.63"
+    "@types/node": "^12.12.63",
+    "@types/uuid": "^3.4.7"
+  },
+  "dependencies": {
+    "@forge/api": "^0.0.0-experimental-64caa5a",
+    "uuid": "^3.4.0"
   }
 }

package/src/__test__/jobProgress.test.ts

@@ -0,0 +1,149 @@
+import { getApiClientMock, verifyApiClientCalledWith } from './utils';
+import { InternalServerError, InvalidQueueNameError, JobDoesNotExistError, RateLimitError } from '../errors';
+import { JobProgress } from '../jobProgress';
+
+const getJobProgress = (apiClientMock: any, jobId: string) => new JobProgress(jobId, apiClientMock);
+
+describe('JobProgress methods', () => {
+  describe('getStats', () => {
+    it('should call the queue/stats endpoint', async () => {
+      const apiClientMock = getApiClientMock(
+        {
+          success: 100,
+          inProgress: 50,
+          failed: 1
+        },
+        200
+      );
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      const response = await jobProgress.getStats();
+      const { success, inProgress, failed } = await response.json();
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+      expect(success).toEqual(100);
+      expect(inProgress).toEqual(50);
+      expect(failed).toEqual(1);
+    });
+
+    it('should throw JobDoesNotExistError', async () => {
+      const apiClientMock = getApiClientMock(
+        {
+          message: 'Job Not Found',
+          code: 404
+        },
+        404
+      );
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      await expect(jobProgress.getStats()).rejects.toThrow(
+        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',
+        jobId: 'test-job-id'
+      });
+    });
+
+    it('should throw RateLimitError', async () => {
+      const apiClientMock = getApiClientMock({}, 429);
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      await expect(jobProgress.getStats()).rejects.toThrow(new RateLimitError(`Too many requests.`));
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+    });
+
+    it('should throw InternalServerError', async () => {
+      const apiClientMock = getApiClientMock(
+        {
+          message: 'Service is not available',
+          code: 513,
+          details: 'The request processing has failed because of an unknown error, exception or failure'
+        },
+        513
+      );
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      await expect(jobProgress.getStats()).rejects.toThrow(
+        new InternalServerError(`513 Status Text: Service is not available`, 513)
+      );
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+    });
+  });
+
+  describe('cancel', () => {
+    it('should call the queue/cancel endpoint', async () => {
+      const apiClientMock = getApiClientMock({}, 204);
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      const response = await jobProgress.cancel();
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+      expect(response.status).toEqual(204);
+    });
+
+    it('should throw JobDoesNotExistError', async () => {
+      const apiClientMock = getApiClientMock(
+        {
+          message: 'Job Not Found',
+          code: 404
+        },
+        404
+      );
+      const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+      await expect(jobProgress.cancel()).rejects.toThrow(
+        new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
+      );
+      verifyApiClientCalledWith(apiClientMock, '/webhook/queue/cancel/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+        queueName: 'test-queue-name',
+        jobId: 'test-job-id'
+      });
+    });
+  });
+
+  it('should throw InternalServerError when WHP returns 422 response', async () => {
+    const apiClientMock = getApiClientMock(
+      {
+        errors: ['jobId must not be null', 'queueName must not be null']
+      },
+      422
+    );
+    const jobProgress = getJobProgress(apiClientMock, 'test-queue-name#test-job-id');
+    await expect(jobProgress.getStats()).rejects.toThrow(
+      new InternalServerError(`422 Status Text: jobId must not be null, queueName must not be null`)
+    );
+
+    verifyApiClientCalledWith(apiClientMock, '/webhook/queue/stats/{cloudId}/{environmentId}/{appId}/{appVersion}', {
+      queueName: 'test-queue-name',
+      jobId: 'test-job-id'
+    });
+  });
+
+  it('should throw errors when queueName or jobId is empty', async () => {
+    const apiClientMock = getApiClientMock(
+      {
+        success: 100,
+        inProgress: 50,
+        failed: 1
+      },
+      200
+    );
+    const jobProgress1 = getJobProgress(apiClientMock, 'test-queue-name#');
+    await expect(jobProgress1.getStats()).rejects.toThrow(new JobDoesNotExistError(`jobId cannot be empty.`));
+
+    const jobProgress2 = getJobProgress(apiClientMock, '#test-job-id');
+    await expect(jobProgress2.getStats()).rejects.toThrow(
+      new InvalidQueueNameError('Queue names can only contain alphanumeric characters, dashes and underscores.')
+    );
+
+    const jobProgress3 = getJobProgress(apiClientMock, '');
+    await expect(jobProgress3.getStats()).rejects.toThrow(new JobDoesNotExistError(`jobId cannot be empty.`));
+
+    expect(apiClientMock).toHaveBeenCalledTimes(0);
+  });
+});