newErrorHandling removed

MrRefactoring · Oct 13, 2023 · 9cc1695 · 9cc1695
1 parent 3317f97
commit 9cc1695
Show file tree

Hide file tree

Showing 43 changed files with 42 additions and 110 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,6 @@ Usability, consistency, and performance are key focuses of jira.js, and it also
 
 - [Installation](#installation)
 - [Documentation](#documentation)
-- [Deprecation warnings](#deprecation-warnings)
 - [Usage](#usage)
   - [Authentication](#authentication)
     - [Basic](#basic-authentication)
@@ -50,56 +49,6 @@ yarn add jira.js
 
 You can find the documentation [here](https://mrrefactoring.github.io/jira.js/).
 
-## Deprecation warnings
-
-1.  Deprecation warning: New error handling mechanism added. Please use `newErrorHandling: true` in config
-> We are using a new error handling mechanism (instead throwing raw axios error will be showed API response). For enable it, make following changes in your config:
-> ```ts
-> const client = new Version3Client({
->   host: '...',
->   newErrorHandling: true, // This flag enable new error handling.
-> });
->
-> // Examples
->
-> /** Old error handling **/
->
-> const client = new Version3Client({ host: '...' });
->
-> client.issues.createIssue();
->
-> // Output:
-> // {
-> //   code: 'ERR_BAD_REQUEST',
-> //   config: { a lot of stuff here },
-> //   request: { a lot of stuff here },
-> //   response: {
-> //     a lot of stuff here
-> //     data: {
-> //       errorMessages: [],
-> //       errors: { project: 'Specify a valid project ID or key' }
-> //     },
-> //     a lot of stuff here
-> //   },
-> //   a lot of stuff here
-> // }
->
-> /** New error handling **/
->
-> const client = new Version3Client({ host: '...', newErrorHandling: true });
->
-> client.issues.createIssue();
->
-> // Output:
-> // {
-> //   code: 'ERR_BAD_REQUEST',
-> //   status: 400,
-> //   errorMessages: [],
-> //   errors: { project: 'Specify a valid project ID or key' }
-> // }
-> ```
-
-
 ## Usage
 
 #### Authentication
@@ -194,7 +143,6 @@ const client = new Version3Client({
       apiToken,
     },
   },
-  newErrorHandling: true,
 });
 
 async function main() {
@@ -273,9 +221,7 @@ Available groups:
   - [filterSharing](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-filter-sharing/#api-group-filter-sharing)
   - [groupAndUserPicker](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-group-and-user-picker/#api-group-group-and-user-picker)
   - [groups](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/#api-group-groups)
-  - [instanceInformation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-instance-information/#api-group-instance-information)
   - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-group-issues)
-  - [issueAdjustmentsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-adjustments--apps-/#api-group-issue-adjustments--apps-)
   - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-group-issue-attachments)
   - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-group-issue-comments)
   - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-)
@@ -366,7 +312,6 @@ Available groups:
   - [groups](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-group-groups)
   - [instanceInformation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-instance-information/#api-group-instance-information)
   - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-group-issues)
-  - [issueAdjustmentsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-adjustments--apps-/#api-group-issue-adjustments--apps-)
   - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-group-issue-attachments)
   - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-group-issue-comments)
   - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-)

diff --git a/examples/src/addFixVersion.ts b/examples/src/addFixVersion.ts
@@ -8,7 +8,6 @@ async function addFixVersion() {
     authentication: {
       basic: { email, apiToken },
     },
-    newErrorHandling: true,
   });
 
   const { id: issueIdOrKey } = await createIssue(client);

diff --git a/examples/src/addWorklog.ts b/examples/src/addWorklog.ts
@@ -8,7 +8,6 @@ async function addWorklog() {
     authentication: {
       basic: { email, apiToken },
     },
-    newErrorHandling: true,
   });
 
   // Used to reduce the amount of code that is not directly related to creating a worklog

diff --git a/examples/src/basic.ts b/examples/src/basic.ts
@@ -6,7 +6,6 @@ const client = new Version3Client({
   authentication: {
     basic: { email, apiToken },
   },
-  newErrorHandling: true,
 });
 
 async function main() {

diff --git a/examples/src/getAllWorklogs.ts b/examples/src/getAllWorklogs.ts
@@ -8,7 +8,6 @@ async function getAllWorklogs() {
     authentication: {
       basic: { email, apiToken }
     },
-    newErrorHandling: true,
   });
 
   // Used to reduce the amount of code that is not directly related to getting a worklogs

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.20.1",
+  "version": "3.0.0",
   "description": "A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.",
   "main": "out/index.js",
   "types": "out/index.d.ts",

diff --git a/src/clients/baseClient.ts b/src/clients/baseClient.ts
@@ -118,8 +118,7 @@ export class BaseClient implements Client {
   }
 
   handleFailedResponse<T>(e: Error, callback?: Callback<T> | never): void {
-    const err =
-      this.config.newErrorHandling && axios.isAxiosError(e) && e.response ? this.buildNewErrorHandlingResponse(e) : e;
+    const err = axios.isAxiosError(e) && e.response ? this.buildErrorHandlingResponse(e) : e;
 
     const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
     const defaultErrorHandler = (error: Error) => {
@@ -133,7 +132,7 @@ export class BaseClient implements Client {
     return errorHandler(err);
   }
 
-  private buildNewErrorHandlingResponse(error: AxiosError<any>) {
+  private buildErrorHandlingResponse(error: AxiosError<any>) {
     return {
       code: error.code,
       status: error.response?.status,

diff --git a/src/config.ts b/src/config.ts
@@ -10,8 +10,6 @@ export interface Config {
   baseRequestConfig?: Config.BaseRequestConfig;
   authentication?: Config.Authentication;
   middlewares?: Config.Middlewares;
-  /** Enable new API error handling. `false` by default. */
-  newErrorHandling?: boolean;
 }
 
 export namespace Config {

diff --git a/src/version2/models/comment.ts b/src/version2/models/comment.ts
@@ -10,7 +10,7 @@ export interface Comment {
   /** The date and time at which the comment was created. */
   created?: string;
   /** The ID of the comment. */
-  id: string;
+  id?: string;
   /**
    * Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external
    * emails to be added as comments on

diff --git a/src/version3/models/comment.ts b/src/version3/models/comment.ts
@@ -8,7 +8,7 @@ export interface Comment {
   /** The URL of the comment. */
   self?: string;
   /** The ID of the comment. */
-  id: string;
+  id?: string;
   author?: UserDetails;
   /**
    * The comment text in [Atlassian Document

diff --git a/tests/integration/utils/getClient.ts b/tests/integration/utils/getClient.ts
@@ -2,7 +2,6 @@ import { ClientType, Config, createClient } from '../../../src';
 
 const config = {
   host: process.env.HOST!,
-  newErrorHandling: true,
   authentication: {
     basic: {
       email: process.env.EMAIL!,

diff --git a/tests/unit/agile/board.test.ts b/tests/unit/agile/board.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import { AgileClient } from '../../../src';
 import test from 'ava';
 
-const config = { host: 'http://localhost', newErrorHandling: true };
+const config = { host: 'http://localhost' };
 
 test('getBoard should accept following parameters', t => {
   const client = new AgileClient(config);

diff --git a/tests/unit/agile/issue.test.ts b/tests/unit/agile/issue.test.ts
@@ -3,7 +3,7 @@ import { AgileClient } from '../../../src';
 import test from 'ava';
 
 test('getIssue should accept follow parameters', t => {
-  const client = new AgileClient({ host: 'http://localhost', newErrorHandling: true });
+  const client = new AgileClient({ host: 'http://localhost' });
   const sendRequestStub = sinon.stub(client, 'sendRequest');
 
   client.issue.getIssue({ issueIdOrKey: 'key' });

diff --git a/tests/unit/agile/sprint.test.ts b/tests/unit/agile/sprint.test.ts
@@ -3,7 +3,7 @@ import { AgileClient } from '../../../src';
 import test from 'ava';
 
 test('moveIssuesToSprintAndRank should accept follow parameters', t => {
-  const client = new AgileClient({ host: 'http://localhost', newErrorHandling: true });
+  const client = new AgileClient({ host: 'http://localhost' });
   const sendRequestStub = sinon.stub(client, 'sendRequest');
 
   client.sprint.moveIssuesToSprintAndRank({

diff --git a/tests/unit/clients/baseClient.test.ts b/tests/unit/clients/baseClient.test.ts
@@ -8,7 +8,6 @@ test('should create X-Atlassian-Token: no-check header in requests', t => {
   const client = new BaseClient({
     host: 'http://localhost',
     noCheckAtlassianToken: true,
-    newErrorHandling: true,
   });
 
   // @ts-ignore
@@ -32,7 +31,6 @@ test('should not create X-Atlassian-Token: no-check header in requests case 1',
   const client = new BaseClient({
     host: 'http://localhost',
     noCheckAtlassianToken: false,
-    newErrorHandling: true,
   });
 
   // @ts-ignore
@@ -55,7 +53,6 @@ test('should not create X-Atlassian-Token: no-check header in requests case 1',
 test('should create X-Atlassian-Token: no-check header in requests case 2', t => {
   const client = new BaseClient({
     host: 'http://localhost',
-    newErrorHandling: true,
   });
 
   // @ts-ignore

diff --git a/tests/unit/createClient.test.ts b/tests/unit/createClient.test.ts
@@ -1,7 +1,7 @@
 import test from 'ava';
 import { AgileClient, BaseClient, ClientType, createClient, Version2Client, Version3Client } from '../../src';
 
-const defaultConfig = { host: 'http://localhost', newErrorHandling: true };
+const defaultConfig = { host: 'http://localhost' };
 
 test('should create Agile client', t => {
   const client = createClient(ClientType.Agile, defaultConfig);

diff --git a/tests/unit/version2/appMigration.test.ts b/tests/unit/version2/appMigration.test.ts
@@ -8,7 +8,7 @@ const entity = {
   value: 'v',
 };
 
-const config = { host: 'http://localhost', newErrorHandling: true };
+const config = { host: 'http://localhost' };
 
 test('updateEntityPropertiesValue should accept actual parameters', t => {
   const client = new Version2Client(config);

diff --git a/tests/unit/version2/issueComments.test.ts b/tests/unit/version2/issueComments.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { IssueComments, Version2Client } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const issueComments = new IssueComments(client);
 

diff --git a/tests/unit/version2/issueFields.test.ts b/tests/unit/version2/issueFields.test.ts
@@ -3,7 +3,7 @@ import test from 'ava';
 import { Version2Client } from '../../../src';
 
 test('getFields should calls without parameters', t => {
-  const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+  const client = new Version2Client({ host: 'http://localhost' });
   const sendRequestStub = sinon.stub(client, 'sendRequest');
 
   client.issueFields.getFields();

diff --git a/tests/unit/version2/issueLinks.test.ts b/tests/unit/version2/issueLinks.test.ts
@@ -2,15 +2,15 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { IssueLinks, Version2Client } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 let issueLinks = new IssueLinks(client);
 
 test('linkIssues should calls without parameters', t => {
   issueLinks.linkIssues({
-    type: undefined,
-    inwardIssue: undefined,
-    outwardIssue: undefined,
+    type: {},
+    inwardIssue: {},
+    outwardIssue: {},
   });
 
   t.truthy(sendRequestStub.calledOnce);
@@ -19,8 +19,8 @@ test('linkIssues should calls without parameters', t => {
 
   t.deepEqual(callArgument.data, {
     comment: undefined,
-    inwardIssue: undefined,
-    outwardIssue: undefined,
-    type: undefined,
+    inwardIssue: {},
+    outwardIssue: {},
+    type: {},
   });
 });
diff --git a/tests/unit/version2/issuePriorities.test.ts b/tests/unit/version2/issuePriorities.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { IssuePriorities, Version2Client } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const issuePriorities = new IssuePriorities(client);
 

diff --git a/tests/unit/version2/issueRemoteLinks.test.ts b/tests/unit/version2/issueRemoteLinks.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { IssueRemoteLinks, Version2Client } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const issueRemoteLinks = new IssueRemoteLinks(client);
 

diff --git a/tests/unit/version2/issueSearch.test.ts b/tests/unit/version2/issueSearch.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { IssueSearch, Version2Client } from '../../../src/version2';
 
-const config = { host: 'http://localhost', newErrorHandling: true };
+const config = { host: 'http://localhost' };
 
 test('should be defined', t => {
   t.truthy(!!IssueSearch);

diff --git a/tests/unit/version2/issueVotes.test.ts b/tests/unit/version2/issueVotes.test.ts
@@ -3,7 +3,7 @@ import { IssueVotes } from '../../../src/version2';
 import test from 'ava';
 import { Version2Client } from '../../../src';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const issueVote = new IssueVotes(client);
 

diff --git a/tests/unit/version2/issueWatcher.test.ts b/tests/unit/version2/issueWatcher.test.ts
@@ -3,7 +3,7 @@ import test from 'ava';
 import { Version2Client } from '../../../src';
 
 test('addWatcher should accept accountId', t => {
-  const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+  const client = new Version2Client({ host: 'http://localhost' });
   const sendRequestStub = sinon.stub(client, 'sendRequest');
 
   client.issueWatchers.addWatcher({ issueIdOrKey: '', accountId: '101010' });

diff --git a/tests/unit/version2/issues.test.ts b/tests/unit/version2/issues.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { Version2Client } from '../../../src';
 
-const config = { host: 'http://localhost', newErrorHandling: true };
+const config = { host: 'http://localhost' };
 
 test('createIssue should accept follow parameters', t => {
   const client = new Version2Client(config);

diff --git a/tests/unit/version2/myself.test.ts b/tests/unit/version2/myself.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { Myself, Version2Client } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const myself = new Myself(client);
 

diff --git a/tests/unit/version2/projectVersions.test.ts b/tests/unit/version2/projectVersions.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { ProjectVersions, Version2Client } from '../../../src/version2';
 
-const config = { host: 'http://localhost', newErrorHandling: true };
+const config = { host: 'http://localhost' };
 
 test('should be defined', t => {
   t.truthy(!!ProjectVersions);

diff --git a/tests/unit/version2/workflowStatuses.test.ts b/tests/unit/version2/workflowStatuses.test.ts
@@ -2,7 +2,7 @@ import * as sinon from 'sinon';
 import test from 'ava';
 import { Version2Client, WorkflowStatuses } from '../../../src/version2';
 
-const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true });
+const client = new Version2Client({ host: 'http://localhost' });
 const sendRequestStub = sinon.stub(client, 'sendRequest');
 const workflowStatuses = new WorkflowStatuses(client);