Skip to content

Some minor tidy up around db item expansion #1936

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

Merged
charisk merged 3 commits into from
Jan 6, 2023
Merged

Some minor tidy up around db item expansion #1936

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
971fb6e
Rename updateItemInExpandedState -> updateExpandedItem and replaceIte…
charisk Jan 6, 2023
d69a048
Handle all db item kinds when checking for equality with expanded items
charisk Jan 6, 2023
51d1d32
Remove unnecessary type casting
charisk Jan 6, 2023
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
11 changes: 7 additions & 4 deletions extensions/ql-vscode/src/databases/db-item-expansion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface RemoteUserDefinedListExpandedDbItem {
listName: string;
}

export function updateItemInExpandedState(
export function updateExpandedItem(
currentExpandedItems: ExpandedDbItem[],
dbItem: DbItem,
itemExpanded: boolean,
Expand All @@ -50,7 +50,7 @@ export function updateItemInExpandedState(
}
}

export function replaceItemInExpandedState(
export function replaceExpandedItem(
currentExpandedItems: ExpandedDbItem[],
currentDbItem: DbItem,
newDbItem: DbItem,
Expand Down Expand Up @@ -108,7 +108,10 @@ function isDbItemEqualToExpandedDbItem(
expandedDbItem.kind === ExpandedDbItemKind.RemoteUserDefinedList &&
expandedDbItem.listName === dbItem.listName
);
default:
throw Error(`Unknown db item kind ${dbItem.kind}`);
case DbItemKind.LocalDatabase:
case DbItemKind.RemoteSystemDefinedList:
case DbItemKind.RemoteOwner:
case DbItemKind.RemoteRepo:
return false;
}
}
8 changes: 4 additions & 4 deletions extensions/ql-vscode/src/databases/db-manager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import {
RemoteUserDefinedListDbItem,
} from "./db-item";
import {
updateItemInExpandedState,
replaceItemInExpandedState,
updateExpandedItem,
replaceExpandedItem,
ExpandedDbItem,
} from "./db-item-expansion";
import {
Expand Down Expand Up @@ -80,7 +80,7 @@ export class DbManager {
): Promise<void> {
const currentExpandedItems = this.getExpandedItems();

const newExpandedItems = updateItemInExpandedState(
const newExpandedItems = updateExpandedItem(
currentExpandedItems,
dbItem,
itemExpanded,
Expand Down Expand Up @@ -127,7 +127,7 @@ export class DbManager {
}

const newDbItem = { ...currentDbItem, listName: newName };
const newExpandedItems = replaceItemInExpandedState(
const newExpandedItems = replaceExpandedItem(
this.getExpandedItems(),
currentDbItem,
newDbItem,
Expand Down
47 changes: 20 additions & 27 deletions extensions/ql-vscode/test/unit-tests/databases/db-item-expansion.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
import {
RemoteUserDefinedListDbItem,
RootRemoteDbItem,
} from "../../../src/databases/db-item";
import {
updateItemInExpandedState,
updateExpandedItem,
ExpandedDbItem,
ExpandedDbItemKind,
replaceItemInExpandedState,
replaceExpandedItem,
} from "../../../src/databases/db-item-expansion";
import {
createRemoteUserDefinedListDbItem,
createRootRemoteDbItem,
} from "../../factories/db-item-factories";

describe("db item expansion", () => {
describe("updateItemInExpandedState", () => {
describe("updateExpandedItem", () => {
it("should add an expanded item to an existing list", () => {
const currentExpandedItems: ExpandedDbItem[] = [
{
Expand All @@ -26,12 +22,11 @@ describe("db item expansion", () => {
},
];

const dbItem: RemoteUserDefinedListDbItem =
createRemoteUserDefinedListDbItem({
listName: "list2",
});
const dbItem = createRemoteUserDefinedListDbItem({
listName: "list2",
});

const newExpandedItems = updateItemInExpandedState(
const newExpandedItems = updateExpandedItem(
currentExpandedItems,
dbItem,
true,
Expand All @@ -47,12 +42,11 @@ describe("db item expansion", () => {
});

it("should add an expanded item to an empty list", () => {
const dbItem: RemoteUserDefinedListDbItem =
createRemoteUserDefinedListDbItem({
listName: "list2",
});
const dbItem = createRemoteUserDefinedListDbItem({
listName: "list2",
});

const newExpandedItems = updateItemInExpandedState([], dbItem, true);
const newExpandedItems = updateExpandedItem([], dbItem, true);

expect(newExpandedItems).toEqual([
{
Expand All @@ -73,12 +67,11 @@ describe("db item expansion", () => {
},
];

const dbItem: RemoteUserDefinedListDbItem =
createRemoteUserDefinedListDbItem({
listName: "list1",
});
const dbItem = createRemoteUserDefinedListDbItem({
listName: "list1",
});

const newExpandedItems = updateItemInExpandedState(
const newExpandedItems = updateExpandedItem(
currentExpandedItems,
dbItem,
false,
Expand All @@ -98,9 +91,9 @@ describe("db item expansion", () => {
},
];

const dbItem: RootRemoteDbItem = createRootRemoteDbItem();
const dbItem = createRootRemoteDbItem();

const newExpandedItems = updateItemInExpandedState(
const newExpandedItems = updateExpandedItem(
currentExpandedItems,
dbItem,
false,
Expand All @@ -110,7 +103,7 @@ describe("db item expansion", () => {
});
});

describe("replaceItemInExpandedState", () => {
describe("replaceExpandedItem", () => {
it("should replace the db item", () => {
const currentExpandedItems: ExpandedDbItem[] = [
{
Expand All @@ -134,12 +127,12 @@ describe("db item expansion", () => {
listName: "list1",
});

const newDbItem: RemoteUserDefinedListDbItem = {
const newDbItem = {
...currentDbItem,
listName: "list1 (renamed)",
};

const newExpandedItems = replaceItemInExpandedState(
const newExpandedItems = replaceExpandedItem(
currentExpandedItems,
currentDbItem,
newDbItem,
Expand Down