I upgraded keys from 6.x-1.1 to 6.x-1.2, which created a constant admin message that I needed to upgrade to Keys 2.0. So, I disabled and uninstalled keys 6.x-1.2, installed keys 6.x-2.0, and then tried my maps and... got the API key error message. Keys 6.x-2.0 doesn't work yet with gmap 6.x-1.0.

Why would you mark the module deprecated if it's replacement doesn't work yet?

Also, is it really not possible to have an upgrade path from 1.2 to 2.0? It's only 5 keys that I need to re-enter, but I need to do it first on my staging server to make sure that it works!

Also, why are there separate entries for gmap and Google Maps? Which one should I use?

Finally, would it be possible to at least create a readme.txt file, such as indicating what version of gmap its compatible with. And the fact that with 2.0 you need to enable the keys_ui module in addition to just keys?

Keys is a very useful module, and I appreciate your development of it, but I just wasted an hour on this upgrade, before downgrading back to 6.x-1.1 to avoid the deprecation messages and have things work correctly again.

Comments

greenskin’s picture

greenskin commented
Title: Don't upgrade to 6.x-1.2 or 6.x-2.0 » Upgrade to 6.x-1.2 or 6.x-2.0 issues

The original keys_api module had several fundamental issues starting with the module being called keys_api. I'm aware that the switch to module name 'keys' is not very elegant but due to the keys_api module having used functions with the namespace 'keys' I could not think of a better way at the time. Whenever I try to make it better, it feels like I am making it worse so I've elected to let it be and hope for the best. This was one of my first modules and I am now seeing the errors of my ways. A prime example to make sure one is doing it right the first time.

I've updated the release details for the 6.x-1.2 to help ensure people do not upgrade to it without knowing fully about the issues that it might bring. I am not aware of what modules, other than Gmap, that actually utilize the Keys module. So I cannot hold off the deprecation of the version 1 releases indefinitely. I have a patch submitted for Gmap that switches it from using 1.x to 2.x of Keys. #676108: Keys version 1 is deprecated. Switch to version 2.

I am terribly sorry for the inconvenience this has caused.

dankohn’s picture

dankohn commented

OK, I'm glad to hear that you are concerned. Let me make a few suggestions:

+ I would create a new patch for gmap that looks for the keys module, and then has an elsif looking for the keys_api module. That way, gmap becomes backward and forward compatible, and the two upgrades don't have to occur simultaneously.

+ Is it possible to have keys, as part of its installation, pull in the keys from the keys_api table? This is not essential.

+ Create a readme.txt explaining the steps of the upgrade. Post it on your main project page.

+ Can you figure out why I had both a gmap and a Google map option in keys 6.x-2.0? I'm happy to give you an account on staging, if you want?

+ I'm not aware of any other modules that use keys.

Thanks again.

dankohn’s picture

dankohn commented

OK, I got things working with keys 6.x-2.0. The steps were to:

1) Open /admin/settings/keys in a tab so I can see my current keys, which will need to be re-entered.
1) Disable, uninstall, and delete keys_api
2) Patch gmap.
3) Install keys.
4) Enable both keys and keys_ui.
5) Open /admin/settings/keys in a new tab and copy and paste keys from old tab to new one.

This was a pain, but at least it does work. I would recommend putting it in a readme. Thanks.