@voxgig/sdkgen 4.32.0 → 4.33.0

package/project/.sdk/src/cmp/lua/Test_lua.ts

@@ -9,6 +9,7 @@ import { cmp, each, Folder, File, Content, entityCollection,
 
 import { TestEntity } from './TestEntity_lua'
 import { TestDirect } from './TestDirect_lua'
+import { TestClean } from './TestClean_lua'
 import { ReadmeExamplesTest } from './ReadmeExamplesTest_lua'
 
 
@@ -44,6 +45,8 @@ end)
       TestDirect({ target, entity })
     })
 
+    TestClean({ target })
+
     // README ```lua example snippets: syntax-check + offline run.
     ReadmeExamplesTest({ target })
   })

package/project/.sdk/src/cmp/lua/fragment/Entity.fragment.lua

@@ -1,5 +1,6 @@
 -- ProjectName SDK EntityName entity
 
+local json = require("dkjson")
 local vs = require("utility.struct.struct")
 local helpers = require("core.helpers")
 
@@ -42,6 +43,26 @@ function EntyClass:get_name()
 end
 
 
+-- The entity serialises and prints as its data, as ts does: the instance
+-- also holds the client, the utility and a match that can carry a query
+-- credential.
+function EntyClass:to_record()
+  local rec = self._utility.clean(self._entctx, vs.clone(self._data or {}))
+  rec["voxgig$entity"] = self._name
+  return rec
+end
+
+EntyClass.__tostring = function(self)
+  local rec = self:to_record()
+  rec["voxgig$entity"] = nil
+  return self._name .. " " .. json.encode(rec)
+end
+
+EntyClass.__tojson = function(self)
+  return json.encode(self:to_record())
+end
+
+
 function EntyClass:make()
   local opts = {}
   for k, v in pairs(self._entopts) do
@@ -151,7 +172,7 @@ function EntyClass:stream(action, args, callopts)
     return false
   end
 
