feat: add storeLog in Config
#21
Conversation
src/interfaces/logSinkInterface.ts
Outdated
| import { Log } from "../types"; | ||
|
|
||
| class ILogSink { | ||
| store = async (log: Log): Promise<void> => { |
There was a problem hiding this comment.
it would be better to address this one's these changes are merged here
There was a problem hiding this comment.
addressed it in backend implementation here
src/core/server.ts
Outdated
| return res.status(mockResponse.statusCode).set(mockResponse.headers).end(mockResponse.body); | ||
| console.debug("[Debug] Final Mock Response", mockResponse); | ||
|
|
||
| res.locals.metadata = mockResponse.metadata; |
There was a problem hiding this comment.
Lets namespace metadata -> rq_metadata for scoping Requestly variables
src/core/server.ts
Outdated
| app: Express | ||
|
|
||
| constructor (port: number = 3000, configFetcher: IConfigFetcher, pathPrefix: string = "") { | ||
| constructor (port: number = 3000, configFetcher: IConfigFetcher, logSink: ILogSink, pathPrefix: string = "") { |
There was a problem hiding this comment.
logSink should be optional. If not given, should default to empty Sink
There was a problem hiding this comment.
The api of the constructor has been updated in the other PR
src/middlewares/har.ts
Outdated
| response: buildHarResponse(res, { body: responseBody }), | ||
| } | ||
|
|
||
| storageService.storeLog({ mockId: res.locals.metadata.mockId, HarEntry, }) |
There was a problem hiding this comment.
Faced a crash here while running locally
/Users/sahilgupta/Documents/dev/requestly/requestly-mock-server/src/middlewares/har.ts:28
storageService.storeLog({ mockId: res.locals.metadata.mockId, HarEntry, })
^
TypeError: Cannot read properties of undefined (reading 'mockId')
There was a problem hiding this comment.
I faced the same error once. Probably because of the order in which we are applying the metadata in core/server.ts (but still the error shouldn't occur).
It suprisingly went away when I restarted the server and tested with the backend
- convert IConfig from class to interface - save src and sink in storageService instead of complete IConfig
Refactor: Exposed MockServer config [BREAKING CHANGE]
src/core/server.ts
Outdated
| mockConfig: MockServerConfig; | ||
| config: IConfig; |
There was a problem hiding this comment.
These both can be merged into 1 as both are same.
mockServerConfig: MockServerConfig
Also IConfig is incorrect name as prefix I is used for marking abstract classes
There was a problem hiding this comment.
This can be converted to this
constructor (config: MockServerConfig)
src/services/storageService.ts
Outdated
|
|
||
| class StorageService { | ||
| configFetcher ?: IConfigFetcher|null = null; | ||
| src: ISource | null = null; |
- combine config and mockServerConfig into serverOptions of MockServerClass (handle types accordingly) - remove the I prefix from storage config
| } | ||
|
|
||
| /* To make the constructor options optional except for storageConfig */ | ||
| type MockServerConstructorOptions = Pick<MockServerOptions, 'storageConfig'> & Partial<MockServerOptions>; |
There was a problem hiding this comment.
we can't, we need port and pathprefix as optional there
will be an optional config argument that expects a function which handles the following log object
requestly-mock-server/src/types/index.ts
Lines 25 to 28 in 9fb9682
builds on top of #4 (now stale). Aims at getting the feature released.