Skip to content

Remove reference to PodBrowser in tests and clean up ESS1.1 artefacts #2666

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
edwardsph merged 6 commits into from
May 13, 2025
Merged

Remove reference to PodBrowser in tests and clean up ESS1.1 artefacts #2666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
af0ae8e
Remove reference to PodBrowser in tests and clean up ESS1.1 artefacts
edwardsph May 12, 2025
0adf1fd
Lint
edwardsph May 12, 2025
a41f613
Remove legacy code no longer needed
NSeydoux May 13, 2025
c8ff013
Revert "Remove legacy code no longer needed"
NSeydoux May 13, 2025
ed37fec
Remove redundant code and update tests and snapshots
edwardsph May 13, 2025
6440023
Merge remote-tracking branch 'origin/ESS-6635-podbrowser' into ESS-66…
edwardsph May 13, 2025
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ The following changes have been implemented but not released yet:

### Bugfixes

- `getWellKnownSolid` fetches well known solid from the server's root by default.
- `getWellKnownSolid` fetches well-known solid from the server's root by default.
Copy link
Copy Markdown
Contributor

@NSeydoux NSeydoux May 13, 2025

Choose a reason for hiding this comment

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

That was already the default behavior, wasn't it? The change is that it will no longer search for it at the Pod root.


## [1.22.0] - 2022-04-26

