Skip to content

fix: align Jira provider with jira-cli commands #474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
haosenwang1018 wants to merge 1 commit into from
Closed

fix: align Jira provider with jira-cli commands #474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 20 additions & 7 deletions src/issue-providers/jira-provider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ class JiraProvider extends IssueProvider {
static id = 'jira';
static displayName = 'Jira';

static getAuthCheckCommand() {
return 'jira me';
}

static getIssueViewCommand(issueKey) {
return `jira issue view ${issueKey} --raw`;
}

/**
* Detect Jira issue keys and URLs
* Matches:
Expand Down Expand Up @@ -71,9 +79,14 @@ class JiraProvider extends IssueProvider {
*/
static checkAuth() {
try {
// go-jira uses 'jira session' to verify authentication
// If not configured, it fails with endpoint/login errors
execSync('jira session', { encoding: 'utf8', stdio: 'pipe', timeout: AUTH_CHECK_TIMEOUT_MS });
// ankitpokhrel/jira-cli exposes `jira me` for auth verification and is the
// same CLI family used by fetchIssue(). Keep the auth check aligned with
// the actual commands this provider runs.
execSync(JiraProvider.getAuthCheckCommand(), {
encoding: 'utf8',
stdio: 'pipe',
timeout: AUTH_CHECK_TIMEOUT_MS,
});
return { authenticated: true, error: null, recovery: [] };
} catch (err) {
const stderr = err.stderr || err.message || '';
Expand All @@ -92,8 +105,8 @@ class JiraProvider extends IssueProvider {
if (stderr.includes('Command timed out')) {
return {
authenticated: false,
error: 'jira session timed out',
recovery: ['Retry: jira session', 'Check ~/.jira.d/config.yml for endpoint/login'],
error: 'jira me timed out',
recovery: ['Retry: jira me', 'Check your jira CLI auth/config for endpoint/login'],
};
}

Expand All @@ -111,7 +124,7 @@ class JiraProvider extends IssueProvider {
'Create ~/.jira.d/config.yml with your Jira endpoint',
'See: https://github.com/go-jira/jira#configuration',
'Example config:\n endpoint: https://yourcompany.atlassian.net\n login: your-email@company.com',
'Then verify: jira session',
'Then verify: jira me',
],
};
}
Expand Down Expand Up @@ -167,7 +180,7 @@ class JiraProvider extends IssueProvider {
const issueKey = this._extractIssueKey(identifier, settings);

// Fetch issue using jira CLI
const cmd = `jira issue view ${issueKey} --template json`;
const cmd = JiraProvider.getIssueViewCommand(issueKey);
const output = execSync(cmd, { encoding: 'utf8' });
const issue = JSON.parse(output);

Expand Down
8 changes: 8 additions & 0 deletions tests/issue-providers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,14 @@ describe('Jira Provider', () => {
expect(tool.name).to.equal('jira');
expect(tool.checkCmd).to.equal('jira version');
});

it('uses jira-cli auth command for auth checks', () => {
expect(JiraProvider.getAuthCheckCommand()).to.equal('jira me');
});

it('uses --raw when fetching issue payloads', () => {
expect(JiraProvider.getIssueViewCommand('PROJ-123')).to.equal('jira issue view PROJ-123 --raw');
});
});

describe('Azure DevOps Provider', () => {
Expand Down