Skip to content

Latest commit

 

History

History
234 lines (195 loc) · 5.82 KB

README.md

File metadata and controls

234 lines (195 loc) · 5.82 KB
Raw

Praise Reports

Praise allows for creating custom reports. This repository is the official library of Praise reports.

TODO: Describe how to use a report in the Praise dashboard.

Run reports locally

This repository contains a CLI for running reports locally. The CLI takes two arguments: the name of the report and the report config as a JSON string.

A local database is used for running reports. The database is populated with live data from the Praise instance of the Token Engineering Commons.

yarn
node src/index.js <reportName> <config>

Examples:

node src/index.js period-stats/report '{"startDate": "2021-09-30", "endDate": "2021-10-31"}'
node src/index.js period-receiver-summary/report '{"startDate": "2021-09-30", "endDate": "2021-10-31"}'

Test all reports

yarn
yarn test

Create a new report

Report folder structure

  • Reports are stored in the reports folder.
  • Every subfolder in the reports folder is one report.
reports
├── my-report
│   ├── manifest.json
│   ├── README.md
│   ├── report.js
│   ├── report.test.js

Report class

Each JavaScript report file must export a class conforms to the following interface:

  • A report class must have a manifest property. See below for details.
  • A report class must have a constructor that takes two arguments: config and db.
  • A report class must have a run method that returns an array of objects.
  • The run method can be async.
export default class Report {
  manifest = {
    name: "simple-report",
    ... // See below
  };

  constructor(config, db) {
    this.config = config;
    this.db = db;
  }

  async run() {
    // Return an array of objects
  }
}

Reports are run in a sandboxed environment. The config and db arguments are passed to the constructor by the Praise dashboard. In addition, the following objects are available in the sandbox:

  • Math - The JavaScript Math object
  • log() - A function that logs to the Praise dashboard. Report logs are displayed in the Praise dashboard after the report has been run.

Report configuration

Each report should accept a

Db object

The db object is a wrapper around the Praise database. It provides a simple interface for querying the database.

db.query(sql);

Report manifest example

Report settings are heavily inspired by VS Code's settings. See https://code.visualstudio.com/api/references/contribution-points#contributes.configuration

const manifest = {
  name: "simple-report",
  displayName: "Simple Report",
  description: "A simple report.",
  version: "1.2.3",
  author: "General Magic",
  publisher: "general-magic",
  license: "MIT",
  repository: "https://github.com/givepraise/reports",
  bugs: "https://github.com/givepraise/reports/issues",
  categories: ["Basic reports", "Praise receiver reports"],
  keywords: ["toplist"],
  configuration: {
    stringSetting: {
      type: "string",
      default: "Some string",
      description: "Description of the string setting",
      markdownDescription: "Description of the string setting",
      editPresentation: "multiline", // If this is not set, the setting is rendered as a single line
      order: 1,
    },
    numberSetting: {
      type: "number",
      default: 42,
      description: "Description of the number setting",
      markdownDescription: "Description of the number setting",
      order: 2,
    },
    booleanSetting: {
      type: "boolean",
      default: true,
      description: "Description of the boolean setting",
      markdownDescription: "Description of the boolean setting",
      order: 3,
    },
    stringEnumSetting: {
      type: "string",
      default: "right",
      enum: ["left", "right"],
      enumDescriptions: ["Left", "Right"], // Not supported yet
      enumMarkdownDescriptions: ["Left", "Right"], // Not supported yet
      enumItemLabels: ["Left", "Right"], // Not supported yet
      description: "Description of the string setting",
      markdownDescription: "Description of the string setting",
      editPresentation: "multiline",
      order: 4,
    },
    stringArraySetting: {
      type: "array",
      items: {
        type: "string",
      },
      default: ["one", "two"],
      description: "Description of the string array setting",
      markdownDescription: "Description of the string array setting",
      order: 5,
    },
  },
};

Database schema

-- users.sql
CREATE TABLE users (
  _id VARCHAR PRIMARY KEY,
  username VARCHAR,
  identityEthAddress VARCHAR,
  rewardsEthAddress VARCHAR,
  roles VARCHAR,
  createdAt TIMESTAMP,
  updatedAt TIMESTAMP
);

-- user_accounts.sql
CREATE TABLE useraccounts (
  _id VARCHAR PRIMARY KEY,
  accountId VARCHAR,
  user VARCHAR,
  name VARCHAR,
  avatarId VARCHAR,
  platform VARCHAR,
  createdAt TIMESTAMP,
  updatedAt TIMESTAMP,
  FOREIGN KEY (user) REFERENCES users(_id)
);

-- praise.sql
CREATE TABLE praises (
  _id VARCHAR PRIMARY KEY,
  giver VARCHAR,
  forwarder VARCHAR,
  receiver VARCHAR,
  reason VARCHAR,
  reasonRaw VARCHAR,
  score DOUBLE,
  sourceId VARCHAR,
  sourceName VARCHAR,
  createdAt TIMESTAMP,
  updatedAt TIMESTAMP,
  FOREIGN KEY (giver) REFERENCES users(_id),
  FOREIGN KEY (receiver) REFERENCES users(_id)
);

-- quantifications.sql
CREATE TABLE quantifications (
  _id VARCHAR PRIMARY KEY,
  praise VARCHAR,
  quantifier VARCHAR,
  score INTEGER,
  scoreRealized DOUBLE,
  dismissed BOOLEAN,
  duplicatePraise VARCHAR,
  createdAt TIMESTAMP,
  updatedAt TIMESTAMP,
  FOREIGN KEY (praise) REFERENCES praises(_id),
  FOREIGN KEY (quantifier) REFERENCES users(_id)
);

-- periods.sql
CREATE TABLE periods (
  _id VARCHAR PRIMARY KEY,
  name VARCHAR,
  status VARCHAR,
  endDate TIMESTAMP,
  createdAt TIMESTAMP,
  updatedAt TIMESTAMP
);

License

GNU General Public License v3.0 or later