Merge pull request #3 from KnisterPeter/fix-status

fix: update status async

Author: KnisterPeter

README.md

@@ -17,3 +17,7 @@ This vscode extension integrates with JIRA.
 Store your project setup in `.vscode/settings.json` and add the keys `jira.baseUrl` and `jira.projectNames`.
 
 Then setup your credentials first by running `Setup credentials...` command.
+
+# Resources
+
+Based on [JIRA APIs](https://docs.atlassian.com/jira/REST/)

src/api.ts

@@ -3,6 +3,7 @@ import { Pretend, Get, Post, Interceptor, IPretendRequestInterceptor, IPretendDe
 export interface Jira {
   serverInfo(): Promise<ServerInfo>;
   search(params: {jql: string}): Promise<Issues>;
+  getIssue(issue: string): Promise<Issue>;
   getTransitions(issue: string): Promise<Transitions>;
   doTransition(issue: string, body: DoTransitionBody): Promise<void>;
 }
@@ -91,6 +92,8 @@ namespace impl {
     public serverInfo(): any {/* */}
     @Post('/rest/api/2/search')
     public search(): any {/* */}
+    @Get('/rest/api/2/issue/:issue')
+    public getIssue(): any {/* */}
     @Get('/rest/api/2/issue/:issue/transitions')
     public getTransitions(): any {/* */}
     @Post('/rest/api/2/issue/:issue/transitions')

src/commands/activate-issue.ts

@@ -3,7 +3,7 @@ import * as vscode from 'vscode';
 
 import { Issue } from '../api';
 import { Command } from '../command';
-import state, { ActiveIssue } from '../state';
+import state, { ActiveIssue, getActiveIssue, setActiveIssue } from '../state';
 
 export class ActivateIssueCommand implements Command {
 
@@ -12,30 +12,18 @@ export class ActivateIssueCommand implements Command {
   @bind
   public async run(preselected: Issue | null): Promise<void> {
     const issue = await this.selectIssue(preselected);
-    if (issue !== undefined && state.workspaceState) {
-      const activeIssue: ActiveIssue = {
-        key: issue ? issue.key : undefined,
-        status: issue ? issue.fields.status.name : undefined
-      };
-      state.workspaceState.update('vscode-jira:active-issue', activeIssue);
-      state.update();
+    if (issue !== undefined) {
+      setActiveIssue(issue);
     }
   }
 
   private async selectIssue(preselected: Issue | null): Promise<Issue | null | undefined> {
     if (preselected || preselected === null) {
       return preselected;
     }
-    const activateIssue = this.getActiveIssue();
-    const name = activateIssue && activateIssue.key
-      ? `Deactivate ${activateIssue.key}`
-      : undefined;
+    const activateIssue = getActiveIssue();
+    const name = activateIssue ? `Deactivate ${activateIssue.key}` : undefined;
     return await vscode.commands.executeCommand<Issue | undefined | null>('vscode-jira.listMyIssues', name);
   }
 
-  private getActiveIssue(): ActiveIssue | undefined {
-    if (state.workspaceState) {
-      return state.workspaceState.get('vscode-jira:active-issue');
-    }
-  }
 }

src/commands/browse-my-issues.ts

@@ -16,7 +16,7 @@ export class BrowseMyIssuesCommand implements Command {
 
   @bind
   public async run(): Promise<void> {
-    const issue = await vscode.commands.executeCommand<Issue | undefined>('vscode-jira.listMyIssues', false);
+    const issue = await vscode.commands.executeCommand<Issue | undefined>('vscode-jira.listMyIssues');
     if (issue) {
       const url = `${this.baseUrl}/browse/${issue.key}`;
       await vscode.commands.executeCommand('vscode.open', vscode.Uri.parse(url));

src/commands/list-my-issues.ts

@@ -3,26 +3,29 @@ import * as vscode from 'vscode';
 
 import { Issue } from '../api';
 import { Command } from '../command';
+import { checkEnabled } from '../extension';
 import state from '../state';
 
 export class ListMyIssuesCommand implements Command<Issue | undefined | null> {
 
   public id = 'vscode-jira.listMyIssues';
 
-  private baseUrl: string | undefined;
+  private baseUrl: string;
 
-  private projectNames: string[] | undefined;
+  private projectNames: string[];
 
   constructor(baseUrl: string | undefined, projectNames: string[] | undefined) {
-    this.baseUrl = baseUrl;
-    this.projectNames = projectNames;
+    if (baseUrl) {
+      this.baseUrl = baseUrl;
+    }
+    if (projectNames) {
+      this.projectNames = projectNames;
+    }
   }
 
   @bind
-  public async run(withEmpty: string): Promise<Issue | undefined | null> {
-    if (!state.jira || !this.baseUrl || !this.projectNames) {
-      vscode.window.showInformationMessage(
-        'No JIRA client configured. Setup baseUrl, projectNames, username and password');
+  public async run(withEmpty?: string): Promise<Issue | undefined | null> {
+    if (!checkEnabled()) {
       return;
     }
     const issues = await state.jira.search({
@@ -53,6 +56,7 @@ export class ListMyIssuesCommand implements Command<Issue | undefined | null> {
     if (selected) {
       return selected.issue;
     }
+    return undefined;
   }
 
 }

src/commands/setup-credentials.ts

@@ -41,7 +41,7 @@ export class SetupCredentialsCommand implements Command {
     }
     await this.context.globalState.update(`vscode-jira:${this.baseUrl}`,
       `${username}${CREDENTIALS_SEPARATOR}${password}`);
-    state.jira = await connectToJira();
+    state.jira = (await connectToJira())!;
     state.update();
   }
 

src/commands/transition-issue.ts

@@ -3,21 +3,20 @@ import * as vscode from 'vscode';
 
 import { Issue, Transition } from '../api';
 import { Command } from '../command';
-import state, { ActiveIssue } from '../state';
+import { checkEnabled } from '../extension';
+import state, { ActiveIssue, getActiveIssue } from '../state';
 
 export class TransitionIssueCommand implements Command {
 
   public id = 'vscode-jira.transitionIssues';
 
   @bind
   public async run(withDeactivation = true): Promise<void> {
-    if (!state.jira) {
-      vscode.window.showInformationMessage(
-        'No JIRA client configured. Setup baseUrl, projectNames, username and password');
+    if (!checkEnabled()) {
       return;
     }
-    const activeIssue = this.getActiveIssue();
-    if (activeIssue && activeIssue.key) {
+    const activeIssue = getActiveIssue();
+    if (activeIssue) {
       const selected = await this.selectTransition(withDeactivation, activeIssue);
       if (selected === null) {
         await vscode.commands.executeCommand('vscode-jira.activateIssues', null);
@@ -35,9 +34,6 @@ export class TransitionIssueCommand implements Command {
 
   private async selectTransition(withActivation: boolean, activeIssue: ActiveIssue):
       Promise<Transition | null | undefined> {
-    if (!state.jira || !activeIssue.key) {
-      return;
-    }
     const transitions = await state.jira.getTransitions(activeIssue.key);
     const picks = transitions.transitions.map(transition => ({
       label: transition.to.name || transition.name,
@@ -64,16 +60,7 @@ export class TransitionIssueCommand implements Command {
     return `Deactivate ${activeIssue.key}`;
   }
 
-  private getActiveIssue(): ActiveIssue | undefined {
-    if (state.workspaceState) {
-      return state.workspaceState.get('vscode-jira:active-issue');
-    }
-  }
-
   private async deactivateWhenDone(activeIssue: ActiveIssue): Promise<void> {
-    if (!state.jira || !activeIssue.key) {
-      return;
-    }
     const result = await state.jira.search({jql: `issue = "${activeIssue.key}" AND resolution = Resolved`});
     if (result.issues.length > 0) {
       vscode.commands.executeCommand('vscode-jira.activateIssues', null);

src/extension.ts

@@ -33,7 +33,7 @@ export function activate(_context: vscode.ExtensionContext): void {
     if (credentials) {
       const connect = async() => {
         const [username, password] = credentials.split(CREDENTIALS_SEPARATOR);
-        state.jira = await connectToJira();
+        state.jira = (await connectToJira())!;
         state.update();
       };
       connect().catch(() => {
@@ -54,6 +54,16 @@ export function activate(_context: vscode.ExtensionContext): void {
   context.subscriptions.push(new StatusBarManager());
 }
 
+export function checkEnabled(): boolean {
+  const config = vscode.workspace.getConfiguration('jira');
+  if (!state.jira || !config.has('baseUrl') || !config.has('projectNames')) {
+    vscode.window.showInformationMessage(
+      'No JIRA client configured. Setup baseUrl, projectNames, username and password');
+    return false;
+  }
+  return true;
+}
+
 export async function connectToJira(): Promise<Jira | undefined> {
   const credentials: string | undefined = context.globalState.get(`vscode-jira:${baseUrl}`);
   if (credentials && baseUrl) {
@@ -67,4 +77,5 @@ export async function connectToJira(): Promise<Jira | undefined> {
     }
     return client;
   }
+  return undefined;
 }

src/state.ts

@@ -1,23 +1,42 @@
 import * as vscode from 'vscode';
-import { Jira } from './api';
+import { Jira, Issue } from './api';
 
 export interface State {
-  jira?: Jira;
+  jira: Jira;
   workspaceState?: vscode.Memento;
   subscriber: (() => void)[];
   update(): void;
 }
 
 export interface ActiveIssue {
-  key?: string;
-  status?: string;
+  key: string;
 }
 
 const state: State = {
+  jira: undefined as any,
   subscriber: [],
   update(): void {
     this.subscriber.forEach(subscriber => subscriber());
   }
 };
 
 export default state;
+
+export function getActiveIssue(): ActiveIssue | undefined {
+  if (state.workspaceState) {
+    return state.workspaceState.get('vscode-jira:active-issue');
+  }
+  return undefined;
+}
+
+export function setActiveIssue(issue: Issue | null): void {
+  if (state.workspaceState) {
+    state.workspaceState.update('vscode-jira:active-issue', issue
+      ? {
+          key: issue.key
+        }
+      : undefined
+    );
+    state.update();
+  }
+}

src/status-bar.ts

@@ -1,24 +1,30 @@
 import * as vscode from 'vscode';
 
-import state, { ActiveIssue } from './state';
+import state, { ActiveIssue, getActiveIssue } from './state';
 
 export class StatusBarManager {
 
   private item: vscode.StatusBarItem;
 
+  private interval: NodeJS.Timer;
+
   constructor() {
     this.item = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 0);
     this.item.text = '$(issue-opened)';
     state.subscriber.push(() => {
       this.updateStatus();
     });
+    this.interval = setInterval(() => {
+      this.updateStatus();
+    }, 1000 * 60 * 5);
   }
 
-  public updateStatus(): void {
+  private async updateStatus(): Promise<void> {
     this.item.show();
-    const activeIssue = this.getActiveIssue();
-    if (activeIssue && activeIssue.key) {
-      this.item.text = `$(issue-opened) ${activeIssue.key} ${activeIssue.status}`;
+    const activeIssue = getActiveIssue();
+    if (activeIssue) {
+      const issue = await state.jira.getIssue(activeIssue.key);
+      this.item.text = `$(issue-opened) ${activeIssue.key} ${issue.fields.status.name}`;
       this.item.tooltip = 'Click to transition issue...';
       this.item.command = 'vscode-jira.transitionIssues';
     } else {
@@ -28,13 +34,8 @@ export class StatusBarManager {
     }
   }
 
-  private getActiveIssue(): ActiveIssue | undefined {
-    if (state.workspaceState) {
-      return state.workspaceState.get('vscode-jira:active-issue');
-    }
-  }
-
   public dispose(): void {
     this.item.dispose();
+    clearInterval(this.interval);
   }
 }