Skip to content

fix: Rename Model Whitelist to Allowed Models#1144

Merged
VisargD merged 4 commits into
Portkey-AI:mainfrom
vrushankportkey:main
Jun 25, 2025
Merged

fix: Rename Model Whitelist to Allowed Models#1144
VisargD merged 4 commits into
Portkey-AI:mainfrom
vrushankportkey:main

Conversation

@vrushankportkey

Copy link
Copy Markdown
Collaborator

Description

Motivation

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)

How Has This Been Tested?

  • Unit Tests
  • Integration Tests
  • Manual Testing

Screenshots (if applicable)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Related Issues

@matterai-app

matterai-app Bot commented Jun 17, 2025

Copy link
Copy Markdown
Contributor

Code Quality type: bug fix

Summary By MatterAI MatterAI logo

🔄 What Changed

Renamed "Model Whitelist" to "Allowed Models" in the UI display text while maintaining the internal ID as "modelwhitelist". Updated related description texts to reflect the new terminology.

🔍 Impact of the Change

This change improves the user interface by using more inclusive language. The functionality remains the same, but the terminology is now more descriptive and avoids potentially problematic language.

📁 Total Files Changed

1 file changed with 4 additions and 4 deletions:

  • plugins/default/manifest.json: Updated display name and descriptions

🧪 Test Added

N/A - This change only affects UI text and doesn't require functional testing.

🔒Security Vulnerabilities

N/A - No security implications in this change.

Motivation

To use more inclusive language by replacing "whitelist" terminology with "allowed models" which is more descriptive and avoids potentially problematic language.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Refactoring (no functional changes)

How Has This Been Tested?

  • Unit Tests
  • Integration Tests
  • Manual Testing

Screenshots (if applicable)

N/A

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Related Issues

Addresses inclusive language concerns by replacing "whitelist" terminology.

Tip

Quality Recommendations

  1. Consider updating the 'id' field from 'modelwhitelist' to 'allowedmodels' to fully align with the new terminology

  2. Add a comment in the code explaining the terminology change for future maintainers

Sequence Diagram

sequenceDiagram
    title Rename Model Whitelist to Allowed Models
    participant User as User
    participant UI as UI Interface
    participant Guardrail as Guardrail System
    participant ModelFilter as Model Filter
    
    User->>UI: Access model filtering settings
    UI->>Guardrail: Load guardrail configuration
    Guardrail->>UI: Return configuration with "modelwhitelist" id
    
    Note over UI: UI displays "Allowed Models" instead of "Model Whitelist"
    Note over UI: Description updated to "Blocks any request whose model isn't on this list"
    Note over UI: Example models shown: "gpt-4o, llama-3-70b, mixtral-8x7b"
    Note over UI: Inversion option described as "When on, any model in the list is blocked instead of allowed"
    
    User->>UI: Configure allowed models
    UI->>Guardrail: Save configuration with "modelwhitelist" id
    Guardrail->>ModelFilter: Apply model filtering based on configuration
    ModelFilter->>Guardrail: Filter API requests using beforeRequestHook
Loading

@matterai-app matterai-app Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This PR makes a good change by replacing the term "whitelist" with "allowed models" in the UI. The changes look good overall, but I have one suggestion to improve consistency.

Comment on lines +598 to 600
"name": "Allowed Models",
"id": "modelwhitelist",
"type": "guardrail",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🛠️ Code Refactor

Issue: While the display name has been updated to "Allowed Models", the internal ID "modelwhitelist" still uses the old terminology.

Fix: Consider updating the ID to match the new terminology for complete consistency.

Impact: This would make the codebase more consistent and avoid confusion for developers who might see mixed terminology.

Suggested change
"name": "Allowed Models",
"id": "modelwhitelist",
"type": "guardrail",
\"name\": \"Allowed Models\",
\"id\": \"allowedmodels\",
\"type\": \"guardrail\",

narengogi
narengogi previously approved these changes Jun 18, 2025

@narengogi narengogi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

would recommend making the changes comprehensive by changing the plugin id

@matterai-app

matterai-app Bot commented Jun 19, 2025

Copy link
Copy Markdown
Contributor

Note

PR Review Skipped

PR review skipped as no relevant changes found due to large diff hunk OR part of a non-reviewable file.

📄Files skipped in review
  • undefined: undefined
💡Tips to use Matter AI

Command List

  • /matter summary: Generate AI Summary for the PR
  • /matter review: Generate AI Reviews for the latest commit in the PR
  • /matter review-full: Generate AI Reviews for the complete PR
  • /matter release-notes: Generate AI release-notes for the PR
  • /matter : Chat with your PR with Matter AI Agent
  • /matter remember : Generate AI memories for the PR
  • /matter explain: Get an explanation of the PR
  • /matter help: Show the list of available commands and documentation
  • Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

@VisargD

VisargD commented Jun 25, 2025

Copy link
Copy Markdown
Collaborator

would recommend making the changes comprehensive by changing the plugin id

@narengogi - We can change the labels as the first step. Changing ids will break existing implementations. Will have to think about it.

@matterai-app

matterai-app Bot commented Jun 25, 2025

Copy link
Copy Markdown
Contributor

Note

PR Review Skipped

PR review skipped as no relevant changes found due to large diff hunk OR part of a non-reviewable file.

📄Files skipped in review
  • undefined: undefined
💡Tips to use Matter AI

Command List

  • /matter summary: Generate AI Summary for the PR
  • /matter review: Generate AI Reviews for the latest commit in the PR
  • /matter review-full: Generate AI Reviews for the complete PR
  • /matter release-notes: Generate AI release-notes for the PR
  • /matter : Chat with your PR with Matter AI Agent
  • /matter remember : Generate AI memories for the PR
  • /matter explain: Get an explanation of the PR
  • /matter help: Show the list of available commands and documentation
  • Need help? Join our Discord server: https://discord.gg/fJU5DvanU3

@VisargD VisargD merged commit 6795e96 into Portkey-AI:main Jun 25, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants