Skip to content

Commit 372261f

Browse files
rohitkrai03cursoragent
rohitkrai03
and
cursoragent
committed
feat(boost): scaffold AI Catalog frontend plugin and dev app
Implements Story 1 (RHIDP-15165) — Plugin Scaffold and Dev App for the AI Catalog frontend feature. Plugin (plugins/boost/): - NFS-only frontend plugin with createFrontendPlugin, no legacy entry point - PageBlueprint at /ai-catalog for the browse page - EntityCardBlueprint stubs (summary, download, version) with isAiAsset filter - EntityContentBlueprint stub (usage tab) with isAiAsset filter - isAiAsset() condition filter for all 7 AI asset kind/type combinations - useAiAssets() hook wrapping catalogApiRef with client-side filtering - Placeholder AiCatalogPage component - i18n scaffold with TranslationBlueprint and translation resource - Translation module auto-discovery entry point for app.packages: all - Unit tests for isAiAsset and AiCatalogPage Dev app (packages/app/): - NFS app with createApp, RHDH theme, sign-in module, nav module - Sidebar with AI Catalog and Catalog entries, app-visualizer, user settings Dev backend (packages/backend/): - Minimal backend with auth (guest), catalog, techdocs, permission, search Fixtures and config: - Sample catalog-info.yaml for all AI asset types - app-config.yaml with app.packages: all and route redirect Also adds @red-hat-developer-hub/backstage-plugin-boost to pluginPackages in all boost-family backend/common/node packages. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 106b9f0 commit 372261f

44 files changed

Lines changed: 17072 additions & 9483 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎workspaces/boost/app-config.yaml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
app:
2+
title: Boost Dev
3+
baseUrl: http://localhost:3000
4+
packages: all
5+
extensions:
6+
- app/routes:
7+
config:
8+
redirects:
9+
- from: /
10+
to: /ai-catalog
11+
12+
organization:
13+
name: Red Hat
14+
15+
backend:
16+
baseUrl: http://localhost:7007
17+
listen:
18+
port: 7007
19+
cors:
20+
origin: http://localhost:3000
21+
methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
22+
credentials: true
23+
database:
24+
client: better-sqlite3
25+
connection: ':memory:'
26+
cache:
27+
store: memory
28+
29+
auth:
30+
environment: development
31+
providers:
32+
guest: {}
33+
34+
techdocs:
35+
builder: 'local'
36+
generator:
37+
runIn: 'local'
38+
publisher:
39+
type: 'local'
40+
41+
catalog:
42+
import:
43+
entityFilename: catalog-info.yaml
44+
pullRequestBranchName: backstage-integration
45+
rules:
46+
- allow:
47+
- Component
48+
- System
49+
- Group
50+
- Resource
51+
- Location
52+
- Template
53+
- API
54+
- AiResource
55+
locations:
56+
- type: file
57+
target: ../../fixtures/ai-catalog-fixtures.yaml
58+
rules:
59+
- allow: [AiResource, API, Component, Resource]

