Hello everyone, my name is Ilya. I have been working in IT for about 6 years, the last 2 years - at Yandex.Money company as a front-end developer. Responsibilities include maintaining / developing parts of the applications, at the moment the “My Account” project (and no, it’s not just “correct the wrong indentation”, “change the color of the button”, or “quickly swap the shape”).

In the development department, we have an internal Challenges project - we call tasks that are not directly related to the main products. These are tasks that will be socially useful and will help improve infrastructure, CI / CD, and more. For example, to refine the bot notifying about releases, make a plug-in for IDEA for self-generating assert on the object and refactor the old UI-library. Such "challenges" can be taken at will - they are great for diluting business tasks.

At one point, I took a long time ago that I was interested in the task of implementing automatic verification of the size of the client bundle of the application. After all, everything that can be checked automatically is better to check automatically.

Naturally, the result was not just a specific implemented task, but a library with rules and general functions (core / core) for implementing any checkers (I hope). In the process of solving the problem, cones were full of which I also want to talk about.

So, there is Jenkins, Bitbucket, mail (or Telegram, Slack - what you need) and the need to check the size of the bundle. We need to make all this friends.

There are 2 automatic checks in Bitbucket for each pull request, without which merge is impossible: the task in Jira is transferred to the “Verified” status, and all automatic checks in Jenkins are started and completed successfully. Further, according to the hook configured in Bitbucket, Jenkins receives notifications about a branch change, for which the entire bundle of checks is launched. Job with check (commit_checker) has a lot of pipeline:

launch lint script;
running tests;
— , pull request , merge build publish Nexus, npm;
package.json.

, Bitbucket commit_checker. , , . challenge- commit_checker pipeline .
checker- -?

( c)

. , ( ) — pull request. , , . , : , , , , 3 . , ( ). , , merge .

. , , : 600 (, , , - ).

— , , pull request , merge , . .

, ...

, . , , API ( , Telegram). , .

. Jenkins job ( job). groove- , npm- , groove bin . , — , Bitbucket , merge .

, , : groove- node — .

: Groove Node?


