Skip to content

Latest commit

 

History

History
192 lines (136 loc) · 11.3 KB

CONTRIBUTING.md

File metadata and controls

192 lines (136 loc) · 11.3 KB

Contributing to Cube.js

Thanks for taking the time for contribution to Cube.js! We're very welcoming community and while it's very much appreciated if you follow these guidelines it's not a requirement.

Code of Conduct

This project and everyone participating in it is governed by the Cube.js Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Contributing Code Changes

Please review the following sections before proposing code changes.

License

Developer Certificate of Origin (DCO)

By contributing to Cube Dev, Inc., You accept and agree to the terms and conditions in the Developer Certificate of Origin for Your present and future Contributions submitted to Cube Dev, Inc. Your contribution includes any submissions to the Cube.js repository when you click on such buttons as Propose changes or Create pull request. Except for the licenses granted herein, You reserve all right, title, and interest in and to Your Contributions.

Step-by-step guide to contributing

  1. Find issues where we need help. Search for issues with either good first issue and/or help wanted labels.
  2. Follow the directions in the Getting Started guide to get Cube.js up and running (incl. the Developer Playground).
  3. Clone the Cube.js repo.
  4. Submit your Pull Request.
  5. Testing: Please include test(s) for your code contribution. See some of the test examples for drivers and backend.
  6. Documentation: When new features are added or there are changes to existing features that require updates to documentation, we encourage you to add/update any missing documentation in the /docs folder. To update an existing documentation page, you can simply click on the Edit this page button on the top right corner of the documentation page.
  7. Relevant team(s) will be pinged automatically for a review based on information in the CODEOWNERS file.

Development Workflow

Prerequisites

Cube.js works with Node.js 10+ and uses Yarn as a package manager.

Cube.js Docker

Cube.js offers two different types of Docker image:

  • Stable (building from published release on npm)
  • Dev (building from source files, needed to test unpublished changes)

For more information, take a look at Docker Development Guide.

Stable Docker Release

  1. After cloning Cube.js repository run $ yarn in packages/cubejs-docker to install dependencies.
  2. Use $ docker build -t cubejs/cube:latest -f latest.Dockerfile in packages/cubejs-docker to build stable docker image.

Development

  1. After cloning Cube.js repository run $ yarn to install dependencies.
  2. Use $ docker build -t cubejs/cube:dev -f dev.Dockerfile ../../ to build stable development image.

Cube.js Client

  1. After cloning Cube.js repository run $ yarn install in root directory.
  2. Use $ yarn link to add these packages to link registry.
  3. Perform required code changes.
  4. Use $ yarn build in the repository root to build CommonJS and UMD modules.
  5. Use $ yarn link @cubejs-client/core and/or $ yarn link @cubejs-client/react in your project to test changes applied.
  6. Use $ yarn test where available to test your changes.
  7. Ensure that any CommonJS and UMD modules are included as part of your commit.

To get set up quickly, you can perform 1) and 2) with one line from the cube.js clone root folder:

cd packages/cubejs-client-core && yarn && yarn link && cd ../.. && cd packages/cubejs-client-react && yarn && yarn link && cd ../..

Cube.js Server

Prerequisites

If you are going to develop any JDBC driver, you need to install Java with JDK.

Development

Cube.js is written in plain JavaScript, but some parts have already been migrated to TypeScript.

Attention: Cube.js uses TypeScript configured in incremental mode, which uses cache to speed up compilation,
but in some cases, you can run into a problem with a not recompiled file. To fix it, we recommend running $ yarn clean and $ yarn tsc.

  1. After cloning Cube.js repository run $ yarn install in root directory.
  2. Use yarn tsc:watch to start TypeScript compiler in watch mode.
  3. Use $ yarn link in packages/cubejs-<pkg> to add these package to link registry.
  4. Create or choose an existed project for testing.
  5. Use $ yarn link @cubejs-backend/cubejs-<pkg> inside your testing project to link changed package in it.
  6. Use $ yarn dev to start your testing project and verify changes.

