Compare commits

...
Author SHA1 Message Date
kaloster 012d3b8b9e flakey test 2024-09-12 21:02:42 -04:00
Timmy Huang 151c28d119 chore: Add ESLint no-floating-promise 2024-09-12 13:36:26 -07:00
Ronen fd8b47b78e chore: Release 1.3.0 (#2700)
* Bump version: 1.2.0 → 1.3.0-rc.0

* Bump version: 1.3.0-rc.0 → 1.3.0
2024-09-12 16:05:14 -04:00
Ronen 487bd13ff8 chore: add support for python 3.12 (#2694) 2024-09-12 14:16:46 -04:00
37 changed files with 906 additions and 787 deletions
+1 -1
View File
@@ -1,5 +1,5 @@
[bumpversion] [bumpversion]
current_version = 1.2.0 current_version = 1.3.0
commit = True commit = True
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<prerel>rc)\.(?P<prerelversion>\d+))? parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(?:-(?P<prerel>rc)\.(?P<prerelversion>\d+))?
serialize = serialize =
+2 -2
View File
@@ -8,8 +8,8 @@ on:
- main - main
# For debug - uncomment below to run on all PRs # For debug - uncomment below to run on all PRs
# pull_request: pull_request:
# branches: "*" branches: "*"
env: env:
JEST_ENV: prod JEST_ENV: prod
+9 -7
View File
@@ -17,10 +17,10 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- run: | - run: |
git fetch --depth=1 origin +${{github.base_ref}} git fetch --depth=1 origin +${{github.base_ref}}
- name: Set up Python 3.11 - name: Set up Python 3.12
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: 3.11 python-version: 3.12
- name: Node cache - name: Node cache
uses: actions/cache@v4 uses: actions/cache@v4
with: with:
@@ -46,10 +46,10 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Set up Python 3.11 (pyenv) # pyenv needed for mlflow in cli annotate tests - name: Set up Python 3.12 (pyenv) # pyenv needed for mlflow in cli annotate tests
uses: gabrielfalcao/pyenv-action@v9 uses: gabrielfalcao/pyenv-action@v9
with: with:
default: 3.11 default: 3.12
command: pip install -U pip # upgrade pip after installing python command: pip install -U pip # upgrade pip after installing python
- run: pip install virtualenv # virtualenv needed for mlflow in cli annotate tests - run: pip install virtualenv # virtualenv needed for mlflow in cli annotate tests
- name: Python cache - name: Python cache
@@ -79,10 +79,10 @@ jobs:
timeout-minutes: 20 timeout-minutes: 20
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Set up Python 3.11 - name: Set up Python 3.12
uses: actions/setup-python@v5 uses: actions/setup-python@v5
with: with:
python-version: 3.11 python-version: 3.12
- name: Python cache - name: Python cache
uses: actions/cache@v4 uses: actions/cache@v4
with: with:
@@ -98,7 +98,9 @@ jobs:
restore-keys: | restore-keys: |
${{ runner.os }}-node- ${{ runner.os }}-node-
- name: Install dependencies - name: Install dependencies
run: make pydist install-dist run: |
pip install setuptools
make pydist install-dist
- name: Smoke tests (without annotations feature) - name: Smoke tests (without annotations feature)
run: | run: |
cd client && make smoke-test cd client && make smoke-test
+11 -11
View File
@@ -1,4 +1,4 @@
<img src="./docs/cellxgene-logo.png" width="300"> ![](https://github.com/chanzuckerberg/cellxgene/raw/main/docs/cellxgene-logo.png)
_an interactive explorer for single-cell transcriptomics data_ _an interactive explorer for single-cell transcriptomics data_
@@ -11,7 +11,8 @@ CZ CELLxGENE Annotate (pronounced "cell-by-gene") is an interactive data explore
Whether you need to visualize one thousand cells or one million, CELLxGENE Annotate helps you gain insight into your single-cell data. Whether you need to visualize one thousand cells or one million, CELLxGENE Annotate helps you gain insight into your single-cell data.
<img src="https://github.com/chanzuckerberg/cellxgene/raw/main/docs/images/crossfilter.gif" width="350" height="200" hspace="30"><img src="https://github.com/chanzuckerberg/cellxgene/raw/main/docs/images/category-breakdown.gif" width="350" height="200" hspace="30"> ![](https://github.com/chanzuckerberg/cellxgene/raw/main/docs/images/crossfilter.gif)
![](https://github.com/chanzuckerberg/cellxgene/raw/main/docs/images/category-breakdown.gif)
# Getting started # Getting started
@@ -27,7 +28,7 @@ Whether you need to visualize one thousand cells or one million, CELLxGENE Annot
### Quick start ### Quick start
To install CELLxGENE Annotate you need Python 3.6+. We recommend [installing Annotate into a conda or virtual environment.](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/desktop/install.md) To install CELLxGENE Annotate you need Python 3.10+. We recommend [installing Annotate into a conda or virtual environment.](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/desktop/install.md)
Install the package. Install the package.
@@ -66,22 +67,21 @@ For any errors, [report bugs on Github](https://github.com/chanzuckerberg/cellxg
### Contributing ### Contributing
We warmly welcome contributions from the community! Please see our [contributing guide](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/contribute.md) and don't hesitate to open an issue or send a pull request to improve CELLxGENE Annotate. Please see the [dev_docs](https://github.com/chanzuckerberg/cellxgene/tree/main/dev_docs) for pull request suggestions, unit test details, local documentation preview, and other development specifics. We warmly welcome contributions from the community! Please see our [contributing guide](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/contribute.md) and don't hesitate to open an issue or send a pull request to improve CELLxGENE Annotate. Please see the [dev_docs](https://github.com/chanzuckerberg/cellxgene/tree/main/dev_docs) for pull request suggestions, unit test details, local documentation preview, and other development specifics.
This project adheres to the Contributor Covenant [code of conduct](https://github.com/chanzuckerberg/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@chanzuckerberg.com. This project adheres to the Contributor Covenant [code of conduct](https://github.com/chanzuckerberg/.github/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@chanzuckerberg.com.
### Reuse ### Reuse
This project was started with the sole goal of empowering the scientific community to explore and understand their data. This project was started with the sole goal of empowering the scientific community to explore and understand their data.
As such, we encourage other scientific tool builders in academia or industry to adopt the patterns, tools, and code from As such, we encourage other scientific tool builders in academia or industry to adopt the patterns, tools, and code from
this project. All code is freely available for reuse under the [MIT license](https://opensource.org/licenses/MIT). this project. All code is freely available for reuse under the [MIT license](https://opensource.org/licenses/MIT).
Before extending CELLxGENE Annotate, we encourage you to reach out to us with ideas or questions. It might be possible that an
extension could be directly contributed, which would make it available for a wider audience, or that it's on our
[roadmap](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/roadmap.md) and under active development.
Before extending CELLxGENE Annotate, we encourage you to reach out to us with ideas or questions. It might be possible that an See the [CELLxGENE extensions](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/community-extensions.md) section of our documentation for examples of community use and CELLxGENE extensions.
extension could be directly contributed, which would make it available for a wider audience, or that it's on our
[roadmap](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/roadmap.md) and under active development.
See the [CELLxGENE extensions](https://github.com/chanzuckerberg/cellxgene-documentation/blob/main/community-extensions.md) section of our documentation for examples of community use and CELLxGENE extensions.
### Security ### Security
+1 -1
View File
@@ -1 +1 @@
16.20.0 18.17.0
+1 -1
View File
@@ -1,4 +1,4 @@
import * as ENV_DEFAULT from "../../../environment.default.json"; import * as ENV_DEFAULT from "Code/cellxgene/environment.default.json";
export const jestEnv = process.env.JEST_ENV || ENV_DEFAULT.JEST_ENV; export const jestEnv = process.env.JEST_ENV || ENV_DEFAULT.JEST_ENV;
export const appUrlBase = export const appUrlBase =
+1 -1
View File
@@ -5,8 +5,8 @@
*/ */
import { setDefaultOptions } from "expect-puppeteer"; import { setDefaultOptions } from "expect-puppeteer";
import * as ENV_DEFAULT from "Code/cellxgene/environment.default.json";
import { isDebug, isDev } from "./config"; import { isDebug, isDev } from "./config";
import * as ENV_DEFAULT from "../../../environment.default.json";
// (thuang): This is the max time a test can take to run. // (thuang): This is the max time a test can take to run.
// Since when debugging, we run slowMo and !headless, this means // Since when debugging, we run slowMo and !headless, this means
+6 -6
View File
@@ -76,7 +76,7 @@ describe("PromiseLimit", () => {
const plimit = new PromiseLimit(1); const plimit = new PromiseLimit(1);
let finishOrder = 0; let finishOrder = 0;
const callback = () => async () => { const callback = async () => {
await delay(100); await delay(100);
const result = finishOrder; const result = finishOrder;
finishOrder += 1; finishOrder += 1;
@@ -84,11 +84,11 @@ describe("PromiseLimit", () => {
}; };
const result = await Promise.all([ const result = await Promise.all([
plimit.add(callback()), plimit.add(callback),
plimit.priorityAdd(4, callback()), plimit.priorityAdd(4, callback),
plimit.priorityAdd(0, callback()), plimit.priorityAdd(0, callback),
plimit.priorityAdd(1, callback()), plimit.priorityAdd(1, callback),
plimit.priorityAdd(-1, callback()), plimit.priorityAdd(-1, callback),
]); ]);
expect(result).toEqual([0, 4, 2, 3, 1]); expect(result).toEqual([0, 4, 2, 3, 1]);
+2 -1
View File
@@ -82,13 +82,14 @@ module.exports = {
}, },
// Can't extend in overrides: https://github.com/eslint/eslint/issues/8813 // Can't extend in overrides: https://github.com/eslint/eslint/issues/8813
// "extends": ["plugin:jest/recommended"] // "extends": ["plugin:jest/recommended"]
plugins: ["jest"], plugins: ["jest", "no-floating-promise"],
rules: { rules: {
"jest/no-disabled-tests": "warn", "jest/no-disabled-tests": "warn",
"jest/no-focused-tests": "error", "jest/no-focused-tests": "error",
"jest/no-identical-title": "error", "jest/no-identical-title": "error",
"jest/prefer-to-have-length": "warn", "jest/prefer-to-have-length": "warn",
"jest/valid-expect": "error", "jest/valid-expect": "error",
"no-floating-promise/no-floating-promise": 2,
}, },
}, },
], ],
+1
View File
@@ -14,6 +14,7 @@ const DEFAULT_LAUNCH_CONFIG = {
headless: !isHeadful, headless: !isHeadful,
args: ["--ignore-certificate-errors", "--ignore-ssl-errors"], args: ["--ignore-certificate-errors", "--ignore-ssl-errors"],
ignoreHTTPSErrors: true, ignoreHTTPSErrors: true,
timeout: 90000,
defaultViewport: { defaultViewport: {
width: 1280, width: 1280,
height: 960, height: 960,
+778 -649
View File
File diff suppressed because it is too large Load Diff
+10 -9
View File
@@ -1,6 +1,6 @@
{ {
"name": "cellxgene", "name": "cellxgene",
"version": "1.2.0", "version": "1.3.0",
"license": "MIT", "license": "MIT",
"description": "cellxgene is a web application for the interactive exploration of single cell sequence data.", "description": "cellxgene is a web application for the interactive exploration of single cell sequence data.",
"repository": "https://github.com/chanzuckerberg/cellxgene", "repository": "https://github.com/chanzuckerberg/cellxgene",
@@ -10,16 +10,16 @@
"dev": "npm run build -- configuration/webpack/webpack.config.dev.js", "dev": "npm run build -- configuration/webpack/webpack.config.dev.js",
"e2e": "jest --config __tests__/e2e/e2eJestConfig.json e2e/e2e.test.js", "e2e": "jest --config __tests__/e2e/e2eJestConfig.json e2e/e2e.test.js",
"e2e-annotations": "jest --config __tests__/e2e/e2eJestConfig.json e2e/e2eAnnotations.test.js", "e2e-annotations": "jest --config __tests__/e2e/e2eJestConfig.json e2e/e2eAnnotations.test.js",
"fmt": "eslint --fix src __tests__", "fmt": "eslint --fix __tests__",
"lint": "eslint --fix src __tests__", "lint": "eslint --fix __tests__",
"prod": "npm run build -- configuration/webpack/webpack.config.prod.js", "prod": "npm run build -- configuration/webpack/webpack.config.prod.js",
"test": "jest --testPathIgnorePatterns e2e", "test": "jest --testPathIgnorePatterns e2e",
"prepare": "cd .. && husky install client/.husky" "prepare": "cd .. && husky install client/.husky"
}, },
"engineStrict": true, "engineStrict": true,
"engines": { "engines": {
"npm": ">=3.0.0", "npm": ">=9.6.7",
"node": "^16.0.0" "node": "^18.17.0"
}, },
"eslintConfig": { "eslintConfig": {
"extends": "./configuration/eslint/eslint.js" "extends": "./configuration/eslint/eslint.js"
@@ -92,7 +92,7 @@
"@babel/preset-react": "^7.13.13", "@babel/preset-react": "^7.13.13",
"@babel/register": "^7.13.16", "@babel/register": "^7.13.16",
"@babel/runtime": "^7.13.16", "@babel/runtime": "^7.13.16",
"@blueprintjs/eslint-plugin": "^0.3.0", "@blueprintjs/eslint-plugin": "^6.1.4",
"@sentry/webpack-plugin": "^1.15.0", "@sentry/webpack-plugin": "^1.15.0",
"babel-jest": "^26.1.0", "babel-jest": "^26.1.0",
"babel-loader": "^8.1.0", "babel-loader": "^8.1.0",
@@ -104,15 +104,16 @@
"codecov": "^3.7.1", "codecov": "^3.7.1",
"css-loader": "^5.2.4", "css-loader": "^5.2.4",
"css-minimizer-webpack-plugin": "^4.0.0", "css-minimizer-webpack-plugin": "^4.0.0",
"eslint": "^7.24.0", "eslint": "^8.56.0",
"eslint-config-airbnb": "^18.2.0", "eslint-config-airbnb": "^19.0.4",
"eslint-config-prettier": "^8.2.0", "eslint-config-prettier": "^8.2.0",
"eslint-plugin-compat": "^4.2.0", "eslint-plugin-compat": "^4.2.0",
"eslint-plugin-eslint-comments": "^3.2.0", "eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-filenames": "^1.3.2", "eslint-plugin-filenames": "^1.3.2",
"eslint-plugin-import": "^2.24.2", "eslint-plugin-import": "^2.24.2",
"eslint-plugin-jest": "^24.3.5", "eslint-plugin-jest": "^28.8.3",
"eslint-plugin-jsx-a11y": "^6.3.1", "eslint-plugin-jsx-a11y": "^6.3.1",
"eslint-plugin-no-floating-promise": "^2.0.0",
"eslint-plugin-react": "^7.23.2", "eslint-plugin-react": "^7.23.2",
"eslint-plugin-react-hooks": "^4.0.8", "eslint-plugin-react-hooks": "^4.0.8",
"expect-puppeteer": "^5.0.0", "expect-puppeteer": "^5.0.0",
@@ -1,8 +1,8 @@
import React from "react"; import React from "react";
import * as globals from "../../globals"; import * as globals from "../../globals";
const ErrorLoading = ({ displayName, zebra }) => ( function ErrorLoading({ displayName, zebra }) {
<div return <div
style={{ style={{
backgroundColor: zebra ? globals.lightestGrey : "white", backgroundColor: zebra ? globals.lightestGrey : "white",
fontStyle: "italic", fontStyle: "italic",
@@ -10,6 +10,6 @@ const ErrorLoading = ({ displayName, zebra }) => (
> >
<span>{`Failure loading ${displayName}`}</span> <span>{`Failure loading ${displayName}`}</span>
</div> </div>
); }
export default ErrorLoading; export default ErrorLoading;
@@ -5,7 +5,7 @@ import * as d3 from "d3";
import maybeScientific from "../../util/maybeScientific"; import maybeScientific from "../../util/maybeScientific";
import clamp from "../../util/clamp"; import clamp from "../../util/clamp";
const Histogram = ({ function Histogram({
field, field,
fieldForId, fieldForId,
display, display,
@@ -18,7 +18,7 @@ const Histogram = ({
isColorBy, isColorBy,
selectionRange, selectionRange,
mini, mini,
}) => { }) {
const svgRef = useRef(null); const svgRef = useRef(null);
const [brush, setBrush] = useState(null); const [brush, setBrush] = useState(null);
@@ -186,6 +186,6 @@ const Histogram = ({
ref={svgRef} ref={svgRef}
/> />
); );
}; }
export default Histogram; export default Histogram;
@@ -3,12 +3,8 @@ import { Button } from "@blueprintjs/core";
import * as globals from "../../globals"; import * as globals from "../../globals";
const StillLoading = ({ zebra, displayName }) => function StillLoading({ zebra, displayName }) {
/* return <div
Render a loading indicator for the field.
*/
(
<div
data-testclass="gene-loading-spinner" data-testclass="gene-loading-spinner"
style={{ style={{
padding: globals.leftSidebarSectionPadding, padding: globals.leftSidebarSectionPadding,
@@ -37,7 +33,6 @@ const StillLoading = ({ zebra, displayName }) =>
</div> </div>
</div> </div>
</div> </div>
) }
;
export default StillLoading; export default StillLoading;
@@ -71,8 +71,7 @@ class Category extends React.PureComponent {
const { metadataField, annotations, obsCrossfilter } = this.props; const { metadataField, annotations, obsCrossfilter } = this.props;
return ( return (
<> <AnnoDialog
<AnnoDialog
isActive={ isActive={
annotations.isAddingNewLabel && annotations.isAddingNewLabel &&
annotations.categoryAddingNewLabel === metadataField annotations.categoryAddingNewLabel === metadataField
@@ -105,7 +104,6 @@ class Category extends React.PureComponent {
/> />
} }
/> />
</>
); );
} }
} }
@@ -105,8 +105,7 @@ class AnnoDialogEditCategoryName extends React.PureComponent {
const { metadataField, annotations } = this.props; const { metadataField, annotations } = this.props;
return ( return (
<> <AnnoDialog
<AnnoDialog
isActive={ isActive={
annotations.isEditingCategoryName && annotations.isEditingCategoryName &&
annotations.categoryBeingEdited === metadataField annotations.categoryBeingEdited === metadataField
@@ -141,7 +140,6 @@ class AnnoDialogEditCategoryName extends React.PureComponent {
/> />
} }
/> />
</>
); );
} }
} }
@@ -288,11 +288,8 @@ class Category extends React.PureComponent {
export default Category; export default Category;
const StillLoading = ({ metadataField, checkboxID }) => ( function StillLoading({ metadataField, checkboxID }) {
/* return <div
We are still loading this category, so render a "busy" signal.
*/
<div
style={{ style={{
maxWidth: globals.maxControlsWidth, maxWidth: globals.maxControlsWidth,
}} }}
@@ -335,8 +332,8 @@ const StillLoading = ({ metadataField, checkboxID }) => (
</div> </div>
</div> </div>
</div> </div>
); }
const ErrorLoading = ({ metadataField, error }) => { function ErrorLoading({ metadataField, error }) {
console.error(error); // log error to console as it is unexpected. console.error(error); // log error to console as it is unexpected.
return ( return (
<div style={{ marginBottom: 10, marginTop: 4 }}> <div style={{ marginBottom: 10, marginTop: 4 }}>
@@ -352,7 +349,7 @@ const ErrorLoading = ({ metadataField, error }) => {
</span> </span>
</div> </div>
); );
}; }
const CategoryHeader = React.memo( const CategoryHeader = React.memo(
({ ({
@@ -162,7 +162,7 @@ class CategoryValue extends React.Component {
); );
}; };
shouldComponentUpdate = (nextProps, nextState) => { shouldComponentUpdate(nextProps, nextState) {
/* /*
Checks to see if at least one of the following changed: Checks to see if at least one of the following changed:
* world state * world state
+2 -2
View File
@@ -109,7 +109,7 @@ const loadAllEmbeddingCounts = async ({ annoMatrix, available }) => {
})); }));
}; };
const EmbeddingChoices = ({ onChange, annoMatrix, layoutChoice }) => { function EmbeddingChoices({ onChange, annoMatrix, layoutChoice }) {
const { available } = layoutChoice; const { available } = layoutChoice;
const { data, error, isPending } = useAsync({ const { data, error, isPending } = useAsync({
promiseFn: loadAllEmbeddingCounts, promiseFn: loadAllEmbeddingCounts,
@@ -149,4 +149,4 @@ const EmbeddingChoices = ({ onChange, annoMatrix, layoutChoice }) => {
); );
} }
return null; return null;
}; }
+2 -2
View File
@@ -1,7 +1,7 @@
import React from "react"; import React from "react";
import icon from "../../images/icon.png"; import icon from "../../images/icon.png";
const Logo = (props) => { function Logo(props) {
const { size } = props; const { size } = props;
return ( return (
<img <img
@@ -11,6 +11,6 @@ const Logo = (props) => {
alt="CELLxGENE Annotate Logo" alt="CELLxGENE Annotate Logo"
/> />
); );
}; }
export default Logo; export default Logo;
@@ -53,8 +53,7 @@ class AddGeneToGenesetDialogue extends React.PureComponent {
const { genesToAdd } = this.state; const { genesToAdd } = this.state;
return ( return (
<> <AnnoDialog
<AnnoDialog
isActive={genesetsUI.isAddingGenesToGeneset === geneset} isActive={genesetsUI.isAddingGenesToGeneset === geneset}
inputProps={{ "data-testid": `${geneset}:create-label-dialog` }} inputProps={{ "data-testid": `${geneset}:create-label-dialog` }}
primaryButtonProps={{ primaryButtonProps={{
@@ -81,7 +80,6 @@ class AddGeneToGenesetDialogue extends React.PureComponent {
handleSubmit={this.handleAddGeneToGeneSet} handleSubmit={this.handleAddGeneToGeneSet}
handleCancel={this.disableAddGeneMode} handleCancel={this.disableAddGeneMode}
/> />
</>
); );
} }
} }
@@ -125,8 +125,7 @@ class CreateGenesetDialogue extends React.PureComponent {
const { genesetsUI, genesets } = this.props; const { genesetsUI, genesets } = this.props;
return ( return (
<> <Dialog
<Dialog
icon="tag" icon="tag"
title="Create gene set" title="Create gene set"
isOpen={genesetsUI.createGenesetModeActive} isOpen={genesetsUI.createGenesetModeActive}
@@ -210,7 +209,6 @@ class CreateGenesetDialogue extends React.PureComponent {
</div> </div>
</form> </form>
</Dialog> </Dialog>
</>
); );
} }
} }
@@ -109,8 +109,7 @@ class RenameGeneset extends React.PureComponent {
} = this.props; } = this.props;
return ( return (
<> <AnnoDialog
<AnnoDialog
isActive={genesetsUI.isEditingGenesetName === originalGenesetName} isActive={genesetsUI.isEditingGenesetName === originalGenesetName}
inputProps={{ inputProps={{
"data-testid": `${genesetsUI.isEditingGenesetName}:rename-geneset-dialog`, "data-testid": `${genesetsUI.isEditingGenesetName}:rename-geneset-dialog`,
@@ -161,7 +160,6 @@ class RenameGeneset extends React.PureComponent {
handleSubmit={this.renameGeneset} handleSubmit={this.renameGeneset}
handleCancel={this.disableEditGenesetNameMode} handleCancel={this.disableEditGenesetNameMode}
/> />
</>
); );
} }
} }
+5 -10
View File
@@ -935,7 +935,7 @@ class Graph extends React.Component {
} }
} }
const ErrorLoading = ({ displayName, error, width, height }) => { function ErrorLoading({ displayName, error, width, height }) {
console.log(error); // log to console as this is an unepected error console.log(error); // log to console as this is an unepected error
return ( return (
<div <div
@@ -949,14 +949,10 @@ const ErrorLoading = ({ displayName, error, width, height }) => {
<span>{`Failure loading ${displayName}`}</span> <span>{`Failure loading ${displayName}`}</span>
</div> </div>
); );
}; }
const StillLoading = ({ displayName, width, height }) => function StillLoading({ displayName, width, height }) {
/* return <div
Render a busy/loading indicator
*/
(
<div
style={{ style={{
position: "fixed", position: "fixed",
fontWeight: 500, fontWeight: 500,
@@ -976,7 +972,6 @@ const StillLoading = ({ displayName, width, height }) =>
<span style={{ fontStyle: "italic" }}>Loading {displayName}</span> <span style={{ fontStyle: "italic" }}>Loading {displayName}</span>
</div> </div>
</div> </div>
) }
;
export default Graph; export default Graph;
@@ -167,7 +167,7 @@ class CentroidLabels extends PureComponent {
} }
} }
const Label = ({ function Label({
label, label,
dilatedValue, dilatedValue,
coords, coords,
@@ -177,7 +177,7 @@ const Label = ({
displayLabel, displayLabel,
onMouseEnter, onMouseEnter,
onMouseOut, onMouseOut,
}) => { }) {
/* /*
Render a label at a given coordinate. Render a label at a given coordinate.
*/ */
@@ -215,4 +215,4 @@ const Label = ({
</text> </text>
</g> </g>
); );
}; }
+1 -3
View File
@@ -159,8 +159,7 @@ export default class LabelInput extends React.PureComponent {
}; };
const { queryResults } = this.state; const { queryResults } = this.state;
return ( return (
<> <Suggest
<Suggest
fill fill
inputValueRenderer={(i) => i.target} inputValueRenderer={(i) => i.target}
items={queryResults} items={queryResults}
@@ -172,7 +171,6 @@ export default class LabelInput extends React.PureComponent {
inputProps={inputProps} inputProps={inputProps}
onKeyDown={this.handleKeyDown} onKeyDown={this.handleKeyDown}
/> />
</>
); );
} }
} }
+2 -2
View File
@@ -35,11 +35,11 @@ export default class MiniHistogram extends React.PureComponent {
} }
}; };
componentDidMount = () => { componentDidMount() {
this.drawHistogram(); this.drawHistogram();
}; };
componentDidUpdate = (prevProps) => { componentDidUpdate(prevProps) {
const { obsOrVarContinuousFieldDisplayName, bins } = this.props; const { obsOrVarContinuousFieldDisplayName, bins } = this.props;
if ( if (
prevProps.obsOrVarContinuousFieldDisplayName !== prevProps.obsOrVarContinuousFieldDisplayName !==
@@ -42,12 +42,12 @@ export default class MiniStackedBar extends React.PureComponent {
} }
}; };
componentDidUpdate = (prevProps) => { componentDidUpdate(prevProps) {
const { occupancy } = this.props; const { occupancy } = this.props;
if (occupancy !== prevProps.occupancy) this.drawStacks(); if (occupancy !== prevProps.occupancy) this.drawStacks();
}; };
componentDidMount = () => { componentDidMount() {
this.drawStacks(); this.drawStacks();
}; };
+1 -1
View File
@@ -32,7 +32,7 @@ const SECOND_HALF_INNER_STYLE = {
right: 0, right: 0,
}; };
export default (props) => { export default function(props) {
const { children, isGenesetDescription, tooltipAddendum = "" } = props; const { children, isGenesetDescription, tooltipAddendum = "" } = props;
// Truncate only support a single child with a text child // Truncate only support a single child with a text child
+1 -1
View File
@@ -1,6 +1,6 @@
import { Colors } from "@blueprintjs/core"; import { Colors } from "@blueprintjs/core";
import ENV_DEFAULT from "Code/cellxgene/environment.default.json";
import { dispatchNetworkErrorMessageToUser } from "./util/actionHelpers"; import { dispatchNetworkErrorMessageToUser } from "./util/actionHelpers";
import ENV_DEFAULT from "../../environment.default.json";
/* overflow category values are created using this string */ /* overflow category values are created using this string */
export const overflowCategoryLabel = ": all other labels"; export const overflowCategoryLabel = ": all other labels";
+3 -3
View File
@@ -3,7 +3,7 @@
## Requirements ## Requirements
- npm - npm
- Python 3.6+ - Python 3.10+
- Chrome - Chrome
[See dev section of README](../README.md) [See dev section of README](../README.md)
@@ -148,6 +148,6 @@ If you would like to run the smoke tests against a hot-reloaded version of the c
### Tips ### Tips
- You can also install/launch the server side code from npm scrips (requires python3.6 with virtualenv) with the `scripts/backend_dev` script. - You can also install/launch the server side code from npm scrips (requires python3.10 with virtualenv) with the `scripts/backend_dev` script.
- Check out [e2e Tests](e2e_tests.md) for more details - Check out [e2e Tests](e2e_tests.md) for more details
+31 -23
View File
@@ -11,9 +11,10 @@ $PROJECT_ROOT`.
### Build ### Build
**Usage:** from the `$PROJECT_ROOT` directory run: **Usage:** from the `$PROJECT_ROOT` directory run:
* `make build` builds whole app client and server
* `make build-client` runs webpack build - `make build` builds whole app client and server
* `make build-for-server-dev` builds client and copies output directly into - `make build-client` runs webpack build
- `make build-for-server-dev` builds client and copies output directly into
source tree (only for server devlopment) source tree (only for server devlopment)
### Clean ### Clean
@@ -21,17 +22,19 @@ $PROJECT_ROOT`.
Deletes generated files. Deletes generated files.
**Usage:** from the `$PROJECT_ROOT` directory run: **Usage:** from the `$PROJECT_ROOT` directory run:
* `make clean` cleans everything including node modules (means build with take
- `make clean` cleans everything including node modules (means build with take
a while a while
* `make clean-lite` cleans built directories - `make clean-lite` cleans built directories
* `make clean-server` cleans source tree - `make clean-server` cleans source tree
### Distribution ### Distribution
Creates distribution for python module to upload to pypi. Creates distribution for python module to upload to pypi.
**Usage:** from the `$PROJECT_ROOT` directory run: **Usage:** from the `$PROJECT_ROOT` directory run:
* `make pydist` builds code and then builds sdist
- `make pydist` builds code and then builds sdist
### Release ### Release
@@ -42,16 +45,18 @@ See `release_process.md`.
Installs requirements files. Installs requirements files.
**Usage:** from the `$PROJECT_ROOT` directory run: **Usage:** from the `$PROJECT_ROOT` directory run:
* `make dev-env` installs requirements and requirments-dev (for building code)
- `make dev-env` installs requirements and requirments-dev (for building code)
### Installing cellxgene packages ### Installing cellxgene packages
**Usage:** from the `$PROJECT_ROOT` directory: **Usage:** from the `$PROJECT_ROOT` directory:
* `install-dev` - installs from local source tree
* `install-release-test` - installs from test pypi - `install-dev` - installs from local source tree
* `install-release` - installs from pypi - `install-release-test` - installs from test pypi
* `install-dist` - installs from local dist folder - `install-release` - installs from pypi
* `uninstall` - uninstalls cellxgene - `install-dist` - installs from local dist folder
- `uninstall` - uninstalls cellxgene
## Client-level scripts ## Client-level scripts
@@ -62,8 +67,9 @@ Installs requirements files.
**About** Serve the current client javascript independently from the `server` code. **About** Serve the current client javascript independently from the `server` code.
**Requires** **Requires**
* The server to be running. Best way to do this is with [backend_dev](#backend_dev).
* `make ci` to install the necessary node modules - The server to be running. Best way to do this is with [backend_dev](#backend_dev).
- `make ci` to install the necessary node modules
**Usage:** from the `$PROJECT_ROOT/client` directory run `make start-frontend` **Usage:** from the `$PROJECT_ROOT/client` directory run `make start-frontend`
@@ -75,23 +81,24 @@ the FE developer gets the current version of the backend with a single command
and no knowledge of python necessary. It creates and activates a virtual and no knowledge of python necessary. It creates and activates a virtual
environment and installs cellxgene from the current branch. environment and installs cellxgene from the current branch.
**Requires** `Python3.6+`, `virtual-env`, `pip` **Requires** `Python3.10+`, `virtual-env`, `pip`
**Usage:** from the `$PROJECT_ROOT` directory run `./scripts/backend_dev` **Usage:** from the `$PROJECT_ROOT` directory run `./scripts/backend_dev`
**Options:** **Options:**
* In parallel, you can then launch the node development server to serve the
- In parallel, you can then launch the node development server to serve the
current state of the FE with [`start-frontend`](#start-frontend), usually in current state of the FE with [`start-frontend`](#start-frontend), usually in
a different terminal tab. a different terminal tab.
* You can also select a specific dataset using `DATASET=<dataset path> ./scripts/backend_dev`. - You can also select a specific dataset using `DATASET=<dataset path> ./scripts/backend_dev`.
* You can also use `CXG_OPTIONS` to pass options to the `cellxgene launch` - You can also use `CXG_OPTIONS` to pass options to the `cellxgene launch`
command, as in `CXG_OPTIONS='--disable-annotations' ./scripts/backend_dev`. command, as in `CXG_OPTIONS='--disable-annotations' ./scripts/backend_dev`.
**Breakdown** **Breakdown**
| command | purpose | | command | purpose |
| ---------------------------------------- | ---------------------------------------------------------- | | ---------------------------------------- | ---------------------------------------------------------- |
| python3.6 -m venv cellxgene | creates cellxgene virtual environment | | python3.12 -m venv cellxgene | creates cellxgene virtual environment |
| source cellxgene/bin/activate | activates virtual environment | | source cellxgene/bin/activate | activates virtual environment |
| yes \| pip uninstall cellxgene \|\| true | uninstalls cellxgene (if installed) | | yes \| pip uninstall cellxgene \|\| true | uninstalls cellxgene (if installed) |
| pip install -e . | installs current local version of cellxgene | | pip install -e . | installs current local version of cellxgene |
@@ -102,14 +109,15 @@ environment and installs cellxgene from the current branch.
Methods used to test the client javascript code Methods used to test the client javascript code
**Usage:** from the `$PROJECT_ROOT/client` directory run: **Usage:** from the `$PROJECT_ROOT/client` directory run:
* `make unit-test` Runs all unit tests. It excludes any tests in the e2e
- `make unit-test` Runs all unit tests. It excludes any tests in the e2e
folder. This is used by travis to run unit tests. folder. This is used by travis to run unit tests.
* `make smoke-test` Starts backend development server and runs end to end - `make smoke-test` Starts backend development server and runs end to end
tests. This is what travis runs. It depends on the `e2e` and the tests. This is what travis runs. It depends on the `e2e` and the
`backend-dev` targets. One starts the server, the other runs the tests. If `backend-dev` targets. One starts the server, the other runs the tests. If
developing a front-end feature and just checking if tests pass, this is developing a front-end feature and just checking if tests pass, this is
probabaly the one you want to run. probabaly the one you want to run.
* `npm run e2e` Runs backend tests without starting the server. You will need to - `npm run e2e` Runs backend tests without starting the server. You will need to
start the rest api separately with the pbmc3k.h5ad file. Note you can use start the rest api separately with the pbmc3k.h5ad file. Note you can use
the `JEST_ENV` environment variable to change how JEST runs in the browser. the `JEST_ENV` environment variable to change how JEST runs in the browser.
The test runs against `localhost:3000` by default. You can use the The test runs against `localhost:3000` by default. You can use the
+1 -1
View File
@@ -2,7 +2,7 @@ import logging
import sys import sys
from server.common.utils.utils import import_plugins from server.common.utils.utils import import_plugins
__version__ = "1.2.0" __version__ = "1.3.0"
display_version = "cellxgene v" + __version__ display_version = "cellxgene v" + __version__
try: try:
+3 -2
View File
@@ -7,7 +7,7 @@ Flask-Cors>=3.0.9
Flask-RESTful>=0.3.6 Flask-RESTful>=0.3.6
flask-server-timing>=0.1.2 flask-server-timing>=0.1.2
flask-talisman>=0.7.0 flask-talisman>=0.7.0
flatbuffers>=1.11.0,<2.0.0 # cellxgene is not compatible with 2.0.0. Requires migration flatbuffers==2.0.7
flatten-dict>=0.2.0 flatten-dict>=0.2.0
fsspec>0.8.0 fsspec>0.8.0
gunicorn>=20.0.4 gunicorn>=20.0.4
@@ -19,4 +19,5 @@ pandas>=2.2.2
PyYAML>=5.4 # CVE-2020-14343 PyYAML>=5.4 # CVE-2020-14343
requests>=2.22.0 requests>=2.22.0
s3fs==0.4.2 s3fs==0.4.2
scipy>=1.4 scipy>=1.4
setuptools
+5 -4
View File
@@ -14,7 +14,7 @@ with open("server/requirements-annotate.txt") as fh:
setup( setup(
name="cellxgene", name="cellxgene",
version="1.2.0", version="1.3.0",
packages=find_packages(), packages=find_packages(),
url="https://github.com/chanzuckerberg/cellxgene", url="https://github.com/chanzuckerberg/cellxgene",
license="MIT", license="MIT",
@@ -24,7 +24,7 @@ setup(
long_description=long_description, long_description=long_description,
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
install_requires=requirements, install_requires=requirements,
python_requires=">=3.6", python_requires=">=3.10",
include_package_data=True, include_package_data=True,
zip_safe=False, zip_safe=False,
classifiers=[ classifiers=[
@@ -37,8 +37,9 @@ setup(
"Operating System :: MacOS :: MacOS X", "Operating System :: MacOS :: MacOS X",
"Programming Language :: JavaScript", "Programming Language :: JavaScript",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3 :: Only",
"Topic :: Scientific/Engineering :: Bio-Informatics", "Topic :: Scientific/Engineering :: Bio-Informatics",
], ],
@@ -134,7 +134,7 @@ float_OK_cases = [
np.arange(-128, 1000, dtype=dtype), np.arange(-128, 1000, dtype=dtype),
pd.Series(np.arange(-128, 1000, dtype=dtype)), pd.Series(np.arange(-128, 1000, dtype=dtype)),
pd.Index(np.arange(-129, 1000, dtype=dtype)), pd.Index(np.arange(-129, 1000, dtype=dtype)),
np.array([-np.nan, np.inf, -1, 0.0, 0, 0.0, 1, np.inf, np.nan], dtype=dtype), np.array([-np.nan, -np.inf, -1, -0.0, 0, 0.0, 1, np.inf, np.nan], dtype=dtype),
np.array([np.finfo(dtype).min, 0, np.finfo(dtype).max], dtype=dtype), np.array([np.finfo(dtype).min, 0, np.finfo(dtype).max], dtype=dtype),
sparse.csr_matrix((10, 100), dtype=dtype), sparse.csr_matrix((10, 100), dtype=dtype),
] ]