@forge/events 0.0.0-experimental-490cfcf → 0.0.0-experimental-51786e9

package/src/__test__/queue.test.ts

@@ -9,17 +9,22 @@ import {
   InvalidPushSettingsError,
   InvocationLimitReachedError
 } from '../errors';
-import { getApiClientMock, getApiClientMockWithoutResponseBody, verifyApiClientCalledPushPathWith } from './utils';
+import { getMockFetchMethod, getApiClientMockWithoutResponseBody, verifyApiClientCalledPushPathWith } from './utils';
 import { Queue } from '../queue';
 import { JobProgress } from '../jobProgress';
+import { createRequestStargateAsApp } from '@forge/api';
 
-const getQueue = (apiClientMock: any, queueName: string) => new Queue({ key: queueName }, apiClientMock);
+jest.mock('@forge/api', () => ({
+  createRequestStargateAsApp: jest.fn().mockReturnValue(getMockFetchMethod('done', 201))
+}));
+
+const getQueue = (queueName: string, apiClientMock?: any) => new Queue({ key: queueName }, apiClientMock);
 
 describe('Queue methods', () => {
   describe('constructor', () => {
     it('should throw InvalidQueueNameError', async () => {
-      const apiClientMock = getApiClientMock();
-      expect(() => getQueue(apiClientMock, 'invalid name')).toThrowError(
+      const apiClientMock = getMockFetchMethod();
+      expect(() => getQueue('invalid name', apiClientMock)).toThrowError(
         new InvalidQueueNameError('Queue names can only contain alphanumeric characters, dashes and underscores.')
       );
     });
@@ -27,8 +32,8 @@ describe('Queue methods', () => {
 
   describe('push', () => {
     it('should call the queue/publish endpoint', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       const payload = {
         page: 1
       };
@@ -37,8 +42,8 @@ describe('Queue methods', () => {
     });
 
     it('should throw InvalidPushSettingsError for delay', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       await expect(queue.push(1, { delayInSeconds: 901 })).rejects.toThrow(
         new InvalidPushSettingsError(`The delayInSeconds setting must be between 0 and 900.`)
       );
@@ -46,15 +51,15 @@ describe('Queue methods', () => {
     });
 
     it('should throw NoEventsToPushError', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       await expect(queue.push([])).rejects.toThrow(new NoEventsToPushError(`No events pushed.`));
       expect(apiClientMock).toHaveBeenCalledTimes(0);
     });
 
     it('should throw TooManyEventsError', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       await expect(queue.push([...Array(51).keys()])).rejects.toThrow(
         new TooManyEventsError(`This push contains more than the 50 events allowed.`)
       );
@@ -62,8 +67,8 @@ describe('Queue methods', () => {
     });
 
     it('should throw PayloadTooBigError', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       await expect(queue.push('x'.repeat(201 * 1024))).rejects.toThrow(
         new PayloadTooBigError(`The maximum payload size is 200KB.`)
       );
@@ -71,16 +76,16 @@ describe('Queue methods', () => {
     });
 
     it('should throw RateLimitError', async () => {
-      const apiClientMock = getApiClientMock({}, 429);
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod({}, 429);
+      const queue = getQueue('name', apiClientMock);
       const payload = [...Array(10).keys()];
       await expect(queue.push(payload)).rejects.toThrow(new RateLimitError(`Too many requests.`));
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
 
     it('should throw InvocationLimitReachedError', async () => {
-      const apiClientMock = getApiClientMock({}, 405);
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod({}, 405);
+      const queue = getQueue('name', apiClientMock);
       const payload = [...Array(5).keys()];
       await expect(queue.push(payload)).rejects.toThrow(
         new InvocationLimitReachedError(`The limit on cyclic invocation has been reached.`)
@@ -89,7 +94,7 @@ describe('Queue methods', () => {
     });
 
     it('should throw PartialSuccessError when there are failed events', async () => {
-      const apiClientMock = getApiClientMock(
+      const apiClientMock = getMockFetchMethod(
         {
           failedEvents: [
             {
@@ -104,7 +109,7 @@ describe('Queue methods', () => {
         },
         202
       );
-      const queue = getQueue(apiClientMock, 'name');
+      const queue = getQueue('name', apiClientMock);
       const payload = [
         {
           content: 'payload-1'
@@ -136,13 +141,13 @@ describe('Queue methods', () => {
     });
 
     it('should throw PartialSuccessError when backend failed to create job stats', async () => {
-      const apiClientMock = getApiClientMock(
+      const apiClientMock = getMockFetchMethod(
         {
           errorMessage: 'Failed to create stats for job name#12345'
         },
         202
       );
-      const queue = getQueue(apiClientMock, 'name');
+      const queue = getQueue('name', apiClientMock);
       const payload = [
         {
           content: 'payload-1'
@@ -161,7 +166,7 @@ describe('Queue methods', () => {
     });
 
     it('should throw PartialSuccessError when there are failed events and backend failed to create job stats', async () => {
-      const apiClientMock = getApiClientMock(
+      const apiClientMock = getMockFetchMethod(
         {
           errorMessage: 'Failed to create stats for job name#12345',
           failedEvents: [
@@ -173,7 +178,7 @@ describe('Queue methods', () => {
         },
         202
       );
-      const queue = getQueue(apiClientMock, 'name');
+      const queue = getQueue('name', apiClientMock);
       const payload = [
         {
           content: 'payload-1'
@@ -196,7 +201,7 @@ describe('Queue methods', () => {
     });
 
     it('should throw InternalServerError', async () => {
-      const apiClientMock = getApiClientMock(
+      const apiClientMock = getMockFetchMethod(
         {
           message: 'AWS SQS timed out',
           code: 500,
@@ -204,7 +209,7 @@ describe('Queue methods', () => {
         },
         500
       );
-      const queue = getQueue(apiClientMock, 'name');
+      const queue = getQueue('name', apiClientMock);
       const payload = [...Array(9).keys()];
       await expect(queue.push(payload)).rejects.toThrow(
         new InternalServerError(
@@ -218,17 +223,23 @@ describe('Queue methods', () => {
 
     it('should throw InternalServerError for error response without response body', async () => {
       const apiClientMock = getApiClientMockWithoutResponseBody(504, 'Gateway Timeout');
-      const queue = getQueue(apiClientMock, 'name');
+      const queue = getQueue('name', apiClientMock);
       const payload = [1];
       await expect(queue.push(1)).rejects.toThrow(new InternalServerError(`504 Gateway Timeout`, 504));
       verifyApiClientCalledPushPathWith(apiClientMock, payload, 'name');
     });
+
+    it('requests stargate if no api client is provided', async () => {
+      const queue = getQueue('queue');
+      await queue.push({ test: 'stargate' });
+      expect(createRequestStargateAsApp()).toBeCalledTimes(1);
+    });
   });
 
   describe('getJob', () => {
     it('should create a JobProgress by jobId', async () => {
-      const apiClientMock = getApiClientMock();
-      const queue = getQueue(apiClientMock, 'name');
+      const apiClientMock = getMockFetchMethod();
+      const queue = getQueue('name', apiClientMock);
       const jobProgress = queue.getJob('test-job-id');
       expect(jobProgress).toEqual(new JobProgress('test-job-id', apiClientMock));
     });

package/src/__test__/utils.ts

@@ -1,6 +1,6 @@
 import { Payload } from '../types';
 
-export const getApiClientMock = (response?: any, statusCode = 201) => {
+export const getMockFetchMethod = (response?: any, statusCode = 201) => {
   return jest.fn().mockReturnValue({
     created: statusCode === 201,
     status: statusCode,

package/src/index.ts

@@ -13,3 +13,6 @@ export {
 } from './errors';
 export { JobProgress } from './jobProgress';
 export { QueueResponse } from './queueResponse';
+export { InvocationError } from './invocationError';
+export { InvocationErrorCode } from './invocationErrorCode';
+export { RetryOptions } from './retryOptions';

package/src/invocationError.ts

@@ -0,0 +1,22 @@
+import { DEFAULT_RETRY_OPTIONS, MIN_RETRY_AFTER, RetryOptions } from './retryOptions';
+import { Response } from './queueResponse';
+
+export class InvocationError extends Response {
+  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;
+  }
+
+  /***
+   * Function to convert class object to JSON object so that app function return this as part of lambda invocation.
+   */
+  public toJSON(): { _retry: boolean; retryOptions: RetryOptions } {
+    return {
+      _retry: this._retry,
+      retryOptions: this.retryOptions
+    };
+  }
+}

package/src/invocationErrorCode.ts

@@ -0,0 +1,8 @@
+export enum InvocationErrorCode {
+  FUNCTION_OUT_OF_MEMORY = 'FUNCTION_OUT_OF_MEMORY',
+  FUNCTION_TIME_OUT = 'FUNCTION_TIME_OUT',
+  FUNCTION_PLATFORM_UNKNOWN_ERROR = 'FUNCTION_PLATFORM_UNKNOWN_ERROR',
+  FUNCTION_PLATFORM_RATE_LIMITED = 'FUNCTION_PLATFORM_RATE_LIMITED',
+  FUNCTION_UPSTREAM_RATE_LIMITED = 'FUNCTION_UPSTREAM_RATE_LIMITED',
+  FUNCTION_RETRY_REQUEST = 'FUNCTION_RETRY_REQUEST'
+}

package/src/jobProgress.ts

@@ -6,6 +6,7 @@ import {
   validateGetStatsPayload
 } from './validators';
 import { APIResponse, CancelJobRequest, FetchMethod, GetStatsRequest } from './types';
+import { createRequestStargateAsApp } from '@forge/api';
 
 export class JobProgress {
   private readonly apiClient: FetchMethod;
@@ -13,7 +14,7 @@ export class JobProgress {
 
   constructor(id: string, apiClient?: FetchMethod) {
     this.id = id;
-    this.apiClient = apiClient || (global as any).api.asApp().__requestAtlassian;
+    this.apiClient = apiClient || createRequestStargateAsApp();
   }
 
   async getStats(): Promise<APIResponse> {

package/src/queue.ts

@@ -3,6 +3,7 @@ import { validatePushAPIResponse, validatePushPayloads, validateQueueKey, valida
 import { FetchMethod, Payload, QueueParams, PushSettings, PushRequest } from './types';
 import uuid from 'uuid/v4';
 import { JobProgress } from './jobProgress';
+import { createRequestStargateAsApp } from '@forge/api';
 
 export class Queue {
   private readonly apiClient: FetchMethod;
@@ -11,7 +12,7 @@ export class Queue {
   constructor(queueParams: QueueParams, apiClient?: FetchMethod) {
     validateQueueKey(queueParams.key);
     this.queueParams = queueParams;
-    this.apiClient = apiClient || (global as any).api.asApp().__requestAtlassian;
+    this.apiClient = apiClient || createRequestStargateAsApp();
   }
 
   async push(payloads: Payload | Payload[], pushSettings?: PushSettings): Promise<string> {

package/src/queueResponse.ts

@@ -1,5 +1,11 @@
-export class QueueResponse {
-  protected _retry = false;
+export class Response {
+  constructor(protected _retry: boolean) {}
+}
+
+export class QueueResponse extends Response {
+  constructor() {
+    super(false);
+  }
 
   retry(): void {
     this._retry = true;

package/src/retryOptions.ts

@@ -0,0 +1,14 @@
+import { InvocationErrorCode } from './invocationErrorCode';
+
+export const MIN_RETRY_AFTER = 1;
+
+export const DEFAULT_RETRY_OPTIONS = {
+  retryAfter: MIN_RETRY_AFTER,
+  retryReason: InvocationErrorCode.FUNCTION_RETRY_REQUEST
+};
+
+export interface RetryOptions {
+  retryAfter: number;
+  retryReason: InvocationErrorCode;
+  retryData?: any;
+}