mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-28 21:22:02 +00:00
Merge pull request #496 from matrix-org/daniel/3
Require ID and as_token be unique for ASs Defaults ID to as_token if not specified. This will change when IDs are fully supported.
This commit is contained in:
commit
2c760372d6
@ -20,6 +20,7 @@ from twisted.internet import defer
|
|||||||
|
|
||||||
from synapse.api.constants import Membership
|
from synapse.api.constants import Membership
|
||||||
from synapse.appservice import ApplicationService, AppServiceTransaction
|
from synapse.appservice import ApplicationService, AppServiceTransaction
|
||||||
|
from synapse.config._base import ConfigError
|
||||||
from synapse.storage.roommember import RoomsForUser
|
from synapse.storage.roommember import RoomsForUser
|
||||||
from synapse.types import UserID
|
from synapse.types import UserID
|
||||||
from ._base import SQLBaseStore
|
from ._base import SQLBaseStore
|
||||||
@ -145,6 +146,7 @@ class ApplicationServiceStore(SQLBaseStore):
|
|||||||
|
|
||||||
def _load_appservice(self, as_info):
|
def _load_appservice(self, as_info):
|
||||||
required_string_fields = [
|
required_string_fields = [
|
||||||
|
# TODO: Add id here when it's stable to release
|
||||||
"url", "as_token", "hs_token", "sender_localpart"
|
"url", "as_token", "hs_token", "sender_localpart"
|
||||||
]
|
]
|
||||||
for field in required_string_fields:
|
for field in required_string_fields:
|
||||||
@ -186,7 +188,7 @@ class ApplicationServiceStore(SQLBaseStore):
|
|||||||
namespaces=as_info["namespaces"],
|
namespaces=as_info["namespaces"],
|
||||||
hs_token=as_info["hs_token"],
|
hs_token=as_info["hs_token"],
|
||||||
sender=user_id,
|
sender=user_id,
|
||||||
id=as_info["as_token"] # the token is the only unique thing here
|
id=as_info["id"] if "id" in as_info else as_info["as_token"],
|
||||||
)
|
)
|
||||||
|
|
||||||
def _populate_appservice_cache(self, config_files):
|
def _populate_appservice_cache(self, config_files):
|
||||||
@ -197,10 +199,32 @@ class ApplicationServiceStore(SQLBaseStore):
|
|||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
# Dicts of value -> filename
|
||||||
|
seen_as_tokens = {}
|
||||||
|
seen_ids = {}
|
||||||
|
|
||||||
for config_file in config_files:
|
for config_file in config_files:
|
||||||
try:
|
try:
|
||||||
with open(config_file, 'r') as f:
|
with open(config_file, 'r') as f:
|
||||||
appservice = self._load_appservice(yaml.load(f))
|
appservice = self._load_appservice(yaml.load(f))
|
||||||
|
if appservice.id in seen_ids:
|
||||||
|
raise ConfigError(
|
||||||
|
"Cannot reuse ID across application services: "
|
||||||
|
"%s (files: %s, %s)" % (
|
||||||
|
appservice.id, config_file, seen_ids[appservice.id],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
seen_ids[appservice.id] = config_file
|
||||||
|
if appservice.token in seen_as_tokens:
|
||||||
|
raise ConfigError(
|
||||||
|
"Cannot reuse as_token across application services: "
|
||||||
|
"%s (files: %s, %s)" % (
|
||||||
|
appservice.token,
|
||||||
|
config_file,
|
||||||
|
seen_as_tokens[appservice.token],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
seen_as_tokens[appservice.token] = config_file
|
||||||
logger.info("Loaded application service: %s", appservice)
|
logger.info("Loaded application service: %s", appservice)
|
||||||
self.services_cache.append(appservice)
|
self.services_cache.append(appservice)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
|
@ -29,6 +29,7 @@ class ApplicationServiceTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
def setUp(self):
|
def setUp(self):
|
||||||
self.service = ApplicationService(
|
self.service = ApplicationService(
|
||||||
|
id="unique_identifier",
|
||||||
url="some_url",
|
url="some_url",
|
||||||
token="some_token",
|
token="some_token",
|
||||||
namespaces={
|
namespaces={
|
||||||
|
@ -12,12 +12,13 @@
|
|||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
import tempfile
|
||||||
|
from synapse.config._base import ConfigError
|
||||||
from tests import unittest
|
from tests import unittest
|
||||||
from twisted.internet import defer
|
from twisted.internet import defer
|
||||||
|
|
||||||
from tests.utils import setup_test_homeserver
|
from tests.utils import setup_test_homeserver
|
||||||
from synapse.appservice import ApplicationService, ApplicationServiceState
|
from synapse.appservice import ApplicationService, ApplicationServiceState
|
||||||
from synapse.server import HomeServer
|
|
||||||
from synapse.storage.appservice import (
|
from synapse.storage.appservice import (
|
||||||
ApplicationServiceStore, ApplicationServiceTransactionStore
|
ApplicationServiceStore, ApplicationServiceTransactionStore
|
||||||
)
|
)
|
||||||
@ -26,7 +27,6 @@ import json
|
|||||||
import os
|
import os
|
||||||
import yaml
|
import yaml
|
||||||
from mock import Mock
|
from mock import Mock
|
||||||
from tests.utils import SQLiteMemoryDbPool, MockClock
|
|
||||||
|
|
||||||
|
|
||||||
class ApplicationServiceStoreTestCase(unittest.TestCase):
|
class ApplicationServiceStoreTestCase(unittest.TestCase):
|
||||||
@ -41,9 +41,16 @@ class ApplicationServiceStoreTestCase(unittest.TestCase):
|
|||||||
|
|
||||||
self.as_token = "token1"
|
self.as_token = "token1"
|
||||||
self.as_url = "some_url"
|
self.as_url = "some_url"
|
||||||
self._add_appservice(self.as_token, self.as_url, "some_hs_token", "bob")
|
self.as_id = "as1"
|
||||||
self._add_appservice("token2", "some_url", "some_hs_token", "bob")
|
self._add_appservice(
|
||||||
self._add_appservice("token3", "some_url", "some_hs_token", "bob")
|
self.as_token,
|
||||||
|
self.as_id,
|
||||||
|
self.as_url,
|
||||||
|
"some_hs_token",
|
||||||
|
"bob"
|
||||||
|
)
|
||||||
|
self._add_appservice("token2", "as2", "some_url", "some_hs_token", "bob")
|
||||||
|
self._add_appservice("token3", "as3", "some_url", "some_hs_token", "bob")
|
||||||
# must be done after inserts
|
# must be done after inserts
|
||||||
self.store = ApplicationServiceStore(hs)
|
self.store = ApplicationServiceStore(hs)
|
||||||
|
|
||||||
@ -55,9 +62,9 @@ class ApplicationServiceStoreTestCase(unittest.TestCase):
|
|||||||
except:
|
except:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def _add_appservice(self, as_token, url, hs_token, sender):
|
def _add_appservice(self, as_token, id, url, hs_token, sender):
|
||||||
as_yaml = dict(url=url, as_token=as_token, hs_token=hs_token,
|
as_yaml = dict(url=url, as_token=as_token, hs_token=hs_token,
|
||||||
sender_localpart=sender, namespaces={})
|
id=id, sender_localpart=sender, namespaces={})
|
||||||
# use the token as the filename
|
# use the token as the filename
|
||||||
with open(as_token, 'w') as outfile:
|
with open(as_token, 'w') as outfile:
|
||||||
outfile.write(yaml.dump(as_yaml))
|
outfile.write(yaml.dump(as_yaml))
|
||||||
@ -74,6 +81,7 @@ class ApplicationServiceStoreTestCase(unittest.TestCase):
|
|||||||
self.as_token
|
self.as_token
|
||||||
)
|
)
|
||||||
self.assertEquals(stored_service.token, self.as_token)
|
self.assertEquals(stored_service.token, self.as_token)
|
||||||
|
self.assertEquals(stored_service.id, self.as_id)
|
||||||
self.assertEquals(stored_service.url, self.as_url)
|
self.assertEquals(stored_service.url, self.as_url)
|
||||||
self.assertEquals(
|
self.assertEquals(
|
||||||
stored_service.namespaces[ApplicationService.NS_ALIASES],
|
stored_service.namespaces[ApplicationService.NS_ALIASES],
|
||||||
@ -110,34 +118,34 @@ class ApplicationServiceTransactionStoreTestCase(unittest.TestCase):
|
|||||||
{
|
{
|
||||||
"token": "token1",
|
"token": "token1",
|
||||||
"url": "https://matrix-as.org",
|
"url": "https://matrix-as.org",
|
||||||
"id": "token1"
|
"id": "id_1"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"token": "alpha_tok",
|
"token": "alpha_tok",
|
||||||
"url": "https://alpha.com",
|
"url": "https://alpha.com",
|
||||||
"id": "alpha_tok"
|
"id": "id_alpha"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"token": "beta_tok",
|
"token": "beta_tok",
|
||||||
"url": "https://beta.com",
|
"url": "https://beta.com",
|
||||||
"id": "beta_tok"
|
"id": "id_beta"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"token": "delta_tok",
|
"token": "gamma_tok",
|
||||||
"url": "https://delta.com",
|
"url": "https://gamma.com",
|
||||||
"id": "delta_tok"
|
"id": "id_gamma"
|
||||||
},
|
},
|
||||||
]
|
]
|
||||||
for s in self.as_list:
|
for s in self.as_list:
|
||||||
yield self._add_service(s["url"], s["token"])
|
yield self._add_service(s["url"], s["token"], s["id"])
|
||||||
|
|
||||||
self.as_yaml_files = []
|
self.as_yaml_files = []
|
||||||
|
|
||||||
self.store = TestTransactionStore(hs)
|
self.store = TestTransactionStore(hs)
|
||||||
|
|
||||||
def _add_service(self, url, as_token):
|
def _add_service(self, url, as_token, id):
|
||||||
as_yaml = dict(url=url, as_token=as_token, hs_token="something",
|
as_yaml = dict(url=url, as_token=as_token, hs_token="something",
|
||||||
sender_localpart="a_sender", namespaces={})
|
id=id, sender_localpart="a_sender", namespaces={})
|
||||||
# use the token as the filename
|
# use the token as the filename
|
||||||
with open(as_token, 'w') as outfile:
|
with open(as_token, 'w') as outfile:
|
||||||
outfile.write(yaml.dump(as_yaml))
|
outfile.write(yaml.dump(as_yaml))
|
||||||
@ -405,3 +413,64 @@ class TestTransactionStore(ApplicationServiceTransactionStore,
|
|||||||
|
|
||||||
def __init__(self, hs):
|
def __init__(self, hs):
|
||||||
super(TestTransactionStore, self).__init__(hs)
|
super(TestTransactionStore, self).__init__(hs)
|
||||||
|
|
||||||
|
|
||||||
|
class ApplicationServiceStoreConfigTestCase(unittest.TestCase):
|
||||||
|
|
||||||
|
def _write_config(self, suffix, **kwargs):
|
||||||
|
vals = {
|
||||||
|
"id": "id" + suffix,
|
||||||
|
"url": "url" + suffix,
|
||||||
|
"as_token": "as_token" + suffix,
|
||||||
|
"hs_token": "hs_token" + suffix,
|
||||||
|
"sender_localpart": "sender_localpart" + suffix,
|
||||||
|
"namespaces": {},
|
||||||
|
}
|
||||||
|
vals.update(kwargs)
|
||||||
|
|
||||||
|
_, path = tempfile.mkstemp(prefix="as_config")
|
||||||
|
with open(path, "w") as f:
|
||||||
|
f.write(yaml.dump(vals))
|
||||||
|
return path
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_unique_works(self):
|
||||||
|
f1 = self._write_config(suffix="1")
|
||||||
|
f2 = self._write_config(suffix="2")
|
||||||
|
|
||||||
|
config = Mock(app_service_config_files=[f1, f2])
|
||||||
|
hs = yield setup_test_homeserver(config=config)
|
||||||
|
|
||||||
|
ApplicationServiceStore(hs)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_duplicate_ids(self):
|
||||||
|
f1 = self._write_config(id="id", suffix="1")
|
||||||
|
f2 = self._write_config(id="id", suffix="2")
|
||||||
|
|
||||||
|
config = Mock(app_service_config_files=[f1, f2])
|
||||||
|
hs = yield setup_test_homeserver(config=config)
|
||||||
|
|
||||||
|
with self.assertRaises(ConfigError) as cm:
|
||||||
|
ApplicationServiceStore(hs)
|
||||||
|
|
||||||
|
e = cm.exception
|
||||||
|
self.assertIn(f1, e.message)
|
||||||
|
self.assertIn(f2, e.message)
|
||||||
|
self.assertIn("id", e.message)
|
||||||
|
|
||||||
|
@defer.inlineCallbacks
|
||||||
|
def test_duplicate_as_tokens(self):
|
||||||
|
f1 = self._write_config(as_token="as_token", suffix="1")
|
||||||
|
f2 = self._write_config(as_token="as_token", suffix="2")
|
||||||
|
|
||||||
|
config = Mock(app_service_config_files=[f1, f2])
|
||||||
|
hs = yield setup_test_homeserver(config=config)
|
||||||
|
|
||||||
|
with self.assertRaises(ConfigError) as cm:
|
||||||
|
ApplicationServiceStore(hs)
|
||||||
|
|
||||||
|
e = cm.exception
|
||||||
|
self.assertIn(f1, e.message)
|
||||||
|
self.assertIn(f2, e.message)
|
||||||
|
self.assertIn("as_token", e.message)
|
||||||
|
Loading…
Reference in New Issue
Block a user