Skip to content
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.

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

Fix route handler property to follow same pattern #1155

Merged
merged 14 commits into from
Jul 3, 2024
Merged

Conversation

rvsiyad
Copy link
Contributor

@rvsiyad rvsiyad commented Jul 2, 2024

DEFRA/water-abstraction-team#122

We have noticed that in some of our routes, the handler is within the options property.

{
  method: 'POST',
  path: '/bills/{id}/remove',
  options: {
    handler: BillsController.submitRemove,
    auth: {
      access: {
        scope: ['billing']
      }
    }
  }
}

Whilst in others it is outside:

{
  method: 'GET',
  path: '/bill-runs',
  handler: BillRunsController.index,
  options: {
    auth: {
      access: {
        scope: ['billing']
      }
    }
  }
}

This is as a result of some contradiction between the Hapi API documentation having the handler within the options property, and the Hapi Tutorial giving examples with the handler outside the options property. The decision has been made to follow the API documentation.

This PR is focused on going through the routes files and ensuring the handler is within the options property.

DEFRA/water-abstraction-team#122

We have noticed that in some of our routes, the `handler` is within the `options property`.
```javascript
{
  method: 'POST',
  path: '/bills/{id}/remove',
  options: {
    handler: BillsController.submitRemove,
    auth: {
      access: {
        scope: ['billing']
      }
    }
  }
}
```

Whilst in others it is outside:
```javascript
{
  method: 'GET',
  path: '/bill-runs',
  handler: BillRunsController.index,
  options: {
    auth: {
      access: {
        scope: ['billing']
      }
    }
  }
}
```

This is as a result of some contraction between the [Hapi API documentation](https://hapi.dev/api/?v=21.3.3#-routeoptionshandler) having the `handler` within the `options` property,
and the [Hapi Tutorial](https://hapi.dev/tutorials/routing/?lang=en_US) giving examples with the `handler` outside the `options` property. The decision has been made to follow the API documentation.

This PR is focused on going through the routes files and ensuring the `handler` is within the `options` property.
@rvsiyad rvsiyad added the housekeeping Refactoring, tidying up or other work which supports the project label Jul 2, 2024
@rvsiyad rvsiyad self-assigned this Jul 2, 2024
@rvsiyad rvsiyad closed this Jul 2, 2024
@rvsiyad rvsiyad deleted the correct-route-handlers branch July 2, 2024 13:21
@rvsiyad rvsiyad restored the correct-route-handlers branch July 2, 2024 13:21
@rvsiyad rvsiyad reopened this Jul 2, 2024
@rvsiyad rvsiyad marked this pull request as ready for review July 2, 2024 14:02
Copy link
Member

@Cruikshanks Cruikshanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rvsiyad rvsiyad merged commit 69d4e39 into main Jul 3, 2024
6 checks passed
@rvsiyad rvsiyad deleted the correct-route-handlers branch July 3, 2024 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Refactoring, tidying up or other work which supports the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants