contactlab / contactsnag Goto Github PK

Upgrade Bugsnag to the new version and make the library configuration/initialization lazy (ref)

From this:

import Bugsnag from 'bugsnag-js';
import project from './../../package.json';

// Bugsnag configuration
Bugsnag.apiKey = project.bugsnag.apiKey;
Bugsnag.endpoint = 'https://notify-bugsnag.contactlab.it/js';
Bugsnag.user = null;
Bugsnag.notifyReleaseStages = ['development'];
Bugsnag.releaseStage = 'development';
Bugsnag.context = null;
Bugsnag.disableAutoBreadcrumbsConsole();

// Export instance reference of Bugsnag
export const ContactSnag = Bugsnag;

to this (TBD):

import bugsnag from '@bugsnag/js';

const DEFAULT_CONFIG = {
  endpoint: 'https://notify-bugsnag.contactlab.it/js',
  // notifyReleaseStages: ['production'],
  // releaseStage: 'production',
  consoleBreadcrumbsEnabled: false
};

export const ContactSnag = (apiKey, config) =>  bugsnag({...DEFAULT_CONFIG, ...config, apiKey});

In order to be able to test with ava.js modules that import this library, the published script needs to be transpiled

Reference: https://github.com/bugsnag/bugsnag-js/blob/master/UPGRADING.md#6x-to-7x

The new version exposes a static interface of Bugsnag client with some options renamed.

The contactsnag's API should not change, except for the renamed options and the notify() and setUser() signature (in order to comply with the original methods)

The upload and report CLI commands are simple wrapper of the @bugsnag/source-maps and bugsnag-build-reporter packages.

They add useless complexity without real value.

If needed they can be installed locally in a specific project with much more flexibility.

Contactsnag already ships with webpack-bugsnag-plugins that cover the more common use cases.

webpack-bugsnag-plugins should be provided as dependency

Update bugsnag and other dependencies version

Add Bugsnag build reporter and make it available from contactsnag CLI

Add Travis integration

The current API has a kind of "design" bug: setOptions() it is almost unusable because even if the underlying reference to Bugsnag client is updated, the provided Client is immutable and further methods that are going to consume it, like notify(), will never use the contained client with changed options.

We need to introduce a "stateful" API that creates "private/scoped" Bugsnag client in order to keep track of changes and it is automatically provided to notify() and setOptions() methods.

Something like:

// --- Definition
type AnyBugsnagConfig = Partial<Bugsnag.IConfig>;

interface Client {
  start: () => Either<Error, Client>;

  notify: (
    error: Bugsnag.NotifiableError,
    opts?: Bugsnag.INotifyOpts
  ) => IOEither<Error, Client>;

  setOptions: (
    opts: AnyBugsnagConfig
  ) => IOEither<Error, Client>;
}

declare function ContactSnag(conf: Config): Client;

// --- Usage
const client = ContactSnag({
  apiKey: 'TEST-API-KEY',
  appVersion: '1.2.3',
  notifyReleaseStages: ['production'],
  releaseStage: 'production'
});

const setUserAndNotify = client
  .setOptions({user: {id: 1}})
  .chain(c =>
    c.notify(
      new Error('Custom error message'),
      metaData: {type: 'MY_ERR'}
    )
  );

// Set notification on button click
document
  .getElementById('btn')
  .addEventListener('click', () => setUserAndNotify.run());

// Start Bugsnag
client.start();

RFC @Arual90 @gabrieleborelli @DarkHelmet67

setOptions() is useless because, despite the name and the signature, it does not update the user for the session (which was the main reason of the ContactSnag method's definition).

It is mostly an internal method of the Bugsnag core Client class.

ContactSnag.setOptions() should be converted into a more explicit setUser().

ref: Bugsnag: identifying users

apiKey option should not be required when calling setOptions().

It should be taken from current client's configuration.

Actually, Bugsnag client's setOptions() is implemented in this way, merging the current client's options with ones provided; it's the Typescript's declaration that does not comply with it

Add to package.json files list only:

• ./bin
• ./index.js

Rewrite the uploader bin in a more functional way and update the documentation

This is preparatory for #28

Should we use Greenkeeper?

Instructions here.

Let's rewrite the package in TS and:

• add fp-ts
• replace AVA with Jest

The dependency io-ts was updated from 1.8.4 to 1.8.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

io-ts is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

• use promises in upload script;
• optimize reading property from package.json;
• optimize paths.

The dependency fp-ts was updated from 1.18.1 to 1.18.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

fp-ts is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

The CLI's upload command should be a simple proxy to bugsnagn-sourcemap CLI in order to allow the user to set any kind of supported option.

The bugsnag/apiKey field in package.json must be the only required configuration and the value must be always passed to the underlying CLI.

The setOptions() method's validation process has to be fixed.

Here is what happens:

1. when the Bugsnag client is created the provided options are merged with some default values and the generated configuration object is set on the config client's field;
2. then, the config object has an endpoints property defined;
3. when setOptions() is ran the passed options are merged with the current client's config value and then validated;
4. the validation fails because the resulting object always has an endpoints key.

This bug didn't come to light because the fake Bugsnag client used for testing (TestClient) don't replicate the feature described in point n° 1.

In order to fix the bug we should:

• not merge the provided options with the entire client's config object, but only with the apiKey value (this key is required by the Bugsnag.IConfig interface which is used in the validate() signature);
• add the "merge with defaults" mechanism to the fake client in tests.

Add some tests:

contactsnag should test that:

• configuration values are taken from the right package.json file;
• ContactSnag object/instance has the correct configuration;
• ContactSnag.notify is is a function and when it is called under the hood is called Bugsnag.notify (stubbed).

update should test that:

• options values are taken from the right package.json file;
• messages are display in the right way in the console.

Default configuration should use the standard notify endpoint for Bugsnag cloud application

It doesn't work on Windows 10 behind the corporate proxy, needs to check if the Bugsnag uploader package already exposes a configuration flag for the proxy and in case to have Contactsnag exposing it too.

Add eslint and eslint-config-contaclab

Add and expose as dependency the @types/webpack-bugsnag-plugins type definitions

Check Bugsnag configurations after updating to the new version.

Also compare with the TypeScript definitions in the package repo

The package should declare fp-ts and io-ts as peer depedencies (like other libs in the fp-ts ecosystem).

Furthermore, the fp-ts minimum version should be set to 2.8.0 and io-ts minimum version to 2.2.10 in order to use import paths without lib/es6 prefixes.

Nodejs v14 went in end-of-life on 2023-04-30 (rif.), so the support for this specific version can be dropped.

ref #138

Lock master branch and allow pull-requests to be merged only by administrators

Add:

• .npmrc
• .yarnrc
• .editorconfig

bugsnag field in package.json should allow to set all the possible options for bugsnag-sourcemaps CLI.

references can be found here

tslint is a deprecated package and should be removed in favour of eslint with TypeScript integration

When contactsnag is installed as dependency and ava (and his babel presets) is not installed, on build is thrown this error:

Couldn't find preset "@ava/stage-4" relative to directory "/node_modules/contactsnag"

Moving the babel configuration out of package.json and ignoring the file on publish should resolve the issue

webpack-bugsnag-plugins v1.6.0 added support for Webpack 5 (backward compatible with v4).

Thus, the version declare in package.json dependencies should be bumped to ^1.6.0