-  return coroutine.wrap(function()
+  local co = coroutine.create(function()
     utility.feature_hook(ctx, "PrePoint")
     local point, err = utility.make_point(ctx)
     ctx.out["point"] = point
@@ -202,6 +223,8 @@ function EntyClass:stream(action, args, callopts)
       stream_fn = result.stream
     end
     if type(stream_fn) == "function" then
+      -- done() does not run on this path, so its record is cleaned here.
+      utility.clean_explain(ctx)
       for item in stream_fn() do
         if aborted() then
           return
@@ -226,6 +249,27 @@ function EntyClass:stream(action, args, callopts)
       end
     end
   end)
+
+  -- An error raised while the caller iterates leaves through the same catch
+  -- path as an operation's. A step's error ends the stream silently, so the
+  -- record is cleaned whenever the stream ends.
+  return function()
+    if coroutine.status(co) == "dead" then
+      return nil
+    end
+    local ok, item = coroutine.resume(co)
+    if ok then
+      if coroutine.status(co) == "dead" then
+        utility.clean_explain(ctx)
+      end
+      return item
+    end
+    local err = self:_unexpected(ctx, item)
+    if err ~= nil then
+      error(err, 0)
+    end
+    return nil
+  end
 end
 
 
@@ -240,7 +284,39 @@ end
 -- #RemoveOp
 
 
+-- A hook, fetcher or parser that raises never reaches make_error: its error
+-- leaves cleaned, and so does the explain record it interrupted.
 function EntyClass:_run_op(ctx, post_done)
+  local ok, out, err = pcall(self._run_steps, self, ctx, post_done)
+  if ok then
+    return out, err
+  end
+  return nil, self:_unexpected(ctx, out)
+end
+
+
+-- The raised error, cleaned; nil when the caller switched throwing off.
+function EntyClass:_unexpected(ctx, raised)
+  local clean = self._utility.clean
+  local cleanerr = clean(ctx, raised)
+  ctx.ctrl.err = cleanerr
+
+  local explain = ctx.ctrl.explain
+  if type(explain) == "table" then
+    self._utility.clean_explain(ctx)
+    if explain.err == nil then
+      explain.err = { message = type(cleanerr) == "table" and cleanerr.msg or tostring(cleanerr) }
+    end
+  end
+
+  if ctx.ctrl.throw_err == false then
+    return nil
+  end
+  return cleanerr
+end
+
+
+function EntyClass:_run_steps(ctx, post_done)
   local utility = self._utility
 
   -- #PrePoint-Hook

package/project/.sdk/src/cmp/lua/fragment/Main.fragment.lua

@@ -1,5 +1,6 @@
 -- ProjectName SDK
 
+local json = require("dkjson")
 local vs = require("utility.struct.struct")
 local Utility = require("core.utility_type")
 local Spec = require("core.spec")
@@ -16,7 +17,53 @@ local features_factory = require("features")
 
 
 local ProjectNameSDK = {}
-ProjectNameSDK.__index = ProjectNameSDK
+
+-- The options and the root context both hold the credential. They live in
+-- a side table rather than in the client, so a dump or an encoder walking
+-- the client's fields never reaches them; `sdk.options` still reads and
+-- writes through the metamethods, and options_map() is the documented way
+-- to read the credential back.
+local HIDDEN = { options = true, _rootctx = true }
+local SLOTS = setmetatable({}, { __mode = "k" })
+
+ProjectNameSDK.__index = function(self, key)
+  local member = rawget(ProjectNameSDK, key)
+  if member ~= nil then
+    return member
+  end
+  if HIDDEN[key] then
+    local slots = SLOTS[self]
+    return slots ~= nil and slots[key] or nil
+  end
+  return nil
+end
+
+ProjectNameSDK.__newindex = function(self, key, val)
+  if HIDDEN[key] then
+    local slots = SLOTS[self]
+    if slots == nil then
+      slots = {}
+      SLOTS[self] = slots
+    end
+    slots[key] = val
+  else
+    rawset(self, key, val)
+  end
+end
+
+-- The client's own record: what a serialiser or clean's snapshot sees in
+-- place of the client, so neither reaches the options through it.
+function ProjectNameSDK:to_record()
+  return { sdk = "ProjectName", mode = self.mode }
+end
+
+ProjectNameSDK.__tostring = function(self)
+  return "ProjectNameSDK mode=" .. tostring(self.mode)
+end
+
+ProjectNameSDK.__tojson = function(self)
+  return json.encode(self:to_record())
+end
 
 
 local function _make_feature(name)
@@ -243,7 +290,7 @@ function ProjectNameSDK:_raw_request(fetchargs)
   local fetched, fetch_err = utility.fetcher(ctx, url, fetchdef)
 
   if fetch_err ~= nil then
-    return { ok = false, err = fetch_err }, nil
+    return { ok = false, err = utility.clean(ctx, fetch_err) }, nil
   end
 
   if fetched == nil then

package/project/.sdk/src/cmp/ocaml/Entity_ocaml.ts

@@ -136,12 +136,13 @@ let rec make (client : sdk_client) (entopts_in : value) : entity_obj =
       ignore (run_op ctx (fun () -> ()));
       let signal = getp callopts "signal" in
       let aborted () = match signal with Func _ -> call_json signal = Bool true | _ -> false in
-      let raw = (match ctx.c_result with
+      (* A feature's stream runs after run_op returns, so it leaves the same way. *)
+      let raw = (try (match ctx.c_result with
           | Some result ->
             (match result.rt_stream with
              | Some fn -> fn ()
              | None -> (match result.rt_resdata with List r -> !r | v when is_nullish v -> [] | v -> [v]))
-          | None -> []) in
+          | None -> []) with e -> unexpected ctx e) in
       let rec seq_of l () = match l with
         | [] -> Seq.Nil
         | x :: rest -> if aborted () then Seq.Nil else Seq.Cons (x, seq_of rest) in

package/project/.sdk/src/cmp/ocaml/PrepareAuth_ocaml.ts

@@ -131,7 +131,7 @@ function renderHeader(spec: AuthSpec, head: string): string {
 let option_apikey = "apikey"
 ${spec.basic ? `let option_secret = "secret"
 ` : ''}let not_found = "__NOTFOUND__"
-` + (spec.basic ? BASE64 : '') + `
+
 let prepare_auth_util (ctx : ctx) : (spec option * sdk_error option) =
   match ctx.c_spec with
   | None -> (None, Some (ctx_make_error ctx "auth_no_spec" "Expected context spec property to be defined."))
@@ -272,6 +272,9 @@ const BASIC = `       if (match getpath_s options "auth.basic" with Bool b -> b
            let apikey_val = match apikey with Str s -> s | _ -> "" in
            let secret_val = if no_secret then "" else match secret with Str s -> s | _ -> "" in
            let joined = base64_encode (apikey_val ^ ":" ^ secret_val) in
+           (* The joined, encoded pair is a wire form neither credential's
+            * own registration covers. base64_encode is Sdk_helpers'. *)
+           (cu ctx).u_clean_add ctx joined;
            setp headers cred_name
              (Str (if auth_prefix <> "" then auth_prefix ^ " " ^ joined else joined))
          end
@@ -280,30 +283,6 @@ const BASIC = `       if (match getpath_s options "auth.basic" with Bool b -> b
 `
 
 
-const BASE64 = `
-let b64_alphabet =
-  "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
-
-let base64_encode (text : string) : string =
-  let n = String.length text in
-  let buf = Buffer.create (((n + 2) / 3) * 4) in
-  let i = ref 0 in
-  while !i < n do
-    let rest = n - !i in
-    let a = Char.code text.[!i] in
-    let b = if 1 < rest then Char.code text.[!i + 1] else 0 in
-    let c = if 2 < rest then Char.code text.[!i + 2] else 0 in
-    let word = (a lsl 16) lor (b lsl 8) lor c in
-    Buffer.add_char buf b64_alphabet.[(word lsr 18) land 0x3f];
-    Buffer.add_char buf b64_alphabet.[(word lsr 12) land 0x3f];
-    (* One trailing source byte yields two characters and "==", two yield
-     * three and "=". *)
-    Buffer.add_char buf (if 1 < rest then b64_alphabet.[(word lsr 6) land 0x3f] else '=');
-    Buffer.add_char buf (if 2 < rest then b64_alphabet.[word land 0x3f] else '=');
-    i := !i + 3
-  done;
-  Buffer.contents buf
-`
 
 
 export {