HTTP GetRequest workflow
- Lenguaje dominante
- C#
- Estrellas
- 2
- Forks
- 1
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Have been playing with the OpenStreetMap_Toolkit leveraging the HTTP_Toolkit 😍 😍 😍
(@rolyhudson)
Did lead to some thoughts around potentially consolidating the http requests to more clearly align with other areas of the BHoM. A few notes for comment - @epignatelli @alelom picking up from our chat earlier. Low priority and great to enable these experiments as some thinking needed I think to create a satisfactorily slick, consistent and clear work flow.
There are currently two implementations of HTTP requests -
1. following the Adapter/Pull work flow
Feeding a `GetRequest` into a _Pull_ with also a `HTTPAdapter`
2. A simpler workflow mirroring the expression of a single http request string. Through
`BH.Engine.HTTP.Compute.GetRequest(url)` which directly returns the `string` response
The 2. above is neat - but needs to move out of Engine `Compute` as is externally interfacing.
The challenge we have is that a traditionally formatted http request contains the domain (i.e. source or adapter in BHoM terms) actually embedded in line with the request itself.
Our standard adapter Pull and Push workflows have naturally separated these concepts out.
Useful to align terminology and concepts where we can - but also be intuitive and respect conventions of the software/platforms we are adapting to.
The main comment I discussed with @epignatelli was to ensure clarity that a **link** (or adapter) with the outside world to BHoM is still being made. Even if not a standard Adapter -> Pull
So few options:
a)
This has redundant information for http as described above.

b)
Could separate out domain and rest of request arguments for the http string - but I think this is unintuitive if already familiar with performing http requests. Others opinions here are welcome - but feels we are forcing too hard into BHoM format!?

c)
Could allow not specifying adapter - where is implicit from the request?

d)
_Could_ then enable implicit casting of correctly such that work flow might allow

e)
An option that might make sense is to achieve very close to the original `BH.Engine.HTTP.Compute.GetRequest(url)` , respecting the current exception of http, but migrating it to an Adapter NameSpace such that we could have something like `BH.Adpater.HTTP.PullRequest(url)`.

This would not currently reflect into UI - so considerations needed there.
f)
Another final option would be that we do this as an extension of the Execute...

With this option I think we come close to some of the ideas we had before, where we considered implementing Executes with the actual Adapter not needing to be explicitly defined as additional input - being implicit in the Method you were executing.
This came up originally from discussions about executing external Python scripts etc.
Wonder if this might be a way forward?
Sorry for long notes - wanted to capture thoughts and discussions.
Perhaps one to pick up over a call?
@epignatelli @alelom @adecler @rolyhudson
Guía de contribución
Línea de trabajo
Empieza revisando los dos workflows descritos en torno a BH.Engine.HTTP.Compute.GetRequest(url), GetRequest y HTTPAdapter. Compara los enfoques propuestos Adapter/Pull, adaptador implícito y Execute, incluido el punto de entrada propuesto BH.Adapter.HTTP.PullRequest(url) y las implicaciones para la UI. La tarea se consideraría terminada cuando se hayan acordado un workflow y una terminología antes de poder definir el alcance de la implementación.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp
- Área
- api, networking
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100