843457 - PROJECT environment variable is not honored when mod_perl is enabled

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, defect)

Description

[Michael Cronenworth]

User Agent: Mozilla/5.0 (X11; Linux x86_64; rv:18.0) Gecko/20100101 Firefox/18.0
Build ID: 20130206152940

Steps to reproduce:

I upgraded my fully functional Bugzilla 4.0 instance to 4.2. I had a Bugzilla setup using the PROJECT variable setup as defined by the official documentation for multiple Bugzilla instances. I have verified that the PROJECT variable is passed from Apache to Bugzilla so this is not an Apache bug.

http://www.bugzilla.org/docs/4.2/en/html/multiple-bz-dbs.html


Actual results:

The PROJECT variable is not honored by "checksetup.pl" or any other part of Bugzilla. Checksetup.pl created a /etc/bugzilla/localhost instead of /etc/bugzilla/localhost.$PROJECT and is not looking at my $PROJECT template directory.


Expected results:

Same functionality as Bugzilla 4.0 in that it looks at /etc/bugzilla/localhost.$PROJECT and uses my $PROJECT template directory.

Comment 1

[bigstijn]

See also bug 467324

Comment 2

[Michael Cronenworth]

I found the root cause for this bug.

In Bugzilla/Constants.pm, bz_locations() is being memoize'd and this causes environment variables to not be passed in the first time Bugzilla is loaded. I'm too Perl-ignorant to come up with a fix as removing memoize breaks Bugzilla and I'm not familiar with how to set an environment variable from the BEGIN block. If I hardcode the PROJECT environment variable inside the BEGIN block things work as expected.

This makes sense as Bugzilla 4.0 did not memoize bz_locations().

Comment 3

[Frédéric Buclin]

Looks like a regression due to bug 576670. Per bug 576670 comment 1:

* I noticed that bz_locations was getting called a lot, and it's really a constant, so I Memoize'd it. This is safe to do because its contents will never change, even under mod_perl.

But if PROJECT is set, the contents can change.

Comment 4

[Frédéric Buclin]

Instead of using Memoize, we could cache bz_locations(). I suppose Bugzilla->request_cache would be a good place for it.

Comment 5

[Frédéric Buclin]

http://perldoc.perl.org/Memoize.html#CAVEATS states that:

"Do not memoize a function whose behavior depends on program state other than its own arguments, such as global variables"

But bz_locations() depends on $ENV{'PROJECT'}. IMO, this is severe enough to be backported to 4.2.8.

Comment 6

[Frédéric Buclin]

Attachment: patch, v1

We cannot use Bugzilla->request_cache nor ->process_cache, because Bugzilla::Constants is called early in the installation process, when these caches are not yet available.

Comment 7

[Frédéric Buclin]

Attachment: patch, v1.1

I forgot to remove the global variable from _bz_locations().

Comment 8

[:glob ✱]

Comment on attachment 831513 [details] [diff] [review]
patch, v1.1

r=glob, nice

Comment 9

[Michael Cronenworth]

I can confirm the patch works for me. Thanks, Frédéric!

Comment 10

[Frédéric Buclin]

Committing to: bzr+ssh://[e-mail]/bugzilla/trunk/
modified Bugzilla/Constants.pm
Committed revision 8810.

Committing to: bzr+ssh://[e-mail]/bugzilla/4.4/
modified Bugzilla/Constants.pm
Committed revision 8636.

Committing to: bzr+ssh://[e-mail]/bugzilla/4.2/
modified Bugzilla/Constants.pm
Committed revision 8237.

Comment 11

[Frédéric Buclin]

Added to relnotes for 4.4.2.