feat: registry processor #14

0xkenj1 · 2024-10-22T15:20:29Z

🤖 Linear

Closes GIT-86 GIT-87 GIT-88 GIT-89

Description

RegistryProcessor
RoleGrantedHandler
ProfileCreatedHandler

Checklist before requesting a review

I have conducted a self-review of my code.
I have conducted a QA.
If it is a core feature, I have included comprehensive tests.

linear · 2024-10-22T15:20:32Z

GIT-86 Registry Processor

GIT-87 RoleGranted

GIT-88 ProfileCreated

GIT-89 Factory

0xnigir1

looks good to me, just a few comments

0xnigir1 · 2024-10-22T15:43:09Z

apps/indexer/src/handlers/Registry.ts

@@ -1,6 +1,12 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import { Registry } from "../../generated";

+// Handler for ProfileNameUpdated event


Suggested change

// Handler for ProfileNameUpdated event

// Handler for RoleGranted event

0xnigir1 · 2024-10-22T15:43:23Z

apps/indexer/src/handlers/Registry.ts

+// Handler for ProfileNameUpdated event
+Registry.RoleGranted.handler(async ({}) => {});
+
+// Handler for ProfileOwnerUpdated event


Suggested change

// Handler for ProfileOwnerUpdated event

// Handler for RoleRevoked event

0xnigir1 · 2024-10-22T15:44:28Z

packages/processors/src/registry/handlers/profileCreated.hanlder.ts

typo in file name

0xnigir1 · 2024-10-22T15:45:26Z

packages/processors/src/registry/handlers/index.ts

@@ -0,0 +1,2 @@
+export * from "./profileCreated.hanlder.js";


0xnigir1 · 2024-10-22T15:46:41Z

packages/shared/src/types/common.ts

@@ -1,3 +1,5 @@
 import { Branded } from "../internal.js";

 export type ChainId = Branded<number, "ChainId">;
+
+export type Bytes32String = Branded<`0x${string}`, "Bytes32String">;


is this type different from Hex from Viem?

packages/processors/src/registry/handlers/roleGranted.handler.ts

packages/processors/src/registry/registry.processor.ts

0xnigir1 · 2024-10-22T16:17:50Z

packages/processors/test/registry/handlers/roleGranted.handler.spec.ts

