Add samples of JS plugins extending or reusing code from other plugins

[bovino]

Adding samples of JS plugins extending or reusing code from other plugins would be nice to promote the idea of code reuse and extensibility in the same way we see in some of the Lua plugins with ":extend()" from Lua.

Considering that the JS plugins probably will not be able to extend the Kong core plugins (given they are written in Lua) , at least promoting code reuse and extensibility between the JS plugins would be a welcome idea.

[fffonion]

@bovino I guess that's a generic question on how to reuse code in javascript. Is there a specific use case you looking for?

[bovino]

i would like to see plugin samples available showing how to perform code reuse beetweb two custom JS plugins... or better yet, samples showing a similar capability we have in Lua where one plugin can directly extend another (not sure if this can be done with JS plugins)

if this helps, i can describe some "specific" scenario as follows:

JS plugin 1 - a basic validation plugin (supports validation only on header field and path variables)
JS plugin 2 - the "advanced" or "extended" version of the basic validation plugin, that extends the parent plugin and add a few more validation capabilities (allows you to apply validation on query params and body content)

i can think of some better scenarios if this is not good enough as a starting point :-)

thanks for your work

[esatterwhite]

this is pretty easy to do if following the plugin conventions in the examples. The only thing to work around really is name collisions.

'use strict'

// Extending local a plugin

const {Plugin: LocalPlugin, Schema: LocalSchema} = require('./local-plugin')
const {version: Version} = require('./package.json')

class Plugin extends LocalPlugin {
  constructor(config) {
    super(config)
    // other setup code
  }

  async access(kong) {
    // logic
    // logic
    return super.access(kong)
  }
}

module.exports = {
  Plugin
, Version
, Priority: 0
, Schema: [
    ...LocalSchema
  , {foo: {type: 'string'}}
  ]
}

---

'use strict'

// Extending a plugin from npm package

const {Plugin: KongPlugin, Schema: KongSchema} = require('@myorg/kong-plugin')
const {version: Version} = require('./package.json')

class Plugin extends KongPlugin {
  constructor(config) {
    super(config)
    // other setup code
  }

  async access(kong) {
    // logic
    // logic
    return super.access(kong)
  }
}

module.exports = {
  Plugin
, Version
, Priority: 0
, Schema: [
    ...KongSchema
  , {foo: {type: 'string'}}
  ]
}

[hanshuebner]

We don't currently have plans to add these types of examples to our documentation, but feel free to open a PR if you have specific suggestions.

[esatterwhite]

Is this project being abandoned?

[hanshuebner]

Is this project being abandoned?

We don't currently have plans to add these specific documentation enhancements, but we also don't plan to abandon this project. As per my review of yesterday, it seems that there are a couple of outstanding documentation items as well as enhancements that could be made. At this point, though, we don't have customers asking for these enhancements. We would certainly be interested in contributions in that regard.