Skip to content

1.142.0rc1 regression fix: Allow coercing a str to a FilePath in MasConfigModel #19144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anoadragon453 merged 2 commits into from
Nov 7, 2025
Merged

1.142.0rc1 regression fix: Allow coercing a str to a FilePath in MasConfigModel #19144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0070d8
Allow coercing a `str` to a `FilePath` in `MasConfigModel`
anoadragon453 Nov 5, 2025
b8d0d6a
newsfile
anoadragon453 Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/19144.bugfix
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a bug introduced in 1.142.0rc1 where any attempt to configure `matrix_authentication_service.secret_path` would prevent the homeserver from starting up.
Copy link
Copy Markdown
Contributor

@MadLittleMods MadLittleMods Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How was this problem caught?

Can we be sure it doesn't happen elsewhere? (feels like no without manually auditing things or test coverage to stress these pieces)

When having a cursory look, only this stood out to me,

synapse/synapse/config/matrixrtc.py

Lines 44 to 45 in 6790312

class MatrixRtcConfigModel(ParseModel):
transports: list = []

Copy link
Copy Markdown
Member

@benbz benbz Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How was this problem caught?

I raised this after the CI for element-hq/ess-helm#853 started failing on RC3

3 changes: 2 additions & 1 deletion synapse/config/mas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ class MasConfigModel(ParseModel):
enabled: StrictBool = False
endpoint: AnyHttpUrl = AnyHttpUrl("http://localhost:8080")
secret: Optional[StrictStr] = Field(default=None)
secret_path: Optional[FilePath] = Field(default=None)
# We set `strict=False` to allow `str` instances.
secret_path: Optional[FilePath] = Field(default=None, strict=False)

@model_validator(mode="after")
def verify_secret(self) -> Self:
Expand Down
7 changes: 7 additions & 0 deletions synapse/util/pydantic_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,13 @@ class ParseModel(BaseModel):

but otherwise uses Pydantic's default behaviour.

Strict mode can adversely affect some types of fields, and should be disabled
for a field if:

- the field's type is a `Path` or `FilePath`. Strict mode will refuse to
coerce from `str` (likely what the yaml parser will produce) to `FilePath`,
raising a `ValidationError`.
Comment on lines +36 to +38
Copy link
Copy Markdown
Contributor

@MadLittleMods MadLittleMods Nov 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This kinda feels like a bug with the pydantic.FilePath type 🤔. Of course it has to be parsed from a string. Feels like it should act like Annotated[StrictStr, AfterValidator(validate_file_path)]

May be worth finding existing issues tracking this or creating one.

Copy link
Copy Markdown
Member Author

@anoadragon453 anoadragon453 Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see both sides of the argument. On one hand, it would be a bit odd to allow coercion for one specific type (str -> FilePath) in strict mode. On the other, most people will be taking in paths as str types. There should be a simple way to validate that the file exists etc. (which is what people expect to do when setting the type of the field to FilePath).

So I agree that there's something either wrong/missing. I'll raise it as an issue in a bit while waiting for the release assets to build.


For now, ignore unknown fields. In the future, we could change this so that unknown
config values cause a ValidationError, provided the error messages are meaningful to
server operators.
Expand Down
Loading