Skip to content

Add SubjectMetadataController:addSubjectMetadata action #3733

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
FrederikBolding merged 3 commits into from
Jan 5, 2024
Merged

Add SubjectMetadataController:addSubjectMetadata action #3733

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
ae6ce5c
Add SubjectMetadata:addSubjectMetadata action
FrederikBolding Jan 5, 2024
1f76b84
Improve test names
FrederikBolding Jan 5, 2024
cfb1f70
Fix lint
FrederikBolding Jan 5, 2024
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
62 changes: 62 additions & 0 deletions packages/permission-controller/src/SubjectMetadataController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,4 +280,66 @@ describe('SubjectMetadataController', () => {
});
});
});

describe('controller actions', () => {
it(':getSubjectMetadata returns the subject metadata', () => {
const [messenger, hasPermissionsSpy] =
getSubjectMetadataControllerMessenger();
const controller = new SubjectMetadataController({
messenger,
subjectCacheLimit: 100,
});
hasPermissionsSpy.mockImplementationOnce(() => true);

controller.addSubjectMetadata(
getSubjectMetadata('foo.com', 'foo', SubjectType.Snap),
);

controller.addSubjectMetadata(
getSubjectMetadata('bar.io', 'bar', SubjectType.Website),
);

expect(
messenger.call(
'SubjectMetadataController:getSubjectMetadata',
'foo.com',
),
).toStrictEqual(getSubjectMetadata('foo.com', 'foo', SubjectType.Snap));

expect(
messenger.call(
'SubjectMetadataController:getSubjectMetadata',
'bar.io',
),
).toStrictEqual(getSubjectMetadata('bar.io', 'bar', SubjectType.Website));
});

it(':addSubjectMetadata adds passed subject metadata', () => {
const [messenger, hasPermissionsSpy] =
getSubjectMetadataControllerMessenger();
const controller = new SubjectMetadataController({
messenger,
subjectCacheLimit: 100,
});
hasPermissionsSpy.mockImplementationOnce(() => true);

messenger.call(
'SubjectMetadataController:addSubjectMetadata',
getSubjectMetadata('foo.com', 'foo', SubjectType.Snap),
);

messenger.call(
'SubjectMetadataController:addSubjectMetadata',
getSubjectMetadata('bar.io', 'bar', SubjectType.Website),
);

expect(controller.getSubjectMetadata('foo.com')).toStrictEqual(
getSubjectMetadata('foo.com', 'foo', SubjectType.Snap),
);

expect(controller.getSubjectMetadata('bar.io')).toStrictEqual(
getSubjectMetadata('bar.io', 'bar', SubjectType.Website),
);
});
});
});
13 changes: 12 additions & 1 deletion packages/permission-controller/src/SubjectMetadataController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,15 @@ export type GetSubjectMetadata = {
handler: (origin: SubjectOrigin) => SubjectMetadata | undefined;
};

export type AddSubjectMetadata = {
type: `${typeof controllerName}:addSubjectMetadata`;
handler: (metadata: SubjectMetadataToAdd) => void;
};

export type SubjectMetadataControllerActions =
| GetSubjectMetadataState
| GetSubjectMetadata;
| GetSubjectMetadata
| AddSubjectMetadata;

export type SubjectMetadataStateChange = ControllerStateChangeEvent<
typeof controllerName,
Expand Down Expand Up @@ -140,6 +146,11 @@ export class SubjectMetadataController extends BaseController<
`${this.name}:getSubjectMetadata`,
this.getSubjectMetadata.bind(this),
);

this.messagingSystem.registerActionHandler(
`${this.name}:addSubjectMetadata`,
this.addSubjectMetadata.bind(this),
);
}

/**
Expand Down