‎workspaces/boost/fixtures/ai-catalog-fixtures.yaml‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
---
2+
# AI Catalog sample fixtures — one entity per AI asset category.
3+
# Used by the dev app for local development and testing.
4+
5+
# ---------------------------------------------------------------------------
6+
# AiResource / skill
7+
# ---------------------------------------------------------------------------
8+
apiVersion: backstage.io/v1alpha1
9+
kind: AiResource
10+
metadata:
11+
name: code-review-skill
12+
title: Code Review Skill
13+
description: Automated code review that checks for common issues, security vulnerabilities, and style violations.
14+
tags:
15+
- code-review
16+
- security
17+
- quality
18+
annotations:
19+
rhdh.io/ai-asset-category: skill
20+
rhdh.io/ai-asset-version: '1.2.0'
21+
rhdh.io/ai-asset-source: github
22+
backstage.io/techdocs-ref: dir:.
23+
links:
24+
- url: https://github.com/example/code-review-skill
25+
title: Source Repository
26+
spec:
27+
type: skill
28+
lifecycle: production
29+
owner: team-ai-platform
30+
disciplines:
31+
- software-engineering
32+
categories:
33+
- code-quality
34+
agents:
35+
- component:default/developer-assistant
36+
37+
---
38+
# ---------------------------------------------------------------------------
39+
# AiResource / rule
40+
# ---------------------------------------------------------------------------
41+
apiVersion: backstage.io/v1alpha1
42+
kind: AiResource
43+
metadata:
44+
name: no-hardcoded-secrets-rule
45+
title: No Hardcoded Secrets
46+
description: Ensures that secrets, API keys, and credentials are never committed to source code repositories.
47+
tags:
48+
- security
49+
- compliance
50+
- secrets
51+
annotations:
52+
rhdh.io/ai-asset-category: rule
53+
rhdh.io/ai-asset-version: '2.0.1'
54+
rhdh.io/ai-asset-source: internal
55+
spec:
56+
type: rule
57+
lifecycle: production
58+
owner: team-security
59+
category: security
60+
rationale: Hardcoded secrets in source code can be extracted by attackers, leading to credential compromise and unauthorized access to systems.
61+
62+
---
63+
# ---------------------------------------------------------------------------
64+
# API / mcp-server
65+
# ---------------------------------------------------------------------------
66+
apiVersion: backstage.io/v1alpha1
67+
kind: API
68+
metadata:
69+
name: github-mcp-server
70+
title: GitHub MCP Server
71+
description: Model Context Protocol server providing GitHub repository context, pull request data, and issue tracking integration.
72+
tags:
73+
- github
74+
- mcp
75+
- context
76+
annotations:
77+
rhdh.io/ai-asset-category: mcp-server
78+
rhdh.io/ai-asset-version: '0.9.0'
79+
rhdh.io/ai-asset-source: registry
80+
spec:
81+
type: mcp-server
82+
lifecycle: experimental
83+
owner: team-integrations
84+
definition: |
85+
openapi: 3.0.0
86+
info:
87+
title: GitHub MCP Server
88+
version: 0.9.0
89+
remotes:
90+
- url: https://mcp.example.com/github
91+
transport: streamable-http
92+
93+
---
94+
# ---------------------------------------------------------------------------
95+
# Component / ai-agent
96+
# ---------------------------------------------------------------------------
97+
apiVersion: backstage.io/v1alpha1
98+
kind: Component
99+
metadata:
100+
name: developer-assistant
101+
title: Developer Assistant Agent
102+
description: An AI agent that helps developers with code generation, debugging, architecture decisions, and documentation.
103+
tags:
104+
- agent
105+
- developer
106+
- assistant
107+
annotations:
108+
rhdh.io/ai-asset-category: agent
109+
rhdh.io/ai-asset-version: '3.1.0'
110+
rhdh.io/ai-asset-source: internal
111+
spec:
112+
type: ai-agent
113+
lifecycle: production
114+
owner: team-ai-platform
115+
116+
---
117+
# ---------------------------------------------------------------------------
118+
# Resource / ai-model
119+
# ---------------------------------------------------------------------------
120+
apiVersion: backstage.io/v1alpha1
121+
kind: Resource
122+
metadata:
123+
name: granite-3-code
124+
title: Granite 3 Code
125+
description: IBM Granite 3 code model optimized for code generation, completion, and explanation tasks.
126+
tags:
127+
- model
128+
- code-generation
129+
- ibm
130+
annotations:
131+
rhdh.io/ai-asset-category: model
132+
rhdh.io/ai-asset-version: '3.0.0'
133+
rhdh.io/ai-asset-source: model-registry
134+
spec:
135+
type: ai-model
136+
lifecycle: production
137+
owner: team-ml-ops
138+
139+
---
140+
# ---------------------------------------------------------------------------
141+
# Resource / ai-tool
142+
# ---------------------------------------------------------------------------
143+
apiVersion: backstage.io/v1alpha1
144+
kind: Resource
145+
metadata:
146+
name: web-search-tool
147+
title: Web Search Tool
148+
description: A tool that performs web searches and returns structured results for AI agent consumption.
149+
tags:
150+
- tool
151+
- search
152+
- web
153+
annotations:
154+
rhdh.io/ai-asset-category: tool
155+
rhdh.io/ai-asset-version: '1.0.0'
156+
rhdh.io/ai-asset-source: kagenti
157+
spec:
158+
type: ai-tool
159+
lifecycle: experimental
160+
owner: team-integrations
161+
162+
---
163+
# ---------------------------------------------------------------------------
164+
# Resource / vector-store
165+
# ---------------------------------------------------------------------------
166+
apiVersion: backstage.io/v1alpha1
167+
kind: Resource
168+
metadata:
169+
name: docs-vector-store
170+
title: Documentation Vector Store
171+
description: Vector store containing embeddings of internal documentation, runbooks, and knowledge base articles.
172+
tags:
173+
- vector-store
174+
- documentation
175+
- rag
176+
annotations:
177+
rhdh.io/ai-asset-category: vector-store
178+
rhdh.io/ai-asset-version: '1.1.0'
179+
rhdh.io/ai-asset-source: internal
180+
spec:
181+
type: vector-store
182+
lifecycle: production
183+
owner: team-ai-platform

