-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support
resolvePackagePath
for dynamic backend plugins.
Signed-off-by: David Festal <dfestal@redhat.com>
- Loading branch information
1 parent
fae98e3
commit db682af
Showing
3 changed files
with
172 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
/* | ||
* Copyright 2023 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. | ||
*/ | ||
import { | ||
ModuleLoader, | ||
ScannedPluginManifest, | ||
} from '@backstage/backend-dynamic-feature-service'; | ||
import { LoggerService } from '@backstage/backend-plugin-api'; | ||
import path from 'path'; | ||
import * as fs from 'fs'; | ||
|
||
export class CommonJSModuleLoader implements ModuleLoader { | ||
constructor(public readonly logger: LoggerService) {} | ||
|
||
async bootstrap( | ||
backstageRoot: string, | ||
dynamicPluginsPaths: string[], | ||
): Promise<void> { | ||
const backstageRootNodeModulesPath = `${backstageRoot}/node_modules`; | ||
const dynamicNodeModulesPaths = [ | ||
...dynamicPluginsPaths.map(p => path.resolve(p, 'node_modules')), | ||
]; | ||
const ModuleObject = require('module'); | ||
const oldNodeModulePaths = ModuleObject._nodeModulePaths; | ||
ModuleObject._nodeModulePaths = (from: string): string[] => { | ||
const result: string[] = oldNodeModulePaths(from); | ||
if (!dynamicPluginsPaths.some(p => from.startsWith(p))) { | ||
return result; | ||
} | ||
const filtered = result.filter(nodeModulePath => { | ||
return ( | ||
nodeModulePath === backstageRootNodeModulesPath || | ||
dynamicNodeModulesPaths.some(p => nodeModulePath.startsWith(p)) | ||
); | ||
}); | ||
this.logger.debug( | ||
`Overriding node_modules search path for dynamic plugin ${from} to: ${filtered}`, | ||
); | ||
return filtered; | ||
}; | ||
|
||
let dynamicPluginPackages: | ||
| { name: string; dependencies: string[]; path: string }[] | ||
| undefined = undefined; | ||
|
||
const oldResolveFileName = ModuleObject._resolveFilename; | ||
ModuleObject._resolveFilename = ( | ||
request: string, | ||
mod: NodeModule, | ||
_: boolean, | ||
options: any, | ||
): any => { | ||
let errorToThrow: any; | ||
try { | ||
return oldResolveFileName(request, mod, _, options); | ||
} catch (e) { | ||
errorToThrow = e; | ||
this.logger.debug( | ||
`Could not resolve '${request}' in the Core backstage backend application`, | ||
e instanceof Error ? e : undefined, | ||
); | ||
} | ||
|
||
if ( | ||
// we're searching for the folder of a backstage package (through @backstage/backend-common/resolvePackagePath) ? | ||
// => - we're trying to resolve a `package.json` | ||
request && | ||
request.endsWith('/package.json') && | ||
// - from the `backend-common` core backstage application module | ||
mod?.path && | ||
!dynamicPluginsPaths.some(p => mod.path.startsWith(p)) && | ||
mod.path.includes(`backend-common`) | ||
) { | ||
this.logger.debug( | ||
`Trying to resolve '${request}' in the dynamic backend plugins`, | ||
); | ||
|
||
if (!dynamicPluginPackages) { | ||
dynamicPluginPackages = []; | ||
dynamicPluginsPaths.forEach(p => { | ||
try { | ||
const manifestFile = path.resolve(p, 'package.json'); | ||
const content = fs.readFileSync(manifestFile); | ||
const manifest: ScannedPluginManifest = JSON.parse( | ||
content.toString(), | ||
); | ||
dynamicPluginPackages!.push({ | ||
name: manifest.name, | ||
dependencies: Object.keys(manifest.dependencies || {}), | ||
path: p, | ||
}); | ||
} catch (e) { | ||
this.logger.error( | ||
`Error when reading 'package.json' in '${p}'`, | ||
e instanceof Error ? e : undefined, | ||
); | ||
} | ||
}); | ||
} | ||
|
||
const searchedPackageName = request.replace(/\/package.json$/, ''); | ||
const searchedPackageNameDynamic = `${searchedPackageName}-dynamic`; | ||
for (const p of dynamicPluginPackages) { | ||
// Case of a dynamic plugin package | ||
if ( | ||
searchedPackageName === p.name || | ||
searchedPackageNameDynamic === p.name | ||
) { | ||
return path.resolve(p.path, 'package.json'); | ||
} | ||
|
||
// Case of a dynamic plugin wrapper package | ||
if (p.dependencies.includes(searchedPackageName)) { | ||
const searchPath = path.resolve(p.path, 'node_modules'); | ||
try { | ||
return require.resolve(searchedPackageName, { | ||
paths: [searchPath], | ||
}); | ||
} catch (e) { | ||
this.logger.error( | ||
`Error when resolving '${searchedPackageName}' with search path: '[${searchPath}]'`, | ||
e instanceof Error ? e : undefined, | ||
); | ||
} | ||
} | ||
} | ||
} | ||
|
||
throw errorToThrow; | ||
}; | ||
} | ||
|
||
async load(packagePath: string): Promise<any> { | ||
return await require(/* webpackIgnore: true */ packagePath); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Copyright 2023 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. | ||
*/ | ||
|
||
export { CommonJSModuleLoader } from './CommonJSModuleLoader'; |