Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added typings to annoMatrix dir. (#2365) #2371

Merged
merged 10 commits into from
Aug 18, 2021
Merged

Added typings to annoMatrix dir. (#2365) #2371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6d883a0
Added typings to annoMatrix directory. (#2365)
MillenniumFalconMechanic Aug 8, 2021
f03bd5e
Added review point updates. (#2365)
MillenniumFalconMechanic Aug 18, 2021
f9a0ea5
Fixed viewOf defect. Added review point updates. (#2365)
MillenniumFalconMechanic Aug 18, 2021
657bfcf
Updated test to use Field key interpolation. (#2365)
MillenniumFalconMechanic Aug 18, 2021
21aea94
Updated test to use Field key interpolation. (#2365)
MillenniumFalconMechanic Aug 18, 2021
865bc6a
Updated test to use Field key interpolation. (#2365)
MillenniumFalconMechanic Aug 18, 2021
df0ecd2
Updated test to use Field key interpolation. (#2365)
MillenniumFalconMechanic Aug 18, 2021
36e277b
Linting. (#2365)
MillenniumFalconMechanic Aug 18, 2021
65af86f
Simplified while condition in middleware GC. (#2365)
MillenniumFalconMechanic Aug 18, 2021
9103cad
Reverted embedding.ts prettier to resolve conflict. (#2365)
MillenniumFalconMechanic Aug 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 38 additions & 37 deletions client/__tests__/util/annoMatrix/annoMatrix.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import {
isubsetMask,
} from "../../../src/annoMatrix";
import { Dataframe } from "../../../src/util/dataframe";
import { Field } from "../../../src/common/types/schema";

enableFetchMocks();

Expand All @@ -34,15 +35,15 @@ describe("AnnoMatrix", () => {
expect(annoMatrix.nObs).toEqual(serverMocks.schema.schema.dataframe.nObs);
expect(annoMatrix.nVar).toEqual(serverMocks.schema.schema.dataframe.nVar);
expect(annoMatrix.isView).toBeFalsy();
expect(annoMatrix.viewOf).toBeUndefined();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bkmartinjr this looks like the opposite of the original assertion (from undefined to now annomatrix), does this indicate runtime code change or something else? Thank you!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tihuan - please review Mim's comments and discussion for an explanation. The runtime changed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tihuan, discussion is here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh perfect! Thanks so much, both 🙏

expect(annoMatrix.viewOf).toBe(annoMatrix);
expect(annoMatrix.rowIndex).toBeDefined();
});

test("simple single column fetch", async () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).once(serverMocks.annotationsObs(["name_0"]));
MillenniumFalconMechanic marked this conversation as resolved.
Show resolved Hide resolved

const df = await annoMatrix.fetch("obs", "name_0");
const df = await annoMatrix.fetch(Field.obs, "name_0");
expect(df).toBeInstanceOf(Dataframe);
expect(df.colIndex.labels()).toEqual(["name_0"]);
expect(df.dims).toEqual([annoMatrix.nObs, 1]);
Expand All @@ -55,7 +56,7 @@ describe("AnnoMatrix", () => {
.once(serverMocks.annotationsObs(["n_genes"]));

await expect(
annoMatrix.fetch("obs", ["name_0", "n_genes"])
annoMatrix.fetch(Field.obs, ["name_0", "n_genes"])
).resolves.toBeInstanceOf(Dataframe);
});

Expand All @@ -72,7 +73,7 @@ describe("AnnoMatrix", () => {
).resolves.toBeInstanceOf(Dataframe);
};

test("obs", async () => getLastTwo("obs"));
test(Field.obs, async () => getLastTwo(Field.obs));
test("var", async () => getLastTwo("var"));
test("emb", async () => getLastTwo("emb"));
});
Expand All @@ -81,15 +82,15 @@ describe("AnnoMatrix", () => {
// single string is a column name
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).once(serverMocks.annotationsObs(["n_genes"]));
await expect(annoMatrix.fetch("obs", "n_genes")).resolves.toBeInstanceOf(
Dataframe
);
await expect(
annoMatrix.fetch(Field.obs, "n_genes")
).resolves.toBeInstanceOf(Dataframe);

// array of column names, expecting n_genes to be cached.
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).once(serverMocks.annotationsObs(["percent_mito"]));
await expect(
annoMatrix.fetch("obs", ["n_genes", "percent_mito"])
annoMatrix.fetch(Field.obs, ["n_genes", "percent_mito"])
).resolves.toBeInstanceOf(Dataframe);

// more complex value filter query, enumerated
Expand Down Expand Up @@ -151,9 +152,9 @@ describe("AnnoMatrix", () => {

test("schema accessors", () => {
expect(annoMatrix.getMatrixFields()).toEqual(
expect.arrayContaining(["X", "obs", "emb", "var"])
expect.arrayContaining(["X", Field.obs, "emb", "var"])
);
expect(annoMatrix.getMatrixColumns("obs")).toEqual(
expect(annoMatrix.getMatrixColumns(Field.obs)).toEqual(
expect.arrayContaining(["name_0", "n_genes", "louvain"])
);
expect(annoMatrix.getColumnSchema("emb", "umap")).toEqual({
Expand All @@ -171,7 +172,7 @@ describe("AnnoMatrix", () => {
test the mask & label access to subset via isubset and isubsetMask
*/
test("isubset", async () => {
const rowList = [0, 10];
const rowList = new Int32Array([0, 10]);
const rowMask = new Uint8Array(annoMatrix.nObs);
for (let i = 0; i < rowList.length; i += 1) {
rowMask[rowList[i]] = 1;
Expand All @@ -188,8 +189,8 @@ describe("AnnoMatrix", () => {
(fetch as any)
.once(serverMocks.annotationsObs(["n_genes"]))
.once(serverMocks.annotationsObs(["n_genes"]));
const ng1 = (await am1.fetch("obs", "n_genes")) as Dataframe;
const ng2 = (await am2.fetch("obs", "n_genes")) as Dataframe;
const ng1 = (await am1.fetch(Field.obs, "n_genes")) as Dataframe;
const ng2 = (await am2.fetch(Field.obs, "n_genes")) as Dataframe;
expect(ng1).toBeDefined();
expect(ng2).toBeDefined();
expect(ng1).toHaveLength(ng2.length);
Expand All @@ -203,10 +204,10 @@ describe("AnnoMatrix", () => {
describe("add/drop column", () => {
// @ts-expect-error ts-migrate(7006) FIXME: Parameter 'base' implicitly has an 'any' type.
async function addDrop(base) {
expect(base.getMatrixColumns("obs")).not.toContain("foo");
expect(base.getMatrixColumns(Field.obs)).not.toContain("foo");
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).mockRejectOnce(new Error("unknown column name"));
await expect(base.fetch("obs", "foo")).rejects.toThrow(
await expect(base.fetch(Field.obs, "foo")).rejects.toThrow(
"unknown column name"
);

Expand All @@ -216,9 +217,9 @@ describe("AnnoMatrix", () => {
Float32Array,
0
);
expect(base.getMatrixColumns("obs")).not.toContain("foo");
expect(am1.getMatrixColumns("obs")).toContain("foo");
const foo: Dataframe = await am1.fetch("obs", "foo");
expect(base.getMatrixColumns(Field.obs)).not.toContain("foo");
expect(am1.getMatrixColumns(Field.obs)).toContain("foo");
const foo: Dataframe = await am1.fetch(Field.obs, "foo");
expect(foo).toBeDefined();
expect(foo).toBeInstanceOf(Dataframe);
expect(foo).toHaveLength(am1.nObs);
Expand All @@ -228,11 +229,11 @@ describe("AnnoMatrix", () => {

/* drop */
const am2 = am1.dropObsColumn("foo");
expect(base.getMatrixColumns("obs")).not.toContain("foo");
expect(am2.getMatrixColumns("obs")).not.toContain("foo");
expect(base.getMatrixColumns(Field.obs)).not.toContain("foo");
expect(am2.getMatrixColumns(Field.obs)).not.toContain("foo");
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).mockRejectOnce(new Error("unknown column name"));
await expect(am2.fetch("obs", "foo")).rejects.toThrow(
await expect(am2.fetch(Field.obs, "foo")).rejects.toThrow(
"unknown column name"
);
}
Expand All @@ -245,10 +246,10 @@ describe("AnnoMatrix", () => {
const am1 = clip(annoMatrix, 0.1, 0.9);
await addDrop(am1);

const am2 = isubset(am1, [0, 1, 2, 20, 30, 400]);
const am2 = isubset(am1, new Int32Array([0, 1, 2, 20, 30, 400]));
await addDrop(am2);

const am3 = isubset(annoMatrix, [10, 0, 7, 3]);
const am3 = isubset(annoMatrix, new Int32Array([10, 0, 7, 3]));
await addDrop(am3);

const am4 = clip(am3, 0, 1);
Expand All @@ -257,10 +258,10 @@ describe("AnnoMatrix", () => {
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).mockResponse(serverMocks.responder);

await am1.fetch("obs", am1.getMatrixColumns("obs"));
await am2.fetch("obs", am2.getMatrixColumns("obs"));
await am3.fetch("obs", am3.getMatrixColumns("obs"));
await am4.fetch("obs", am4.getMatrixColumns("obs"));
await am1.fetch(Field.obs, am1.getMatrixColumns(Field.obs));
await am2.fetch(Field.obs, am2.getMatrixColumns(Field.obs));
await am3.fetch(Field.obs, am3.getMatrixColumns(Field.obs));
await am4.fetch(Field.obs, am4.getMatrixColumns(Field.obs));

// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).resetMocks();
Expand All @@ -287,32 +288,32 @@ describe("AnnoMatrix", () => {
"unassigned"
);

const testVal = await am.fetch("obs", "test");
const testVal = await am.fetch(Field.obs, "test");
expect(testVal.col("test").asArray()).toEqual(
new Array(am.nObs).fill("unassigned")
);

/* set values in column */
const whichRows = [1, 2, 10];
const am1 = await am.setObsColumnValues("test", whichRows, "yo");
const testVal1 = await am1.fetch("obs", "test");
const testVal1 = await am1.fetch(Field.obs, "test");
const expt = new Array(am1.nObs).fill("unassigned");
for (let i = 0; i < whichRows.length; i += 1) {
const offset = am1.rowIndex.getOffset(whichRows[i]);
expt[offset] = "yo";
}
expect(testVal1).not.toBe(testVal);
expect(testVal1.col("test").asArray()).toEqual(expt);
expect(am1.getColumnSchema("obs", "test").type).toBe("categorical");
expect(am1.getColumnSchema("obs", "test").categories).toEqual(
expect(am1.getColumnSchema(Field.obs, "test").type).toBe("categorical");
expect(am1.getColumnSchema(Field.obs, "test").categories).toEqual(
expect.arrayContaining(["unassigned", "red", "green", "yo"])
);

/* drop column */
// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).mockRejectOnce(new Error("unknown column name"));
am = am1.dropObsColumn("test");
await expect(am.fetch("obs", "test")).rejects.toThrow(
await expect(am.fetch(Field.obs, "test")).rejects.toThrow(
"unknown column name"
);
}
Expand All @@ -325,18 +326,18 @@ describe("AnnoMatrix", () => {
const am1 = clip(annoMatrix, 0.1, 0.9);
await addSetDrop(am1);

const am2 = isubset(am1, [0, 1, 2, 10, 20, 30, 400]);
const am2 = isubset(am1, new Int32Array([0, 1, 2, 10, 20, 30, 400]));
await addSetDrop(am2);

const am3 = isubset(annoMatrix, [10, 1, 0, 30, 2]);
const am3 = isubset(annoMatrix, new Int32Array([10, 1, 0, 30, 2]));
await addSetDrop(am3);

// eslint-disable-next-line @typescript-eslint/no-explicit-any --- FIXME: disabled temporarily on migrate to TS.
(fetch as any).mockResponse(serverMocks.responder);

await am1.fetch("obs", am1.getMatrixColumns("obs"));
await am2.fetch("obs", am2.getMatrixColumns("obs"));
await am3.fetch("obs", am3.getMatrixColumns("obs"));
await am1.fetch(Field.obs, am1.getMatrixColumns(Field.obs));
await am2.fetch(Field.obs, am2.getMatrixColumns(Field.obs));
await am3.fetch(Field.obs, am3.getMatrixColumns(Field.obs));

await addSetDrop(am1);
await addSetDrop(am2);
Expand Down
Loading