feat: [CDE-354]: Adding gitspace usage limiter & checking usage before creation and start. (#2745)

* feat: [CDE-354]: Adding gitspace usage limiter & checking usage before creation and start.

app/api/controller/gitspace/action.go

@@ -89,6 +89,11 @@ func (c *Controller) Action(
 	// All the actions should be idempotent.
 	switch in.Action {
 	case enum.GitspaceActionTypeStart:
+		err = c.gitspaceLimiter.Usage(ctx, space.ID)
+		if err != nil {
+			return nil, fmt.Errorf("usage has exceeded limit, can not start any gitspaces: %w", err)
+		}
+
 		c.emitGitspaceConfigEvent(ctx, gitspaceConfig, enum.GitspaceEventTypeGitspaceActionStart)
 		err = c.startGitspaceAction(ctx, gitspaceConfig)
 		return gitspaceConfig, err

app/api/controller/gitspace/controller.go

@@ -15,6 +15,7 @@
 package gitspace
 
 import (
+	"github.com/harness/gitness/app/api/controller/limiter"
 	"github.com/harness/gitness/app/auth/authz"
 	gitspaceevents "github.com/harness/gitness/app/events/gitspace"
 	"github.com/harness/gitness/app/gitspace/logutil"
@@ -40,6 +41,7 @@ type Controller struct {
 	scm                   scm.SCM
 	repoStore             store.RepoStore
 	gitspaceSvc           *gitspace.Service
+	gitspaceLimiter       limiter.Gitspace
 }
 
 func NewController(
@@ -56,6 +58,7 @@ func NewController(
 	scm scm.SCM,
 	repoStore store.RepoStore,
 	gitspaceSvc *gitspace.Service,
+	gitspaceLimiter limiter.Gitspace,
 ) *Controller {
 	return &Controller{
 		tx:                    tx,
@@ -71,5 +74,6 @@ func NewController(
 		scm:                   scm,
 		repoStore:             repoStore,
 		gitspaceSvc:           gitspaceSvc,
+		gitspaceLimiter:       gitspaceLimiter,
 	}
 }

app/api/controller/gitspace/create.go

@@ -81,6 +81,12 @@ func (c *Controller) Create(
 		enum.PermissionGitspaceEdit); err != nil {
 		return nil, err
 	}
+
+	err = c.gitspaceLimiter.Usage(ctx, space.ID)
+	if err != nil {
+		return nil, fmt.Errorf("usage has exceeded limit, can not create any gitspaces: %w", err)
+	}
+
 	// check if it's an internal repo
 	if in.CodeRepoType == enum.CodeRepoTypeGitness && *in.CodeRepoRef != "" {
 		repo, err := c.repoStore.FindByRef(ctx, *in.CodeRepoRef)

app/api/controller/gitspace/wire.go

@@ -15,6 +15,7 @@
 package gitspace
 
 import (
+	"github.com/harness/gitness/app/api/controller/limiter"
 	"github.com/harness/gitness/app/auth/authz"
 	gitspaceevents "github.com/harness/gitness/app/events/gitspace"
 	"github.com/harness/gitness/app/gitspace/logutil"
@@ -47,6 +48,7 @@ func ProvideController(
 	scm scm.SCM,
 	repoStore store.RepoStore,
 	gitspaceSvc *gitspace.Service,
+	gitspaceLimiter limiter.Gitspace,
 ) *Controller {
 	return NewController(
 		tx,
@@ -62,5 +64,6 @@ func ProvideController(
 		scm,
 		repoStore,
 		gitspaceSvc,
+		gitspaceLimiter,
 	)
 }

app/api/controller/limiter/gitspace.go

@@ -0,0 +1,39 @@
+// Copyright 2023 Harness, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package limiter
+
+import (
+	"context"
+)
+
+// Gitspace is an interface for managing gitspace limitations.
+type Gitspace interface {
+	// Usage checks if the total usage for the root space and all sub-spaces is under a limit.
+	Usage(ctx context.Context, spaceID int64) error
+}
+
+var _ Gitspace = (*UnlimitedUsage)(nil)
+
+type UnlimitedUsage struct {
+}
+
+// NewUnlimitedUsage creates a new instance of UnlimitedGitspace.
+func NewUnlimitedUsage() Gitspace {
+	return UnlimitedUsage{}
+}
+
+func (UnlimitedUsage) Usage(_ context.Context, _ int64) error {
+	return nil
+}

app/api/controller/limiter/wire.go

@@ -20,8 +20,13 @@ import (
 
 var WireSet = wire.NewSet(
 	ProvideLimiter,
+	ProvideGitspaceLimiter,
 )
 
 func ProvideLimiter() (ResourceLimiter, error) {
 	return NewResourceLimiter(), nil
 }
+
+func ProvideGitspaceLimiter() Gitspace {
+	return NewUnlimitedUsage()
+}

cmd/gitness/wire_gen.go

@@ -405,7 +405,8 @@ func initSystem(ctx context.Context, config *types.Config) (*server.System, erro
 	resolverFactory := secret2.ProvideResolverFactory(passwordResolver)
 	orchestratorOrchestrator := orchestrator.ProvideOrchestrator(scmSCM, infraProviderResourceStore, infraProvisioner, containerOrchestrator, reporter5, orchestratorConfig, vsCode, vsCodeWeb, resolverFactory)
 	gitspaceEventStore := database.ProvideGitspaceEventStore(db)
-	gitspaceController := gitspace2.ProvideController(transactor, authorizer, infraproviderService, gitspaceConfigStore, gitspaceInstanceStore, spaceStore, reporter5, orchestratorOrchestrator, gitspaceEventStore, statefulLogger, scmSCM, repoStore, gitspaceService)
+	limiterGitspace := limiter.ProvideGitspaceLimiter()
+	gitspaceController := gitspace2.ProvideController(transactor, authorizer, infraproviderService, gitspaceConfigStore, gitspaceInstanceStore, spaceStore, reporter5, orchestratorOrchestrator, gitspaceEventStore, statefulLogger, scmSCM, repoStore, gitspaceService, limiterGitspace)
 	rule := migrate.ProvideRuleImporter(ruleStore, transactor, principalStore)
 	migrateWebhook := migrate.ProvideWebhookImporter(webhookConfig, transactor, webhookStore)
 	migrateController := migrate2.ProvideController(authorizer, publicaccessService, gitInterface, provider, pullReq, rule, migrateWebhook, resourceLimiter, auditService, repoIdentifier, transactor, spaceStore, repoStore)