Skip to content

fix: improve TypeScript types #650

New issue

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

#

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

Already on GitHub? # to your account

Merged
merged 2 commits into from
Mar 19, 2020
Merged

fix: improve TypeScript types #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
08a8b87
fix: improve TypeScript types
JustinBeckwith Mar 19, 2020
c832981
fixy
JustinBeckwith Mar 19, 2020
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
16 changes: 8 additions & 8 deletions src/chunktransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface Qualifier {
}
export interface Row {
key?: Value;
data?: Data;
data?: {[index: string]: Family};
}
export interface TransformErrorProps {
message: string;
Expand Down Expand Up @@ -354,10 +354,10 @@ export class ChunkTransformer extends Transform {
}) as string;
this.validateNewRow(chunk, newRowKey);
if (chunk.familyName && chunk.qualifier) {
const row = this.row;
row!.key = newRowKey;
row!.data = {} as Data;
this.family = row!.data![chunk.familyName.value] = {} as Family;
const row = this.row!;
row.key = newRowKey;
row.data = {};
this.family = row.data[chunk.familyName.value] = {} as Family;
Copy link
Contributor

Choose a reason for hiding this comment

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

am I dreaming, or am I really seeing the good old a = b = {} in the real-life JavaScript code? o_O

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Trying not to change the functionality here, but yeah....

Copy link
Contributor

Choose a reason for hiding this comment

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

You know what, I'm taking this back! I just realized that it might be what they actually wanted to assign the same object to both this.family and row.data[chunk.familyName.value]. I'm afraid of this code :(

const qualifierName = Mutation.convertFromBytes(
chunk.qualifier.value as Bytes,
{
Expand Down Expand Up @@ -388,10 +388,10 @@ export class ChunkTransformer extends Transform {
if (chunk.resetRow) {
return this.reset();
}
const row = this.row;
const row = this.row!;
if (chunk.familyName) {
this.family = row!.data![chunk.familyName.value] =
row!.data![chunk.familyName.value] || {};
this.family = row.data![chunk.familyName.value] =
row.data![chunk.familyName.value] || {};
}
if (chunk.qualifier) {
const qualifierName = Mutation.convertFromBytes(
Expand Down
147 changes: 97 additions & 50 deletions src/filter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,48 @@ export class FilterError extends Error {
}
}

export interface Column {
name?: string | RegExp;
cellLimit?: number;
start?: BoundData;
end?: {};
family?: BoundData;
}

export interface BoundData {
inclusive?: boolean;
value?: {};
}

export interface Time {
start: Date;
end: Date;
}

export interface RawFilter {
[index: string]: {};
}

export interface Condition {
pass: {};
fail: {};
test: {};
}

export interface Row {
cellLimit?: number;
sample?: string;
cellOffset?: number;
key?: string;
}

export interface ValueFilter {
value?: string;
start?: BoundData;
end?: BoundData;
strip?: boolean;
}

/**
* A filter takes a row as input and produces an alternate view of the row based
* on specified rules. For example, a row filter might trim down a row to
Expand Down Expand Up @@ -103,17 +145,17 @@ export class Filter {
return regex.toString().replace(/^\/|\/$/g, '');
}

if (is.array(regex)) {
if (Array.isArray(regex)) {
return `(${(regex as string[])
.map(Filter.convertToRegExpString)
.join('|')})`;
}

if (is.string(regex)) {
return regex as string;
if (typeof regex === 'string') {
return regex;
}

if (is.number(regex)) {
if (typeof regex === 'number') {
return regex.toString();
}

Expand Down Expand Up @@ -160,7 +202,7 @@ export class Filter {
* // startTest2Exclusive: 'value3'
* // }
*/
static createRange(start, end, key: string) {
static createRange(start: BoundData, end: BoundData, key: string) {
const range = {};

if (start) {
Expand All @@ -173,11 +215,10 @@ export class Filter {

return range;

function createBound(boundName, boundData, key) {
function createBound(boundName: string, boundData: BoundData, key: string) {
const isInclusive = boundData.inclusive !== false;
const boundKey = boundName + key + (isInclusive ? 'Closed' : 'Open');
const bound = {};

const bound = {} as {[index: string]: {}};
bound[boundKey] = Mutation.convertToBytes(boundData.value || boundData);
return bound;
}
Expand Down Expand Up @@ -213,14 +254,17 @@ export class Filter {
* // }
* // }
*/
static parse(filters) {
static parse(filters: RawFilter[] | RawFilter) {
interface Fn {
[index: string]: Function;
}
const filter = new Filter();
arrify(filters).forEach(filterObj => {
const key = Object.keys(filterObj)[0];
if (!is.function(filter[key])) {
if (typeof ((filter as {}) as Fn)[key] !== 'function') {
throw new FilterError(key);
}
filter[key](filterObj[key]);
((filter as {}) as Fn)[key](filterObj[key]);
});
return filter.toProto();
}
Expand Down Expand Up @@ -372,32 +416,31 @@ export class Filter {
* }
* ];
*/
column(column) {
column(column: RegExp | string | {}): void {
let col: Column;
if (!is.object(column)) {
column = {
name: column,
col = {
name: column as string,
};
} else {
col = column as Column;
}

if (column.name) {
if (col.name) {
const name = Mutation.convertToBytes(
Filter.convertToRegExpString(column.name)
Filter.convertToRegExpString(col.name)
);
this.set('columnQualifierRegexFilter', name);
}

if (is.number(column.cellLimit)) {
this.set('cellsPerColumnLimitFilter', column.cellLimit);
if (typeof col.cellLimit === 'number') {
this.set('cellsPerColumnLimitFilter', col.cellLimit!);
}

if (column.start || column.end) {
const range: any = Filter.createRange(
column.start,
column.end,
'Qualifier'
);
if (col.start || col.end) {
const range: any = Filter.createRange(col.start!, col.end!, 'Qualifier');

range.familyName = column.family;
range.familyName = col.family;
this.set('columnRangeFilter', range);
}
}
Expand Down Expand Up @@ -454,7 +497,7 @@ export class Filter {
* }
* ];
*/
condition(condition) {
condition(condition: Condition) {
this.set('condition', {
predicateFilter: Filter.parse(condition.test),
trueFilter: Filter.parse(condition.pass),
Expand Down Expand Up @@ -522,7 +565,7 @@ export class Filter {
* }
* ];
*/
interleave(filters) {
interleave(filters: RawFilter[]): void {
this.set('interleave', {
filters: filters.map(Filter.parse),
});
Expand Down Expand Up @@ -658,30 +701,31 @@ export class Filter {
* }
* ];
*/
row(row) {
row(row: Row | string | RegExp | string[]): void {
let r: Row;
if (!is.object(row)) {
row = {
key: row,
r = {
key: row as string,
};
} else {
r = row as Row;
}

if (row.key) {
const key = Mutation.convertToBytes(
Filter.convertToRegExpString(row.key)
);
if (r.key) {
const key = Mutation.convertToBytes(Filter.convertToRegExpString(r.key));
this.set('rowKeyRegexFilter', key);
}

if (row.sample) {
this.set('rowSampleFilter', row.sample);
if (r.sample) {
this.set('rowSampleFilter', r.sample);
}

if (is.number(row.cellOffset)) {
this.set('cellsPerRowOffsetFilter', row.cellOffset);
if (typeof r.cellOffset === 'number') {
this.set('cellsPerRowOffsetFilter', r.cellOffset!);
}

if (is.number(row.cellLimit)) {
this.set('cellsPerRowLimitFilter', row.cellLimit);
if (typeof r.cellLimit === 'number') {
this.set('cellsPerRowLimitFilter', r.cellLimit!);
}
}

Expand Down Expand Up @@ -770,7 +814,7 @@ export class Filter {
* }
* ];
*/
time(time) {
time(time: Time): void {
const range = Mutation.createTimeRange(time.start, time.end);
this.set('timestampRangeFilter', range);
}
Expand Down Expand Up @@ -892,27 +936,30 @@ export class Filter {
* }
* ];
*/
value(value): void {
value(value: string | string[] | ValueFilter): void {
let v: ValueFilter;
if (!is.object(value)) {
value = {
value,
v = {
value: value as string,
};
} else {
v = value as ValueFilter;
}

if (value.value) {
if (v.value) {
const valueReg = Mutation.convertToBytes(
Filter.convertToRegExpString(value.value)
Filter.convertToRegExpString(v.value)
);
this.set('valueRegexFilter', valueReg);
}

if (value.start || value.end) {
const range = Filter.createRange(value.start, value.end, 'Value');
if (v.start || v.end) {
const range = Filter.createRange(v.start!, v.end!, 'Value');
this.set('valueRangeFilter', range);
}

if (value.strip) {
this.set('stripValueTransformer', value.strip);
if (v.strip) {
this.set('stripValueTransformer', v.strip);
}
}
}
Loading