[#ADV-124] Conform all API calls to serverkey, which is what is actually used

Auctioneer

Conform all API calls to serverkey, which is what is actually used

Created: 06/Dec/07 10:08 AM Updated: 14/Dec/09 11:52 AM

Component/s:

API

Affects Version/s:

None

Fix Version/s:

None

Issue Links:

Blocks

This issue blocks:

ADV-135 Ability to see your faction and the opposite factions prices (in the Tool Tip) when you mouse over an item that has been scanned on both sides.

This issue is blocked by:

ADV-508 Modify API.QueryImage to use serverKey

~~ADV-431~~ Modify GetMatcherValue to use serverKey

~~SIMP-17~~ Modify StatSimple to use serverKey correctly

~~PURC-14~~ Modify StatPurchased to use serverKey correctly

~~ASAL-20~~ Modify StatSales to use serverKey correctly

Reference

This issue relates:

~~UCUT-29~~ Modify GetMatchArray to use serverKey

~~ADV-106~~ Wrong use of GetMarketValue in GetBestMatch

This issue is related to:

ADV-114 Provide API for requesting cross-faction or cross-realm-faction Price info

Description

« Hide

Many places in the module API call for {faction, realm} as arguments, when what is really passed, and used, is serverkey

All

Comments

Change History

Transitions

FishEye

Crucible

Sort Order:

[ Permalink | « Hide ]

dinesh added a comment - 22/Sep/08 11:52 AM

Is this even still an issue?

[ Permalink | « Hide ]

Ed Barton (RockSlice) added a comment - 01/Oct/08 07:35 PM

After a thorough search through the code, the only API function that uses the (faction, realm) in it's definition, or when called, is AucAdvanced.API.QueryImage(query, faction, realm, ...)

This function actually does need to have faction and realm specified separately, so the code is not misleading.

However, we may want to consider changing this to serverkey, for consistency.

[ Permalink | « Hide ]

Ed Barton (RockSlice) added a comment - 01/Oct/08 07:38 PM

removed search tag

[ Permalink | « Hide ]

Bryan (brykrys) added a comment - 06/Jan/09 06:09 AM

The API functions call certain functions from the Auc-Stat-* modules, particularly lib.GetItemPDF, lib.GetPriceArray, lib.GetPrice, lib.ClearItem

Many of these functions in the Auc-Stat-* files take (hyperlink, faction, realm) parameters. I had a quick look through to see (to put it bluntly) why we were not getting glaring errors all the time...

Some treat 'faction' as a serverKey (i.e. works correctly, but would be nice to change the names for clarity)
Some ignore the parameters passed and lookup the current realm/faction
One (Simple) still expects faction, realm - the only reason this doesn't break is that all the data is stored under AAStatSimpleData.RealmData[realm][serverKey] (I had to check my saved variables file before I would believe this...)

[ Permalink | « Hide ]

Bryan (brykrys) added a comment - 17/Mar/09 05:46 AM

The matching modules do not conform to serverKey either:
The GetMatchArray function does not take a serverKey parameter.
However both Undercut and BeanCounter matchers are based on current server data.

[ Permalink | « Hide ]

Nikk (Nechckn) added a comment - 12/Aug/09 03:35 AM

Verified in dev/Trunk: serverKey changes implemented and functioning for all statistics.

[ Permalink | « Hide ]

Bryan (brykrys) added a comment - 10/Nov/09 07:21 AM - edited

Reopened as incomplete - some API calls still not using serverKey at all (i.e. Matchers ~~ADV-431~~)

[ Permalink | « Hide ]

Bryan (brykrys) added a comment - 27/Nov/09 07:58 AM

Contrary to the above, I believe AucAdvanced.API.QueryImage(query, faction, realm, ...) does need to be converted to take serverKey
It may need to split the key, as Auc-Scandata currently stores its database in a [Realm][Faction] format - possibly this needs to be converted as well?
Looking into the code in CoreScan Auc-ScanData, I suspect there may be a bug which prevents other realm data from being accessed properly.

[ Permalink | « Hide ]

Esteban Santana Santana (MentalPower) added a comment - 27/Nov/09 07:20 PM

Enhancing this to critical since we really should be consistent with our API.

[ Permalink | « Hide ]

Bryan (brykrys) added a comment - 14/Dec/09 11:52 AM

We're almost done. Right now every API function should accept serverKey if appropriate.

Some blocker issues are still "unresolved" because they currently have temporary conversion code in place, and still need more work. However from the outside they should function correctly using serverKey.

It should now be "safe" to go ahead with writing code that uses serverKey, e.g. unblocking Appraiser's GetPrice and going ahead with ADV-135.