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

Follow up ticket for v3 release #336

Closed
11 of 14 tasks
jptosso opened this issue Aug 18, 2022 · 11 comments
Closed
11 of 14 tasks

Follow up ticket for v3 release #336

jptosso opened this issue Aug 18, 2022 · 11 comments

Comments

@jptosso
Copy link
Member

jptosso commented Aug 18, 2022

This issue is meant to keep track of V3 alpha release issues

CC @fzipi @piyushroshan @anuraaga @Bxlxx @jcchavezs

Tasks

  • Variable engine rework (90%)
  • API refactor (90%)
    • Pending moving a few functions to internal and validating if we keep tx context
    • Moving tx metadata to types
  • Response body processor (50%)
    • Pieces are programmed, but there are some pending tests and connections
  • Refactor core interfaces for plugins (90%)
    • Some other types must be moved to types
  • 100% CRS compatibility
  • Implement custom dynamic variables (TIME, ENV, etc): 0%
  • Tinygo and WASM compatibility
  • Remove zap and create logging interface
  • Performance optimization
  • Create benchmarks between v2 and v3
  • Rework the rule error log mechanism
  • Expose Directive plugins api
  • Update documentation for coraza.io #810
  • Add more tests for rule exceptions (example: Wordpress exceptions for CRS)

High-Level breaking changes

  • waf.NewTransaction now receives a Context
  • seclang.NewParser will stop returning an error
  • tx.Collections now returns Collection objects. Raw data is not available anymore. Variables can be retrieved from tx.Variables.RemoteAddr

Milestone dates (Expected)

  • 09/09/2022: Tag v3.0.0-alpha.1
  • 09/09/2022: Add repository rules to v3/dev: 1 approver
  • 09/09/2022: Replace v2/master with v3/dev as the default branch
  • 14/10/2022: Tag v3.0.0-rc.1
  • 14/10/2022: Add repository rules to v3/dev: 2 approvers
  • 14/10/2022: Rename the v3/dev branch to v3/main and v2/master to v2/main
  • 18/11/2022: v3.0.0 stable release
@jptosso jptosso pinned this issue Aug 18, 2022
@jptosso jptosso changed the title Follow up ticket to release v3.0.0-alpha.1 Follow up ticket to release v3 release Aug 18, 2022
@jptosso jptosso changed the title Follow up ticket to release v3 release Follow up ticket for v3 release Aug 18, 2022
@anuraaga
Copy link
Contributor

If we go with current API, I think the proposed schedule makes sense. But if decide to go with #371, it will be a big change, and we may lump in other similar API changes at this chance. So if going with it, I believe we need 1 extra month, but no more. That would push back e.g., v3.0.0-alpha.1 to 07/10/2002. If not, let's stick to simple renames and the proposed schedule.

@github-actions
Copy link

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Oct 10, 2022
@github-actions
Copy link

This issue was closed because it has been inactive for 14 days since being marked as stale.

@jcchavezs jcchavezs reopened this Oct 24, 2022
@jcchavezs jcchavezs added the v3 label Oct 24, 2022
@jptosso jptosso removed the stale label Nov 3, 2022
@github-actions
Copy link

github-actions bot commented Dec 4, 2022

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Dec 4, 2022
@fzipi fzipi removed the stale label Dec 4, 2022
@jcchavezs jcchavezs removed the v3 label Dec 13, 2022
@sts
Copy link
Contributor

sts commented Dec 22, 2022

@fzipi
Copy link
Member

fzipi commented Dec 28, 2022

Do we know what is needed for the body processors mentioned here?

@github-actions
Copy link

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Jan 28, 2023
@jptosso jptosso removed the stale label Jan 28, 2023
@jptosso jptosso unpinned this issue Mar 9, 2023
@github-actions
Copy link

github-actions bot commented Apr 9, 2023

This issue is stale because it has been open for 30 days with no activity.

@github-actions github-actions bot added the stale label Apr 9, 2023
@github-actions
Copy link

This issue was closed because it has been inactive for 14 days since being marked as stale.

@hex-m
Copy link

hex-m commented Apr 23, 2023

This issue is linked on the very top of the website. This does not look good. Please reopen and give a status update or stop linking to this.

@fzipi fzipi removed the stale label Apr 24, 2023
@fzipi fzipi reopened this Apr 24, 2023
@jcchavezs
Copy link
Member

Closed as v3 is out.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants