Use FriendlyNames

[mmorel-35]

Stores ID and Names for entities in memDB to print friendly names in logs
Fixes #417

[codecov-commenter]

Codecov Report

Merging #459 (8543e06) into main (46b074e) will decrease coverage by 0.44%.
The diff coverage is 31.89%.

@@            Coverage Diff             @@
##             main     #459      +/-   ##
==========================================
- Coverage   50.29%   49.85%   -0.45%     
==========================================
  Files          72       72              
  Lines        5700     7905    +2205     
==========================================
+ Hits         2867     3941    +1074     
- Misses       2501     3608    +1107     
- Partials      332      356      +24     

Impacted Files	Coverage Δ
state/builder.go	0.00% <0.00%> (ø)
state/types.go	71.00% <47.19%> (-2.43%)	⬇️
file/builder.go	55.45% <50.00%> (+3.38%)	⬆️
state/rbac_endpoint_permission.go	71.31% <100.00%> (+0.20%)	⬆️
diff/diff_helpers.go	60.65% <0.00%> (-6.02%)	⬇️
cmd/reset.go	22.50% <0.00%> (-4.92%)	⬇️
cmd/dump.go	21.18% <0.00%> (-4.63%)	⬇️
cmd/convert.go	38.70% <0.00%> (-3.60%)	⬇️
utils/defaulter.go	71.42% <0.00%> (-2.77%)	⬇️
cmd/validate.go	20.00% <0.00%> (-2.59%)	⬇️
... and 66 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 46b074e...8543e06. Read the comment docs.

[carnei-ro]

Nice features! I just built and tested here and it seems to always present a "diff" adding the property "name".

DECK_MY_VAR=bar /tmp/deck/deck diff -s kong.yml

updating route httpbin  {
   "https_redirect_status_code": 426,
   "id": "ca017d00-c80a-4831-b69c-c975fdef3509",
   "name": "httpbin",
   "path_handling": "v0",
   "paths": [
     "/"
   ],
   "preserve_host": false,
   "protocols": [
     "http",
     "https"
   ],
   "regex_priority": 1,
   "service": {
     "id": "0567f908-7a05-42eb-b53a-a7500c0f7427"
+    "name": "httpbin"
   },
   "strip_path": false
 }

updating plugin pre-function for route httpbin  {
   "config": {
     "access": [
       "return kong.response.exit(200, {["msg"] = "hello from my function" }, {['x-kong-function'] = '[masked]'})
"
     ],
     "body_filter": [
     ],
     "certificate": [
     ],
     "functions": [
     ],
     "header_filter": [
     ],
     "log": [
     ],
     "rewrite": [
     ]
   },
   "enabled": true,
   "id": "49fe5c3a-779a-4a5f-a1b5-f6de9146fc1b",
   "name": "pre-function",
   "protocols": [
     "http",
     "https"
   ],
   "route": {
     "id": "ca017d00-c80a-4831-b69c-c975fdef3509"
+    "name": "httpbin"
   }
 }

Summary:
  Created: 0
  Updated: 2
  Deleted: 0

kong.yml:

---
_format_version: "1.1"

services:
- name: httpbin
  url: https://httpbin.org/anything
  retries: 5
  routes:
  - path_handling: v0
    protocols: 
      - http
      - https
    https_redirect_status_code: 426
    name: httpbin
    paths:
    - /
    preserve_host: false
    regex_priority: 1
    strip_path: false
    plugins:
      - name: pre-function
        enabled: true
        protocols: 
          - http
          - https
        config:
          body_filter: []
          certificate: []
          header_filter: []
          log: []
          rewrite: []
          functions: []
          access:
            - |
              return kong.response.exit(200, {["msg"] = "hello from my function" }, {['x-kong-function'] = '${{ env "DECK_MY_VAR" }}'})

[mmorel-35]

I see, the names are not loaded on the dump part. I'm not sure what is right way to do this.
@kong/team-k8s, any idea?

[mmorel-35]

I think modifying the state/builder.go to integrate Names shall do the trick

[mmorel-35]

@carnei-ro would you mind trying this latest version ?

[carnei-ro]

@mmorel-35 It seems to be working as expected!

[mmorel-35]

Hi @hbagdi @mflendrich , any updates an this pull-request ?

[hbagdi]

Name is not a required field for Route or Service.
Please guard dereferences with a nil check. The same applies to consumer because, at runtime, it may happen that the object may not have username (even though it is a required field).

[hbagdi]

This PR is too big and touches different aspects of code - it is very hard to review carefully.
Please break it down into smaller digestible and logical pieces.

There are significant nil exceptions that are written all over the code as well - so please take care of those.

[GGabriele]

Hi @mmorel-35 , are you still working on this? Any updates since the last request for changes?

[mmorel-35]

Hi @GGabriele , I'm sorry I couldn't find the time to work on this lately. I don't know when I'll be able to get back on this so feel free to take it over from now.

[nwsparks]

would be pretty huge to get this available 🙏 the diffs are borderline useless in a lot of cases without this.

[GGabriele]

@mmorel-35 thanks a LOT for your contribution! I've picked it and merged it in #662

[mmorel-35]

Thank you @GGabriele 👍🏻 !!!