Implementing Driver

  1. Copy existing driver package structure and name it in @cubejs-backend/<db-name>-driver format. @cubejs-backend/mysql-driver is a very good candidate for copying this structure.
  2. Please do not copy CHANGELOG.md.
  3. Name driver class and adjust package.json, README.md accordingly.
  4. As a rule of thumb please use only Pure JS libraries as a dependencies where possible. It increases driver adoption rate a lot.
  5. Typically, you need to implement only query() and testConnection() methods of driver. The rest will be done by BaseDriver class.
  6. If db requires connection pooling prefer use generic-pool implementation with settings similar to other db packages.
  7. Make sure your driver has release() method in case DB expects graceful shutdowns for connections.
  8. Please use yarn to add any dependencies and run $ yarn within the package before committing to ensure right yarn.lock is in place.
  9. Add this driver dependency to cubejs-server-core/core/DriverDependencies.js.

Implementing JDBC Driver

If there's existing JDBC Driver in place for Database of interest you can just create DbTypes configuration inside cubejs-jdbc-driver/driver/JDBCDriver.js. Most of the time no additional adjustments required for base JDBCDriver implementation as JDBC is pretty standard. In case you need to tweak it a little please follow Implementing Driver steps but use JDBCDriver as your base driver class.

Implementing SQL Dialect

  1. Find the most similar BaseQuery implementation in @cubejs-backend/schema-compiler/adapter.
  2. Copy it, adjust SQL generation accordingly and put it in driver package. Driver package will obtain @cubejs-backend/schema-compiler dependency from that point.
  3. Add static dialectClass() method to your driver class which returns BaseQuery implementation for the database. For example:
const { BaseDriver } = require('@cubejs-backend/query-orchestrator');
const FooQuery = require('./FooQuery');

class FooDriver extends BaseDriver {
  // ...
  static dialectClass() {
    return FooQuery;
  }
}

If driver class contains static dialectClass() method it'll be used to lookup corresponding SQL dialect. Otherwise, it will use the default dialect for the database type.

Publishing Driver npm Package

Cube.js looks up cubejs-{dbType}-driver package among installed modules to fullfil driver dependency if there's no corresponding default driver for the specified database type. For example one can publish cubejs-foo-driver npm package to fullfil driver dependency for the foo database type.

Testing Schema Compiler

In order to run tests in cubejs-schema-compiler package you need to have running Docker on your machine. When it's up and running just use $ npm test in packages/cubejs-schema-compiler to execute tests.

Linking Server Core for Development

It's convenient to link @cubejs-backend/server-core into your project for manual tests of changes of backend code. Cube.js uses yarn as package manager instead of npm. In order to link @cubejs-backend/server-core:

  1. Create new project using npx cubejs-cli create or use existing one.
  2. Install yarn: npm install -g yarn.
  3. Link server-core package: yarn link inside packages/cubejs-server-core.
  4. Link all drivers and dependent packages where you make changes in packages/cubejs-server-core.
  5. Run yarn build in packages/cubejs-playground.
  6. Install dependencies in all linked packages using yarn.
  7. Run yarn link @cubejs-backend/server-core in your project directory.

Client Packages

If you want to make changes to the Cube.js client packages and test them locally in your project you can do it the following way:

  1. Make the desired changes and run yarn build in the root directory (you can also use yarn watch)
  2. Go to the ~/some-path/cube.js/packages/cubejs-client-core directory and run yarn link. (You'll see the messages Registered "@cubejs-client/core")
  3. Now you can link it in your project (e.g. /my-project/dashboard-app). You can do so running yarn link "@cubejs-client/core"

If you want to make changes to the @cubejs-client/react package you'll need a few extra steps

  1. Go to your project's node_modules directory and find the react package (e.g. /my-project/dashboard-app/node_modules/react and run yarn link
  2. Go to the ~/some-path/cube.js/packages/cubejs-client-react directory and run yarn link react

Now your project will be using the local packages.

NOTE: You might need to restart your project after linking the packages.

Style guides

We're passionate about what code can do rather how it's formatted. But in order to make code and docs maintainable following style guides will be enforced. Following these guidelines is not a requirement, but you can save some time for maintainers if you apply those to your contribution beforehand.

Code

  1. Run npm run lint in package before committing your changes. If package doesn't have lint script, please add it and run. There's one root .eslintrc.js file for all packages except client ones. Client packages has it's own .eslintrc.js files.
  2. Run npm test before committing if package has tests.
  3. Please use conventional commits name for your PR. It'll be used to build change logs. All PRs are merged using squash so only PR name matters.
  4. Do not reformat code you aren't really changing unless it's absolutely necessary (e.g. fixing linter). Such changes make it really hard to use git blame feature when we need to find a commit where line change of interest was introduced.