+        await expect(handler.handle()).rejects.toThrow(InvalidAddressError);
+    });
+
+    it("should throw an error if projectRepository throws an error", async () => {


Suggested change

it("should throw an error if projectRepository throws an error", async () => {

it("throw an error if projectRepository throws an error", async () => {

0xnigir1 · 2024-10-22T16:18:32Z

packages/processors/test/registry/handlers/roleGranted.handler.spec.ts

+        mockedEvent["params"]["role"] = "0x1231231234" as Bytes32String;
+        const event = mockedEvent;
+
+        mockProjectRepository.getProjectById.mockResolvedValueOnce(null);


should we test undefined case too?

actually we only need to test undefined since this is the signature getProjectById(chainId: ChainId, projectId: string): Promise<Project | undefined>;

0xnigir1

🫡

jahabeebs

nice pr, made a couple of comments 🤠

jahabeebs · 2024-10-22T20:07:46Z

packages/processors/src/registry/handlers/roleGranted.handler.ts

+    ) {}
+    async handle(): Promise<Changeset[]> {
+        const { projectRepository } = this.dependencies;
+        const role = this.event.params.role.toLocaleLowerCase();


is this supposed to be toLocaleLowerCase rather than toLowerCase()? Not sure if you want different behavior depending on locale-specific case mappings

jahabeebs · 2024-10-22T20:10:11Z

packages/processors/src/registry/handlers/roleGranted.handler.ts

+        }
+
+        const account = getAddress(this.event.params.account);
+        const project = await projectRepository.getProjectById(this.chainId, role);


just double checking that the role will definitely be the profileId unless role === ALLO_OWNER_ROLE. No other validation needed?

no other needed, i will double check it anyways :)

jahabeebs · 2024-10-22T20:15:23Z

apps/indexer/src/handlers/Registry.ts

@@ -1,6 +1,12 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import { Registry } from "../../generated";

+// Handler for RoleGranted event
+Registry.RoleGranted.handler(async ({}) => {});


maybe a TODO for this file

There is nothing to do here. Won't need to fill the handler with any code, this line is just needed to save the event on the database :)

jahabeebs · 2024-10-22T20:16:32Z

packages/processors/test/registry/registry.processor.spec.ts

+        vi.resetAllMocks();
+    });
+
+    it("should throw UnsupportedEventException for unsupported events", async () => {


should 😄

jahabeebs · 2024-10-22T20:18:56Z

packages/processors/src/registry/handlers/profileCreated.handler.ts

+        const { metadataProvider, evmProvider, projectRepository } = this.dependencies;
+        const profileId = this.event.params.profileId;
+        const metadataCid = this.event.params.metadata[1];
+        const metadata = await metadataProvider.getMetadata(metadataCid);


I noticed there's no error handling here--are you okay with the error bubbling up?

Yes, the idea is to buble the error up to the Processors and finally handle the errors there. But will figure it out on a specific milestone that we set up specifically for error handling :)

jahabeebs · 2024-10-22T20:19:47Z

packages/processors/src/registry/handlers/roleGranted.handler.ts

+
+        // The member role for an Allo V2 profile, is the profileId itself.
+        // If a project exists with that id, we create the member role
+        // If it doesn't exists we create a pending project role. This can happens


*exist
*happen

jahabeebs

👍🏻

0xnigir1

just two test naming fixes but can fix it in another PR, let's gooo

0xnigir1 · 2024-10-23T17:01:36Z

packages/processors/test/registry/registry.processor.spec.ts

+        await expect(processor.process(event)).rejects.toThrow(UnsupportedEventException);
+    });
+
+    it("should call ProfileCreatedHandler", async () => {


Suggested change

it("should call ProfileCreatedHandler", async () => {

it("calls ProfileCreatedHandler", async () => {

0xnigir1 · 2024-10-23T17:01:54Z

packages/processors/test/registry/registry.processor.spec.ts

+        expect(result).toEqual([]); // Check if handle returns []
+    });
+
+    it("should call RoleGrantedHandler", async () => {


Suggested change

it("should call RoleGrantedHandler", async () => {

it("calls RoleGrantedHandler", async () => {

0xkenj1 added 8 commits October 15, 2024 16:26

feat: registry base

cc5b5b2

Merge branch 'feat/providers-and-logger' into feat/registry-processor

c12fb66

feat: roleGranted

105a70b

Merge branch 'feat/providers-and-logger' into feat/registry-processor

46d206b

feat: role granted

fcf00b0

Merge branch 'dev' into feat/registry-processor

775fad8

feat: tests for handlers

30c3eaf

fix: envio client test

ac86f6f

0xkenj1 changed the title ~~Feat/registry processor~~ feat: registry processor Oct 22, 2024

0xkenj1 requested a review from 0xnigir1 October 22, 2024 15:20

0xnigir1 reviewed Oct 22, 2024

View reviewed changes

fix: pr comments

fab3bc2

0xnigir1 previously approved these changes Oct 22, 2024

View reviewed changes

Merge remote-tracking branch 'origin/dev' into feat/registry-processor

3991da5

0xkenj1 requested review from jahabeebs and 0xyaco October 22, 2024 18:40

jahabeebs reviewed Oct 22, 2024

View reviewed changes

fix: pr comments

41cd088

0xkenj1 dismissed 0xnigir1’s stale review via 41cd088 October 23, 2024 16:32

0xkenj1 added 2 commits October 23, 2024 13:49

Merge remote-tracking branch 'origin/dev' into feat/registry-processor

3faf95e

fix: protocolEvent

38aff32

0xkenj1 requested review from jahabeebs and 0xnigir1 October 23, 2024 16:51

jahabeebs approved these changes Oct 23, 2024

View reviewed changes

0xnigir1 approved these changes Oct 23, 2024

View reviewed changes

0xkenj1 merged commit 28dcae6 into dev Oct 23, 2024
6 checks passed

0xkenj1 deleted the feat/registry-processor branch October 23, 2024 17:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: registry processor #14

feat: registry processor #14

0xkenj1 commented Oct 22, 2024

linear bot commented Oct 22, 2024

0xnigir1 left a comment

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xnigir1 Oct 22, 2024

0xkenj1 Oct 22, 2024

0xnigir1 left a comment

jahabeebs left a comment

jahabeebs Oct 22, 2024

jahabeebs Oct 22, 2024

0xkenj1 Oct 23, 2024 •

edited

Loading

jahabeebs Oct 22, 2024

0xkenj1 Oct 23, 2024

jahabeebs Oct 22, 2024

jahabeebs Oct 22, 2024

0xkenj1 Oct 23, 2024

jahabeebs Oct 22, 2024 •

edited

Loading

jahabeebs left a comment

0xnigir1 left a comment

0xnigir1 Oct 23, 2024

0xnigir1 Oct 23, 2024

	// Handler for ProfileNameUpdated event
	// Handler for RoleGranted event

	// Handler for ProfileOwnerUpdated event
	// Handler for RoleRevoked event

	it("should throw an error if projectRepository throws an error", async () => {
	it("throw an error if projectRepository throws an error", async () => {

	it("should call ProfileCreatedHandler", async () => {
	it("calls ProfileCreatedHandler", async () => {

	it("should call RoleGrantedHandler", async () => {
	it("calls RoleGrantedHandler", async () => {

feat: registry processor #14

feat: registry processor #14

Conversation

0xkenj1 commented Oct 22, 2024

🤖 Linear

Description

Checklist before requesting a review

linear bot commented Oct 22, 2024

0xnigir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xnigir1 left a comment

Choose a reason for hiding this comment

jahabeebs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xkenj1 Oct 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jahabeebs Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

jahabeebs left a comment

Choose a reason for hiding this comment

0xnigir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0xkenj1 Oct 23, 2024 •

edited

Loading

jahabeebs Oct 22, 2024 •

edited

Loading