Skip to content

Commit

Permalink
merge
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucianHymer
lucianHymer committed Jan 23, 2023
1 parent 53385e2 commit 4ce9bfc
Show file tree
Hide file tree
Showing 2 changed files with 135 additions and 73 deletions.
196 changes: 129 additions & 67 deletions database-client/__tests__/CeramicDatabase.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,95 +147,150 @@ describe("Verify Ceramic Database", () => {
expect(passport.passport?.expiryDate).toEqual(expiryDate);
});

it("ignores stamps that cannot be loaded succefully from ceramic", async () => {
const issuanceDate = new Date("2022-06-01");
const expiryDate = new Date("2022-09-01");
const maxGoodStamps = 2;
let numGoodStamps = 0;
let spyStoreGet = jest.spyOn(ceramicDatabase.store, "get").mockImplementation(async (name) => {
return {
id: "passport-id",
issuanceDate,
expiryDate,
stamps: [
{
provider: "Provider-1",
credential: "ceramic://credential-1",
},
{
provider: "Provider-2",
credential: "ceramic://credential-2",
},
{
provider: "Provider-3",
credential: "ceramic://credential-3",
},
],
};
});
let spyStoreGetRecordDocument = jest
.spyOn(ceramicDatabase.store, "getRecordDocument")
.mockImplementation(async (name) => {
describe("when stamps cannot successfully be loaded from ceramic", () => {
let spyAxiosGet, spyStoreGet, spyStoreGetRecordDocument, spyPinAdd, issuanceDate, expiryDate;
const parseStreamIdFromUrl = (url: string) => url.split("/").slice(-1);

beforeEach(() => {
issuanceDate = new Date("2022-06-01");
expiryDate = new Date("2022-09-01");

spyStoreGet = jest.spyOn(ceramicDatabase.store, "get").mockImplementation(async (name) => {
return {
id: "passport-id",
} as unknown as TileDoc;
issuanceDate,
expiryDate,
stamps: [
{
provider: "Provider-1",
credential: "ceramic://credential-1",
},
{
provider: "Provider-2",
credential: "ceramic://credential-2",
},
{
provider: "Provider-3",
credential: "ceramic://credential-3",
},
],
};
});
const spyLoadStreamReq = jest.spyOn(axios, "get").mockImplementation((url: string): Promise<{}> => {
return new Promise((resolve, reject) => {
const urlSegments = url.split("/");
const streamId = urlSegments[urlSegments.length - 1];
spyStoreGetRecordDocument = jest
.spyOn(ceramicDatabase.store, "getRecordDocument")
.mockImplementation(async (name) => {
return {
id: "passport-id",
} as unknown as TileDoc;
});

spyAxiosGet = jest.spyOn(axios, "get");

spyPinAdd = jest.spyOn(ceramicDatabase.ceramicClient.pin, "add").mockImplementation(async (streamId) => {
// Nothing to do here
return;
});
});

it("ignores unsuccessful stamps", async () => {
const maxGoodStamps = 2;
let numGoodStamps = 0;

spyAxiosGet.mockImplementation(async (url: string): Promise<{}> => {
const streamId = parseStreamIdFromUrl(url);
if (numGoodStamps < maxGoodStamps) {
numGoodStamps += 1;
resolve({
return {
data: {
state: {
content: "Stamp Content for ceramic://" + streamId,
},
},
status: 200,
});
};
}
reject("Error loading stamp!");
throw "Error loading stamp!";
});
});

let spyPinAdd = jest.spyOn(ceramicDatabase.ceramicClient.pin, "add").mockImplementation(async (streamId) => {
// Nothing to do here
return;
const passport = (await ceramicDatabase.getPassport()) as PassportWithErrors;

// We do not expect to have any passport, hence `false` should be returned
expect(spyStoreGet).toBeCalledTimes(1);
expect(spyStoreGet).toBeCalledWith("Passport");
expect(spyAxiosGet).toBeCalledTimes(3);
expect(spyStoreGetRecordDocument).toBeCalledTimes(1);

// Ensure the document is pinned
expect(spyPinAdd).toBeCalledTimes(1);
expect(spyPinAdd).toBeCalledWith("passport-id");

// We only expect 2 stamps to have been loaded
expect(passport.passport?.stamps).toEqual([
{
credential: "Stamp Content for ceramic://credential-1",
provider: "Provider-1",
streamId: "ceramic://credential-1",
},
{
credential: "Stamp Content for ceramic://credential-2",
provider: "Provider-2",
streamId: "ceramic://credential-2",
},
]);
expect(passport.passport?.issuanceDate).toEqual(issuanceDate);
expect(passport.passport?.expiryDate).toEqual(expiryDate);
});

const passport = (await ceramicDatabase.getPassport()) as PassportWithErrors;

// We do not expect to have any passport, hence `false` should be returned
expect(spyStoreGet).toBeCalledTimes(1);
expect(spyStoreGet).toBeCalledWith("Passport");
expect(spyLoadStreamReq).toBeCalledTimes(3);
expect(spyStoreGetRecordDocument).toBeCalledTimes(1);

// Ensure the document is pinned
expect(spyPinAdd).toBeCalledTimes(1);
expect(spyPinAdd).toBeCalledWith("passport-id");
it("records the stream index when a stamp has a CACAO error", async () => {
spyAxiosGet
.mockImplementationOnce(async (): Promise<{}> => {
throw { response: { data: { error: "CACAO has expired" } } };
})
.mockImplementation(async (url: string): Promise<{}> => {
return {
data: {
state: {
content: "Stamp Content for ceramic://" + parseStreamIdFromUrl(url),
},
},
status: 200,
};
});

// We only expect 2 stamps to have been loaded
expect(passport.passport?.stamps).toEqual([
{
credential: "Stamp Content for ceramic://credential-1",
provider: "Provider-1",
streamId: "ceramic://credential-1",
},
{
credential: "Stamp Content for ceramic://credential-2",
provider: "Provider-2",
streamId: "ceramic://credential-2",
},
]);
expect(passport.passport?.issuanceDate).toEqual(issuanceDate);
expect(passport.passport?.expiryDate).toEqual(expiryDate);
const passport = (await ceramicDatabase.getPassport()) as PassportWithErrors;

expect(spyAxiosGet).toBeCalledTimes(3);

expect(passport.passport?.stamps).toEqual([
{
credential: "Stamp Content for ceramic://credential-2",
provider: "Provider-2",
streamId: "ceramic://credential-2",
},
{
credential: "Stamp Content for ceramic://credential-3",
provider: "Provider-3",
streamId: "ceramic://credential-3",
},
]);

expect(passport.errors?.error).toBe(true);
expect(passport.errors?.stamps).toEqual(["ceramic://credential-1"]);
});
});
it("checkPassportCACAOError should indicate if a passport stream is throwing a CACAO error", async () => {
jest
.spyOn(ceramicDatabase.store, "getRecordID")
.mockImplementation(async (name) => "passport-id" as unknown as string);

let spyStoreGetRecordDocument = jest
.spyOn(ceramicDatabase.store, "getRecordDocument")
.mockImplementation(async (name) => {
return {
id: "passport-id",
} as unknown as TileDoc;
});

const spyLoadStreamReq = jest.spyOn(axios, "get").mockImplementation((url: string): Promise<{}> => {
return new Promise((resolve, reject) => {
reject({
Expand All @@ -251,6 +306,7 @@ describe("Verify Ceramic Database", () => {

expect(ceramicDatabase.checkPassportCACAOError()).resolves.toBe(true);
});

it("checkPassportCACAOError should not indicate cacao error if not present", () => {
jest.spyOn(ceramicDatabase.store, "getRecordDocument").mockImplementation(async (name) => {
return {
Expand All @@ -277,6 +333,12 @@ describe("Verify Ceramic Database", () => {
.spyOn(ceramicDatabase.store, "getRecordID")
.mockImplementation(async (name) => "passport-id" as unknown as string);

jest.spyOn(ceramicDatabase.store, "getRecordDocument").mockImplementation(async (name) => {
return {
id: "passport-id",
} as unknown as TileDoc;
});

const spyLoadStream = jest.spyOn(ceramicDatabase.ceramicClient, "loadStream");

spyLoadStream.mockImplementationOnce(() => {
Expand Down
12 changes: 6 additions & 6 deletions database-client/integration-tests/ceramicDatabaseTest.ts
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PassportWithErrors } from './../../types/src/index.d';
import { PassportWithErrors } from "./../../types/src/index.d";
import { Passport, VerifiableCredential, Stamp, PROVIDER_ID } from "@gitcoin/passport-types";
import { DID } from "dids";
import { Ed25519Provider } from "key-did-provider-ed25519";
Expand Down Expand Up @@ -83,7 +83,7 @@ describe("when there is an existing passport without stamps for the given did",
});

it("getPassport retrieves the passport from ceramic", async () => {
const {passport} = (await ceramicDatabase.getPassport()) as PassportWithErrors;
const { passport } = (await ceramicDatabase.getPassport()) as PassportWithErrors;

expect(passport).toBeDefined();
expect(passport).toEqual(existingPassport);
Expand Down Expand Up @@ -336,9 +336,9 @@ describe("when there is an existing passport with stamps for the given did", ()
});

it("deleteStamps deletes selected stamps from passport", async () => {
ceramicDatabase.deleteStamps(providerIds);
await ceramicDatabase.deleteStamps(providerIds);

// The deletion will not be reflected immediatly, we need to wait a bit ...
// The deletion will not be reflected immediately, we need to wait a bit ...
await new Promise((r) => setTimeout(r, 2000));
const passport = await ceramicDatabase.store.get("Passport");

Expand All @@ -361,9 +361,9 @@ describe("when there is an existing passport with stamps for the given did", ()
});

it("deleteStamp deletes an existing stamp from passport", async () => {
ceramicDatabase.deleteStamp(existingGoogleStampTileStreamID);
await ceramicDatabase.deleteStamp(existingGoogleStampTileStreamID);

// The deletion will not be reflected immediatly, we need to wait a bit ...
// The deletion will not be reflected immediately, we need to wait a bit ...
await new Promise((r) => setTimeout(r, 2000));
const passport = await ceramicDatabase.store.get("Passport");

Expand Down

0 comments on commit 4ce9bfc

Please sign in to comment.