refactor(core) using new events library #8715

chronolaw · 2022-04-22T02:38:08Z

Summary

Now we have a new event libaray, let's try to introduce it to replace lua-resty-worker-events.

This PR is closed, we have an equivalent PR #8890, please check it.

Full changelog

Modify init_worker_events in global.lua, switch to new events library.
Modify templates/nginx_kong.lua, add unix listening
Modify templates/kong_defaults.lua, add config legacy_worker_events
Add a temporary kong/resty/healthcheck.lua to use resty.events.compat
Modify test cases to pass ci, wrap them with wait_until()

Notice

Temporary kong/resty/healthcheck.lua should be replaced by a formal version.
Flaky test 02-integration/05-proxy/10-balancer/01-healthchecks_spec.lua now is fixed.

kikito · 2022-06-01T22:59:53Z

.github/workflows/build_and_test.yml

@@ -31,7 +31,7 @@ jobs:
      with:
        repository: Kong/kong-build-tools
        path: kong-build-tools
-        ref: master
+        ref: feat/new_resty_events


This will almost certainly have to be changed before we can merge it, so leaving this comment as a reminder.

kikito · 2022-06-01T23:00:19Z

.requirements

@@ -7,6 +7,7 @@ RESTY_LUAROCKS_VERSION=3.8.0
 RESTY_OPENSSL_VERSION=1.1.1n
 RESTY_PCRE_VERSION=8.45
 RESTY_LMDB_VERSION=master
+RESTY_EVENTS_VERSION=dev


Same: we'll have to make a resty events release and change this before merging.

now it is main

kikito · 2022-06-01T23:01:36Z

kong-2.8.0-0.rockspec

@@ -484,6 +484,9 @@ build = {
    ["kong.plugins.azure-functions.handler"] = "kong/plugins/azure-functions/handler.lua",
    ["kong.plugins.azure-functions.schema"]  = "kong/plugins/azure-functions/schema.lua",

+    -- XXX: test only


So, remove before merging?

Yes, Vini is working on new version health check library.

kikito · 2022-06-01T23:02:22Z

kong/conf_loader/init.lua

  lmdb_environment_path = { typ = "string" },
  lmdb_map_size = { typ = "string" },
+
+  opentelemetry_tracing = { typ = "array" },


It seems that opentelemetry_tracing_* was included by mistake

I did it just for solving the merge conflict.

#8890 fix it.

kikito · 2022-06-01T23:04:15Z

kong/global.lua

+      wait_max = 0.5,         -- max wait time before discarding event
+    }
+
+    worker_events = require "resty.worker.events"


I'd rather have the two requires at the top of the file, even if that means having to use some temp var names here.

worker_events will not work correctly if required at the top of the file, It must be required right here, inside the init function

kikito · 2022-06-01T23:06:52Z

kong/templates/kong_defaults.lua

+opentelemetry_tracing = off
+opentelemetry_tracing_sampling_rate = 1.0


Should opentelemetry_tracing* be here?

just for solving the merge conflict.

#8890 fix it.

kikito · 2022-06-01T23:09:21Z

spec/02-integration/02-cmd/02-start_stop_spec.lua

@@ -351,7 +352,8 @@ describe("kong start/stop #" .. strategy, function()
        path = "/hello",
      })
      assert.res_status(404, res) -- no Route configured
-      assert(helpers.stop_kong(helpers.test_conf.prefix))
+      --assert(helpers.stop_kong(helpers.test_conf.prefix))
+      assert(helpers.kong_exec("quit --prefix " .. helpers.test_conf.prefix))


Perhaps we should change stop_kong using quit.

Likely a bit slower, but it might help with flakyness (less dangling requests).

maybe in another PR, not this?

kikito · 2022-06-01T23:10:30Z

spec/02-integration/02-cmd/12-hybrid_spec.lua

@@ -129,6 +129,7 @@ for _, strategy in helpers.each_strategy() do
          cluster_control_plane = "127.0.0.1:9005",
          proxy_listen = "0.0.0.0:9002",
        }))
+        ngx.sleep(0.2)   -- wait for 'pids/nginx.pid'


I think this could be done with a wait_until that checks that the pid file exists.

kikito · 2022-06-01T23:12:04Z

spec/02-integration/05-proxy/01-proxy_spec.lua

@@ -43,7 +43,8 @@ describe("Proxy interface listeners", function()
      proxy_listen = "off",
      admin_listen = "0.0.0.0:9001",
    }))
-    assert.equals(1, count_server_blocks(helpers.test_conf.nginx_kong_conf))
+    assert.equals(2, count_server_blocks(helpers.test_conf.nginx_kong_conf))
+    --assert.equals(1, count_server_blocks(helpers.test_conf.nginx_kong_conf))


Leaving the old lines as comments doesn't make it more clear to me, I suggest removing.

