ESOUI - [outdated] GetNewSavedVars() mishandled optional namespace argument

ESOUI (https://www.esoui.com/forums/index.php)

- Bug Reports (https://www.esoui.com/forums/forumdisplay.php?f=187)

- - [outdated] GetNewSavedVars() mishandled optional namespace argument (https://www.esoui.com/forums/showthread.php?t=7956)

[outdated] GetNewSavedVars() mishandled optional namespace argument

Code:

ZO_SavedVars:New("TestSV",1,{},"TestProfile");

Running this despite an attempt to handle namespace as an optional argument causes an error in trying to access "TestProfile" as the defaults table instead of a string. This is caused by GetNewSavedVars() checking the wrong argument being nil.

EsoUI\Libraries\Utility\ZO_SavedVars.lua:143

Code:

if defaults == nil and type(namespace) == "table" then

defaults should at least be changed to profile since in this case, that's the argument that's nil.

Code:

if profile == nil and type(namespace) == "table" then

Preferably, there shouldn't be a check for nil there anyway since the following code block handles rearranging the arguments into the correct places. Stopping this from happening causes this error in the first place. The down side to removing this check? You ignore a value that should be discarded anyway.

Maybe I got you wrong but you tried to use namespace as an "optional argument". So why don't you just put nil in the correct place as you call the function?

Lua Code:

ZO_SavedVars:New("TestSV",1, nil, {},"TestProfile")

Edit:
Oh sorry just saw the lines 142ff in the sourcecode and now I understood what you are up to

Lua Code:

--namespace is an optional argument
    if defaults == nil and type(namespace) == "table" then
        profile = defaults
        defaults = namespace        
        namespace = nil
    end
    profile = profile or "Default"
    if type(profile) ~= "string" then
        error("Profile must be a string or nil")
    end

Here are the prameters of the function GetNewSavedVars from the live server:

Lua Code:

local function GetNewSavedVars(savedVariableTable, version, namespace, defaults, profile, displayName, characterName, characterId, characterKeyType)

Parameters of ZO_SavedVars:New()

Lua Code:

function ZO_SavedVars:New(savedVariableTable, version, namespace, defaults, profile, displayName, characterName, characterId, characterKeyType)

If you use ZO_SavedVars:New from your example:

Lua Code:

ZO_SavedVars:New("TestSV",1,{},"TestProfile")

savedVariableTable: "TestSV"
version: 1
namespace: {}
defaults: "TestProfile"
profile: nil

The syntax is also noted near the top of the file as:

Code:

local sv = ZO_SavedVars:New(savedVariableTable, version, [, namespace], defaults [, profile])

I actually discovered it by glancing over the code and found a spot that "didn't look right". The example, I made up by working backwards through the code to build a case where something follows the syntax for the API, but throws an error when run.