Skip to content

feat: Front permission #3764

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

Merged
zhanweizhang7 merged 1 commit into from
Jul 29, 2025
Merged

feat: Front permission #3764

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
56 changes: 55 additions & 1 deletion ui/src/utils/permission/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,10 +219,64 @@ const PermissionConst = {
RESOURCE_TOOL_EXPORT: new Permission('SYSTEM_RESOURCE_TOOL:READ+EXPORT'),

RESOURCE_KNOWLEDGE_READ: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ'),
RESOURCE_KNOWLEDGE_CREATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+CREATE'),
RESOURCE_KNOWLEDGE_SYNC: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+SYNC'),
RESOURCE_KNOWLEDGE_VECTOR: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+VECTOR'),
RESOURCE_KNOWLEDGE_EDIT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+EDIT'),
RESOURCE_KNOWLEDGE_EXPORT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+EXPORT'),
RESOURCE_KNOWLEDGE_DELETE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+DELETE'),
RESOURCE_KNOWLEDGE_GENERATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE:READ+GENERATE'),

RESOURCE_KNOWLEDGE_DOCUMENT_READ: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ'),
RESOURCE_KNOWLEDGE_DOCUMENT_CREATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+CREATE'),
RESOURCE_KNOWLEDGE_DOCUMENT_DELETE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+DELETE'),
RESOURCE_KNOWLEDGE_DOCUMENT_EDIT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+EDIT'),
RESOURCE_KNOWLEDGE_DOCUMENT_SYNC: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+SYNC'),
RESOURCE_KNOWLEDGE_DOCUMENT_MIGRATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+MIGRATE'),
RESOURCE_KNOWLEDGE_DOCUMENT_VECTOR: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+VECTOR'),
RESOURCE_KNOWLEDGE_DOCUMENT_GENERATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+GENERATE'),
RESOURCE_KNOWLEDGE_DOCUMENT_EXPORT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+EXPORT'),
RESOURCE_KNOWLEDGE_DOCUMENT_DOWNLOAD_SOURCE_FILE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_DOCUMENT:READ+DOWNLOAD'),

RESOURCE_KNOWLEDGE_PROBLEM_READ: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_PROBLEM:READ'),
RESOURCE_KNOWLEDGE_PROBLEM_CREATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_PROBLEM:READ+CREATE'),
RESOURCE_KNOWLEDGE_PROBLEM_EDIT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_PROBLEM:READ+EDIT'),
RESOURCE_KNOWLEDGE_PROBLEM_RELATE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_PROBLEM:READ+RELATE'),
RESOURCE_KNOWLEDGE_PROBLEM_DELETE: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_PROBLEM:READ+DELETE'),

RESOURCE_KNOWLEDGE_CHAT_USER_READ: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_CHAT_USER:READ'),
RESOURCE_KNOWLEDGE_CHAT_USER_EDIT: new Permission('SYSTEM_RESOURCE_KNOWLEDGE_CHAT_USER:READ+EDIT'),

RESOURCE_APPLICATION_READ: new Permission('SYSTEM_RESOURCE_APPLICATION:READ'),
RESOURCE_APPLICATION_EDIT: new Permission('SYSTEM_RESOURCE_APPLICATION:READ+EDIT'),
RESOURCE_APPLICATION_DEBUG: new Permission('SYSTEM_RESOURCE_APPLICATION:READ+DEBUG'),
RESOURCE_APPLICATION_IMPORT: new Permission('SYSTEM_RESOURCE_APPLICATION:READ+IMPORT'),
RESOURCE_APPLICATION_EXPORT: new Permission('SYSTEM_RESOURCE_APPLICATION:READ+EXPORT'),
RESOURCE_APPLICATION_DELETE: new Permission('SYSTEM_RESOURCE_APPLICATION:READ+DELETE'),

RESOURCE_APPLICATION_OVERVIEW_READ: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ'),
RESOURCE_APPLICATION_OVERVIEW_EMBED: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ+EMBED'),
RESOURCE_APPLICATION_OVERVIEW_ACCESS: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ+ACCESS'),
RESOURCE_APPLICATION_OVERVIEW_DISPLAY: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ+DISPLAY'),
RESOURCE_APPLICATION_OVERVIEW_API_KEY: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ+API_KEY'),
RESOURCE_APPLICATION_OVERVIEW_PUBLIC: new Permission('SYSTEM_RESOURCE_APPLICATION_OVERVIEW:READ+PUBLIC_ACCESS'),

RESOURCE_APPLICATION_CHAT_LOG_READ: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_LOG:READ'),
RESOURCE_APPLICATION_CHAT_LOG_ANNOTATION: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_LOG:READ+ANNOTATION'),
RESOURCE_APPLICATION_CHAT_LOG_EXPORT: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_LOG:READ+EXPORT'),
RESOURCE_APPLICATION_CHAT_LOG_CLEAR_POLICY: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_LOG:READ+CLEAR_POLICY'),
RESOURCE_APPLICATION_CHAT_LOG_ADD_KNOWLEDGE: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_LOG:READ+ADD_KNOWLEDGE'),

RESOURCE_APPLICATION_ACCESS_READ: new Permission('SYSTEM_RESOURCE_APPLICATION_ACCESS:READ'),
RESOURCE_APPLICATION_ACCESS_EDIT: new Permission('SYSTEM_RESOURCE_APPLICATION_ACCESS:READ+EDIT'),

RESOURCE_APPLICATION_CHAT_USER_READ: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_USER:READ'),
RESOURCE_APPLICATION_CHAT_USER_EDIT: new Permission('SYSTEM_RESOURCE_APPLICATION_CHAT_USER:READ+EDIT'),

RESOURCE_MODEL_READ: new Permission('SYSTEM_RESOURCE_MODEL:READ'),

RESOURCE_MODEL_EDIT: new Permission('SYSTEM_RESOURCE_MODEL:READ+EDIT'),
RESOURCE_MODEL_DELETE: new Permission('SYSTEM_RESOURCE_MODEL:READ+DELETE'),

APPEARANCE_SETTINGS_READ: new Permission('APPEARANCE_SETTINGS:READ'),
APPEARANCE_SETTINGS_EDIT: new Permission('APPEARANCE_SETTINGS:READ+EDIT'),

Copy link
Copy Markdown
Contributor Author

@shaohuzhang1 shaohuzhang1 Jul 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several optimizations and improvements that can be made to the code snippet you provided:

  1. Reduce Redundancy: The Permission class could be modified to allow specifying both read (r) and create (c), edit (e), sync (s), vector (v), generate (g), and delete (d) permissions using a constructor that takes an object of these properties.

  2. Error Handling: Implement error handling in methods like toString() if necessary, especially during permission string generation.

  3. Validation: Add validation checks for null or undefined input when creating a new instance of Permission. Ensure that only valid strings are used as identifiers.

  4. Cache Mechanism: Consider adding caching mechanisms if this will save performance in repetitive access scenarios.

  5. Logging and Debugging: Provide logging options or a debugger to track the behavior of permission instances and their usage within the application.

  6. Documentation: Enhance documentation with more detailed comments explaining each property and method purpose.

Here is a simplified example of how the Permission class could be optimized:

class Permission {
  constructor(params) {
    const read = params.read || false;
    const create = params.create || false;
    // ... add other flags

    return { r: read, c: create, e: true /* default */, s: true, v: true, g: false, d: false };
  }

  toString() {
    let result = 'RESOURCE_';
    ['KNOWLEDGE', 'DOCUMENT'].forEach(type => this[`RESOURCE_${type}_`].keys().forEach(permission => {
      if (this[permission]) {
        result += `${permission.toUpperCase('')}`;
      }
    }));

    return result.trim();
  }

  hasPermission(property) {
    // Check if a specific permission exists within the permission set
    switch (property) {
      case 'READ':
        // Default to read permission since it's always available unless explicitly denied
        return this.r;
      case 'CREATE':
        return this.c && !this.d; // Create allowed except if DELETE flag is also set
      case 'EDIT':
        return this.e && !this.d;
      case 'SYNC':
        return this.s;
      case 'VECTOR':
        return this.v;
      case 'GENERATE':
        return this.g;
      case 'DELETE':
        return this.d;
      default:
        throw new Error(`Unknown property: ${property}`);
    }
  }
}

// Usage
const KnowledgePermissions = new Permission({
  read: true,
  create: true,
  edit: true,
  sync: true,
  vector: true,
  generate: true,
});

console.log(KnowledgePermissions.toString()); // Output: RESOURCE_KNOWLEDGE_READ CREATE EDIT SYNC VECTOR GENERATE

These changes aim to reduce redundancy, improve clarity, introduce useful features for managing and checking permissions, and potentially enhance overall modularity and reusability.

Expand Down
Loading