Summary

Add a get_data_dir() function, and proper developer-mode data management.

Review Request #13168 — Created July 31, 2023 and submitted Aug. 7, 2023, 12:53 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This introduces reviewboard.admin.server.get_data_dir(), which returns
the the absolute path to the data directory.

In practice, this is always $HOME, whether in production or
development. This is important, as much of the state stored and accessed
in this directory is SCM-specific, which hard-code $HOME. However,
that also means that for development, state gets written to the user's
$HOME, but that's not a new problem.

Our checks have been updated to use this, and some upcoming code will be
using this as well.

Testing Done

Unit tests pass.

Made sure that startup checks still work.

Made use of this in some in-progress code.

Commits

Summary	ID
Add a get_data_dir() function, and proper developer-mode data management. This introduces `reviewboard.admin.server.get_data_dir()`, which returns the the absolute path to the data directory. In practice, this is always `$HOME`, whether in production or development. This is important, as much of the state stored and accessed in this directory is SCM-specific, which hard-code `$HOME`. However, that also means that for development, state gets written to the user's `$HOME`, but that's not a new problem. Our checks have been updated to use this, and some upcoming code will be using this as well.	52370a62743d077a440d7e567380d0e77fdbfa7b

Summary

Add a get_data_dir() function, and proper developer-mode data management.

This introduces `reviewboard.admin.server.get_data_dir()`, which returns the the absolute path to the data directory. In practice, this is always `$HOME`, whether in production or development. This is important, as much of the state stored and accessed in this directory is SCM-specific, which hard-code `$HOME`. However, that also means that for development, state gets written to the user's `$HOME`, but that's not a new problem. Our checks have been updated to use this, and some upcoming code will be using this as well.

52370a62743d077a440d7e567380d0e77fdbfa7b

Issues

Description	From	Last Updated
'django.conf.settings' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 2, 2023, 1:26 a.m.
'reviewboard' imported but unused Column: 1 Error code: F401	reviewbot	Aug. 2, 2023, 1:26 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/admin/server.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'django.conf.settings' imported but unused

Column: 1
Error code: F401
```
reviewboard/admin/server.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'reviewboard' imported but unused

Column: 1
Error code: F401
```

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Add a get_data_dir() function, and proper developer-mode data management. This introduces `reviewboard.admin.server.get_data_dir()`, which returns the the absolute path to the data directory. In practice, this is always `$HOME`, whether in production or development. This is important, as much of the state stored and accessed in this directory is SCM-specific, which hard-code `$HOME`. However, that also means that for development, state gets written to the user's `$HOME`, but that's not a new problem. Our checks have been updated to use this, and some upcoming code will be using this as well.	e4dc3c1217b7c3ee4f49f3897ba8324ac58c70b8
	Add a get_data_dir() function, and proper developer-mode data management. This introduces `reviewboard.admin.server.get_data_dir()`, which returns the the absolute path to the data directory. In practice, this is always `$HOME`, whether in production or development. This is important, as much of the state stored and accessed in this directory is SCM-specific, which hard-code `$HOME`. However, that also means that for development, state gets written to the user's `$HOME`, but that's not a new problem. Our checks have been updated to use this, and some upcoming code will be using this as well.	52370a62743d077a440d7e567380d0e77fdbfa7b

Diff:

Revision 2 (+132 -8)

Show changes

	reviewboard/admin/checks.py
	reviewboard/admin/server.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (d7939a8)

reviewboard/admin/server.py (Diff revision 1)

reviewboard/admin/server.py (Diff revision 1)