chore: fix lint issues

Author: juanpicado

.eslintignore

@@ -3,3 +3,4 @@ build/
 flow-typed/
 coverage/
 tests-report/
+test/unit/partials/

.eslintrc

@@ -12,6 +12,8 @@
     "@typescript-eslint/array-type": ["warn"],
     "@typescript-eslint/no-explicit-any": 0,
     "@typescript-eslint/indent": 0,
-    "@typescript-eslint/interface-name-prefix": 0
+    "@typescript-eslint/explicit-function-return-type": 0,
+    "@typescript-eslint/interface-name-prefix": 0,
+    "@typescript-eslint/explicit-member-accessibility": 0
   }
 }

.flowconfig

@@ -22,7 +22,7 @@
     "build:docker": "docker build -t verdaccio-gitlab . --no-cache",
     "test": "yarn test:unit",
     "test:unit": "cross-env BABEL_ENV=test TZ=UTC jest --config ./test/jest.config.unit.js --maxWorkers 2",
-    "test:functional": "cross-env BABEL_ENV=test TZ=UTC jest --config ./test/jest.config.functional.js",
+    "test:functional": "cross-env BABEL_ENV=test TZ=UTC jest --config ./test/jest.config.functional.js --testPathPattern ./test/functional/index* --passWithNoTests",
     "test:all": "yarn test && yarn test:functional"
   },
   "main": "build/index.js",
