René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Inconsistency in middleware docs","articleBody":"_A separate issue could be opened for [roach-php/core](https://github.com/roach-php/core), wherein code refactoring is suggested._\r\n\r\nThe documentation at https://roach-php.dev/docs/downloader-middleware states:\r\n\r\n\u003e Downloader middleware that process outgoing requests before they get sent need to implement `RequestMiddlewareInterface`.\r\n\r\nThen example code is provided,\r\n```php\r\nuse RoachPHP\\Downloader\\Middleware\\RequestMiddlewareInterface;\r\nuse RoachPHP\\Http\\Request;\r\nuse RoachPHP\\Support\\Configurable;\r\n\r\nclass MyRequestMiddleware implements RequestMiddlewareInterface\r\n{\r\n    // ...\r\n}\r\n```\r\nNote the namespace of `RequestMiddlewareInterface`.\r\n\r\nFurther down, the documentation states:\r\n\r\n\u003e Downloader middleware that deal with responses need to implement `ResponseMiddlewareInterface`.\r\n\r\nThen example code is provided,\r\n```php\r\nuse RoachPHP\\Http\\Response;\r\nuse RoachPHP\\Spider\\Middleware\\ResponseMiddlewareInterface;\r\nuse RoachPHP\\Support\\Configurable;\r\n\r\nclass MyResponseMiddleware implements ResponseMiddlewareInterface\r\n{\r\n    // ...\r\n}\r\n```\r\nNote again the namespace, this time of `ResponseMiddlewareInterface`.\r\n\r\nApparently there is:\r\n```php\r\nuse RoachPHP\\Downloader\\Middleware\\RequestMiddlewareInterface;\r\nuse RoachPHP\\Spider\\Middleware\\RequestMiddlewareInterface;\r\n\r\nuse RoachPHP\\Downloader\\Middleware\\ResponseMiddlewareInterface;\r\nuse RoachPHP\\Spider\\Middleware\\ResponseMiddlewareInterface;\r\n```\r\n\r\nAlthough there is the disclaimer that\r\n\u003e Note that downloader request middleware gets run after [spider request middleware](https://roach-php.dev/docs/spider-middleware#request-middleware). The exception to this are the [initial requests](https://roach-php.dev/docs/spiders#generating-the-initial-requests), which don’t get sent through the spider middleware at all.\r\n\r\nand that\r\n\u003e Downloader response middleware gets run immediately after a response was received. This means it gets run before any [spider response middleware](https://roach-php.dev/docs/spider-middleware#response-middleware).\r\n\r\n(which I only saw upon writing this issue), I suggest making this less confusing. Perhaps a code refactoring should be done: why two interface namespaces if they could be simplified to one?\r\n\r\nHow I stumbled upon this, is my IDE suggesting that both namespaces could be used.","author":{"url":"https://github.com/pedzed","@type":"Person","name":"pedzed"},"datePublished":"2023-05-25T07:04:40.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/13/roach-php.dev/issues/13"}