Description

I was trying to figure how to "throw" from modules when an error occur or how to handle when you need to skip some modules because client is not logged or his method (POST, GET, ...) is not allowed on our server or anything like that.

Proposed solution

Maybe it could be cool to have a way to throw an exception from the pipeline (maybe a class), the exception could possibly be catch in the core to handle response (with status code + error message if necessary, something like that) :)

[FEATURES] Replace the lists of variables in HttpConstants with enum class

Description

The lists of variables that are used as number can and should be replaced by enum class.

Is your feature request related to a problem? Please describe.

Nope

Describe the solution you'd like

Replace the lists that can be by enum class

Expected behaviour

Same

Actual behaviour

Same

Logs

None

Additional context

None

Description

There are compilation warnings in the Http.hpp file :

ziapi/Http.hpp:33:8: warning: ‘ziapi::http::Response::version’ should be initialized in the member initialization list [-Weffc++]
   33 | struct Response {
      |        ^~~~~~~~
ziapi/Http.hpp:33:8: warning: ‘ziapi::http::Response::status_code’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:33:8: warning: ‘ziapi::http::Response::reason’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:33:8: warning: ‘ziapi::http::Response::fields’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:33:8: warning: ‘ziapi::http::Response::body’ should be initialized in the member initialization list [-Weffc++]

ziapi/Http.hpp:16:8: warning: ‘ziapi::http::Request::version’ should be initialized in the member initialization list [-Weffc++]
   16 | struct Request {
      |        ^~~~~~~
ziapi/Http.hpp:16:8: warning: ‘ziapi::http::Request::method’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:16:8: warning: ‘ziapi::http::Request::target’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:16:8: warning: ‘ziapi::http::Request::fields’ should be initialized in the member initialization list [-Weffc++]
ziapi/Http.hpp:16:8: warning: ‘ziapi::http::Request::body’ should be initialized in the member initialization list [-Weffc++]

Your environment

• OS and version: PopOs (v 21.10)
• branch that causes this issue: main

Steps to reproduce

Use -Wall -Wextra -Weffc++ compilation flags.

Warnings are located in Http.hpp lines 16 and 33.

[FEATURES] [Modify Pop() function prototype of IResponseInputQueue]

Description

Hard to determine if std::pair<Request, Context> has been filled. For example, if we implement the Pop function like this:

std::pair<Request, Context> MyResponseInputQueue::Pop()
{
    if(myContainer.Size() == 0)
        return {};
    return myContainer.Pop();
}

If the function returns {}, the default constructors of Request and Context will be called, which will make it harder to know if the std::pair has been filled.

Describe the solution you'd like

Change the prototype of the Pop() function with:

virtual bool Pop(std::pair<Request, Context> &req) = 0;

Now we can implement the new function :

bool MyResponseInputQueue::Pop(std::pair<ziapi::http::Request, ziapi::http::Context> &req)
{
    if (myContainer.Size() == 0)
        return false;
    req = myContainer.Pop()
    return true;
}

And use it like that :

IResponseInputQueue* networkQueue = new ...;
std::pair<ziapi::http::Request, ziapi::http::Context> req;
while (networkQueue->Pop(req) {
    //process new request
 }

just added the key value for "keep alive"

Description

I canot found the key "keep alive" in http header constants so i added it.

Breaking changes

new value available in http header constants

Additional Changes

Checklist

• [x] I have assigned this PR to myself
• [ ] I have added at least 1 reviewer
• [x] I have tested this code
• [x] I have added sufficient documentation and/or updated documentation to reflect my changes

Additional comments

Please post additional comments in this section if you have them, otherwise delete it.

Description

Why returning a copy instead of a reference in the AsString method in struct Node ? String AsString() const { return std::get<String>(*this); } It's a good practice to return references instead of copies.

Is your feature request related to a problem? Please describe.

I'm frustrated because I can't return const references with my configuration because it's causing a warning during compilation.

Describe the solution you'd like

Return references or const references.

Description

This PR adds some doc for the target member of the Request structure. It also reorders the members so that it corresponds to the order it is in the HTTP request. It also renames the fields field to headers. For more explanations refer to the commits

Breaking changes

The order change of the structure members might break some structure constructions which rely on the order of the structure members. The name of the field fields changed to headers

Checklist

• [ ] I have assigned this PR to myself
• [ ] I have added at least 1 reviewer
• [x] I have tested this code
• [x] I have added sufficient documentation and/or updated documentation to reflect my changes

Description

it returns a Request 😢

class IResponseInputQueue {
public:
    virtual ~IResponseInputQueue() = default;

    virtual std::pair<Request, Context> Pop() = 0;

    [[nodiscard]] virtual std::size_t Size() const noexcept = 0;
};

Expected behaviour

it should return a Response

Proposed solution

class IResponseInputQueue {
public:
    virtual ~IResponseInputQueue() = default;

    virtual std::pair<Response, Context> Pop() = 0;

    [[nodiscard]] virtual std::size_t Size() const noexcept = 0;
};

Description

This pull request closes #18, closes #19, closes #20, closes #21, closes #22 and contains all changes made in version 3.0.0 of ZIAPI

Breaking Changes

• Update ziapi::Version class to match versioning system of the ZIAPI project
• Update ziapi::config::Node so that it uses smart pointers instead of raw pointers
  • Add MakeDict and MakeArray static factory methods
  • Drop constructors of ziapi::config::Node that use std::initializer_list
• Update ziapi::INetworkModule::Run() documentation. This call is now expected to be blocking

Additional Changes

• Add documentation on the set of standards and best practices for developing ZIAPI modules
• Bump dylib version from 1.7.1 to 1.8.1
• Improve issue templates and pull request templates
• Update documentation to reflect said changes
• Fix compilation warning

Checklist

• [X] I have assigned this PR to myself
• [X] I have added at least 1 reviewer
• [X] I have tested this code
• [X] I have added sufficient documentation in the code

[BUG] on peut mettre n'importe quoi comme key

Description

"client" = structure client

mais les modules des autres groupes n'implementeront pas la value "client" sous forme de structure.

A voir si on peut pas imposer une nome / faire un enum

histoire que tout le monde utilise la meme chose

voir meme utiliser un data type comme celui du json

[BUG] Warning on windows

Description

When compiling , a lot of warning C4458 appear due of same member name, and function parameters name.

Your environment

• OS: Windows
• Environement: Visual Studio 2019 (occure on higher version)
• Branch: main

Steps to reproduce

Warning appear at compilation time.

Expected behaviour

No warning should appear.

Actual behaviour

6 warning C4458 appear. (see Logs)

Logs

ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,25): warning C4458:  la déclaration de 'status_code' masque le membre de classe
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(38,10): message :  voir la déclaration de 'ziapi::http::Response::status_code'
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,62): warning C4458:  la déclaration de 'reason' masque le membre de classe
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(41,17): message :  voir la déclaration de 'ziapi::http::Response::reason'
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,92): warning C4458:  la déclaration de 'version' masque le membre de classe
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(35,13): message :  voir la déclaration de 'ziapi::http::Response::version'
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,25): warning C4458:  la déclaration de 'status_code' masque le membre de classe
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(38,10): message :  voir la déclaration de 'ziapi::http::Response::status_code'
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,62): warning C4458:  la déclaration de 'reason' masque le membre de classe
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(41,17): message :  voir la déclaration de 'ziapi::http::Response::reason'
ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(47,92): warning C4458:  la déclaration de 'version' masque le membre de classe
\ziapi-prefix\src\ziapi\include\ziapi\Http.hpp(35,13): message :  voir la déclaration de 'ziapi::http::Response::version'

Proposed solution

Change function parameters or member name.

Description

Please provide a detailed description of what was done in this PR.

Breaking changes

Please complete this section if any breaking changes have been made, otherwise delete it.

Additional Changes

Checklist

• [ ] I have assigned this PR to myself
• [ ] I have added at least 1 reviewer
• [ ] I have tested this code
• [ ] I have added sufficient documentation and/or updated documentation to reflect my changes

Additional comments

Please post additional comments in this section if you have them, otherwise delete it.

Description

Bonjour,

J'ai remarqué une erreur inadmissible dans le fichier 'HttpConstants.hpp'. Effectivement une coquille s'est glissée dans dans le namespace 'ziapi::http::reason'. La constexpr auto kConflicT = " Conflict" possède un T majuscule en dernier caractère de son nom. J'accepte de vous pardonner, si et seulement si le nom de cette constexpr est changé par kConflict. (avec un t minuscule)

Cordialement,

Login : [email protected] Membre de : Paris Anniversaire: 06/11/2001 Numéro de téléphone: +33 06 99 20 68 50 Localisation: 26 rue Gabriel Peri, Yerres, France (La cité de Ninho) GPA: 2.59