@verdaccio/hooks 8.0.0-next-8.12 → 8.0.0-next-8.13

package/src/index.ts

@@ -1 +0,0 @@
-export { handleNotify, notify, sendNotification } from './notify';

package/src/notify-request.ts

@@ -1,43 +0,0 @@
-import buildDebug from 'debug';
-import got from 'got-cjs';
-
-import { HTTP_STATUS } from '@verdaccio/core';
-import { logger } from '@verdaccio/logger';
-
-const debug = buildDebug('verdaccio:hooks:request');
-
-export type FetchOptions = {
-  body: string;
-  headers?: {};
-  method?: string;
-};
-
-export async function notifyRequest(url: string, options: FetchOptions): Promise<boolean> {
-  let response;
-  try {
-    debug('uri %o', url);
-    response = got.post(url, {
-      body: JSON.stringify(options.body),
-      method: 'POST',
-      headers: { 'Content-Type': 'application/json' },
-    });
-    debug('response.status  %o', response.status);
-    const body = await response.json();
-    if (response.status >= HTTP_STATUS.BAD_REQUEST) {
-      throw new Error(body);
-    }
-
-    logger.info(
-      { content: options.body },
-      'The notification @{content} has been successfully dispatched'
-    );
-    return true;
-  } catch (err: any) {
-    debug('request error %o', err);
-    logger.error(
-      { errorMessage: err?.message },
-      'notify service has thrown an error: @{errorMessage}'
-    );
-    return false;
-  }
-}

package/src/notify.ts

@@ -1,139 +0,0 @@
-/* eslint-disable no-undef */
-import buildDebug from 'debug';
-import Handlebars from 'handlebars';
-
-import { logger } from '@verdaccio/logger';
-import { Config, Notification, Package, RemoteUser } from '@verdaccio/types';
-
-import { FetchOptions, notifyRequest } from './notify-request';
-
-const debug = buildDebug('verdaccio:hooks');
-
-export function compileTemplate(content, metadata) {
-  // FUTURE: multiple handlers
-  return new Promise((resolve, reject) => {
-    let handler;
-    try {
-      if (!handler) {
-        debug('compile default template handler %o', content);
-        const template: HandlebarsTemplateDelegate = Handlebars.compile(content);
-        return resolve(template(metadata));
-      }
-    } catch (error: any) {
-      debug('error  template handler %o', error);
-      reject(error);
-    }
-  });
-}
-
-export async function handleNotify(
-  metadata: Partial<Package>,
-  notifyEntry,
-  remoteUser: Partial<RemoteUser>,
-  publishedPackage: string
-): Promise<boolean> {
-  let regex;
-  if (metadata.name && notifyEntry.packagePattern) {
-    regex = new RegExp(notifyEntry.packagePattern, notifyEntry.packagePatternFlags || '');
-    if (!regex.test(metadata.name)) {
-      return false;
-    }
-  }
-
-  let content;
-  // FIXME: publisher is not part of the expected types metadata
-  // @ts-ignore
-  if (typeof metadata?.publisher === 'undefined' || metadata?.publisher === null) {
-    // @ts-ignore
-    metadata = { ...metadata, publishedPackage, publisher: { name: remoteUser.name as string } };
-    debug('template metadata %o', metadata);
-    content = await compileTemplate(notifyEntry.content, metadata);
-  }
-
-  const options: FetchOptions = {
-    body: JSON.stringify(content),
-  };
-
-  // provides fallback support, it's accept an Object {} and Array of {}
-  if (notifyEntry.headers && Array.isArray(notifyEntry.headers)) {
-    const header = {};
-    // FIXME: we can simplify this
-    notifyEntry.headers.map(function (item): void {
-      if (Object.is(item, item)) {
-        for (const key in item) {
-          /* eslint no-prototype-builtins: 0 */
-          if (item.hasOwnProperty(key)) {
-            header[key] = item[key];
-          }
-        }
-      }
-    });
-    options.headers = header;
-  } else if (Object.is(notifyEntry.headers, notifyEntry.headers)) {
-    options.headers = notifyEntry.headers;
-  }
-
-  if (!notifyEntry.endpoint) {
-    debug('error due endpoint is missing');
-    throw new Error('missing parameter');
-  }
-
-  return notifyRequest(notifyEntry.endpoint, {
-    method: notifyEntry.method,
-    ...options,
-  });
-}
-
-export function sendNotification(
-  metadata: Partial<Package>,
-  notify: Notification,
-  remoteUser: Partial<RemoteUser>,
-  publishedPackage: string
-): Promise<boolean> {
-  return handleNotify(metadata, notify, remoteUser, publishedPackage) as Promise<any>;
-}
-
-export async function notify(
-  metadata: Partial<Package>,
-  config: Partial<Config>,
-  remoteUser: Partial<RemoteUser>,
-  publishedPackage: string
-): Promise<boolean[]> {
-  debug('init send notification');
-  if (config.notify) {
-    const isSingle = Object.keys(config.notify).includes('method');
-    if (isSingle) {
-      debug('send single notification');
-      try {
-        const response = await sendNotification(
-          metadata,
-          config.notify as Notification,
-          remoteUser,
-          publishedPackage
-        );
-        return [response];
-      } catch {
-        debug('error on sending single notification');
-        return [false];
-      }
-    } else {
-      debug('send multiples notification');
-      const results = await Promise.allSettled(
-        Object.keys(config.notify).map((keyId: string) => {
-          // @ts-ignore
-          const item = config.notify[keyId];
-          debug('send item %o', item);
-          return sendNotification(metadata, item, remoteUser, publishedPackage);
-        })
-      ).catch((error) => {
-        logger.error({ error }, 'notify request has failed: @error');
-      });
-
-      // @ts-ignore
-      return Object.keys(results).map((promiseValue) => results[promiseValue].value);
-    }
-  } else {
-    debug('no notifications configuration detected');
-    return [false];
-  }
-}

