used the nginx lua code style. (#10)

* used the nginx lua code style for tracing context.

* fixed test cases.

* fixed

* fixed test cases

* fixed

* fixed code style of register.

* code style of segment.

* add test cases for segment ref.

* fixed

* fixed bug in TracingContext:drainAfterFinished

Co-authored-by: 吴晟 Wu Sheng <[email protected]>
Co-authored-by: Daming <[email protected]>

Author: wu-sheng

.gitignore

@@ -13,9 +13,10 @@ packages/
 /dist/
 /docker/snapshot/*.gz
 .mvn/wrapper/*.jar
-.factorypath  
-.vscode 
+.factorypath
+.vscode
 .checkstyle
 .externalToolBuilders
 /test/plugin/dist
 /test/plugin/workspace
+/t/servroot/

README.md

@@ -8,19 +8,19 @@ Apache SkyWalking Nginx Agent
 ![CI](https://github.com/apache/skywalking-nginx-lua/workflows/CI/badge.svg?branch=master)
 
 
-[**SkyWalking**](https://github.com/apache/skywalking) Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module. 
+[**SkyWalking**](https://github.com/apache/skywalking) Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module.
 
-This agent follows the SkyWalking tracing and header protocol. It reports tracing data to SkyWalking APM through HTTP protocol. 
+This agent follows the SkyWalking tracing and header protocol. It reports tracing data to SkyWalking APM through HTTP protocol.
 All HTTP 1.1 requests go through Nginx could be collected by this agent.
 
 # Setup Doc
 ```
 http {
     lua_package_path "/Path/to/.../skywalking-nginx-lua/lib/skywalking/?.lua;;";
 
-    # Buffer represents the register inform and the queue of the finished segment 
+    # Buffer represents the register inform and the queue of the finished segment
     lua_shared_dict tracing_buffer 100m;
-    
+
     # Init is the timer setter and keeper
     # Setup an infinite loop timer to do register and trace report.
     init_worker_by_lua_block {
@@ -112,13 +112,13 @@ The following APIs are for developers or using this lib out of the Nginx case.
 
 ## Tracing APIs at LUA level
 **TracingContext** is the entrance API for lua level tracing.
-- `TracingContext:new(serviceId, serviceInstID)`, create an active tracing context.
-- `TracingContext:newNoOP()`, create a no OP tracing context.
-- `TracingContext:drainAfterFinished()`, fetch the segment includes all finished spans.
+- `TracingContext.new(serviceId, serviceInstID)`, create an active tracing context.
+- `TracingContext.newNoOP()`, create a no OP tracing context.
+- `TracingContext.drainAfterFinished()`, fetch the segment includes all finished spans.
 
 Create 2 kinds of span
-- `TracingContext:createEntrySpan(operationName, parent, contextCarrier)`
-- `TracingContext:createExitSpan(operationName, parent, peer, contextCarrier)`
+- `TracingContext.createEntrySpan(operationName, parent, contextCarrier)`
+- `TracingContext.createExitSpan(operationName, parent, peer, contextCarrier)`
 
 
 # Download
@@ -131,4 +131,4 @@ Have no release yet.
 * QQ Group: 392443393(2000/2000, not available), 901167865(available)
 
 # License
-Apache 2.0
+Apache 2.0

lib/skywalking/client.lua

@@ -1,19 +1,19 @@
--- 
+--
 -- Licensed to the Apache Software Foundation (ASF) under one or more
 -- contributor license agreements.  See the NOTICE file distributed with
 -- this work for additional information regarding copyright ownership.
 -- The ASF licenses this file to You under the Apache License, Version 2.0
 -- (the "License"); you may not use this file except in compliance with
 -- the License.  You may obtain a copy of the License at
--- 
+--
 --    http://www.apache.org/licenses/LICENSE-2.0
--- 
+--
 -- Unless required by applicable law or agreed to in writing, software
 -- distributed under the License is distributed on an "AS IS" BASIS,
 -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 -- See the License for the specific language governing permissions and
 -- limitations under the License.
--- 
+--
 
 local Client = {}
 
@@ -78,9 +78,9 @@ function Client:registerService(metadata_buffer, backend_http_uri)
     local ERR = ngx.ERR
 
     local serviceName = metadata_buffer:get('serviceName')
-    
+
     local cjson = require('cjson')
-    local serviceRegister = require("register"):newServiceRegister(serviceName)
+    local serviceRegister = require("register").newServiceRegister(serviceName)
     local serviceRegisterParam = cjson.encode(serviceRegister)
 
     local http = require('resty.http')
@@ -102,7 +102,7 @@ function Client:registerService(metadata_buffer, backend_http_uri)
         for i, result in ipairs(registerResults)
         do
             if result.key == serviceName then
-                local serviceId = result.value 
+                local serviceId = result.value
                 log(DEBUG, "Service registered, service id = " .. serviceId)
                 metadata_buffer:set('serviceId', serviceId)
             end
@@ -122,9 +122,9 @@ function Client:registerServiceInstance(metadata_buffer, backend_http_uri)
     metadata_buffer:set('serviceInstanceUUID', serviceInstName)
 
     local cjson = require('cjson')
-    local serviceInstanceRegister = require("register"):newServiceInstanceRegister(
-        metadata_buffer:get('serviceId'), 
-        serviceInstName, 
+    local serviceInstanceRegister = require("register").newServiceInstanceRegister(
+        metadata_buffer:get('serviceId'),
+        serviceInstName,
         ngx.now() * 1000)
     local serviceInstanceRegisterParam = cjson.encode(serviceInstanceRegister)
 
@@ -146,7 +146,7 @@ function Client:registerServiceInstance(metadata_buffer, backend_http_uri)
             for i, result in ipairs(registerResults)
             do
                 if result.key == serviceInstName then
-                    local serviceId = result.value 
+                    local serviceId = result.value
                     log(DEBUG, "Service Instance registered, service instance id = " .. serviceId)
                     metadata_buffer:set('serviceInstId', serviceId)
                 end
@@ -166,9 +166,9 @@ function Client:ping(metadata_buffer, backend_http_uri)
     local ERR = ngx.ERR
 
     local cjson = require('cjson')
-    local pingPkg = require("register"):newServiceInstancePingPkg(
-        metadata_buffer:get('serviceInstId'), 
-        metadata_buffer:get('serviceInstanceUUID'), 
+    local pingPkg = require("register").newServiceInstancePingPkg(
+        metadata_buffer:get('serviceInstId'),
+        metadata_buffer:get('serviceInstanceUUID'),
         ngx.now() * 1000)
     local pingPkgParam = cjson.encode(pingPkg)
 
@@ -214,7 +214,7 @@ function Client:reportTraces(metadata_buffer, backend_http_uri)
                 ["Content-Type"] = "application/json",
             },
         })
-        
+
         if err == nil then
             if res.status ~= 200 then
                 log(ERR, "Segment report fails, response code " .. res.status)
@@ -235,4 +235,4 @@ function Client:reportTraces(metadata_buffer, backend_http_uri)
     end
 end
 
-return Client
+return Client

lib/skywalking/register.lua

@@ -1,28 +1,28 @@
--- 
+--
 -- Licensed to the Apache Software Foundation (ASF) under one or more
 -- contributor license agreements.  See the NOTICE file distributed with
 -- this work for additional information regarding copyright ownership.
 -- The ASF licenses this file to You under the Apache License, Version 2.0
 -- (the "License"); you may not use this file except in compliance with
 -- the License.  You may obtain a copy of the License at
--- 
+--
 --    http://www.apache.org/licenses/LICENSE-2.0
--- 
+--
 -- Unless required by applicable law or agreed to in writing, software
 -- distributed under the License is distributed on an "AS IS" BASIS,
 -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 -- See the License for the specific language governing permissions and
 -- limitations under the License.
--- 
+--
 
-local Register = {}
+local _M = {}
 
 -- Return Services as service register parameter
-function Register:newServiceRegister(unRegisterServiceName)
+function _M.newServiceRegister(unRegisterServiceName)
     local serv = {
         services = {}
     }
-    
+
     local service = {
         serviceName = unRegisterServiceName,
         -- Field type is optional, default value is `normal`
@@ -34,11 +34,11 @@ function Register:newServiceRegister(unRegisterServiceName)
     return serv
 end
 
-function Register:newServiceInstanceRegister(registeredServiceId, serviceInstUUID, registerTime)
+function _M.newServiceInstanceRegister(registeredServiceId, serviceInstUUID, registerTime)
     local serviceInstances = {
         instances = {}
     }
-    
+
     local serviceInstance = {
         serviceId = registeredServiceId,
         instanceUUID = serviceInstUUID,
@@ -53,7 +53,7 @@ function Register:newServiceInstanceRegister(registeredServiceId, serviceInstUUI
     return serviceInstances
 end
 
-function Register:newServiceInstancePingPkg(registeredServiceInstId, serviceInstUUID, updateTime)
+function _M.newServiceInstancePingPkg(registeredServiceInstId, serviceInstUUID, updateTime)
     local serviceInstancePingPkg = {
         serviceInstanceId = registeredServiceInstId,
         time = updateTime,
@@ -63,4 +63,4 @@ function Register:newServiceInstancePingPkg(registeredServiceInstId, serviceInst
     return serviceInstancePingPkg
 end
 
-return Register
+return _M

lib/skywalking/segment.lua

@@ -17,65 +17,49 @@
 
 -- Segment represents a finished tracing context
 -- Including all information to send to the SkyWalking OAP server.
-local Util = require('util')
+local Span = require('span')
 
-local Segment = {
-    trace_id,
-    segment_id,
-    service_id,
-    service_inst_id,
-    spans,
-}
+local _M = {}
+-- local Segment = {
+--     trace_id,
+--     segment_id,
+--     service_id,
+--     service_inst_id,
+--     spans,
+-- }
 
 -- Due to nesting relationship inside Segment/Span/TracingContext at the runtime,
 -- SegmentProtocol is created to prepare JSON format serialization.
 -- Following SkyWalking official trace protocol v2
 -- https://github.com/apache/skywalking-data-collect-protocol/blob/master/language-agent-v2/trace.proto
-local SegmentProtocol = {
-    globalTraceIds,
-    traceSegmentId,
-    serviceId,
-    serviceInstanceId,
-    spans,
-}
-
-function Segment:new()
-    local o = {}
-    setmetatable(o, self)
-    self.__index = self
-
-    return o
-end
-
-function SegmentProtocol:new()
-    local o = {}
-    setmetatable(o, self)
-    self.__index = self
-
-    o.globalTraceIds = {}
-
-    return o
-end
+-- local SegmentProtocol = {
+--     globalTraceIds,
+--     traceSegmentId,
+--     serviceId,
+--     serviceInstanceId,
+--     spans,
+-- }
 
 -- Return SegmentProtocol
-function Segment:transform()
-    local segmentBuilder = SegmentProtocol:new()
-    segmentBuilder.serviceId = self.service_id
-    segmentBuilder.globalTraceIds[1] = { idParts = self.trace_id}
-    segmentBuilder.traceSegmentId = { idParts = self.segment_id}
-    segmentBuilder.serviceId = self.service_id
-    segmentBuilder.serviceInstanceId = self.service_inst_id
+function _M.transform(segment)
+    local segmentBuilder = {}
+    segmentBuilder.serviceId = segment.service_id
+    segmentBuilder.globalTraceIds = {}
+    segmentBuilder.globalTraceIds[1] = {idParts = segment.trace_id}
+    segmentBuilder.traceSegmentId = {idParts = segment.segment_id}
+    segmentBuilder.serviceId = segment.service_id
+    segmentBuilder.serviceInstanceId = segment.service_inst_id
 
     segmentBuilder.spans = {}
 
-    if self.spans ~= nil and #self.spans > 0 then
-        for i, span in ipairs(self.spans)
-        do 
-            segmentBuilder.spans[#segmentBuilder.spans + 1] = span:transform()
+    if segment.spans ~= nil and #segment.spans > 0 then
+        for i, span in ipairs(segment.spans)
+        do
+            segmentBuilder.spans[#segmentBuilder.spans + 1] = Span.transform(span)
         end
     end
 
     return segmentBuilder
 end
 
-return Segment
+return _M