Просмотр исходного кода

Fix params and return type

https://youtrack.weseek.co.jp/issue/GW-7824
- Fix typo of method name getOIDCIssuerInstace
- Add params and return type of isOidcHostReachable , getOIDCMetadataURL and  getOIDCIssuerInstance method
mudana 3 лет назад
Родитель
Сommit
3621028ee4
1 измененных файлов с 6 добавлено и 6 удалено
  1. 6 6
      packages/app/src/server/service/passport.ts

+ 6 - 6
packages/app/src/server/service/passport.ts

@@ -638,7 +638,7 @@ class PassportService implements S2sMessageHandlable {
       : configManager.getConfig('crowi', 'security:passport-oidc:callbackUrl'); // DEPRECATED: backward compatible with v3.2.3 and below
       : configManager.getConfig('crowi', 'security:passport-oidc:callbackUrl'); // DEPRECATED: backward compatible with v3.2.3 and below
 
 
     // Prevent request timeout error on app init
     // Prevent request timeout error on app init
-    const oidcIssuer = await this.getOIDCIssuerInstace(issuerHost);
+    const oidcIssuer = await this.getOIDCIssuerInstance(issuerHost);
     if (oidcIssuer != null) {
     if (oidcIssuer != null) {
       logger.debug('Discovered issuer %s %O', oidcIssuer.issuer, oidcIssuer.metadata);
       logger.debug('Discovered issuer %s %O', oidcIssuer.issuer, oidcIssuer.metadata);
 
 
@@ -726,7 +726,7 @@ class PassportService implements S2sMessageHandlable {
    * @param issuerHost string
    * @param issuerHost string
    * @returns string URL/.well-known/openid-configuration
    * @returns string URL/.well-known/openid-configuration
    */
    */
-  getOIDCMetadataURL(issuerHost) {
+  getOIDCMetadataURL(issuerHost: string) : string {
     const protocol = 'https://';
     const protocol = 'https://';
     const pattern = /^https?:\/\//i;
     const pattern = /^https?:\/\//i;
     const metadataPath = '/.well-known/openid-configuration';
     const metadataPath = '/.well-known/openid-configuration';
@@ -746,10 +746,10 @@ class PassportService implements S2sMessageHandlable {
  * Check and initialize connection to OIDC issuer host
  * Check and initialize connection to OIDC issuer host
  * Prevent request timeout error on app init
  * Prevent request timeout error on app init
  *
  *
- * @param issuerHost
+ * @param issuerHost string
  * @returns boolean
  * @returns boolean
  */
  */
-  async isOidcHostReachable(issuerHost) {
+  async isOidcHostReachable(issuerHost: string): Promise<boolean | undefined> {
     try {
     try {
       const metadataUrl = this.getOIDCMetadataURL(issuerHost);
       const metadataUrl = this.getOIDCMetadataURL(issuerHost);
       const client = require('axios').default;
       const client = require('axios').default;
@@ -773,10 +773,10 @@ class PassportService implements S2sMessageHandlable {
    * Get oidcIssuer object
    * Get oidcIssuer object
    * Utilize p-retry package to retry oidcIssuer initialization 3 times
    * Utilize p-retry package to retry oidcIssuer initialization 3 times
    *
    *
-   * @param issuerHost
+   * @param issuerHost string
    * @returns instance of OIDCIssuer
    * @returns instance of OIDCIssuer
    */
    */
-  async getOIDCIssuerInstace(issuerHost) {
+  async getOIDCIssuerInstance(issuerHost: string): Promise<void | OIDCIssuer> {
     const OIDC_TIMEOUT_MULTIPLIER = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:timeoutMultiplier');
     const OIDC_TIMEOUT_MULTIPLIER = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:timeoutMultiplier');
     const OIDC_DISCOVERY_RETRIES = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:discoveryRetries');
     const OIDC_DISCOVERY_RETRIES = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:discoveryRetries');
     const OIDC_ISSUER_TIMEOUT_OPTION = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:oidcIssuerTimeoutOption');
     const OIDC_ISSUER_TIMEOUT_OPTION = await this.crowi.configManager.getConfig('crowi', 'security:passport-oidc:oidcIssuerTimeoutOption');