package/test/__helper/index.ts

@@ -1,5 +0,0 @@
-import path from 'path';
-
-export const parseConfigurationFile = (name) => {
-  return path.join(__dirname, `../partials/config/yaml/${name}.yaml`);
-};

package/test/notify-request.spec.ts

@@ -1,83 +0,0 @@
-import nock from 'nock';
-import { beforeEach, describe, expect, test } from 'vitest';
-
-import { createRemoteUser, parseConfigFile } from '@verdaccio/config';
-import { setup } from '@verdaccio/logger';
-import { Config } from '@verdaccio/types';
-
-import { notify } from '../src/notify';
-import { parseConfigurationFile } from './__helper';
-
-const parseConfigurationNotifyFile = (name) => {
-  return parseConfigurationFile(`notify/${name}`);
-};
-const singleHeaderNotificationConfig = parseConfigFile(
-  parseConfigurationNotifyFile('single.header.notify')
-);
-const multiNotificationConfig = parseConfigFile(parseConfigurationNotifyFile('multiple.notify'));
-
-setup({});
-
-const domain = 'http://slack-service';
-
-const options = {
-  path: '/foo?auth_token=mySecretToken',
-};
-
-describe('Notifications:: notifyRequest', () => {
-  beforeEach(() => {
-    nock.cleanAll();
-  });
-  test('when sending a empty notification', async () => {
-    nock(domain).post(options.path).reply(200, { body: 'test' });
-
-    const notificationResponse = await notify({}, {}, createRemoteUser('foo', []), 'bar');
-    expect(notificationResponse).toEqual([false]);
-  });
-
-  test('when sending a single notification', async () => {
-    nock(domain).post(options.path).reply(200, { body: 'test' });
-    const notificationResponse = await notify(
-      {},
-      singleHeaderNotificationConfig,
-      createRemoteUser('foo', []),
-      'bar'
-    );
-    expect(notificationResponse).toEqual([true]);
-  });
-
-  test('when notification endpoint is missing', async () => {
-    nock(domain).post(options.path).reply(200, { body: 'test' });
-    const name = 'package';
-    const config: Partial<Config> = {
-      // @ts-ignore
-      notify: {
-        method: 'POST',
-        endpoint: undefined,
-        content: '',
-      },
-    };
-    const notificationResponse = await notify({ name }, config, createRemoteUser('foo', []), 'bar');
-    expect(notificationResponse).toEqual([false]);
-  });
-
-  test('when multiple notifications', async () => {
-    nock(domain)
-      .post(options.path)
-      .once()
-      .reply(200, { body: 'test' })
-      .post(options.path)
-      .once()
-      .reply(400, {})
-      .post(options.path)
-      .once()
-      .reply(500, { message: 'Something bad happened' });
-    // mockClient.intercept(options).reply(200, { body: 'test' });
-    // mockClient.intercept(options).reply(400, {});
-    // mockClient.intercept(options).reply(500, { message: 'Something bad happened' });
-
-    const name = 'package';
-    const responses = await notify({ name }, multiNotificationConfig, { name: 'foo' }, 'bar');
-    expect(responses).toEqual([true, false, false]);
-  });
-});

package/test/partials/config/yaml/notify/multiple.notify.yaml

@@ -1,16 +0,0 @@
-notify:
-  'example-google-chat':
-    method: POST
-    headers: [{ 'Content-Type': 'application/json' }]
-    endpoint: http://slack-service/foo?auth_token=mySecretToken
-    content: '{"text":"New package published: `{{ name }}{{#each versions}} v{{version}}{{/each}}`"}'
-  'example-hipchat':
-    method: POST
-    headers: [{ 'Content-Type': 'application/json' }]
-    endpoint: http://slack-service/foo?auth_token=mySecretToken
-    content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'
-  'example-stride':
-    method: POST
-    headers: [{ 'Content-Type': 'application/json' }, { 'authorization': 'Bearer secretToken' }]
-    endpoint: http://slack-service/foo?auth_token=mySecretToken
-    content: '{"body": {"version": 1,"type": "doc","content": [{"type": "paragraph","content": [{"type": "text","text": "New package published: * {{ name }}* Publisher name: * {{ publisher.name }}"}]}]}}'

package/test/partials/config/yaml/notify/single.header.notify.yaml

@@ -1,5 +0,0 @@
-notify:
-  method: POST
-  headers: { 'Content-Type': 'application/json' }
-  endpoint: http://slack-service/foo?auth_token=mySecretToken
-  content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'

package/test/partials/config/yaml/notify/single.notify.yaml

@@ -1,5 +0,0 @@
-notify:
-  method: POST
-  headers: [{ 'Content-Type': 'application/json' }]
-  endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
-  content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'

package/test/partials/config/yaml/notify/single.packagePattern.notify.yaml

@@ -1,7 +0,0 @@
-notify:
-  method: POST
-  headers: { 'Content-Type': 'application/json' }
-  packagePattern: package
-  packagePatternFlags: g
-  endpoint: https://usagge.hipchat.com/v2/room/3729485/notification?auth_token=mySecretToken
-  content: '{"color":"green","message":"New package published: * {{ name }}*","notify":true,"message_format":"text"}'

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./build"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["src/**/*.test.ts"]
-}

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "extends": "../../tsconfig.reference.json",
-  "compilerOptions": {
-    "rootDir": "./src",
-    "outDir": "./build"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["src/**/*.test.ts"],
-  "references": [
-    {
-      "path": "../auth"
-    },
-    {
-      "path": "../config"
-    },
-    {
-      "path": "../logger/logger"
-    }
-  ]
-}