‎workspaces/boost/package.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
},
4141
"devDependencies": {
4242
"@backstage/cli": "^0.36.3",
43+
"@backstage/cli-defaults": "^0.1.0",
4344
"@backstage/e2e-test-utils": "^0.1.2",
4445
"@backstage/repo-tools": "^0.17.3",
4546
"@changesets/cli": "^2.27.1",

‎workspaces/boost/packages/app/.eslintrc.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = {
2+
...require('@backstage/cli/config/eslint-factory')(__dirname),
3+
root: true,
4+
};

‎workspaces/boost/packages/app/package.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"name": "app",
3+
"version": "0.0.0",
4+
"private": true,
5+
"bundled": true,
6+
"backstage": {
7+
"role": "frontend"
8+
},
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/redhat-developer/rhdh-plugins",
12+
"directory": "workspaces/boost/packages/app"
13+
},
14+
"scripts": {
15+
"start": "backstage-cli package start",
16+
"build": "backstage-cli package build",
17+
"clean": "backstage-cli package clean",
18+
"test": "backstage-cli package test",
19+
"lint": "backstage-cli package lint"
20+
},
21+
"dependencies": {
22+
"@backstage/cli": "^0.36.3",
23+
"@backstage/core-components": "^0.18.10",
24+
"@backstage/core-plugin-api": "^1.12.6",
25+
"@backstage/frontend-defaults": "^0.5.2",
26+
"@backstage/frontend-plugin-api": "^0.17.1",
27+
"@backstage/plugin-app-react": "^0.2.3",
28+
"@backstage/plugin-app-visualizer": "^0.2.5",
29+
"@backstage/plugin-catalog": "^2.0.5",
30+
"@backstage/plugin-user-settings": "^0.9.3",
31+
"@backstage/ui": "^0.15.0",
32+
"@mui/icons-material": "^5.17.1",
33+
"@mui/material": "^5.17.1",
34+
"@red-hat-developer-hub/backstage-plugin-boost": "workspace:^",
35+
"@red-hat-developer-hub/backstage-plugin-theme": "^0.14.0",
36+
"react": "^18.0.2",
37+
"react-dom": "^18.0.2",
38+
"react-router": "^6.30.4",
39+
"react-router-dom": "^6.3.0"
40+
},
41+
"devDependencies": {
42+
"@backstage/test-utils": "^1.7.18",
43+
"@testing-library/dom": "^9.0.0",
44+
"@testing-library/jest-dom": "^6.0.0",
45+
"@testing-library/react": "^14.0.0",
46+
"@types/react-dom": "*",
47+
"cross-env": "^7.0.0"
48+
},
49+
"browserslist": {
50+
"production": [
51+
">0.2%",
52+
"not dead",
53+
"not op_mini all"
54+
],
55+
"development": [
56+
"last 1 chrome version",
57+
"last 1 firefox version",
58+
"last 1 safari version"
59+
]
60+
},
61+
"files": [
62+
"dist"
63+
]
64+
}

‎workspaces/boost/packages/app/src/App.tsx‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright Red Hat, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import { createApp } from '@backstage/frontend-defaults';
18+
import { rhdhThemeModule } from '@red-hat-developer-hub/backstage-plugin-theme/alpha';
19+
20+
import { navModule } from './modules/nav';
21+
import { signInModule } from './modules/signIn';
22+
23+
export default createApp({
24+
features: [rhdhThemeModule, signInModule, navModule],
25+
});

‎workspaces/boost/packages/app/src/index.tsx‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Copyright Red Hat, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
import '@backstage/cli/asset-types';
18+
import ReactDOM from 'react-dom/client';
19+
import App from './App';
20+
import '@backstage/ui/css/styles.css';
21+
22+
ReactDOM.createRoot(document.getElementById('root')!).render(App.createRoot());

0 commit comments

Comments
 (0)