Expand Down
52 changes: 4 additions & 48 deletions src/resource/__snapshots__/solidDataset.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,55 +57,11 @@ exports[`getSolidDataset returns a SolidDataset representing the fetched Turtle
}
`;

exports[`getWellKnownSolid returns the contents of .well-known/solid for the given resource (1.1) 1`] = `
exports[`getWellKnownSolid returns the contents of .well-known/solid for the given resource 1`] = `
{
"graphs": {
"default": {
"_:b0": {
"predicates": {
"http://inrupt.com/ns/ess#consentIssuer": {
"namedNodes": [
"https://consent.pod.inrupt.com",
],
},
"http://inrupt.com/ns/ess#notificationGatewayEndpoint": {
"namedNodes": [
"https://notification.pod.inrupt.com",
],
},
"http://inrupt.com/ns/ess#powerSwitchEndpoint": {
"namedNodes": [
"https://pod.inrupt.com/powerswitch/username",
],
},
"http://www.w3.org/ns/pim/space#storage": {
"namedNodes": [
"https://pod.inrupt.com/username/",
],
},
},
"type": "Subject",
"url": "_:b0",
},
},
},
"internal_resourceInfo": {
"contentLocation": undefined,
"contentType": "application/ld+json",
"isRawData": false,
"linkedResources": {},
"location": undefined,
"sourceIri": "https://example.org/pod/.well-known/solid",
},
"type": "Dataset",
}
`;

exports[`getWellKnownSolid returns the contents of .well-known/solid for the given resource (2.0) 1`] = `
{
"graphs": {
"default": {
"_:n3-3": {
"_:n3-2": {
"predicates": {
"http://www.w3.org/1999/02/22-rdf-syntax-ns#type": {
"namedNodes": [
Expand All @@ -114,7 +70,7 @@ exports[`getWellKnownSolid returns the contents of .well-known/solid for the giv
},
"http://www.w3.org/ns/auth/acl#trustedApp": {
"namedNodes": [
"https://podbrowser.inrupt.com/api/app",
"https://inrupt.com",
],
},
"http://www.w3.org/ns/solid/terms#maxPodsPerOwner": {
Expand Down Expand Up @@ -143,7 +99,7 @@ exports[`getWellKnownSolid returns the contents of .well-known/solid for the giv
},
},
"type": "Subject",
"url": "_:n3-3",
"url": "_:n3-2",
},
},
},
Expand Down
218 changes: 12 additions & 206 deletions src/resource/solidDataset.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3334,18 +3334,17 @@ describe("changeLogAsMarkdown", () => {

describe("getWellKnownSolid", () => {
const serverUrl = "https://example.org/";
const podUrl = "https://example.org/pod/";
const resourceUrl = "https://example.org/pod/resource";
const wellKnownSolid = ".well-known/solid";

const ess20Implementation: typeof fetch = async () =>
const essDiscoveryDoc: typeof fetch = async () =>
new Response(
`@prefix solid: <http://www.w3.org/ns/solid/terms#> .

[
a solid:DiscoveryDocument ;
<http://www.w3.org/ns/auth/acl#trustedApp>
<https://podbrowser.inrupt.com/api/app> ;
<https://inrupt.com> ;
solid:maxPodsPerOwner 10 ;
solid:notificationGateway <https://notification.inrupt.com/> ;
solid:provision <https://provision.inrupt.com/> ;
Expand All @@ -3358,56 +3357,12 @@ describe("getWellKnownSolid", () => {
},
);

const ess11Implementation: typeof fetch = async (
url: RequestInfo | URL,
init?: RequestInit,
) => {
if (url === "https://example.org/.well-known/solid") {
return mockResponse(undefined, { status: 404 }, url);
}
const mockESS = () =>
jest.spyOn(globalThis, "fetch").mockImplementation(essDiscoveryDoc);

if (url === "https://example.org/pod/resource") {
return mockResponse(
undefined,
{
headers: {
"Content-Type": "text/turtle",
link: `<${podUrl}>; rel="http://www.w3.org/ns/pim/space#storage"`,
},
},
resourceUrl,
);
}

if (url === "https://example.org/pod/.well-known/solid") {
return mockResponse(
`
{
"@context":"https://pod.inrupt.com/solid/v1",
"consent":"https://consent.pod.inrupt.com",
"notificationGateway":"https://notification.pod.inrupt.com",
"powerSwitch":"https://pod.inrupt.com/powerswitch/username",
"storage":"https://pod.inrupt.com/username/"
}`,
{
headers: { "Content-Type": "application/ld+json" },
},
url,
);
}

throw new Error(`Unhandled request: ${url}, ${JSON.stringify(init)}`);
};

const mockESS20 = () =>
jest.spyOn(globalThis, "fetch").mockImplementation(ess20Implementation);

const mockESS11 = () =>
jest.spyOn(globalThis, "fetch").mockImplementation(ess11Implementation);

it("fetches root well known solid by default", async () => {
// Fetches root well known
mockESS20();
it("fetches root well-known solid by default", async () => {
// Fetches root well-known
mockESS();

await getWellKnownSolid(resourceUrl);

Expand All @@ -3418,174 +3373,25 @@ describe("getWellKnownSolid", () => {
);
});

it("uses the given fetcher for root well known solid if provided", async () => {
const mockFetch = jest.fn<typeof fetch>(ess20Implementation);

await getWellKnownSolid(resourceUrl, { fetch: mockFetch });

expect(mockFetch).toHaveBeenCalledTimes(0);
// Unauthenticated fetch is still used to get the .well-known
expect(fetch).toHaveBeenCalledTimes(1);
expect(fetch).toHaveBeenCalledWith(
serverUrl.concat(wellKnownSolid),
expect.anything(),
);
});

it("fetches pod root well known solid otherwise", async () => {
mockESS11();

await getWellKnownSolid(resourceUrl);

expect(fetch).toHaveBeenCalledTimes(3);
// Tries the root well known solid first is used to determine well known Solid
expect(fetch).toHaveBeenNthCalledWith(
1,
serverUrl.concat(wellKnownSolid),
expect.anything(),
);
// Checks the resource's location header otherwise
expect(fetch).toHaveBeenNthCalledWith(2, resourceUrl, expect.anything());
// The advertised podIdentifier (as storage) is used to determine well known Solid
expect(fetch).toHaveBeenNthCalledWith(
3,
podUrl.concat(wellKnownSolid),
expect.anything(),
);
});

it("uses the given fetcher for pod root well known solid if provided", async () => {
const mockFetch = jest.fn<typeof fetch>(ess11Implementation);

await getWellKnownSolid(resourceUrl, { fetch: mockFetch });

expect(mockFetch).toHaveBeenCalledTimes(2);
expect(fetch).toHaveBeenCalledTimes(1);
// Tries the root well known solid first is used to determine well known Solid
expect(fetch).toHaveBeenNthCalledWith(
1,
serverUrl.concat(wellKnownSolid),
expect.anything(),
);
// Checks the resource's location header otherwise
expect(mockFetch).toHaveBeenNthCalledWith(
1,
resourceUrl,
expect.anything(),
);
// The advertised podIdentifier (as storage) is used to determine well known Solid
expect(mockFetch).toHaveBeenNthCalledWith(
2,
podUrl.concat(wellKnownSolid),
expect.anything(),
);
});

it("appends a / to the Pod root if missing before appending .well-known/solid", async () => {
const spyFetch = jest.spyOn(globalThis, "fetch");

// Root cannot be fetched
spyFetch.mockResolvedValueOnce(new Response(undefined, { status: 404 }));
// Resource advertises Pod root
spyFetch.mockResolvedValueOnce(
mockResponse(
undefined,
{
headers: {
"Content-Type": "text/turtle",
link: `</username>; rel="http://www.w3.org/ns/pim/space#storage"`,
},
},
resourceUrl,
),
);
// Fetches Pod root well known
spyFetch.mockResolvedValueOnce(
new Response(
`{
"@context":"https://pod.inrupt.com/solid/v1",
"consent":"https://consent.pod.inrupt.com",
"notificationGateway":"https://notification.pod.inrupt.com",
"powerSwitch":"https://pod.inrupt.com/powerswitch/username",
"storage":"https://pod.inrupt.com/username/"
}`,
{
headers: {
"Content-Type": "application/ld+json",
},
},
),
);

await getWellKnownSolid(resourceUrl);

expect(spyFetch.mock.calls).toHaveLength(3);

// Tries the root well known solid first is used to determine well known Solid
expect(spyFetch.mock.calls[0][0]).toBe(serverUrl.concat(wellKnownSolid));
// Checks the resource's location header otherwise
expect(spyFetch.mock.calls[1][0]).toBe(resourceUrl);
// The advertised podIdentifier (as storage) is used to determine well known Solid
expect(spyFetch.mock.calls[2][0]).toBe(
serverUrl.concat("username/", wellKnownSolid),
);
});

it("Throws an error if the resource metadata can't be fetched", async () => {
it("Throws an error if the well-known solid resource cannot be found", async () => {
const spyFetch = jest.spyOn(globalThis, "fetch");

// Can't fetch root well known
// Can't fetch root well-known
spyFetch.mockResolvedValueOnce(new Response(undefined, { status: 404 }));
// Resource advertises Pod root
spyFetch.mockResolvedValueOnce(
mockResponse(
undefined,
{
headers: {
"Content-Type": "text/turtle",
link: `</username>; rel="http://www.w3.org/ns/pim/space#storage"`,
},
},
resourceUrl,
),
);
// Can't fetch pod root well known solid
spyFetch.mockResolvedValueOnce(new Response(undefined, { status: 404 }));

await expect(getWellKnownSolid(resourceUrl)).rejects.toThrow();

expect(spyFetch.mock.calls).toHaveLength(3);
});

it("Throws an error if the pod root cannot be determined", async () => {
const spyFetch = jest.spyOn(globalThis, "fetch");

// Can't fetch root well known
spyFetch.mockResolvedValueOnce(new Response(undefined, { status: 404 }));
// Resource does not advertise pod root
spyFetch.mockResolvedValueOnce(new Response(undefined));

await expect(getWellKnownSolid(resourceUrl)).rejects.toThrow(
"Could not determine storage root or well-known solid resource.",
);

expect(spyFetch.mock.calls).toHaveLength(2);
expect(spyFetch.mock.calls).toHaveLength(1);
});

it("returns the contents of .well-known/solid for the given resource (2.0)", async () => {
mockESS20();
it("returns the contents of .well-known/solid for the given resource", async () => {
mockESS();

const wellKnownSolidResponse = await getWellKnownSolid(resourceUrl);
// skipIf confuses jest
// eslint-disable-next-line jest/no-standalone-expect
expect(wellKnownSolidResponse).toMatchSnapshot();
});

it("returns the contents of .well-known/solid for the given resource (1.1)", async () => {
mockESS11();

const wellKnownSolidResponse = await getWellKnownSolid(resourceUrl);

expect(wellKnownSolidResponse).toMatchSnapshot();
});
});
Loading
Loading