paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make a warning for invalid plugin and module Ids

Browse Source 
Signed-off-by: Juan Pablo Garcia Ripa <sarabadu@gmail.com>
This commit is contained in:
Juan Pablo Garcia Ripa
2025-09-07 22:50:30 +02:00
parent 051b3af31d
commit f4470cd3a3
4 changed files with 52 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/src/wiring/constants.ts
+28
View File
@@ -0,0 +1,28 @@
/*
* Copyright 2025 The Backstage Authors
*
* 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.
*/
/**
* The pattern that IDs must match.
*
* @remarks
* ids must only contain the letters `a` through `z` and digits, in groups separated by
* dashes. Additionally, the very first character of each such group
* must be a letter, not a digit
*
* @public
*/
export const ID_PATTERN = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/i;
export const ID_PATTERN_OLD = /^[a-z][a-z0-9]*(?:[-_][a-z0-9]+)*$/i;
packages/backend-plugin-api/src/wiring/createBackendModule.ts
+8 -3
View File
@@ -14,8 +14,8 @@
* limitations under the License.
*/
import { CONFIG_KEY_PART_PATTERN } from '@backstage/config';
import { BackendFeature } from '../types';
import { ID_PATTERN, ID_PATTERN_OLD } from './constants';
import {
BackendModuleRegistrationPoints,
InternalBackendModuleRegistration,
@@ -56,9 +56,14 @@ export function createBackendModule(
options: CreateBackendModuleOptions,
): BackendFeature {
function getRegistrations() {
if (!CONFIG_KEY_PART_PATTERN.test(options.moduleId)) {
if (!ID_PATTERN.test(options.moduleId)) {
console.warn(
`WARNING: The moduleId '${options.moduleId}' for plugin '${options.pluginId}', will be invalid soon please must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,
);
}
if (!ID_PATTERN_OLD.test(options.moduleId)) {
throw new Error(
`Invalid moduleId '${options.moduleId}' for plugin '${options.pluginId}', must match the pattern ${CONFIG_KEY_PART_PATTERN} (letters, digits, dashes, and underscores only, starting with a letter)`,
`Invalid moduleId '${options.moduleId}' for plugin '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,
);
}
packages/backend-plugin-api/src/wiring/createBackendPlugin.ts
+8 -3
View File
@@ -14,13 +14,13 @@
* limitations under the License.
*/
import { CONFIG_KEY_PART_PATTERN } from '@backstage/config';
import { BackendFeature } from '../types';
import {
BackendPluginRegistrationPoints,
InternalBackendPluginRegistration,
InternalBackendRegistrations,
} from './types';
import { ID_PATTERN, ID_PATTERN_OLD } from './constants';
/**
* The configuration options passed to {@link createBackendPlugin}.
@@ -50,9 +50,14 @@ export function createBackendPlugin(
options: CreateBackendPluginOptions,
): BackendFeature {
function getRegistrations() {
if (!CONFIG_KEY_PART_PATTERN.test(options.pluginId)) {
if (!ID_PATTERN.test(options.pluginId)) {
console.warn(
`WARNING: The pluginId '${options.pluginId}' will be invalid soon please must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,
);
}
if (!ID_PATTERN_OLD.test(options.pluginId)) {
throw new Error(
`Invalid pluginId '${options.pluginId}', must match the pattern ${CONFIG_KEY_PART_PATTERN} (letters, digits, dashes, and underscores only, starting with a letter)`,
`Invalid pluginId '${options.pluginId}', must match the pattern ${ID_PATTERN} (letters, digits, and dashes only, starting with a letter)`,
);
}