yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: Plugin registration (#6623)

Browse Source 
* first pass

* test

* test

* priority

* Reduce boilerplate further

* Update server/utils/PluginManager.ts

Co-authored-by: Apoorv Mishra <apoorvmishra101092@gmail.com>

* fix: matchesNode error in destroyed editor transaction

* fix: Individual imported files do not display source correctly in 'Insights'

* chore: Add sleep before Slack notification

* docs

* fix: Error logged about missing plugin.json

* Remove email template glob

---------

Co-authored-by: Apoorv Mishra <apoorvmishra101092@gmail.com>
This commit is contained in:
Tom Moor
2024-03-08 21:32:05 -07:00
committed by GitHub
parent f3334cedb2
commit f9a11a28d8
43 changed files with 400 additions and 276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
server/models/helpers/AuthenticationHelper.ts
View File

@@ -1,23 +1,10 @@
/* eslint-disable @typescript-eslint/no-var-requires */
import path from "path";
import { glob } from "glob";
import Router from "koa-router";
import find from "lodash/find";
import sortBy from "lodash/sortBy";
import env from "@server/env";
import Team from "@server/models/Team";
import environment from "@server/utils/environment";
export type AuthenticationProviderConfig = {
id: string;
name: string;
enabled: boolean;
router: Router;
};
import { PluginManager, PluginType } from "@server/utils/PluginManager";
export default class AuthenticationHelper {
private static providersCache: AuthenticationProviderConfig[];
/**
* Returns the enabled authentication provider configurations for the current
* installation.
@@ -25,46 +12,7 @@ export default class AuthenticationHelper {
* @returns A list of authentication providers
*/
public static get providers() {
if (this.providersCache) {
return this.providersCache;
}
const authenticationProviderConfigs: AuthenticationProviderConfig[] = [];
const rootDir = env.ENVIRONMENT === "test" ? "" : "build";
glob
.sync(path.join(rootDir, "plugins/*/server/auth/!(*.test|schema).[jt]s"))
.forEach((filePath: string) => {
const { default: authProvider, name } = require(path.join(
process.cwd(),
filePath
));
const id = filePath.replace("build/", "").split("/")[1];
const config = require(path.join(
process.cwd(),
rootDir,
"plugins",
id,
"plugin.json"
));
// Test the all required env vars are set for the auth provider
const enabled = (config.requiredEnvVars ?? []).every(
(name: string) => !!environment[name]
);
if (enabled) {
authenticationProviderConfigs.push({
id,
name: name ?? config.name,
enabled,
router: authProvider,
});
}
});
this.providersCache = sortBy(authenticationProviderConfigs, "id");
return this.providersCache;
return PluginManager.getEnabledPlugins(PluginType.AuthProvider);
}
/**
@@ -78,11 +26,11 @@ export default class AuthenticationHelper {
const isCloudHosted = env.isCloudHosted;
return AuthenticationHelper.providers
.sort((config) => (config.id === "email" ? 1 : -1))
.filter((config) => {
// Guest sign-in is an exception as it does not have an authentication
.sort((plugin) => (plugin.id === "email" ? 1 : -1))
.filter((plugin) => {
// Email sign-in is an exception as it does not have an authentication
// provider using passport, instead it exists as a boolean option.
if (config.id === "email") {
if (plugin.id === "email") {
return team?.emailSigninEnabled;
}
@@ -92,7 +40,7 @@ export default class AuthenticationHelper {
}
const authProvider = find(team.authenticationProviders, {
name: config.id,
name: plugin.id,
});
// If cloud hosted then the auth provider must be enabled for the team,