@types - AuthCallback: Incorrect definition #1924

pusherman · 2020-06-17T21:20:16Z

https://github.com/verdaccio/monorepo/blob/9.x/core/types/index.d.ts defines

type AuthAccessCallback = (error: string | null, access: boolean) => void;

interface IPluginAuth<T> extends IPlugin<T> {
  authenticate(user: string, password: string, cb: AuthCallback): void;
  adduser?(user: string, password: string, cb: AuthCallback): void;
  changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
  allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
  allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
  allow_unpublish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
  allow_publish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
  allow_access?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
  allow_unpublish?(user: RemoteUser, pkg: AllowAccess & PackageAccess, cb: AuthAccessCallback): void;
  apiJWTmiddleware?(helpers: any): Function;
}

However, the server seems to be expecting an object when there is an error for the callback, not a string.

When I try to pass an error: string the server throws an error, it seems to be expecting an object. I have to pass null to prevent the server from throwing an error.

Example Code

public authenticate(username: string, password: string, cb: AuthCallback): void {

  // fetch the user and set validPassword

  return validPassword ? cb(null, fetchedUser.groups) : cb('user not found', false);
}

Output from server

npm ERR! Unexpected token u in JSON at position 0 while parsing near 'user not found'

juanpicado · 2020-07-04T12:37:48Z

Hi @pusherman would you willing to PR a solution?

dnafication · 2020-10-24T01:04:18Z

I checked this in https://github.com/verdaccio/verdaccio/tree/5.x and found to be fixed? Is there any work left on this? Or need to do replicate it in master?

Code in 5.x

type AuthError = HttpError & { code: number };
  type AuthAccessCallback = (error: AuthError | null, access: boolean) => void;
  type AuthCallback = (error: AuthError | null, groups: string[] | false) => void;

  interface IPluginAuth<T> extends IPlugin<T> {
    authenticate(user: string, password: string, cb: AuthCallback): void;
    adduser?(user: string, password: string, cb: AuthCallback): void;
    changePassword?(user: string, password: string, newPassword: string, cb: AuthCallback): void;
    allow_publish?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;
    allow_access?(user: RemoteUser, pkg: T & PackageAccess, cb: AuthAccessCallback): void;

juanpicado · 2020-11-12T07:31:07Z

@dnafication there is no progress on this yet, I decided to move first all plugins and modules to 5.x so change types is way easier, that step was already done. So the next step would be this one.

juanpicado self-assigned this Jun 19, 2020

juanpicado transferred this issue from verdaccio/monorepo Aug 28, 2020

juanpicado added this to the 5.x.x milestone Aug 28, 2020

juanpicado added the good first issue label Sep 28, 2020

juanpicado added the dev: refactor label Nov 10, 2020

verdaccio / verdaccio

@types - AuthCallback: Incorrect definition #1924

@types - AuthCallback: Incorrect definition #1924

pusherman commented Jun 17, 2020

juanpicado commented Jul 4, 2020

dnafication commented Oct 24, 2020

juanpicado commented Nov 12, 2020

verdaccio / verdaccio

Sponsor verdaccio/verdaccio

Join GitHub today

GitHub is where the world builds software

@types - AuthCallback: Incorrect definition #1924

@types - AuthCallback: Incorrect definition #1924

Comments

pusherman commented Jun 17, 2020

juanpicado commented Jul 4, 2020

dnafication commented Oct 24, 2020

juanpicado commented Nov 12, 2020

Essential cookies

Always active

Analytics cookies