@@ -57,22 +57,22 @@
     "verdaccio": "^4.3.4"
   },
   "devDependencies": {
-    "@verdaccio/babel-preset": "^8.2.0",
-    "@verdaccio/eslint-config": "^8.2.0",
-    "@verdaccio/commons-api": "^8.2.0",
-    "@verdaccio/types": "^8.3.0",
     "@commitlint/cli": "7.0.0",
     "@commitlint/config-conventional": "7.0.1",
     "@commitlint/travis-cli": "7.0.0",
     "@types/http-errors": "1.6.1",
     "@types/jest": "24.0.15",
     "@types/node": "^12.0.10",
+    "@types/lodash": "^4.14.141",
     "@typescript-eslint/eslint-plugin": "2.1.0",
+    "@verdaccio/babel-preset": "^8.2.0",
+    "@verdaccio/commons-api": "^8.2.0",
+    "@verdaccio/eslint-config": "^8.2.0",
+    "@verdaccio/types": "^8.3.0",
     "body-parser": "^1.18.3",
     "chalk": "^2.4.1",
     "cross-env": "^5.2.0",
     "eslint": "^6.3.0",
-
     "express": "^4.16.3",
     "generate-changelog": "1.7.1",
     "http-status": "^1.2.0",
@@ -83,6 +83,7 @@
     "license-checker": "20.1.0",
     "lodash": "^4.17.10",
     "markdownlint-cli": "0.11.0",
+    "prettier": "^1.18.2",
     "repolinter": "0.7.0",
     "request": "^2.88.0",
     "rimraf": "^2.6.2",

package.json

@@ -1,17 +1,19 @@
 // Copyright 2018 Roger Meier <[email protected]>
 // SPDX-License-Identifier: MIT
 
-import { Logger } from '@verdaccio/types';
-
 import Crypto from 'crypto';
+
+import { Logger } from '@verdaccio/types';
 import NodeCache from 'node-cache';
 
 export class AuthCache {
   logger: Logger;
   ttl: number;
   storage: NodeCache;
 
-  static get DEFAULT_TTL() { return 300; }
+  static get DEFAULT_TTL() {
+    return 300;
+  }
 
   static _generateKeyHash(username: string, password: string) {
     const sha = Crypto.createHash('sha256');
@@ -25,7 +27,7 @@ export class AuthCache {
 
     this.storage = new NodeCache({
       stdTTL: this.ttl,
-      useClones: false
+      useClones: false,
     });
     this.storage.on('expired', (key, value) => {
       this.logger.trace(`[gitlab] expired key: ${key} with value:`, value);
@@ -42,16 +44,22 @@ export class AuthCache {
 }
 
 export type UserDataGroups = {
-  publish: string[]
+  publish: string[];
 };
 
 export class UserData {
   _username: string;
   _groups: UserDataGroups;
 
-  get username(): string { return this._username; }
-  get groups(): UserDataGroups { return this._groups; }
-  set groups(groups: UserDataGroups) { this._groups = groups; }
+  get username(): string {
+    return this._username;
+  }
+  get groups(): UserDataGroups {
+    return this._groups;
+  }
+  set groups(groups: UserDataGroups) {
+    this._groups = groups;
+  }
 
   constructor(username: string, groups: UserDataGroups) {
     this._username = username;

src/authcache.ts

@@ -3,53 +3,46 @@
 
 import { Callback, IPluginAuth, Logger, PluginOptions, RemoteUser, PackageAccess } from '@verdaccio/types';
 import { getInternalError, getUnauthorized, getForbidden } from '@verdaccio/commons-api';
-import { UserDataGroups } from './authcache';
-
 import Gitlab from 'gitlab';
+
+import { UserDataGroups } from './authcache';
 import { AuthCache, UserData } from './authcache';
 
-export type VerdaccioGitlabAccessLevel =
-  '$guest' |
-  '$reporter' |
-  '$developer' |
-  '$maintainer' |
-  '$owner';
+export type VerdaccioGitlabAccessLevel = '$guest' | '$reporter' | '$developer' | '$maintainer' | '$owner';
 
 export type VerdaccioGitlabConfig = {
-  url: string,
+  url: string;
   authCache?: {
-    enabled?: boolean,
-    ttl?: number
-  },
-  legacy_mode?: boolean,
-  publish?: VerdaccioGitlabAccessLevel
+    enabled?: boolean;
+    ttl?: number;
+  };
+  legacy_mode?: boolean;
+  publish?: VerdaccioGitlabAccessLevel;
 };
 
 export interface VerdaccioGitlabPackageAccess extends PackageAccess {
-  name?: string,
-  gitlab?: boolean
-};
+  name?: string;
+  gitlab?: boolean;
+}
 
 const ACCESS_LEVEL_MAPPING = {
   $guest: 10,
   $reporter: 20,
   $developer: 30,
   $maintainer: 40,
-  $owner: 50
+  $owner: 50,
 };
 
 // List of verdaccio builtin levels that map to anonymous access
-const BUILTIN_ACCESS_LEVEL_ANONYMOUS = [ '$anonymous', '$all' ];
+const BUILTIN_ACCESS_LEVEL_ANONYMOUS = ['$anonymous', '$all'];
 
 // Level to apply on 'allow_access' calls when a package definition does not define one
-const DEFAULT_ALLOW_ACCESS_LEVEL = [ '$all' ];
-
+const DEFAULT_ALLOW_ACCESS_LEVEL = ['$all'];
 
 export interface VerdaccioGitLabPlugin extends IPluginAuth<VerdaccioGitlabConfig> {
   authCache: AuthCache;
 }
 
-
 export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
   options: PluginOptions<VerdaccioGitlabConfig>;
   config: VerdaccioGitlabConfig;
@@ -104,53 +97,58 @@ export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
 
     const GitlabAPI = new Gitlab({
       url: this.config.url,
-      token: password
+      token: password,
     });
 
-    GitlabAPI.Users.current().then(response => {
-      if (user !== response.username) {
-        return cb(getForbidden('wrong gitlab username'));
-      }
-
-      const publishLevelId = ACCESS_LEVEL_MAPPING[this.publishLevel];
-
-      // Set the groups of an authenticated user, in normal mode:
-      // - for access, depending on the package settings in verdaccio
-      // - for publish, the logged in user id and all the groups they can reach as configured with access level `$auth.gitlab.publish`
-      //
-      // In legacy mode, the groups are:
-      // - for access, depending on the package settings in verdaccio
-      // - for publish, the logged in user id and all the groups they can reach as fixed `$auth.gitlab.publish` = `$owner`
-      const gitlabPublishQueryParams = this.config.legacy_mode ? { owned: true } : { min_access_level: publishLevelId };
-      // @ts-ignore
-      this.logger.trace('[gitlab] querying gitlab user groups with params:', gitlabPublishQueryParams);
-
-      const groupsPromise = GitlabAPI.Groups.all(gitlabPublishQueryParams).then(groups => {
-        return groups.filter(group => group.path === group.full_path).map(group => group.path);
-      });
-
-      const projectsPromise = GitlabAPI.Projects.all(gitlabPublishQueryParams).then(projects => {
-        return projects.map(project => project.path_with_namespace);
-      });
-
-      Promise.all([groupsPromise, projectsPromise]).then(([groups, projectGroups]) => {
-        const realGroups = [user, ...groups, ...projectGroups];
-        this._setCachedUserGroups(user, password, { publish: realGroups });
+    GitlabAPI.Users.current()
+      .then(response => {
+        if (user !== response.username) {
+          return cb(getForbidden('wrong gitlab username'));
+        }
 
-        this.logger.info(`[gitlab] user: ${user} successfully authenticated`);
+        const publishLevelId = ACCESS_LEVEL_MAPPING[this.publishLevel];
+
+        // Set the groups of an authenticated user, in normal mode:
+        // - for access, depending on the package settings in verdaccio
+        // - for publish, the logged in user id and all the groups they can reach as configured with access level `$auth.gitlab.publish`
+        //
+        // In legacy mode, the groups are:
+        // - for access, depending on the package settings in verdaccio
+        // - for publish, the logged in user id and all the groups they can reach as fixed `$auth.gitlab.publish` = `$owner`
+        const gitlabPublishQueryParams = this.config.legacy_mode
+          ? { owned: true }
+          : { min_access_level: publishLevelId };
         // @ts-ignore
-        this.logger.debug(`[gitlab] user: ${user}, with groups:`, realGroups);
-
-        return cb(null, realGroups);
-      }).catch(error => {
-        this.logger.error(`[gitlab] user: ${user} error querying gitlab: ${error}`);
+        this.logger.trace('[gitlab] querying gitlab user groups with params:', gitlabPublishQueryParams);
+
+        const groupsPromise = GitlabAPI.Groups.all(gitlabPublishQueryParams).then(groups => {
+          return groups.filter(group => group.path === group.full_path).map(group => group.path);
+        });
+
+        const projectsPromise = GitlabAPI.Projects.all(gitlabPublishQueryParams).then(projects => {
+          return projects.map(project => project.path_with_namespace);
+        });
+
+        Promise.all([groupsPromise, projectsPromise])
+          .then(([groups, projectGroups]) => {
+            const realGroups = [user, ...groups, ...projectGroups];
+            this._setCachedUserGroups(user, password, { publish: realGroups });
+
+            this.logger.info(`[gitlab] user: ${user} successfully authenticated`);
+            // @ts-ignore
+            this.logger.debug(`[gitlab] user: ${user}, with groups:`, realGroups);
+
+            return cb(null, realGroups);
+          })
+          .catch(error => {
+            this.logger.error(`[gitlab] user: ${user} error querying gitlab: ${error}`);
+            return cb(getUnauthorized('error authenticating user'));
+          });
+      })
+      .catch(error => {
+        this.logger.error(`[gitlab] user: ${user} error querying gitlab user data: ${error.message || {}}`);
         return cb(getUnauthorized('error authenticating user'));
       });
-
-    }).catch(error => {
-      this.logger.error(`[gitlab] user: ${user} error querying gitlab user data: ${error.message || {}}`);
-      return cb(getUnauthorized('error authenticating user'));
-    });
   }
 
   adduser(user: string, password: string, cb: Callback) {
@@ -166,12 +164,14 @@ export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
   allow_access(user: RemoteUser, _package: VerdaccioGitlabPackageAccess & PackageAccess, cb: Callback) {
     if (!_package.gitlab) return cb(null, false);
 
-    const packageAccess = (_package.access && _package.access.length > 0) ? _package.access : DEFAULT_ALLOW_ACCESS_LEVEL;
+    const packageAccess = _package.access && _package.access.length > 0 ? _package.access : DEFAULT_ALLOW_ACCESS_LEVEL;
 
-    if (user.name !== undefined) { // successfully authenticated
+    if (user.name !== undefined) {
+      // successfully authenticated
       this.logger.debug(`[gitlab] allow user: ${user.name} authenticated access to package: ${_package.name}`);
       return cb(null, true);
-    } else { // unauthenticated
+    } else {
+      // unauthenticated
       if (BUILTIN_ACCESS_LEVEL_ANONYMOUS.some(level => packageAccess.includes(level))) {
         this.logger.debug(`[gitlab] allow anonymous access to package: ${_package.name}`);
         return cb(null, true);
@@ -185,13 +185,16 @@ export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
   allow_publish(user: RemoteUser, _package: VerdaccioGitlabPackageAccess & PackageAccess, cb: Callback) {
     if (!_package.gitlab) return cb(null, false);
 
-    let packageScopePermit = false;
+    const packageScopePermit = false;
     let packagePermit = false;
     // Only allow to publish packages when:
     //  - the package has exactly the same name as one of the user groups, or
     //  - the package scope is the same as one of the user groups
-    for (let real_group of user.real_groups) { // jscs:ignore requireCamelCaseOrUpperCaseIdentifiers
-      this.logger.trace(`[gitlab] publish: checking group: ${real_group} for user: ${user.name || ''} and package: ${_package.name}`);
+    for (const real_group of user.real_groups) {
+      // jscs:ignore requireCamelCaseOrUpperCaseIdentifiers
+      this.logger.trace(
+        `[gitlab] publish: checking group: ${real_group} for user: ${user.name || ''} and package: ${_package.name}`
+      );
 
       if (this._matchGroupWithPackage(real_group, _package.name as string)) {
         packagePermit = true;
@@ -201,7 +204,9 @@ export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
 
     if (packagePermit || packageScopePermit) {
       const perm = packagePermit ? 'package-name' : 'package-scope';
-      this.logger.debug(`[gitlab] user: ${user.name || ''} allowed to publish package: ${_package.name} based on ${perm}`);
+      this.logger.debug(
+        `[gitlab] user: ${user.name || ''} allowed to publish package: ${_package.name} based on ${perm}`
+      );
       return cb(null, true);
     } else {
       this.logger.debug(`[gitlab] user: ${user.name || ''} denied from publishing package: ${_package.name}`);
@@ -213,7 +218,7 @@ export default class VerdaccioGitLab implements VerdaccioGitLabPlugin {
 
   _matchGroupWithPackage(real_group: string, package_name: string): boolean {
     if (real_group === package_name) {
-      return true
+      return true;
     }
 
     if (package_name.indexOf('@') === 0) {

src/gitlab.ts

@@ -1,8 +1,9 @@
 // Copyright 2018 Roger Meier <[email protected]>
 // SPDX-License-Identifier: MIT
 
-import VerdaccioGitLab from './gitlab';
 import { PluginOptions } from '@verdaccio/types';
+
+import VerdaccioGitLab from './gitlab';
 import { VerdaccioGitlabConfig } from './gitlab';
 
 export default function(config: VerdaccioGitlabConfig, options: PluginOptions<VerdaccioGitlabConfig>) {