kikito · 2022-06-01T23:13:01Z

spec/02-integration/05-proxy/06-ssl_spec.lua

@@ -212,6 +212,8 @@ for _, strategy in helpers.each_strategy() do
        nginx_http_proxy_ssl_trusted_certificate = "../spec/fixtures/kong_spec.crt",
      })

+      ngx.sleep(0.01)


Why is this one needed?

We need some time to wait for event broker/client to establish unix domain socket connect.

chronolaw · 2022-06-02T07:02:44Z

The master branch has too many changes, it is hard to rebase to this PR.

I create a new PR #8890, let's talk there.

chronolaw added 30 commits March 31, 2022 20:55

events frame/protocol

e241f6d

callback.lua

b6afdb5

broker.lua

2b5c72b

client.lua

aead4cf

client.lua

757b533

default opts for broker

619b07d

post local event

30be16b

code clean for queue

7576479

poll simulate

1f76e6c

clean broker

2ac81a4

clean worker

3752d72

change worker events in global.lua

06e281f

add worker events server in template

9e7576a

add event config

47fc24b

nginx kong template

d660e81

add events code into rockspec

e09b7f8

code clean

6139960

code clean

ba458db

add config entry

2e32759

localize assert

18f5143

move events code to another repo

0a629fe

fix broker in template

b9b6dd0

try run github ci

5dd74ce

stream supports events

606021d

use unified resty.events

ca3a618

change config params

997ec27

add resty events in requirements

489e184

fix rebase error

4280adc

conf events mechanism

e8b8468

edit custom_nginx.template

360c0b5

chronolaw added 8 commits May 11, 2022 10:31

clean 03-integration_spec.lua

4990387

clean 02-access_spec.lua

87c2f15

clean 01-healthchecks_spec.lua

c7b5444

clean 04-plugins_triggering_spec.lua

311fa25

clean 01-healthchecks_spec.lua

c31866a

clean 02-core_entities_invalidations_spec.lua

690d99c

try flaky in 01-healthchecks_spec.lua

5a90e34

01-healthchecks_spec.lua is still flaky

99a3350

chronolaw added this to the 3.0 milestone May 12, 2022

chronolaw force-pushed the feat/new_events branch from e86be69 to 99a3350 Compare May 20, 2022 10:29

chronolaw and others added 2 commits May 21, 2022 11:49

sync up master

a4afde5

tests(healthchecks) fix flaky 401 test (#8839)

58bde7a

jschmid1 mentioned this pull request May 23, 2022

chore(conf): deprecate <strict> worker_consistency #8842

Merged

chronolaw added 8 commits May 30, 2022 21:37

update 02-start_stop_spec.lua

8681de3

update kong_defaults.lua

7f46e85

update kong_defaults.lua

b2a67a1

update kong_defaults.lua

374120e

fix event repo branch

523f084

fix build-tools

0c4bd5c

fix build-tools

2fb901b

remove singletons

0701841

kikito reviewed Jun 1, 2022

View reviewed changes

change events library to main branch

22fb057

chronolaw force-pushed the feat/new_events branch from acbf303 to 22fb057 Compare June 2, 2022 01:59

fix 05-proxy/02-router_spec.lua

408ca0a

chronolaw mentioned this pull request Jun 2, 2022

refactor(core) integrate new events library #8890

Merged

chronolaw closed this Jun 2, 2022

mayocream removed this from the 3.0 milestone Jun 7, 2022

hbagdi deleted the feat/new_events branch October 26, 2022 18:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(core) using new events library #8715

refactor(core) using new events library #8715

chronolaw commented Apr 22, 2022 •

edited

Loading

kikito Jun 1, 2022

kikito Jun 1, 2022

chronolaw Jun 2, 2022

kikito Jun 1, 2022

chronolaw Jun 1, 2022

kikito Jun 1, 2022

chronolaw Jun 1, 2022

chronolaw Jun 2, 2022

kikito Jun 1, 2022

chronolaw Jun 2, 2022

kikito Jun 1, 2022

chronolaw Jun 1, 2022

chronolaw Jun 2, 2022

kikito Jun 1, 2022

chronolaw Jun 2, 2022

kikito Jun 1, 2022

kikito Jun 1, 2022

chronolaw Jun 1, 2022

kikito Jun 1, 2022

chronolaw Jun 1, 2022

chronolaw commented Jun 2, 2022

		opentelemetry_tracing = off
		opentelemetry_tracing_sampling_rate = 1.0

refactor(core) using new events library #8715

refactor(core) using new events library #8715

Conversation

chronolaw commented Apr 22, 2022 • edited Loading

Summary

Full changelog

Notice

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chronolaw commented Jun 2, 2022

chronolaw commented Apr 22, 2022 •

edited

Loading