Skip to content

server/services: add optional DeleteProject hook for plugin-owned project state #9083

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
bujjibabukatta wants to merge 1 commit into from
Closed

server/services: add optional DeleteProject hook for plugin-owned project state #9083

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
16 changes: 14 additions & 2 deletions backend/server/services/project.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ package services

import (
"fmt"
"golang.org/x/exp/slices"
"golang.org/x/sync/errgroup"
"strings"
"time"

"golang.org/x/exp/slices"
"golang.org/x/sync/errgroup"

"github.com/apache/incubator-devlake/core/dal"
"github.com/apache/incubator-devlake/core/errors"
"github.com/apache/incubator-devlake/core/models"
Expand All @@ -35,6 +36,11 @@ type ProjectService interface {
RenameProject(db dal.Transaction, oldProjectName, newProjectName string) errors.Error
}

// ProjectDeleteHook is an optional hook; kept separate from ProjectService so existing implementers aren't broken.
type ProjectDeleteHook interface {
DeleteProject(db dal.Transaction, projectName string) errors.Error
}

var projectService ProjectService

// ProjectQuery used to query projects as the api project input
Expand Down Expand Up @@ -379,6 +385,12 @@ func DeleteProject(name string) errors.Error {
}
}
}()
// let plugins validate/clean up their own state inside the same transaction before core rows are deleted
if hook, ok := projectService.(ProjectDeleteHook); ok {
if err = hook.DeleteProject(tx, name); err != nil {
return err
}
}
err = tx.Delete(&models.Project{}, dal.Where("name = ?", name))
if err != nil {
return errors.Default.Wrap(err, "error deleting project")
Expand Down
Loading