Mercurial > libervia-backend
annotate doc/contributing/index.rst @ 4212:5f2d496c633f
core: get rid of `pickle`:
Use of `pickle` to serialise data was a technical legacy that was causing trouble to store
in database, to update (if a class was serialised, a change could break update), and to
security (pickle can lead to code execution).
This patch remove all use of Pickle in favour in JSON, notably:
- for caching data, a Pydantic model is now used instead
- for SQLAlchemy model, the LegacyPickle is replaced by JSON serialisation
- in XEP-0373 a class `PublicKeyMetadata` was serialised. New method `from_dict` and
`to_dict` method have been implemented to do serialisation.
- new methods to (de)serialise data can now be specified with Identity data types. It is
notably used to (de)serialise `path` of avatars.
A migration script has been created to convert data (for upgrade or downgrade), with
special care for XEP-0373 case. Depending of size of database, this migration script can
be long to run.
rel 443
author | Goffi <goffi@goffi.org> |
---|---|
date | Fri, 23 Feb 2024 13:31:04 +0100 |
parents | e65395e5f649 |
children |
rev | line source |
---|---|
3645 | 1 .. _contributing: |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 |
3645 | 3 ============ |
4 contributing | |
5 ============ | |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 This part of the documentation is for people willing to contribute to the development of |
3505 | 8 Libervia and its ecosystem, it is not needed to read this if you only plan to use the |
3430
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 software. |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 .. toctree:: |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 :glob: |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 :maxdepth: 2 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 |
4ba31dd1f0f5
doc: documentation for testing in new `contributing` section
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 testing |