plugin-git-manager 1.0.3 → 1.0.11

package/src/server/ai-tools.ts

@@ -0,0 +1,263 @@
+import { z } from 'zod';
+import type { Application } from '@nocobase/server';
+import * as gitlabApi from './actions/gitlab-api';
+import * as gitActions from './actions/git-actions';
+
+/**
+ * Register AI tools that allow an AI employee to inspect git repositories,
+ * merge requests, commits, and file content during a review session.
+ *
+ * Each tool is invoked by the AI runtime; the `invoke` callback constructs a
+ * synthetic `ctx.action.params` payload then delegates to the existing
+ * resource action implementation.
+ */
+export function registerGitReviewAiTools(app: Application) {
+  const aiManager = (app as any).aiManager;
+  if (!aiManager?.toolsManager?.registerTools) {
+    app.log?.warn?.('plugin-git-manager: AIManager.toolsManager not available; skipping AI tool registration');
+    return;
+  }
+
+  /**
+   * Enforce that the AI session has an authenticated user and that this user
+   * is permitted to invoke the underlying resource:action. Without this check,
+   * a prompt-injected AI could pass an arbitrary `repositoryId` to the tools
+   * and read any repository's MRs / commits / file content regardless of the
+   * caller's ACL.
+   */
+  const enforceAcl = (ctx: any, resource: string, action: string) => {
+    const user = ctx?.state?.currentUser;
+    if (!user?.id) {
+      const err: any = new Error('AI tool requires an authenticated user context');
+      err.status = 401;
+      throw err;
+    }
+    const acl = ctx.app?.acl;
+    if (!acl?.can) return; // ACL not available — fail-open is acceptable for legacy contexts
+    const role =
+      ctx?.state?.currentRole ||
+      (Array.isArray(user.roles) && user.roles[0]?.name) ||
+      null;
+    if (!role) {
+      const err: any = new Error('AI tool requires a resolvable role on the current user');
+      err.status = 403;
+      throw err;
+    }
+    const allowed = acl.can({ role, resource, action });
+    if (!allowed) {
+      const err: any = new Error(`Permission denied: ${resource}:${action}`);
+      err.status = 403;
+      throw err;
+    }
+  };
+
+  const runResourceAction = async (
+    ctx: any,
+    handler: (ctx: any, next: () => Promise<void>) => Promise<void>,
+    params: Record<string, any>,
+    gate: { resource: string; action: string },
+  ) => {
+    enforceAcl(ctx, gate.resource, gate.action);
+    const synthCtx: any = {
+      ...ctx,
+      app: ctx.app,
+      db: ctx.db,
+      action: { params },
+      throw: (status: number, message: string) => {
+        const err: any = new Error(message);
+        err.status = status;
+        throw err;
+      },
+    };
+    await handler(synthCtx, async () => undefined);
+    return synthCtx.body;
+  };
+
+  aiManager.toolsManager.registerTools([
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: Get merge request' },
+      definition: {
+        name: 'git_get_merge_request',
+        description:
+          'Get full details of a GitLab merge request including its file-level diffs. Use this to inspect the code changes that need review.',
+        schema: z.object({
+          repositoryId: z.number().describe('The numeric ID of the gitRepositories record'),
+          mrIid: z.number().describe('The GitLab merge request internal ID (iid)'),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitlabApi.mergeRequestDetail, args, {
+          resource: 'gitManager',
+          action: 'mergeRequestDetail',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: List merge requests' },
+      definition: {
+        name: 'git_list_merge_requests',
+        description: 'List GitLab merge requests for a repository, with optional state and search filters.',
+        schema: z.object({
+          repositoryId: z.number(),
+          state: z.enum(['opened', 'closed', 'merged', 'all']).optional(),
+          search: z.string().optional(),
+          page: z.number().optional(),
+          perPage: z.number().optional(),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitlabApi.mergeRequests, args, {
+          resource: 'gitManager',
+          action: 'mergeRequests',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: Get merge request notes' },
+      definition: {
+        name: 'git_get_merge_request_notes',
+        description: 'Get existing comments / notes on a merge request to avoid duplicating feedback.',
+        schema: z.object({
+          repositoryId: z.number(),
+          mrIid: z.number(),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitlabApi.mergeRequestNotes, args, {
+          resource: 'gitManager',
+          action: 'mergeRequestNotes',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: Get commit detail' },
+      definition: {
+        name: 'git_get_commit',
+        description: 'Get details and diff of a specific commit in a cloned repository.',
+        schema: z.object({
+          repositoryId: z.number(),
+          commitHash: z.string().describe('Full or short commit SHA'),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitActions.commitDetail, args, {
+          resource: 'gitManager',
+          action: 'commitDetail',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: Get diff' },
+      definition: {
+        name: 'git_get_diff',
+        description:
+          'Get the diff between two refs (branches/commits) in a cloned repository, or the diff of a single commit when only commitHash is given.',
+        schema: z.object({
+          repositoryId: z.number(),
+          commitHash: z.string().optional(),
+          compareHash: z.string().optional(),
+          file: z.string().optional().describe('Optional file path to scope the diff'),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitActions.diff, args, {
+          resource: 'gitManager',
+          action: 'diff',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: Get file content' },
+      definition: {
+        name: 'git_get_file_content',
+        description:
+          'Read the content of a single file in a cloned repository at a given ref. Useful when reviewing changes in surrounding context.',
+        schema: z.object({
+          repositoryId: z.number(),
+          filePath: z.string(),
+          ref: z.string().optional(),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitActions.fileContent, args, {
+          resource: 'gitManager',
+          action: 'fileContent',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: List branches' },
+      definition: {
+        name: 'git_list_branches',
+        description: 'List branches available in a cloned repository.',
+        schema: z.object({ repositoryId: z.number() }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitActions.branches, args, {
+          resource: 'gitManager',
+          action: 'branches',
+        });
+        return body?.data ?? body;
+      },
+    },
+    {
+      scope: 'GENERAL',
+      execution: 'backend',
+      defaultPermission: 'ALLOW',
+      silence: false,
+      introduction: { title: 'Git: List recent commits' },
+      definition: {
+        name: 'git_list_commits',
+        description: 'List recent commits in a cloned repository, optionally scoped to a single file.',
+        schema: z.object({
+          repositoryId: z.number(),
+          maxCount: z.number().optional(),
+          file: z.string().optional(),
+        }),
+      },
+      invoke: async (ctx: any, args: any) => {
+        const body = await runResourceAction(ctx, gitActions.log, args, {
+          resource: 'gitManager',
+          action: 'log',
+        });
+        return body?.data ?? body;
+      },
+    },
+  ]);
+
+  app.log?.info?.('plugin-git-manager: registered git_* AI tools for code review');
+}

package/src/server/collections/gitCodeReviews.ts

@@ -0,0 +1,191 @@
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'gitCodeReviews',
+  title: 'Git Code Reviews',
+  autoGenId: true,
+  createdBy: true,
+  updatedBy: true,
+  createdAt: true,
+  updatedAt: true,
+  fields: [
+    {
+      type: 'belongsTo',
+      name: 'flow',
+      target: 'gitReviewFlows',
+      foreignKey: 'flowId',
+      interface: 'm2o',
+      uiSchema: {
+        title: 'Flow',
+        'x-component': 'AssociationField',
+        'x-component-props': { fieldNames: { label: 'name', value: 'id' } },
+      },
+    },
+    {
+      type: 'belongsTo',
+      name: 'repository',
+      target: 'gitRepositories',
+      foreignKey: 'repositoryId',
+      interface: 'm2o',
+      uiSchema: {
+        title: 'Repository',
+        'x-component': 'AssociationField',
+        'x-component-props': { fieldNames: { label: 'name', value: 'id' } },
+      },
+    },
+    {
+      type: 'string',
+      name: 'targetType',
+      interface: 'select',
+      uiSchema: {
+        title: 'Target Type',
+        type: 'string',
+        'x-component': 'Select',
+        enum: [
+          { value: 'mr', label: 'Merge Request' },
+          { value: 'commit', label: 'Commit' },
+          { value: 'branch', label: 'Branch' },
+        ],
+      },
+    },
+    {
+      type: 'integer',
+      name: 'mrIid',
+      interface: 'integer',
+      uiSchema: { title: 'MR IID', type: 'number', 'x-component': 'InputNumber' },
+    },
+    {
+      type: 'string',
+      name: 'commitSha',
+      interface: 'input',
+      uiSchema: { title: 'Commit SHA', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'branch',
+      interface: 'input',
+      uiSchema: { title: 'Branch', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'headSha',
+      interface: 'input',
+      uiSchema: { title: 'Reviewed SHA', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'latestSha',
+      interface: 'input',
+      uiSchema: { title: 'Latest SHA', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'triggeredBy',
+      defaultValue: 'manual',
+      interface: 'input',
+      uiSchema: { title: 'Triggered By', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'status',
+      defaultValue: 'pending',
+      interface: 'select',
+      uiSchema: {
+        title: 'Status',
+        type: 'string',
+        'x-component': 'Select',
+        enum: [
+          { value: 'pending', label: 'Pending' },
+          { value: 'running', label: 'Running' },
+          { value: 'completed', label: 'Completed' },
+          { value: 'failed', label: 'Failed' },
+        ],
+      },
+    },
+    {
+      type: 'text',
+      length: 'long',
+      name: 'reviewMarkdown',
+      interface: 'vditor',
+      uiSchema: {
+        title: 'Review Content',
+        type: 'string',
+        'x-component': 'MarkdownVditor',
+      },
+    },
+    {
+      type: 'json',
+      name: 'metadata',
+      interface: 'json',
+      uiSchema: {
+        title: 'Metadata',
+        type: 'object',
+        'x-component': 'Input.JSON',
+      },
+    },
+    {
+      type: 'string',
+      name: 'postStatus',
+      defaultValue: 'pending_approval',
+      interface: 'select',
+      uiSchema: {
+        title: 'Post Status',
+        type: 'string',
+        'x-component': 'Select',
+        enum: [
+          { value: 'pending_approval', label: 'Pending Approval' },
+          { value: 'approved', label: 'Approved' },
+          { value: 'posted', label: 'Posted' },
+          { value: 'skipped', label: 'Skipped' },
+          { value: 'rejected', label: 'Rejected' },
+        ],
+      },
+    },
+    {
+      type: 'string',
+      name: 'postedNoteId',
+      interface: 'input',
+    },
+    {
+      type: 'string',
+      name: 'approvedBy',
+      interface: 'input',
+    },
+    {
+      type: 'date',
+      name: 'approvedAt',
+      interface: 'datetime',
+    },
+    {
+      type: 'integer',
+      name: 'durationMs',
+      interface: 'integer',
+    },
+    {
+      type: 'date',
+      name: 'startedAt',
+      interface: 'datetime',
+    },
+    {
+      type: 'date',
+      name: 'finishedAt',
+      interface: 'datetime',
+    },
+    {
+      type: 'text',
+      name: 'error',
+      interface: 'textarea',
+    },
+    {
+      type: 'text',
+      length: 'long',
+      name: 'rawOutput',
+      interface: 'textarea',
+    },
+    {
+      type: 'string',
+      name: 'sessionId',
+      interface: 'input',
+    },
+  ],
+});

package/src/server/collections/gitRepositories.ts

@@ -3,6 +3,9 @@ import { defineCollection } from '@nocobase/database';
 export default defineCollection({
   name: 'gitRepositories',
   title: 'Git Repositories',
+  autoGenId: true,
+  createdAt: true,
+  updatedAt: true,
   fields: [
     {
       type: 'string',
@@ -16,6 +19,12 @@ export default defineCollection({
       interface: 'input',
       uiSchema: { title: 'Repository URL', type: 'string', 'x-component': 'Input' },
     },
+    {
+      type: 'string',
+      name: 'username',
+      interface: 'input',
+      uiSchema: { title: 'Username', type: 'string', 'x-component': 'Input' },
+    },
     {
       type: 'string',
       name: 'localPath',
@@ -23,7 +32,7 @@ export default defineCollection({
       uiSchema: { title: 'Local Path', type: 'string', 'x-component': 'Input' },
     },
     {
-      type: 'password',
+      type: 'string',
       name: 'pat',
       interface: 'password',
       uiSchema: { title: 'Personal Access Token', type: 'string', 'x-component': 'Password' },
@@ -41,5 +50,17 @@ export default defineCollection({
       defaultValue: 'disconnected',
       interface: 'input',
     },
+    {
+      type: 'boolean',
+      name: 'autoReview',
+      defaultValue: false,
+      interface: 'checkbox',
+      uiSchema: { title: 'Auto Review', type: 'boolean', 'x-component': 'Checkbox' },
+    },
+    {
+      type: 'date',
+      name: 'lastPolledAt',
+      interface: 'datetime',
+    },
   ],
 });

package/src/server/collections/gitReviewFlows.ts

@@ -0,0 +1,108 @@
+import { defineCollection } from '@nocobase/database';
+
+export default defineCollection({
+  name: 'gitReviewFlows',
+  title: 'Git Review Flows',
+  autoGenId: true,
+  createdBy: true,
+  updatedBy: true,
+  createdAt: true,
+  updatedAt: true,
+  fields: [
+    {
+      type: 'string',
+      name: 'name',
+      interface: 'input',
+      uiSchema: { title: 'Flow Name', type: 'string', 'x-component': 'Input', required: true },
+    },
+    {
+      type: 'belongsTo',
+      name: 'repository',
+      target: 'gitRepositories',
+      foreignKey: 'repositoryId',
+      interface: 'm2o',
+      uiSchema: {
+        title: 'Repository',
+        'x-component': 'AssociationField',
+        'x-component-props': { fieldNames: { label: 'name', value: 'id' } },
+      },
+    },
+    {
+      type: 'boolean',
+      name: 'enabled',
+      defaultValue: true,
+      interface: 'checkbox',
+      uiSchema: { title: 'Enabled', type: 'boolean', 'x-component': 'Checkbox' },
+    },
+    {
+      type: 'string',
+      name: 'triggerMode',
+      defaultValue: 'manual',
+      interface: 'select',
+      uiSchema: {
+        title: 'Trigger Mode',
+        type: 'string',
+        'x-component': 'Select',
+        enum: [
+          { value: 'manual', label: 'Manual' },
+          { value: 'onMergeRequestCreated', label: 'On Merge Request Created' },
+          { value: 'both', label: 'Both' },
+        ],
+      },
+    },
+    {
+      type: 'string',
+      name: 'aiEmployeeUsername',
+      interface: 'input',
+      uiSchema: { title: 'AI Employee', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'llmService',
+      interface: 'input',
+      uiSchema: { title: 'LLM Service (optional)', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'model',
+      interface: 'input',
+      uiSchema: { title: 'Model (optional)', type: 'string', 'x-component': 'Input' },
+    },
+    {
+      type: 'string',
+      name: 'branchFilter',
+      interface: 'input',
+      uiSchema: {
+        title: 'Branch Filter (regex, optional)',
+        type: 'string',
+        'x-component': 'Input',
+      },
+    },
+    {
+      type: 'string',
+      name: 'postMode',
+      defaultValue: 'manual',
+      interface: 'select',
+      uiSchema: {
+        title: 'Post Mode',
+        type: 'string',
+        'x-component': 'Select',
+        enum: [
+          { value: 'auto', label: 'Auto' },
+          { value: 'manual', label: 'Manual (require approval)' },
+          { value: 'disabled', label: 'Disabled' },
+        ],
+      },
+    },
+    {
+      type: 'text',
+      name: 'instructions',
+      interface: 'textarea',
+      uiSchema: {
+        title: 'Additional Instructions',
+        type: 'string',
+        'x-component': 'Input.TextArea',
+      },
+    },
+  ],
+});