Skip to content
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.

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

feat(api,ui): add workflow template usage #3761

Merged
merged 1 commit into from
Dec 21, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions engine/api/api_routes.go
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,7 @@ func (api *API) InitRouter() {
r.Handle("/template/{groupName}/{templateSlug}/apply", r.POST(api.applyTemplateHandler))
r.Handle("/template/{groupName}/{templateSlug}/instance", r.GET(api.getTemplateInstancesHandler))
r.Handle("/template/{groupName}/{templateSlug}/audit", r.GET(api.getTemplateAuditsHandler))
r.Handle("/template/{groupName}/{templateSlug}/usage", r.GET(api.getTemplateUsageHandler))
r.Handle("/project/{key}/workflow/{permWorkflowName}/templateInstance", r.GET(api.getTemplateInstanceHandler))

//Not Found handler
Expand Down
17 changes: 17 additions & 0 deletions engine/api/templates.go
Original file line number Diff line number Diff line change
Expand Up @@ -583,3 +583,20 @@ func (api *API) getTemplateAuditsHandler() service.Handler {
return service.WriteJSON(w, as, http.StatusOK)
}
}

func (api *API) getTemplateUsageHandler() service.Handler {
return func(ctx context.Context, w http.ResponseWriter, r *http.Request) error {
ctx, err := api.middlewareTemplate(false)(ctx, w, r)
if err != nil {
return err
}
wfTmpl := getWorkflowTemplate(ctx)

wfs, err := workflow.LoadByWorkflowTemplateID(ctx, api.mustDB(), wfTmpl.ID)
if err != nil {
return sdk.WrapError(err, "Cannot load templates")
}

return service.WriteJSON(w, wfs, http.StatusOK)
}
}
29 changes: 29 additions & 0 deletions engine/api/workflow/dao.go
Original file line number Diff line number Diff line change
Expand Up @@ -409,6 +409,35 @@ func LoadByEnvName(db gorp.SqlExecutor, projectKey string, envName string) ([]sd
return res, nil
}

// LoadByWorkflowTemplateID load all workflows linked to a workflow template but without loading workflow details
func LoadByWorkflowTemplateID(ctx context.Context, db gorp.SqlExecutor, templateID int64) ([]sdk.Workflow, error) {
var dbRes []Workflow
query := `
SELECT workflow.*
FROM workflow
JOIN workflow_template_instance ON workflow_template_instance.workflow_id = workflow.id
WHERE workflow_template_instance.workflow_template_id = $1 AND workflow.to_delete = false
`
if _, err := db.Select(&dbRes, query, templateID); err != nil {
if err == sql.ErrNoRows {
return nil, nil
}
return nil, err
}

workflows := make([]sdk.Workflow, len(dbRes))
for i, wf := range dbRes {
var err error
wf.ProjectKey, err = db.SelectStr("SELECT projectkey FROM project WHERE id = $1", wf.ProjectID)
if err != nil {
return nil, sdk.WrapError(err, "cannot load project key for workflow %s and project_id %d", wf.Name, wf.ProjectID)
}
workflows[i] = sdk.Workflow(wf)
}

return workflows, nil
}

func load(ctx context.Context, db gorp.SqlExecutor, store cache.Store, proj *sdk.Project, opts LoadOptions, u *sdk.User, query string, args ...interface{}) (*sdk.Workflow, error) {
t0 := time.Now()
dbRes := Workflow{}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
WorkflowTemplateInstance,
WorkflowTemplateRequest
} from '../../model/workflow-template.model';
import { Workflow } from '../../model/workflow.model';

