(2/2) Introduce spec_version 2.0 (#654)

Co-authored-by: Vladimir Bobrikov <[email protected]>
Co-authored-by: Lev Gorodetskiy <[email protected]>

Author: 3 people

src/dipdup/__init__.py

@@ -7,20 +7,3 @@
 # NOTE: Load version from package
 __version__ = importlib.metadata.version('dipdup')
 __spec_version__ = '1.2'
-
-version = tuple(__version__.split('.'))
-major_version = version[0]
-minor_version = f'{version[0]}.{version[1]}'
-
-spec_version_mapping = {
-    '0.1': '<=0.4.3',
-    '1.0': '>=1.0.0, <=1.1.2',
-    '1.1': '>=2.0.0, <=2.0.9',
-    '1.2': '>=3.0.0',
-}
-spec_reindex_mapping = {
-    '0.1': False,
-    '1.0': False,
-    '1.1': True,
-    '1.2': True,
-}

src/dipdup/cli.py

@@ -15,11 +15,8 @@
 
 import asyncclick as click
 
-from dipdup import __spec_version__
 from dipdup import __version__
 from dipdup import env
-from dipdup import spec_reindex_mapping
-from dipdup import spec_version_mapping
 from dipdup.utils.sys import IGNORE_CONFIG_CMDS
 from dipdup.utils.sys import set_up_logging
 from dipdup.utils.sys import set_up_process
@@ -159,7 +156,6 @@ async def cli(ctx: click.Context, config: list[str], env_file: list[str]) -> Non
     from dipdup.config import DipDupConfig
     from dipdup.exceptions import ConfigurationError
     from dipdup.exceptions import InitializationRequiredError
-    from dipdup.exceptions import MigrationRequiredError
     from dipdup.sentry import init_sentry
 
     _config = DipDupConfig.load(config_paths)
@@ -180,13 +176,6 @@ async def cli(ctx: click.Context, config: list[str], env_file: list[str]) -> Non
     except Exception as e:
         raise InitializationRequiredError(f'Failed to create a project package: {e}') from e
 
-    # NOTE: Ensure that `spec_version` is valid and supported
-    if _config.spec_version not in spec_version_mapping:
-        raise ConfigurationError(f'Unknown `spec_version`, correct ones: {", ".join(spec_version_mapping)}')
-    if _config.spec_version != __spec_version__:
-        reindex = spec_reindex_mapping[__spec_version__]
-        raise MigrationRequiredError(_config.spec_version, __spec_version__, reindex)
-
     @dataclass
     class CLIContext:
         config_paths: list[str]

src/dipdup/exceptions.py

@@ -8,10 +8,8 @@
 from typing import Optional
 from typing import Type
 
-from tabulate import tabulate
 from tortoise.models import Model
 
-from dipdup import spec_version_mapping
 from dipdup.enums import ReindexingReason
 
 tab = ('_' * 80) + '\n\n'
@@ -161,37 +159,6 @@ def _help(self) -> str:
         """
 
 
-@dataclass(repr=False)
-class MigrationRequiredError(Error):
-    """Project and DipDup spec versions don't match"""
-
-    from_: str
-    to: str
-    reindex: bool = False
-
-    def _help(self) -> str:
-        version_table = tabulate(
-            [
-                ['current', self.from_, spec_version_mapping[self.from_]],
-                ['required', self.to, spec_version_mapping[self.to]],
-            ],
-            headers=['', 'spec_version', 'DipDup version'],
-        )
-        reindex = '\n\n' + tab + ReindexingRequiredError(ReindexingReason.migration).help() if self.reindex else ''
-        return f"""
-            Project migration required!
-
-            {version_table.strip()}
-
-            Perform the following actions:
-
-              1. Run `dipdup migrate`.
-              2. Review and commit changes.
-
-            See https://docs.dipdup.io/release-notes for more information. {reindex}
-        """
-
-
 @dataclass(repr=False)
 class ReindexingRequiredError(Error):
     """Unable to continue indexing with existing database"""

src/dipdup/project.py

@@ -9,7 +9,7 @@
 from pydantic import Field
 from tabulate import tabulate
 
-from dipdup import major_version
+from dipdup import __version__
 from dipdup.exceptions import ConfigurationError
 from dipdup.utils.codegen import load_template
 from dipdup.utils.codegen import write
@@ -123,7 +123,7 @@ def prompt(self) -> str:
 class JinjaAnswers(dict[str, Any]):
     def __init__(self, *args: str, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
-        self['dipdup_version'] = major_version
+        self['dipdup_version'] = __version__
 
     def __getattr__(self, item: str) -> Any:
         return self[item]

src/dipdup/yaml.py

@@ -25,6 +25,7 @@
 from pydantic.json import pydantic_encoder
 from ruamel.yaml import YAML
 
+from dipdup import __spec_version__
 from dipdup.exceptions import ConfigurationError
 
 # NOTE: ${VARIABLE:-default} | ${VARIABLE}
@@ -105,6 +106,8 @@ def load(
 
             config.update(yaml.load(path_yaml))
 
+        config.validate_version()
+
         # FIXME: Can't use `from_` field alias in dataclass; fixed in dipdup.yaml instead
         # FIXME: See https://github.com/pydantic/pydantic/issues/4286
         fix_dataclass_field_aliases(config)
@@ -121,3 +124,10 @@ def dump(self) -> str:
         buffer = StringIO()
         yaml.dump(config_yaml, buffer)
         return buffer.getvalue()
+
+    def validate_version(self) -> None:
+        config_spec_version = self['spec_version']
+        if config_spec_version != __spec_version__:
+            raise ConfigurationError(
+                f'Incompatible spec version: expected {__spec_version__}, got {config_spec_version}. See https://docs.dipdup.io/config/spec_version'
+            )