Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions packages/json-rpc-engine/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- Add legacy `createOriginMiddleware` utility ([#8734](https://github.com/MetaMask/core/pull/8734))

## [10.3.0]

### Added
Expand Down
27 changes: 27 additions & 0 deletions packages/json-rpc-engine/src/createOriginMiddleware.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { JsonRpcRequest } from '@metamask/utils';

import { makeRequest } from '../tests/utils';
import { createOriginMiddleware } from './createOriginMiddleware';
import { JsonRpcEngine } from './JsonRpcEngine';

describe('createOriginMiddleware', () => {
it('adds the origin property to the request', async () => {
const origin = 'https://metamask.io';
const engine = new JsonRpcEngine();

engine.push(createOriginMiddleware(origin));

engine.push((request, response, _next, end) => {
response.result = (
request as unknown as JsonRpcRequest & { origin: string }
).origin;
end();
});

expect(await engine.handle(makeRequest())).toStrictEqual({
id: '1',
jsonrpc: '2.0',
result: origin,
});
});
});
19 changes: 19 additions & 0 deletions packages/json-rpc-engine/src/createOriginMiddleware.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { Json, JsonRpcRequest } from '@metamask/utils';

import { JsonRpcMiddleware } from './JsonRpcEngine';

/**
* Create a middleware function that adds `origin` to the request object.
*
* @deprecated Use the v2 `createOriginMiddleware` instead.
* @param origin - The origin.
* @returns The middleware.
*/
export function createOriginMiddleware(
origin: string,
): JsonRpcMiddleware<JsonRpcRequest, Json> {
return (request, _result, next) => {
(request as unknown as JsonRpcRequest & { origin: string }).origin = origin;
next();
};
}
1 change: 1 addition & 0 deletions packages/json-rpc-engine/src/index.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ describe('@metamask/json-rpc-engine', () => {
"asV2Middleware",
"createAsyncMiddleware",
"createMethodMiddleware",
"createOriginMiddleware",
"createScaffoldMiddleware",
"getUniqueId",
"createIdRemapMiddleware",
Expand Down
1 change: 1 addition & 0 deletions packages/json-rpc-engine/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export type {
MethodHandlerImplementation,
} from './createMethodMiddleware';
export { createMethodMiddleware } from './createMethodMiddleware';
export { createOriginMiddleware } from './createOriginMiddleware';
export { createScaffoldMiddleware } from './createScaffoldMiddleware';
export { getUniqueId } from './getUniqueId';
export { createIdRemapMiddleware } from './idRemapMiddleware';
Expand Down
Loading