@forge/events 1.1.0-next.0 → 2.0.0-next.2

package/out/jobProgress.js

@@ -5,35 +5,35 @@ const api_1 = require("@forge/api");
 const queries_1 = require("./queries");
 const validators_1 = require("./validators");
 class JobProgress {
+    queueParams;
     id;
     apiClient;
-    constructor(id, apiClient = api_1.__requestAtlassianAsApp) {
+    constructor(queueParams, id, apiClient = api_1.__requestAtlassianAsApp) {
+        this.queueParams = queueParams;
         this.id = id;
         this.apiClient = apiClient;
     }
     async getStats() {
-        const [queueName, jobId] = this.id.split('#');
         const getStatsRequest = {
-            queueName: queueName,
-            jobId: jobId,
+            queueName: this.queueParams.key,
+            jobId: this.id,
             time: new Date().toISOString()
         };
         (0, validators_1.validateGetStatsPayload)(getStatsRequest);
         const response = await (0, queries_1.post)(queries_1.GET_STATS_PATH, getStatsRequest, this.apiClient);
         await (0, validators_1.validateGetStatsAPIResponse)(response, getStatsRequest);
-        return response;
+        const { success, inProgress, failed } = await response.json();
+        return { success, inProgress, failed };
     }
     async cancel() {
-        const [queueName, jobId] = this.id.split('#');
         const cancelJobRequest = {
-            queueName: queueName,
-            jobId: jobId,
+            queueName: this.queueParams.key,
+            jobId: this.id,
             time: new Date().toISOString()
         };
         (0, validators_1.validateCancelJobRequest)(cancelJobRequest);
         const response = await (0, queries_1.post)(queries_1.CANCEL_JOB_PATH, cancelJobRequest, this.apiClient);
         await (0, validators_1.validateCancelJobAPIResponse)(response, cancelJobRequest);
-        return response;
     }
 }
 exports.JobProgress = JobProgress;

package/out/queue.d.ts

@@ -1,11 +1,11 @@
 import { FetchMethod } from '@forge/api';
-import { Payload, QueueParams, PushSettings } from './types';
+import { QueueParams, PushEvent, PushResult } from './types';
 import { JobProgress } from './jobProgress';
 export declare class Queue {
     private readonly queueParams;
     private readonly apiClient;
     constructor(queueParams: QueueParams, apiClient?: FetchMethod);
-    push(payloads: Payload | Payload[], pushSettings?: PushSettings): Promise<string>;
+    push(events: PushEvent | PushEvent[]): Promise<PushResult>;
     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":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAe,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,qBAAa,KAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,WAAqC;IAK7D,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"}
+{"version":3,"file":"queue.d.ts","sourceRoot":"","sources":["../src/queue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAA2B,MAAM,YAAY,CAAC;AAGlE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAe,UAAU,EAAE,MAAM,SAAS,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,qBAAa,KAAK;IAEd,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,WAAW,EAAE,WAAW,EACxB,SAAS,GAAE,WAAqC;IAK7D,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC;IAoBhE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;CAGnC"}

package/out/queue.js

@@ -14,30 +14,25 @@ class Queue {
         this.apiClient = apiClient;
         (0, validators_1.validateQueueKey)(this.queueParams.key);
     }
-    async push(payloads, pushSettings) {
-        (0, validators_1.validatePushPayloads)(payloads);
+    async push(events) {
+        const validEvents = (0, validators_1.validatePushEvents)(events);
         const queueName = this.queueParams.key;
         const jobId = (0, uuid_1.v4)();
         const pushRequest = {
             queueName: queueName,
             jobId: jobId,
             type: 'avi:forge:app:event',
-            schema: 'ari:cloud:ecosystem::forge/app-event',
-            payload: Array.isArray(payloads) ? payloads : [payloads],
+            schema: 'ari:cloud:ecosystem::forge/app-event-2',
+            payload: validEvents,
             time: new Date().toISOString()
         };
-        if (pushSettings) {
-            (0, validators_1.validatePushSettings)(pushSettings);
-            if (pushSettings.delayInSeconds) {
-                pushRequest.delayInSeconds = pushSettings.delayInSeconds;
-            }
-        }
         const response = await (0, queries_1.post)(queries_1.PUSH_PATH, pushRequest, this.apiClient);
-        await (0, validators_1.validatePushAPIResponse)(response, pushRequest);
-        return `${queueName}#${jobId}`;
+        const result = { jobId };
+        await (0, validators_1.validatePushAPIResponse)(pushRequest, response, result);
+        return result;
     }
     getJob(jobId) {
-        return new jobProgress_1.JobProgress(jobId, this.apiClient);
+        return new jobProgress_1.JobProgress(this.queueParams, jobId, this.apiClient);
     }
 }
 exports.Queue = Queue;

package/out/text.d.ts

@@ -1,6 +1,8 @@
 export declare const Text: {
     error: {
         invalidQueueName: string;
+        invalidEvent: string;
+        invalidEventBody: string;
         invalidDelayInSecondsSetting: string;
         maxEventsAllowed: (maxEventsCount: number) => string;
         maxPayloadAllowed: (maxPayloadSize: number) => 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;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../src/text.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI;;;;;;2CAMsB,MAAM,KAAG,MAAM;4CAEd,MAAM,KAAG,MAAM;;;;;gCAK3B,MAAM,aAAa,MAAM,KAAG,MAAM;;CAG7D,CAAC"}

package/out/text.js

@@ -4,6 +4,8 @@ exports.Text = void 0;
 exports.Text = {
     error: {
         invalidQueueName: `Queue names can only contain alphanumeric characters, dashes and underscores.`,
+        invalidEvent: `Event must be an object.`,
+        invalidEventBody: `Event body must be an object.`,
         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.`,

package/out/types.d.ts

@@ -1,26 +1,41 @@
-export declare type Payload = string | number | boolean | {
-    [key: string]: Payload;
-};
-export interface PushSettings {
-    delayInSeconds: number;
-}
+import { InvocationErrorCode } from './invocationErrorCode';
+export declare type Payload = Record<string, unknown>;
 export interface QueueParams {
     key: string;
 }
 export interface PushRequest extends APIRequest {
-    payload: Payload[];
+    payload: PushEvent[];
     schema: string;
     type: string;
-    delayInSeconds?: number;
+    jobId: string;
 }
 export interface APIRequest {
     queueName: string;
     jobId: string;
     time: string;
 }
+export interface PushEvent {
+    body: Body;
+    delayInSeconds?: number;
+}
+export declare type Body = Record<string, unknown>;
+export interface PushResult {
+    jobId: string;
+}
 export interface FailedEvent {
     errorMessage: string;
-    payload: Payload;
+    event: PushEvent;
+}
+export interface AsyncEvent extends PushEvent {
+    queueName: string;
+    jobId: string;
+    eventId: string;
+    retryContext?: RetryContext;
+}
+export interface RetryContext {
+    retryCount: number;
+    retryReason: InvocationErrorCode;
+    retryData: any;
 }
 export declare type GetStatsRequest = APIRequest;
 export declare type CancelJobRequest = APIRequest;

package/out/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,oBAAY,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,IAAI,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,oBAAY,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE3C,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,mBAAmB,CAAC;IACjC,SAAS,EAAE,GAAG,CAAC;CAChB;AAED,oBAAY,eAAe,GAAG,UAAU,CAAC;AACzC,oBAAY,gBAAgB,GAAG,UAAU,CAAC"}

package/out/validators.d.ts

@@ -1,12 +1,12 @@
 import { APIResponse } from '@forge/api';
-import { CancelJobRequest, GetStatsRequest, Payload, PushRequest, PushSettings } from './types';
+import { CancelJobRequest, GetStatsRequest, PushEvent, PushRequest, PushResult } 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 validatePushSettings: (event: PushEvent) => void;
+export declare function validatePushEvents(arg: PushEvent | PushEvent[]): PushEvent[];
 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 validatePushAPIResponse: (requestBody: PushRequest, response: APIResponse, result: PushResult) => 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":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAczC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAMhG,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"}
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAezC,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAMhG,eAAO,MAAM,gBAAgB,cAAe,MAAM,SAIjD,CAAC;AAEF,eAAO,MAAM,oBAAoB,UAAW,SAAS,SAIpD,CAAC;AAEF,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS,EAAE,CA6B5E;AAED,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,gBAAuB,WAAW,YAAY,WAAW,UAAU,UAAU,kBAkChH,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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushPayloads = exports.validatePushSettings = exports.validateQueueKey = void 0;
+exports.validateCancelJobAPIResponse = exports.validateGetStatsAPIResponse = exports.validatePushAPIResponse = exports.validateAPIResponse = exports.validateCancelJobRequest = exports.validateGetStatsPayload = exports.validatePushEvents = 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-_]+$/;
@@ -12,25 +12,36 @@ const validateQueueKey = (queueName) => {
     }
 };
 exports.validateQueueKey = validateQueueKey;
-const validatePushSettings = (settings) => {
-    if ((settings.delayInSeconds && settings.delayInSeconds > 900) || settings.delayInSeconds < 0) {
+const validatePushSettings = (event) => {
+    if ((event.delayInSeconds && event.delayInSeconds > 900) || (event.delayInSeconds && event.delayInSeconds < 0)) {
         throw new errors_1.InvalidPushSettingsError(text_1.Text.error.invalidDelayInSecondsSetting);
     }
 };
 exports.validatePushSettings = validatePushSettings;
-const validatePushPayloads = (payloads) => {
-    if (!payloads || (Array.isArray(payloads) && payloads.length === 0)) {
+function validatePushEvents(arg) {
+    const events = Array.isArray(arg) ? arg : [arg];
+    if (events.length === 0) {
         throw new errors_1.NoEventsToPushError(text_1.Text.error.noEventsPushed);
     }
-    if (Array.isArray(payloads) && payloads.length > MAXIMUM_EVENTS) {
+    if (events.length > MAXIMUM_EVENTS) {
         throw new errors_1.TooManyEventsError(text_1.Text.error.maxEventsAllowed(MAXIMUM_EVENTS));
     }
-    const payloadSizeKB = Buffer.byteLength(JSON.stringify(payloads)) / 1024;
+    for (const event of events) {
+        if (typeof event !== 'object' || Array.isArray(event) || event === null) {
+            throw new errors_1.InvalidPayloadError(text_1.Text.error.invalidEvent);
+        }
+        if (typeof event.body !== 'object' || Array.isArray(event.body) || event.body === null) {
+            throw new errors_1.InvalidPayloadError(text_1.Text.error.invalidEventBody);
+        }
+        (0, exports.validatePushSettings)(event);
+    }
+    const payloadSizeKB = Buffer.byteLength(JSON.stringify(events)) / 1024;
     if (payloadSizeKB > MAXIMUM_PAYLOAD_SIZE_KB) {
         throw new errors_1.PayloadTooBigError(text_1.Text.error.maxPayloadAllowed(MAXIMUM_PAYLOAD_SIZE_KB));
     }
-};
-exports.validatePushPayloads = validatePushPayloads;
+    return events;
+}
+exports.validatePushEvents = validatePushEvents;
 const validateGetStatsPayload = (getStatsRequest) => {
     if (!getStatsRequest.jobId) {
         throw new errors_1.JobDoesNotExistError(text_1.Text.error.jobIdEmpty);
@@ -67,7 +78,7 @@ const validateAPIResponse = async (response, expectedSuccessStatus) => {
     }
 };
 exports.validateAPIResponse = validateAPIResponse;
-const validatePushAPIResponse = async (response, requestBody) => {
+const validatePushAPIResponse = async (requestBody, response, result) => {
     if (response.status === 413) {
         const responseBody = await response.json();
         throw new errors_1.PayloadTooBigError(responseBody.errorMessage);
@@ -75,7 +86,7 @@ const validatePushAPIResponse = async (response, requestBody) => {
     if (response.status === 202) {
         const responseBody = await response.json();
         const defaultErrorMessage = 'Failed to process some events.';
-        const partialSuccessError = new errors_1.PartialSuccessError(defaultErrorMessage, []);
+        const partialSuccessError = new errors_1.PartialSuccessError(defaultErrorMessage, result, []);
         if (responseBody.failedEvents && responseBody.failedEvents.length > 0) {
             partialSuccessError.message = `Failed to process ${responseBody.failedEvents.length} event(s).`;
             partialSuccessError.failedEvents = responseBody.failedEvents.map((failedEvent) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/events",
-  "version": "1.1.0-next.0",
+  "version": "2.0.0-next.2",
   "description": "Forge Async Event methods",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",

package/src/__test__/jobProgress.test.ts

@@ -2,12 +2,14 @@ import { getMockFetchMethod, verifyApiClientCalledWith } from './utils';
 import { InternalServerError, InvalidQueueNameError, JobDoesNotExistError, RateLimitError } from '../errors';
 import { JobProgress } from '../jobProgress';
 import { __requestAtlassianAsApp } from '@forge/api';
+import { QueueParams } from '../types';
 
 jest.mock('@forge/api', () => ({
-  __requestAtlassianAsApp: getMockFetchMethod('done', 200)
+  __requestAtlassianAsApp: getMockFetchMethod({ done: true }, 200)
 }));
 
-const getJobProgress = (jobId: string, apiClientMock?: any) => new JobProgress(jobId, apiClientMock);
+const queueParams: QueueParams = { key: 'test-queue-name' };
+const getJobProgress = (jobId: string, apiClientMock?: any) => new JobProgress(queueParams, jobId, apiClientMock);
 
 describe('JobProgress methods', () => {
   describe('getStats', () => {
@@ -20,9 +22,8 @@ describe('JobProgress methods', () => {
         },
         200
       );
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-      const response = await jobProgress.getStats();
-      const { success, inProgress, failed } = await response.json();
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
+      const { success, inProgress, failed } = await jobProgress.getStats();
       verifyApiClientCalledWith(
         apiClientMock,
         '/webhook/queue/stats/{contextAri}/{environmentId}/{appId}/{appVersion}',
@@ -44,7 +45,7 @@ describe('JobProgress methods', () => {
         },
         404
       );
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
       await expect(jobProgress.getStats()).rejects.toThrow(
         new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
       );
@@ -60,7 +61,7 @@ describe('JobProgress methods', () => {
 
     it('should throw RateLimitError', async () => {
       const apiClientMock = getMockFetchMethod({}, 429);
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
       await expect(jobProgress.getStats()).rejects.toThrow(new RateLimitError(`Too many requests.`));
       verifyApiClientCalledWith(
         apiClientMock,
@@ -81,7 +82,7 @@ describe('JobProgress methods', () => {
         },
         513
       );
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
       await expect(jobProgress.getStats()).rejects.toThrow(
         new InternalServerError(`513 Status Text: Service is not available`, 513)
       );
@@ -99,8 +100,8 @@ describe('JobProgress methods', () => {
   describe('cancel', () => {
     it('should call the queue/cancel endpoint', async () => {
       const apiClientMock = getMockFetchMethod({}, 204);
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
-      const response = await jobProgress.cancel();
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
+      await jobProgress.cancel();
       verifyApiClientCalledWith(
         apiClientMock,
         '/webhook/queue/cancel/{contextAri}/{environmentId}/{appId}/{appVersion}',
@@ -109,7 +110,6 @@ describe('JobProgress methods', () => {
           jobId: 'test-job-id'
         }
       );
-      expect(response.status).toEqual(204);
     });
 
     it('should throw JobDoesNotExistError', async () => {
@@ -120,7 +120,7 @@ describe('JobProgress methods', () => {
         },
         404
       );
-      const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+      const jobProgress = getJobProgress('test-job-id', apiClientMock);
       await expect(jobProgress.cancel()).rejects.toThrow(
         new JobDoesNotExistError(`The job test-job-id was not found for the queue test-queue-name.`)
       );
@@ -142,7 +142,7 @@ describe('JobProgress methods', () => {
       },
       422
     );
-    const jobProgress = getJobProgress('test-queue-name#test-job-id', apiClientMock);
+    const jobProgress = getJobProgress('test-job-id', apiClientMock);
     await expect(jobProgress.getStats()).rejects.toThrow(
       new InternalServerError(`422 Status Text: jobId must not be null, queueName must not be null`)
     );
@@ -162,10 +162,10 @@ describe('JobProgress methods', () => {
       },
       200
     );
-    const jobProgress1 = getJobProgress('test-queue-name#', apiClientMock);
+    const jobProgress1 = getJobProgress('', apiClientMock);
     await expect(jobProgress1.getStats()).rejects.toThrow(new JobDoesNotExistError(`jobId cannot be empty.`));
 
-    const jobProgress2 = getJobProgress('#test-job-id', apiClientMock);
+    const jobProgress2 = new JobProgress({ key: '!' }, 'test-job-id', apiClientMock);
     await expect(jobProgress2.getStats()).rejects.toThrow(
       new InvalidQueueNameError('Queue names can only contain alphanumeric characters, dashes and underscores.')
     );
@@ -177,7 +177,7 @@ describe('JobProgress methods', () => {
   });
 
   it('requests stargate if no api client is provided', async () => {
-    const jobProgress = getJobProgress('test-queue-name#job-id');
+    const jobProgress = getJobProgress('job-id');
     await jobProgress.getStats();
     expect(__requestAtlassianAsApp).toHaveBeenCalledTimes(1);
   });