How to skip the plugins

[renshunhang]

I have developed two custom plugins and configured them in a route. If I want to stop executing the other plugins configured in the route when the first plugin is executed based on the value of a certain parameter, how can I do that?

[dosubot[bot]]

To stop executing other plugins when the first custom plugin is executed based on a certain parameter, you can use the ext.go({stop = true}) function in the content_by_lua_block. This function is part of the lib.ext-plugin module and halts further plugin execution.

Here's an example configuration:

server {
    listen unix:$TEST_NGINX_HTML_DIR/nginx.sock;

    content_by_lua_block {
        local ext = require("lib.ext-plugin")
        ext.go({stop = true})
    }
}

This setup will stop the execution of subsequent plugins when the stop parameter is set to true ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[mikyll]

Hi @renshunhang

I have developed two custom plugins and configured them in a route. If I want to stop executing the other plugins configured in the route when the first plugin is executed based on the value of a certain parameter, how can I do that?

You can do so by using the request context.

I suggest you to have a look at this blog post: Down the rabbit hole of an Apache APISIX plugin.

Example

File plugin1.lua:

local _M = {
    version = 0.1,
    priority = 200,
    name = "plugin1",
}

function _M.rewrite(conf, ctx)
  -- do something
  
  ctx.my_custom_var = true
end

File plugin2.lua:

local _M = {
    version = 0.1,
    priority = 100,
    name = "plugin2",
}

function _M.rewrite(conf, ctx)
  if ctx.my_custom_var then
      -- plugin1 executed! Do something more

      ctx.my_custom_var = nil
  fi
end