feat: Integrate with Azure Devops #2388

BalighMehrez · 2022-12-26T15:43:33Z

Description

Integration with Azure DevOps boards.

Issues Resolved

#356

Check List

New functionality includes testing.
New functionality has been documented in the README if applicable.

github-actions

Hello there BalighMehrez! 👋

Thank you and congrats 🎉 for opening your first PR on this project! ✨ 💖

We will try to review it soon!

johannesjo · 2023-01-04T18:23:06Z

Thank you very much!! I try to have a look tomorrow!

johannesjo · 2023-01-05T13:37:07Z

There seem to be some minor linting errors:

Linting "sp2"...

/home/runner/work/super-productivity/super-productivity/src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts
Error:   72:1  error  This line has a length of 244. Maximum allowed is 150  max-len
Lint errors found in the listed files.


/home/runner/work/super-productivity/super-productivity/src/app/features/issue/providers/azuredevops/azuredevops-common-interfaces.service.ts
Error:   4:[10](https://github.com/johannesjo/super-productivity/actions/runs/3782159290/jobs/6539750367#step:8:11)  error  'catchError' is defined but never used  @typescript-eslint/no-unused-vars
Error:   4:10  error  'catchError' is defined but never used  unused-imports/no-unused-imports
Error:   4:45  error  'switchMap' is defined but never used   @typescript-eslint/no-unused-vars
Error:   4:45  error  'switchMap' is defined but never used   unused-imports/no-unused-imports

✖ 5 problems (5 errors, 0 warnings)
  2 errors and 0 warnings potentially fixable with the `--fix` option.

Error: Process completed with exit code 1.

PsikoBlock · 2023-01-09T14:32:57Z

src/app/features/issue/providers/azuredevops/azuredevops.const.ts

+export const AZUREDEVOPS_POLL_INTERVAL = 10 * 60 * 1000;
+export const AZUREDEVOPS_INITIAL_POLL_DELAY = 8 * 1000;
+
+export const AZUREDEVOPS_API_BASE_URL = 'https://dev.azure.com';


Just thought of this integration when discussing in my team, awesome that you are on it! Will definitely try this out. One request: can you please make this URL configurable? My employer uses on-premise Azure DevOps Server.

rklec

Hi thanks a lot for working on it! 🎉 I am personally curious to test this out. I've left some comments, where I see potential problems (especially with the self-hosted/on-premise Azure DevOps Server) or ideas for improvement.

rklec · 2023-01-09T15:43:31Z

src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts

+    );
+  }
+
+  wiql$(cfg: AzuredevopsCfg, query: string): Observable<AzuredevopsWIQLSearchResult> {


What is this abbreviation about? Maybe use a non-abbreviated name?

WIQL is a query language used to query work items form Azure DevOps APIs, it stands for (Work Items Query Language).

rklec · 2023-01-09T15:46:18Z

src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts

+  getById$(issueId: number, cfg: AzuredevopsCfg): Observable<AzuredevopsIssue> {
+    return this._sendRequest$(
+      {
+        url: `${BASE}/${cfg.organization}/${cfg.project}/_apis/wit/workitems/${issueId}?fields=${WIT_FIELDS_STR}&api-version=7.1-preview.3`,


api-version=7.1-preview.3 -> maybe use more stable API version? I.e. at least not a preview build?

This table here shows the latest stable is 6.0, which is Azure DevOps Server 2020 (build 18.170.30525.1), your version would be 7.1, which is a good development target, but the integration should be possible with at least some somewhat recent version.

Also it would be good to note somewhere, with which Azure DevOps version this is compatible/which does it require?

See also: API docs

Good point,
this should be configurable for compatibility with on-premise versions, as some users still work with older versions as well.

Yeah, depends on how the API may have changed in previous versions (i.e. which is the minimal API version your code works with). But if it is configurable, then people could just "try it out".

rklec · 2023-01-09T15:47:55Z

src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts

+    const owner = cfg.filterUsername;
+    return this.wiql$(
+      cfg,
+      ` Select [System.Id], [System.Title], [System.State] From WorkItems Where [State] <> 'Closed' AND [State] <> 'Removed' AND [System.AssignedTo] contains '${owner}' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc `,


This query should potentially be configurable, should not it? At least for the Jira integration, their query system is configurable in SuperProducitivity.

One use case I have in mind is that one may want to filter the items by their Epic, because one may use one epic per (sub)project.

rklec · 2023-01-09T15:49:59Z

src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts

+export class AzuredevopsApiService {
+  constructor(private _snackService: SnackService, private _http: HttpClient) {}
+
+  getById$(issueId: number, cfg: AzuredevopsCfg): Observable<AzuredevopsIssue> {


IMHO abbreviations such as cfg for configshould be discouraged, as it decreases readability, but that is a thing the maintainer should decide.

Agree with you, but I wanted it to be much closer to current integrations, so I have just used same abbreviations and naming conventions I have found.

rklec · 2023-01-09T15:50:27Z

src/assets/i18n/en.json

+        "WRITE_A_COMMENT": "Write a comment"
+      },
+      "S": {
+        "ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. Api Rate limit exceeded?"


Suggested change

"ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. Api Rate limit exceeded?"

"ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. API rate limit exceeded?"

spelling

Suggested change

"ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. Api Rate limit exceeded?"

"ERR_UNKNOWN": "Azure DevOps: Unknown error {{statusCode}} {{errorMsg}}. API rate limit exceeded?"

Also AFAIK/IIRC that is the official spelling of the service.

rklec · 2023-01-09T16:08:12Z

src/app/features/issue/providers/azuredevops/azuredevops-issue/azuredevops-issue-map.util.ts

+export const mapAzuredevopsReducedIssueFromWIQL = (
+  workItem: any,
+): AzuredevopsIssueReduced => {
+  console.log(workItem);


This was just there for debugging and should be removed in prod code then, should not it?

rklec · 2023-01-09T16:09:46Z

...edevops/azuredevops-issue/azuredevops-issue-content/azuredevops-issue-content.component.scss

@@ -0,0 +1,56 @@
+@import 'src/variables';
+
+// table styled by ./src/styles/components/issue-table.scss


random thought: would not an @import ./src/styles/components/issue-table.scss be possible instead of coping?

TBH, I am not familiar with SCSS. I have copied from another issue module and replaced names 😅

Well then you could just try that out, could not you? That @import is actually part of CSS (now), and it works quite simple: https://developer.mozilla.org/en-US/docs/Web/CSS/@import

rklec · 2023-01-09T16:10:43Z

src/app/features/issue/providers/azuredevops/azuredevops-common-interfaces.service.ts

+    return {
+      title: this._formatIssueTitle(issue.id, issue.title),
+      issueWasUpdated: false,
+      // NOTE: we use Date.now() instead to because updated does not account for comments


Suggested change

// NOTE: we use Date.now() instead to because updated does not account for comments

// NOTE: we use Date.now() instead, because updated does not account for comments

grammar

rklec · 2023-01-09T16:12:06Z

src/app/features/issue/providers/azuredevops/azuredevops-common-interfaces.service.ts

+
+  issueLink$(issueId: number, projectId: string): Observable<string> {
+    return this._getCfgOnce$(projectId).pipe(
+      map((cfg) => `https://azuredevops.com/${cfg.organization}/issues/${issueId}`),


This also needs to be configurable/use the configured base url for hosted/on-premise Azure DevOps Server instances, otherwise the link is broken... 🙃

Also I am unsure what is different about our on-premise Azure DevOps instance (maybe the template?), but we have a different URL format and the above one does not work. It's https://{host}/tfs/{collection|organisation}/{project}/_workitems/edit/{issueId}.

Collections: https://learn.microsoft.com/en-us/azure/devops/server/admin/manage-project-collections?view=azure-devops-2022
Projects: https://learn.microsoft.com/en-us/azure/devops/organizations/projects/create-project?view=azure-devops-2022&tabs=browser

This is Azure DevOps Server 2020 Update 1.1. Also tried the URL on Azure DevOps Server 2022 (AzureDevOpsServer_20221122.1) and it does not work either.

Yeah, this link it totally wrong, will not work in hosted either.

rklec · 2023-01-09T16:18:13Z

src/app/features/issue/providers/azuredevops/azuredevops-api.service.ts

+  }
+  private _b64EncodeUnicode(str: string): string {


Suggested change

}

private _b64EncodeUnicode(str: string): string {

}

private _b64EncodeUnicode(str: string): string {

LukasKlepper · 2023-04-12T12:56:58Z

Whats the status on this? I would really love to see a DevOps Integration.

johannesjo · 2023-04-14T10:34:17Z

The linting stuff needs to be fixed. Apart from that I am open to merge this. Unfortunately I can't test the feature myself, so help with that would be welcome!

LukasKlepper · 2023-08-03T08:59:46Z

@johannesjo I'd like to fix the linting errors, but the job's log is expired. Could you please rerun it so I can see whats wrong?

johannesjo · 2023-08-04T16:04:40Z

@LukasKlepper looks like I can't :/ But you can also run all the linting/unit testing stuff locally via:

npm run lint
npm run test

If this doesn't work for you, you can retrigger the build by submitting a new commit.

xTamasu · 2023-08-04T17:16:45Z

Hi @johannesjo, before I've looked into the linting errors I've checked the integration with devops myself and saw some things which may need to improve before matching the quality of a master pr.

When going on "Project Specific Settings -> Issue Integration" the name of the implementation is written "AZUREDEVOPS", should be "Azure DevOps".
Currently all backlog items are getting fetched (Epic, Features, User Stories), in a real scenario we mostly log to user stories (in my experience). It would be nice to see the type of the issue within Super Productivitiy. We can get the information from the workItem's System.WorkItemType in the api's answer.
It would be nice to also see the acceptance criteria within Super Productivitiy, not only the Description.
A link to the item within Super Productivity which opens the item in Azure DevOps would be nice to have. It seems like there is something like that implemented in the Summary but it always leads me back to localhost. (Could also be an problem to my local environment?) We can get the information from the workItem's _links.html.href in the api's answer.

The linting errors seem quite easy to fix.

src\app\features\issue\providers\azuredevops\azuredevops-api.service.ts
  error  This line has a length of 244. Maximum allowed is 150  max-len
src\app\features\issue\providers\azuredevops\azuredevops-common-interfaces.service.ts
  error  'catchError' is defined but never used  @typescript-eslint/no-unused-vars
  error  'catchError' is defined but never used  unused-imports/no-unused-imports
  error  'switchMap' is defined but never used   @typescript-eslint/no-unused-vars
  error  'switchMap' is defined but never used   unused-imports/no-unused-imports

rklec · 2023-08-07T08:43:15Z

Currently all backlog items are getting fetched (Epic, Features, User Stories), in a real scenario we mostly log to user stories (in my experience). It would be nice to see the type of the issue within Super Productivitiy.

Attention: This depends on the template you use/have in ADS. You have several different ones and AFAIK you can also customize them. In my experience we log to Tasks, mostly. e.g. and the parent of that can e.g. be called Product Backlog Item (PBI) in the Scrum process.

xTamasu · 2023-08-07T08:50:09Z

@rklec Yeah, it depends mostly on the organization guidelines/settings. Thats why it should only show the type of the item so the user can decide whats important for him.

Kevinf63 · 2023-11-16T15:13:48Z

Keeping a watchful eye, would be a great addition to my workflow to have this!

Kigstn · 2023-12-13T20:13:29Z

Second this, would be amazing to have!

github-actions · 2024-04-28T01:48:14Z

This PR has not received any updates in 90 days. Please comment, if this still relevant!

Kevinf63 · 2024-04-28T10:53:31Z

This PR has not received any updates in 90 days. Please comment, if this still relevant!

Very relevant.

nemanja010 · 2024-05-07T09:21:48Z

What's the status on this? Any chance of getting it merged?

johannesjo · 2024-05-09T17:26:58Z

I am unable to test this myself, so if someone were to test this and report how it is working back here, I am all for merging this.

rklec · 2024-05-16T16:33:56Z

Note you can AFAIK create a free(?) account on https://dev.azure.com/ and test it. Though this obviously only tests the hosted/SaaS solution.

feat: Integrate with Azure Devops

cdeb858

github-actions bot reviewed Dec 26, 2022

View reviewed changes

PsikoBlock reviewed Jan 9, 2023

View reviewed changes

rklec suggested changes Jan 9, 2023

View reviewed changes

github-actions bot added the Stale label Apr 28, 2024

github-actions bot removed the Stale label Apr 29, 2024

	"ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. Api Rate limit exceeded?"
	"ERR_UNKNOWN": "Azure Devops: Unknown error {{statusCode}} {{errorMsg}}. API rate limit exceeded?"

		@@ -0,0 +1,56 @@
		@import 'src/variables';

		// table styled by ./src/styles/components/issue-table.scss

	// NOTE: we use Date.now() instead to because updated does not account for comments
	// NOTE: we use Date.now() instead, because updated does not account for comments

feat: Integrate with Azure Devops #2388

Are you sure you want to change the base?

feat: Integrate with Azure Devops #2388

Conversation

BalighMehrez commented Dec 26, 2022

Description

Issues Resolved

Check List

github-actions bot left a comment

Choose a reason for hiding this comment

johannesjo commented Jan 4, 2023

johannesjo commented Jan 5, 2023

PsikoBlock Jan 9, 2023 • edited

Choose a reason for hiding this comment

rklec left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rklec Jan 9, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LukasKlepper commented Apr 12, 2023

johannesjo commented Apr 14, 2023

LukasKlepper commented Aug 3, 2023

johannesjo commented Aug 4, 2023

xTamasu commented Aug 4, 2023

rklec commented Aug 7, 2023

xTamasu commented Aug 7, 2023

Kevinf63 commented Nov 16, 2023

Kigstn commented Dec 13, 2023

github-actions bot commented Apr 28, 2024

Kevinf63 commented Apr 28, 2024

nemanja010 commented May 7, 2024

johannesjo commented May 9, 2024

rklec commented May 16, 2024

PsikoBlock Jan 9, 2023 •

edited

rklec left a comment •

edited

rklec Jan 9, 2023 •

edited