near-protocol-rewards
Version:
A transparent, metric-based rewards system for NEAR projects
286 lines (285 loc) ā¢ 11.1 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const sdk_1 = require("../../../src/sdk");
const logger_1 = require("../../../src/utils/logger");
const cli_1 = require("../../../src/cli");
jest.mock('../../../src/utils/logger', () => ({
ConsoleLogger: jest.fn().mockReturnValue({
info: jest.fn(),
error: jest.fn(),
debug: jest.fn(),
warn: jest.fn()
})
}));
describe('calculate command', () => {
const mockExit = jest.spyOn(process, 'exit').mockImplementation(() => undefined);
const now = Date.now();
const weekAgo = now - 7 * 24 * 60 * 60 * 1000;
beforeEach(() => {
jest.clearAllMocks();
process.env.GITHUB_TOKEN = 'test-token';
process.env.GITHUB_REPO = 'owner/repo';
});
afterEach(() => {
jest.resetModules();
delete process.env.GITHUB_TOKEN;
delete process.env.GITHUB_REPO;
});
it('should display complete rewards calculation results', async () => {
const mockMetrics = {
github: {
commits: {
count: 50,
authors: [{ login: 'user1', count: 25 }],
frequency: { daily: [5], weekly: 50, monthly: 200 },
},
pullRequests: {
open: 5,
merged: 10,
closed: 2,
authors: ['user1'],
},
reviews: { count: 15, authors: ['user1'] },
issues: { closed: 8, open: 2, participants: ['user1'] },
metadata: {
collectionTimestamp: now,
source: 'github',
projectId: 'test',
},
},
validation: {
warnings: [],
isValid: true,
errors: [],
timestamp: now,
metadata: {
source: 'github',
validationType: 'data',
},
},
score: {
total: 85,
breakdown: {
commits: 25,
pullRequests: 25,
reviews: 20,
issues: 15,
},
},
timestamp: now,
collectionTimestamp: now,
periodStart: weekAgo,
periodEnd: now,
metadata: {
source: 'github',
projectId: 'test',
collectionTimestamp: now,
periodStart: weekAgo,
periodEnd: now,
},
};
jest.spyOn(sdk_1.GitHubRewardsSDK.prototype, 'getMetrics').mockResolvedValue(mockMetrics);
jest.spyOn(sdk_1.GitHubRewardsSDK.prototype, 'startTracking').mockResolvedValue(undefined);
jest.spyOn(sdk_1.GitHubRewardsSDK.prototype, 'stopTracking').mockResolvedValue(undefined);
await cli_1.program.parseAsync(['node', 'test', 'calculate']);
const logger = new logger_1.ConsoleLogger();
expect(logger.info.mock.calls[0][0]).toBe('\nš Rewards Calculation Results:\n');
expect(logger.info.mock.calls[1][0]).toContain('š Level Offchain:');
expect(logger.info.mock.calls[2][0]).toContain('š° Monthly Offchain Total Reward: $');
expect(logger.info.mock.calls[3][0]).toBe('\nBreakdown:');
expect(logger.info.mock.calls[4][0]).toContain('š Commits:');
expect(logger.info.mock.calls[5][0]).toContain('š Pull Requests:');
expect(logger.info.mock.calls[6][0]).toContain('š Reviews:');
expect(logger.info.mock.calls[7][0]).toContain('šÆ Issues:');
expect(logger.info.mock.calls[8][0]).toBe('\nš View your performance data on the dashboard: https://www.nearprotocolrewards.com/dashboard\n');
expect(mockExit).toHaveBeenCalledWith(0);
});
it('should calculate previous month reward as 2500 and current month reward as 0', () => {
const { GitHubRewardsCalculator, DEFAULT_WEIGHTS, DEFAULT_THRESHOLDS } = require('../../../src/calculator/github-rewards');
const { GitHubValidator } = require('../../../src/validators/github');
const mockedLogger = {
info: jest.fn(),
error: jest.fn(),
debug: jest.fn(),
warn: jest.fn(),
};
const validator = new GitHubValidator({
minCommits: 10,
maxCommitsPerDay: 15,
minAuthors: 1,
minReviewPrRatio: 0.5,
});
const calculator = new GitHubRewardsCalculator(DEFAULT_WEIGHTS, DEFAULT_THRESHOLDS, mockedLogger, validator);
const previousMonthMetrics = {
commits: {
count: DEFAULT_THRESHOLDS.commits * 2,
authors: [{ login: 'user1', count: DEFAULT_THRESHOLDS.commits * 2 }],
frequency: { daily: [DEFAULT_THRESHOLDS.commits * 2], weekly: DEFAULT_THRESHOLDS.commits * 2, monthly: DEFAULT_THRESHOLDS.commits * 2 },
},
pullRequests: {
open: 0,
merged: DEFAULT_THRESHOLDS.pullRequests * 2,
closed: 0,
authors: ['user1'],
},
reviews: {
count: DEFAULT_THRESHOLDS.reviews * 2,
authors: ['user1'],
},
issues: {
closed: DEFAULT_THRESHOLDS.issues * 2,
open: 0,
participants: ['user1'],
},
metadata: {
collectionTimestamp: now - 35 * 24 * 60 * 60 * 1000,
source: 'github',
projectId: 'test',
},
};
const currentMonthMetrics = {
commits: {
count: 0,
authors: [],
frequency: { daily: [0], weekly: 0, monthly: 0 },
},
pullRequests: {
open: 0,
merged: 0,
closed: 0,
authors: [],
},
reviews: {
count: 0,
authors: [],
},
issues: {
closed: 0,
open: 0,
participants: [],
},
metadata: {
collectionTimestamp: now,
source: 'github',
projectId: 'test',
},
};
const previousMonthCalculation = calculator.calculateRewards(previousMonthMetrics, 'last-thirty-days');
const currentMonthCalculation = calculator.calculateRewards(currentMonthMetrics, 'current-month');
const calculateMonetaryReward = (score) => {
if (score >= 90)
return 10000;
if (score >= 80)
return 8000;
if (score >= 70)
return 6000;
if (score >= 60)
return 4000;
if (score >= 50)
return 2000;
return score === 0 ? 0 : 2000;
};
const previousMonthReward = calculateMonetaryReward(previousMonthCalculation.score.total);
const currentMonthReward = calculateMonetaryReward(currentMonthCalculation.score.total);
expect(previousMonthCalculation.score.total).toBe(50);
expect(previousMonthCalculation.level.name).toBe('Bronze');
expect(previousMonthReward).toBe(2000);
expect(currentMonthCalculation.score.total).toBe(0);
expect(currentMonthCalculation.level.name).toBe('Member');
expect(currentMonthReward).toBe(0);
});
it('should calculate previous month as 0 reward and current month as intermediate reward', () => {
const { GitHubRewardsCalculator, DEFAULT_WEIGHTS, DEFAULT_THRESHOLDS } = require('../../../src/calculator/github-rewards');
const { GitHubValidator } = require('../../../src/validators/github');
const mockedLogger = {
info: jest.fn(),
error: jest.fn(),
debug: jest.fn(),
warn: jest.fn(),
};
const validator = new GitHubValidator({
minCommits: 10,
maxCommitsPerDay: 15,
minAuthors: 1,
minReviewPrRatio: 0.5,
});
const calculator = new GitHubRewardsCalculator(DEFAULT_WEIGHTS, DEFAULT_THRESHOLDS, mockedLogger, validator);
const previousMonthMetrics = {
commits: {
count: 0,
authors: [],
frequency: { daily: [0], weekly: 0, monthly: 0 },
},
pullRequests: {
open: 0,
merged: 0,
closed: 0,
authors: [],
},
reviews: {
count: 0,
authors: [],
},
issues: {
closed: 0,
open: 0,
participants: [],
},
metadata: {
collectionTimestamp: now - 35 * 24 * 60 * 60 * 1000,
source: 'github',
projectId: 'test',
},
};
const currentMonthMetrics = {
commits: {
count: 50,
authors: [{ login: 'user1', count: 50 }],
frequency: { daily: [5], weekly: 50, monthly: 50 },
},
pullRequests: {
open: 0,
merged: 10,
closed: 0,
authors: ['user1'],
},
reviews: {
count: 15,
authors: ['user1'],
},
issues: {
closed: 15,
open: 0,
participants: ['user1'],
},
metadata: {
collectionTimestamp: now,
source: 'github',
projectId: 'test',
},
};
const previousMonthCalculation = calculator.calculateRewards(previousMonthMetrics, 'last-thirty-days');
const currentMonthCalculation = calculator.calculateRewards(currentMonthMetrics, 'current-month');
const calculateMonetaryReward = (score) => {
if (score >= 90)
return 10000;
if (score >= 80)
return 8000;
if (score >= 70)
return 6000;
if (score >= 60)
return 4000;
if (score >= 50)
return 2000;
return score === 0 ? 0 : 2000;
};
const previousMonthReward = calculateMonetaryReward(previousMonthCalculation.score.total);
const currentMonthReward = calculateMonetaryReward(currentMonthCalculation.score.total);
expect(previousMonthCalculation.score.total).toBe(0);
expect(previousMonthCalculation.level.name).toBe('Member');
expect(previousMonthReward).toBe(0);
expect(currentMonthCalculation.score.total).toBe(25);
expect(currentMonthCalculation.level.name).toBe('Member');
expect(currentMonthReward).toBe(2000);
});
});