Skip to content

fix(useProvider): compatibility with string of cachekey #2328

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
merged 1 commit into from
Oct 22, 2022
Merged

fix(useProvider): compatibility with string of cachekey #2328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
120 changes: 102 additions & 18 deletions packages/brick-kit/src/hooks/useProvider/fetch.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ customGlobal.fetch = require("jest-fetch-mock");
customGlobal.fetchMock = customGlobal.fetch;

const fakeFetch = global.fetch as FetchMock;

const fakeRevolve = jest.fn();
// Mock a custom element of `any-provider`.
customElements.define(
"any-provider",
class Tmp extends HTMLElement {
resolve(): string {
fakeRevolve();
return "resolved";
}
}
Expand Down Expand Up @@ -59,18 +60,20 @@ describe("fetch", () => {

afterEach((): void => {
fakeFetch.resetMocks();
fakeRevolve.mockClear();
});

it("should resolve normal provider", async () => {
const result = await fetch("any-provider", true, ["abc"]);
const result = await fetch("any-provider", true, ...["abc"]);

expect(result).toBe("resolved");
expect(fakeRevolve).toHaveBeenCalledTimes(1);
});

it("should throw error ", async () => {
expect.assertions(1);
try {
await fetch("error-provider", true, ["abc"]);
await fetch("error-provider", true, ...["abc"]);
} catch (e) {
expect(e.message).toBe("oops");
}
Expand All @@ -79,32 +82,36 @@ describe("fetch", () => {
it("should throw error when not defined provider", async () => {
expect.assertions(1);
try {
await fetch("undefined-provider", true, ["abc"]);
await fetch("undefined-provider", true, "abc");
} catch (e) {
expect(e.message).toContain('Provider not defined: "undefined-provider"');
}
});

it("should resolve flow api provider", async () => {
const result = await fetch("easyops.custom_api@test", false, [
"abc",
{ a: "a", c: "c", b: "b" },
]);
const result = await fetch("easyops.custom_api@test", false, "abc", {
a: "a",
c: "c",
b: "b",
});

expect(result).toEqual(expected);
expect(fakeFetch).toHaveBeenCalledTimes(1);

const result2 = await fetch("easyops.custom_api@test", false, [
"abc",
{ a: "a", c: "c", b: "b" },
]);
const result2 = await fetch("easyops.custom_api@test", false, "abc", {
a: "a",
c: "c",
b: "b",
});

expect(result2).toEqual(expected);
expect(fakeFetch).toHaveBeenCalledTimes(2);
});

it("should resolve flow api provider by cache", async () => {
const result = await fetch("easyops.custom_api@test", true, [
const result = await fetch(
"easyops.custom_api@test",
true,
{
url: "api/gateway/easyops.api.cmdb.cmdb_object.ListObjectBasic@1.1.0/object_basic",
originalUri: "/object_basic",
Expand All @@ -116,13 +123,15 @@ describe("fetch", () => {
a: "a",
c: "c",
b: "b",
},
]);
}
);

expect(result).toEqual(expected);
expect(fakeFetch).toHaveBeenCalledTimes(1);

const result2 = await fetch("easyops.custom_api@test", true, [
const result2 = await fetch(
"easyops.custom_api@test",
true,
{
isFileType: false,
responseWrapper: true,
Expand All @@ -134,8 +143,8 @@ describe("fetch", () => {
c: "c",
b: "b",
a: "a",
},
]);
}
);

// use cached response data
expect(result2).toEqual(expected);
Expand All @@ -160,4 +169,79 @@ describe("fetch", () => {
expect(result3).toEqual(expected);
expect(fakeFetch).toHaveBeenCalledTimes(2);
});

it("should resolve normal provider by cache", async () => {
const result = await fetch(
"providers-of-cmbd.a",
true,
...[
"_DASHBOARD_PROVIDER",
{
fields: {
provider: 1,
args: 1,
name: 1,
instanceId: 1,
transform: 1,
},
query: {
$or: [
{
name: {
$like: "%alexabcdes%",
},
},
{
provider: {
$like: "%alexabcdes%",
},
},
],
},
page: 1,
page_size: 30,
},
{},
]
);

expect(result).toEqual("resolved");
expect(fakeRevolve).toHaveBeenCalledTimes(1);

const result2 = await fetch(
"providers-of-cmbd.a",
true,
"_DASHBOARD_PROVIDER",
{
fields: {
provider: 1,
args: 1,
name: 1,
instanceId: 1,
transform: 1,
},
query: {
$or: [
{
name: {
$like: "%alexabcdes%",
},
},
{
provider: {
$like: "%alexabcdes%",
},
},
],
},
page: 1,
page_size: 30,
},
{}
);

// cached response data
expect(result2).toEqual("resolved");
expect(fakeRevolve).toHaveBeenCalledTimes(1);
});
});
9 changes: 7 additions & 2 deletions packages/brick-kit/src/hooks/useProvider/fetch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,20 @@ function isObj(v: any): boolean {
return typeof v === "object" && v !== null && !Array.isArray(v);
}

function buildSortedCacheKey(provider: string, args: any): string {
function isString(v: any): v is string {
return typeof v === "string";
}
function buildSortedCacheKey(provider: string, ...args: any): string {
const sortObj = (obj: Record<string, any>) =>
Object.keys(obj)
.sort()
.map((k) => ({ [k]: (obj as any)[k] }));
try {
const sortedArgs = isObj(args)
? sortObj(args)
: (args as Record<string, any>[]).map((arg) => sortObj(arg));
: (args as Record<string, any>[]).map((arg) =>
isString(arg) ? arg : sortObj(arg)
);

return JSON.stringify({
provider,
Expand Down