@Injectable()
export class WorkflowTemplateService {
Expand Down Expand Up @@ -54,4 +55,8 @@ export class WorkflowTemplateService {
let url = '/template/' + groupName + '/' + templateSlug + '/audit' + (version ? '?sinceVersion=' + version : '');
return this._http.get<Array<AuditWorkflowTemplate>>(url);
}

getWorkflowTemplateUsage(groupName: string, templateSlug: string): Observable<Array<Workflow>> {
return this._http.get<Array<Workflow>>('/template/' + groupName + '/' + templateSlug + '/usage');
}
}
7 changes: 6 additions & 1 deletion ui/src/app/shared/usage/workflows/usage.workflows.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@ <h3><i class="share alternate icon"></i> {{'usage_workflow_list' | translate}}</
<ng-template #workflowsDisplay>
<div class="ui stackable four column grid">
<div class="center aligned column" *ngFor="let workflow of workflows">
<a [routerLink]="['/project', project.key, 'workflow', workflow.name]">{{workflow.name}}</a>
<ng-container *ngIf="project">
<a [routerLink]="['/project', project.key, 'workflow', workflow.name]">{{workflow.name}}</a>
</ng-container>
<ng-container *ngIf="!project">
<a [routerLink]="['/project', workflow.project_key, 'workflow', workflow.name]">{{workflow.name}}</a>
</ng-container>
</div>
</div>
</ng-template>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@ import { Component, OnInit } from '@angular/core';
import { ActivatedRoute, Router } from '@angular/router';
import { TranslateService } from '@ngx-translate/core';
import { finalize } from 'rxjs/internal/operators/finalize';
import { first } from 'rxjs/operators';
import { AuditWorkflowTemplate } from '../../../../model/audit.model';
import { Group } from '../../../../model/group.model';
import { WorkflowTemplate } from '../../../../model/workflow-template.model';
import { Workflow } from '../../../../model/workflow.model';
import { GroupService } from '../../../../service/services.module';
import { WorkflowTemplateService } from '../../../../service/workflow-template/workflow-template.service';
import { PathItem } from '../../../../shared/breadcrumb/breadcrumb.component';
Expand All @@ -24,13 +26,17 @@ export class WorkflowTemplateEditComponent implements OnInit {
workflowTemplate: WorkflowTemplate;
groups: Array<Group>;
audits: Array<AuditWorkflowTemplate>;
workflowsLinked: Array<Workflow>;
loading: boolean;
loadingAudits: boolean;
loadingUsage: boolean;
path: Array<PathItem>;
tabs: Array<Tab>;
selectedTab: Tab;
columns: Array<Column>;
diffItems: Array<Item>;
groupName: string;
templateSlug: string;

constructor(
private _workflowTemplateService: WorkflowTemplateService,
Expand All @@ -51,6 +57,10 @@ export class WorkflowTemplateEditComponent implements OnInit {
translate: 'common_audit',
icon: 'history',
key: 'audits'
}, <Tab>{
translate: 'common_usage',
icon: 'map signs',
key: 'usage'
}];

this.columns = [
Expand Down Expand Up @@ -79,10 +89,10 @@ export class WorkflowTemplateEditComponent implements OnInit {
];

this._route.params.subscribe(params => {
const groupName = params['groupName'];
const templateSlug = params['templateSlug'];
this.getTemplate(groupName, templateSlug);
this.getAudits(groupName, templateSlug);
this.groupName = params['groupName'];
this.templateSlug = params['templateSlug'];
this.getTemplate(this.groupName, this.templateSlug);
this.getAudits(this.groupName, this.templateSlug);
});

this.getGroups();
Expand Down Expand Up @@ -160,6 +170,9 @@ export class WorkflowTemplateEditComponent implements OnInit {
}

selectTab(tab: Tab): void {
if (tab.key === 'usage') {
this.getUsage();
}
this.selectedTab = tab;
}

Expand Down Expand Up @@ -192,4 +205,15 @@ export class WorkflowTemplateEditComponent implements OnInit {
}
this.saveWorkflowTemplate();
}

getUsage() {
if (this.workflowsLinked) {
return;
}
this.loadingUsage = true;
this._workflowTemplateService.getWorkflowTemplateUsage(this.groupName, this.templateSlug)
.pipe(first())
.pipe(finalize(() => this.loadingUsage = false))
.subscribe((workflows) => this.workflowsLinked = workflows);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,13 @@ <h3>{{ "common_last_modified" | translate }}</h3>
<app-diff-list *ngIf="diffItems" [items]="diffItems"></app-diff-list>
</div>
</div>
<div *ngSwitchCase="'usage'" class="ui grid">
<div class="sixteen wide column">
<div class="ui active centered inline loader" *ngIf="loadingUsage"></div>
<ng-container *ngIf="!loadingUsage">
<app-usage [workflows]="workflowsLinked"></app-usage>
</ng-container>
</div>
</div>
</app-scrollview>
</div>