Groove	— , - .	1. : , JS, // JS, Groove. 2. .
Node	1. : , Node. 2. , /. 3. /Jira API/Bitbucket API. 4. -, , [size-limit](https://www.npmjs.com/package/size-limit).	1. Node, Jenkins . 2. API Jenkins /.

, Node.

«, », 3

, . ( , Jira), . , .

, checker-core. , , .

. — : -, /, dist, , . — .

— pull request.

— ? :

dev/master ( ), - . — .
/ . — , .
Git , , package.json, API Bitbucket dev/master , . , .

— ?

, , , — . — . , , .

, , BitBucket ( Jenkins package.json). …

, , : «!», , , , .

. - , : , - .

. : , , … : « Jenkins? - », — , Jenkins ( ). -> -> -> .

, . , , (, ). , .

(, ) .

size-limit: , , .

. , … !

, roadmap .

, , size-limit , — , . , , API , CLI. . cli- . .

, -, , , .

:

Checker-core

/src —   
    |__ /tasks —      ; ,  ,  ,   ,  .    - `job`.
    |__ /models — ,   ;      `core`. ,      , , npm-.    `job`,  `tasks`   ,   `job,`   .  ,          `tasks`   `job`.
    |__ /types —  .
    |__ /utils —   (, ,    (npm)).
    |__ /errors — ,   .
    |__ /enums —  .
    |__ /decorators — ,   `utils`, `tasks`, `job`.
    |__ /declarations —  ,     Typescript.

Checker

Checker , . , , ..

Module

Module /, . ( , ..).

get-issue-assignees

. Checker project, assignee, lead.
Examples

import {
    Checker,
    Logger,
    IChecker,
    JiraManagerSettings,
    GetIssueAssignee
} from 'checker-core';
import {JiraSettings} from 'jira-manager';

import {IJobSettings} from '../types/IJobSettings';

export class ExampleJob {
    readonly _checker: IChecker;
    _jiraSettings: JiraManagerSettings;

    constructor(settings: IJobSettings) {
        if (settings === void 0) {
            throw new Error('Has no Checker settings');
        }

        this._checker = new Checker(settings.checker);
        this._jiraSettings = new JiraSettings(settings.jira);

        Logger.info('-- ExampleJob:');
        Logger.info(this._checker.appName);
    }

    start() {
        const getIssueAssignee = new GetIssueAssignee();

        return getIssueAssignee.run(this._checker, this._jiraSettings);
    }
}

get-last-merged-issue

. Checker .
Examples

import {Checker, Logger, IChecker, GetLastMergedIssue} from 'checker-core';

import {IJobSettings} from '../types/IJobSettings';

export class ExampleJob {
    readonly _checker: IChecker;

    constructor(settings: IJobSettings) {
        if (settings === void 0) {
            throw new Error('Has no Checker settings');
        }

        this._checker = new Checker(settings);

        Logger.info('-- ExampleJob:');
        Logger.info(this._checker.appName);
    }

    start() {
        const getLastMergedIssue = new GetLastMergedIssue();

        return getLastMergedIssue.run(this._checker);
    }
}

get-last-commit-issue

. Checker .

Examples

import {Checker, Logger, IChecker, GetLastCommitIssue} from 'checker-core';

import {IJobSettings} from '../types/IJobSettings';

export class ExampleJob {
    readonly _checker: IChecker;

    constructor(settings: IJobSettings) {
        if (settings === void 0) {
            throw new Error('Has no Checker settings');
        }

        this._checker = new Checker(settings);

        Logger.info('-- ExampleJob:');
        Logger.info(this._checker.appName);
    }

    start() {
        const getLastCommitIssue = new GetLastCommitIssue();

        return getLastCommitIssue.run(this._checker);
    }
}

send-notification send-smtp-notification

. .

send-notification send-smtp-notification — . smtp- IMailTransportSettings.
Examples

import {
    Checker,
    Logger,
    IChecker,
    IMailTransportSettings,
    IMailContent,
    SendSmtpNotification
} from 'checker-core';

import {IJobSettings} from '../types/IJobSettings';

export class ExampleJob {
    readonly _checker: IChecker;
    _emailSettings: IMailTransportSettings;

    constructor(settings: IJobSettings) {
        if (settings === void 0) {
            throw new Error('Has no Checker settings');
        }

        this._checker = new Checker(settings.checker);
        this._emailSettings = settings.email;

        Logger.info('-- ExampleJob:');
        Logger.info(this._checker.appName);
    }

    start() {
        const sendSmtpNotification = new SendSmtpNotification();
        const mailContent: IMailContent = {
            subject: '',
            content: ' , ?'
        };

        return sendSmtpNotification.run(this._checker, mailContent, this._emailSettings);
    }
}

: , .

Logger

Npm

Nexus.

mailTransport

( mail linux nodemailer smtp).

Decorators

logAsyncMethod

, .

process.env.IS_DEBUG_MODE , .

validate

. .

Examples
import {
    notNullProp, validate, required,
    validInfo, notNull, requiredProp
} from 'checker-core';

class TestSum {
    @validate
    static sum(
        @required
        @notNull
        @requiredProp(['a'])
        @notNullProp(['a'])
        @validInfo('a', Object)
        a: Object,
        @required
        @notNull
        @requiredProp(['b'])
        @notNullProp(['b'])
        @validInfo('b', Object)
        b: Object
    ) {
        return a.a + b.b;
    }
}

Errors

MissingRequiredArgument

MissingRequiredProperty

, .

NullArgument

, null.

NullProperty

, , null.

TypeMismatch

bundle-size-checker

checker-core core, :

/src —   
    |__ /bin —  , CLI     ,  2  :            `job`.         , ,    1 `process.exit(1)`;
    |__ /jobs — ,       (`checker` + ,   ),        .      `task`, `utils`,    ;
    |__ /tasks —      ; ,  ,  ,   ,  .    - `job`;
    |__ /models — ,   ,      `core`. ,      , , npm-.    `job`,  `tasks`   ,   `job`,   .  ,          `tasks`   `job`;
    |__ /types —  ;
    |__ /utils —   (, ,    (npm));
    |__ /errors — ,   ;
    |__ /enums —  ;
    |__ /decorators —    `utils`, `tasks`, `job`;
    |__ /declarations —  ,     Typescript.

, job — , , checker-, , , , - , , , ( , ..).

import path from 'path';
import {JiraSettings} from 'jira-manager';
import {
    Logger,
    JiraManagerSettings,
    IMailTransportSettings,
    MissingRequiredProperty
} from 'checker-core';
import {Module} from '../models/module';
import {CompareBundleSize} from '../tasks/compare-bundle-size';
import {Checker} from '../models';
import {IJobCheckBundleSizeSettings} from '../types/IJobCheckBundleSizeSettings';
import {IModule} from '../types/IModule';
import {IModuleSettings} from '../types/IModuleSettings';
import {GetMetaInfo} from '../tasks/get-meta-info';
import {CheckBundleSizeNotEmpty} from '../tasks/check-bundle-size-not-empty';
import {GetBundleSize} from '../tasks/get-bundle-size';
import {ReadFileError} from '../errors/ReadFileError';
import {IPackageJson} from '../types/IPackageJson';
import {IChecker} from '../types/IChecker';
import {FilterException} from '../tasks/filter-exception';

//      .
export class CheckBundleSize {
    readonly _checker: IChecker;
    readonly _jobName = 'CheckBundleSize';

    _moduleSettings: IModuleSettings;
    _checkerModule: IModule;
    _jiraSettings: JiraManagerSettings;
    _emailSettings: IMailTransportSettings;

    constructor(settings: IJobCheckBundleSizeSettings) {
        if (settings.checker === void 0) {
            throw new MissingRequiredProperty(this._jobName, 'constructor', 'settings', 'checker');
        }

        this._moduleSettings = settings.module;
        this._emailSettings = settings.emailSettings;
        this._jiraSettings = new JiraSettings(settings.jira);
        this._checker = new Checker(settings.checker);

        try {
            const packageJsonPath = path.resolve(this._checker.rootPath, 'package.json');
            const packageJson: IPackageJson = require(packageJsonPath);
            this._checkerModule = new Module(
                packageJson,
                this._moduleSettings.maxBundleSize,
                this._moduleSettings.needCheckBundleSize
            );
        } catch (err) {
            Logger.info('Can nott load package.json');
            throw new ReadFileError(this._jobName, 'package.json');
        }

        Logger.info(`${this._jobName}:`);
        Logger.info(this._checker.appName);
    }

    //     
    async start() {
        try {
            const getBundleSizeTask = new GetBundleSize();
            const getMetaInfo = new GetMetaInfo();
            const checkBundleSizeEmpty = new CheckBundleSizeNotEmpty();
            const compareBundleSize = new CompareBundleSize();

            const getBundleSize = await getBundleSizeTask.run(this._checker, this._checkerModule);

            if (!getBundleSize) {
                return;
            }

            await getMetaInfo.run(this._checker, this._jiraSettings);
            await checkBundleSizeEmpty.run(this._checker, this._checkerModule);

            await compareBundleSize.run(this._checker, this._checkerModule);
        } catch (err) {
            const filterException = new FilterException(this._emailSettings);
            await filterException.run(this._checker  v , this._checkerModule, err);

            throw err;
        }
    }
}

bin , cli .

…
const checkBundleSize = new CheckBundleSize(settings);

checkBundleSize.start()
    .then(() => {
        process.exit(0);
    })
    .catch((err: Error) => {
        console.error(err);
        console.error(`Can fail build: ${canFailBuild}`);
        if (canFailBuild) {
            process.exit(1);
        } else {
            process.exit(0);
        }
    });

/ , , (, , ). , : , , . roadmap . , — .

, .

. : ? , open source.

All at once: automatic check of the bundle size