data.py 17.7 KB
Newer Older
Markus Scheidgen's avatar
Markus Scheidgen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Copyright 2018 Markus Scheidgen
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an"AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
This module comprises a set of persistent document classes that hold all user related
data. These are information about users, their uploads and datasets, the associated
calculations, and files


.. autoclass:: Calc
    :members:
.. autoclass:: Upload
    :members:
"""

27
from typing import List, Any, ContextManager, Tuple, Generator
Markus Scheidgen's avatar
Markus Scheidgen committed
28
from mongoengine import StringField, BooleanField, DateTimeField, DictField, IntField
Markus Scheidgen's avatar
Markus Scheidgen committed
29
import logging
30
from structlog import wrap_logger
31
from contextlib import contextmanager
Markus Scheidgen's avatar
Markus Scheidgen committed
32

33
from nomad import utils, coe_repo, datamodel
34
from nomad.files import PathObject, ArchiveBasedStagingUploadFiles
Markus Scheidgen's avatar
Markus Scheidgen committed
35
from nomad.repo import RepoCalc, RepoUpload
36
from nomad.processing.base import Proc, Chord, process, task, PENDING, SUCCESS, FAILURE
Markus Scheidgen's avatar
Markus Scheidgen committed
37
from nomad.parsing import parsers, parser_dict
Markus Scheidgen's avatar
Markus Scheidgen committed
38
39
40
41
42
43
from nomad.normalizing import normalizers


class NotAllowedDuringProcessing(Exception): pass


44
class Calc(Proc, datamodel.Calc):
Markus Scheidgen's avatar
Markus Scheidgen committed
45
46
47
48
49
50
51
52
53
54
    """
    Instances of this class represent calculations. This class manages the elastic
    search index entry, files, and archive for the respective calculation.

    It also contains the calculations processing and its state.

    The attribute list, does not include the various repository properties generated
    while parsing, including ``program_name``, ``program_version``, etc.

    Attributes:
55
        calc_id: the calc_id of this calc
Markus Scheidgen's avatar
Markus Scheidgen committed
56
57
58
59
        parser: the name of the parser used to process this calc
        upload_id: the id of the upload used to create this calculation
        mainfile: the mainfile (including path in upload) that was used to create this calc
    """
60
    calc_id = StringField(primary_key=True)
Markus Scheidgen's avatar
Markus Scheidgen committed
61
62
63
64
65
66
    upload_id = StringField()
    mainfile = StringField()
    parser = StringField()

    meta: Any = {
        'indices': [
67
            'upload_id', 'mainfile', 'code', 'parser', 'status'
Markus Scheidgen's avatar
Markus Scheidgen committed
68
69
70
71
72
73
        ]
    }

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self._parser_backend = None
74
75
        self._upload: Upload = None
        self._upload_files: ArchiveBasedStagingUploadFiles = None
76
        self._calc_proc_logwriter = None
77
        self._calc_proc_logwriter_ctx: ContextManager = None
Markus Scheidgen's avatar
Markus Scheidgen committed
78
79
80

    @classmethod
    def get(cls, id):
81
        return cls.get_by_id(id, 'calc_id')
Markus Scheidgen's avatar
Markus Scheidgen committed
82

Markus Scheidgen's avatar
Markus Scheidgen committed
83
    @property
84
85
    def mainfile_file(self) -> PathObject:
        return self.upload_files.raw_file_object(self.mainfile)
Markus Scheidgen's avatar
Markus Scheidgen committed
86

87
88
89
90
91
92
    @property
    def upload(self) -> 'Upload':
        if not self._upload:
            self._upload = Upload.get(self.upload_id)
        return self._upload

93
94
95
    @property
    def upload_files(self) -> ArchiveBasedStagingUploadFiles:
        if not self._upload_files:
96
            self._upload_files = ArchiveBasedStagingUploadFiles(self.upload_id, is_authorized=lambda: True, local_path=self.upload.local_path)
97
98
        return self._upload_files

Markus Scheidgen's avatar
Markus Scheidgen committed
99
100
101
    def get_logger(self, **kwargs):
        logger = super().get_logger()
        logger = logger.bind(
102
            upload_id=self.upload_id, mainfile=self.mainfile, calc_id=self.calc_id, **kwargs)
103

Markus Scheidgen's avatar
Markus Scheidgen committed
104
105
        return logger

106
107
108
109
110
111
112
113
    def get_calc_logger(self, **kwargs):
        """
        Returns a wrapped logger that additionally saves all entries to the calculation
        processing log in the archive.
        """
        logger = self.get_logger(**kwargs)

        if self._calc_proc_logwriter is None:
114
            self._calc_proc_logwriter_ctx = self.upload_files.archive_log_file(self.calc_id, 'wt')
115
            self._calc_proc_logwriter = self._calc_proc_logwriter_ctx.__enter__()  # pylint: disable=E1101
116

117
        def save_to_calc_log(logger, method_name, event_dict):
118
119
120
121
122
123
124
125
126
127
128
            program = event_dict.get('normalizer', 'parser')
            event = event_dict.get('event', '')
            entry = '[%s] %s: %s' % (method_name, program, event)
            if len(entry) > 120:
                self._calc_proc_logwriter.write(entry[:120])
                self._calc_proc_logwriter.write('...')
            else:
                self._calc_proc_logwriter.write(entry)
            self._calc_proc_logwriter.write('\n')
            return event_dict

129
        return wrap_logger(logger, processors=[save_to_calc_log])
130

Markus Scheidgen's avatar
Markus Scheidgen committed
131
132
    @process
    def process(self):
133
        logger = self.get_logger()
134
        if self.upload is None:
135
            logger.error('calculation upload does not exist')
Markus Scheidgen's avatar
Markus Scheidgen committed
136
137
138
139
140
141

        try:
            self.parsing()
            self.normalizing()
            self.archiving()
        finally:
Markus Scheidgen's avatar
Markus Scheidgen committed
142
            # close loghandler that was not closed due to failures
143
            try:
144
145
146
                if self._calc_proc_logwriter is not None:
                    self._calc_proc_logwriter.close()
                    self._calc_proc_logwriter = None
147
148
149
150
            except Exception as e:
                logger.error('could not close calculation proc log', exc_info=e)

            # inform parent proc about completion
151
            self.upload.completed_child()
Markus Scheidgen's avatar
Markus Scheidgen committed
152
153
154

    @task
    def parsing(self):
155
156
        context = dict(parser=self.parser, step=self.parser)
        logger = self.get_calc_logger(**context)
157
        parser = parser_dict[self.parser]
Markus Scheidgen's avatar
Markus Scheidgen committed
158

159
        with utils.timer(logger, 'parser executed', input_size=self.mainfile_file.size):
160
161
            self._parser_backend = parser.run(
                self.upload_files.raw_file_object(self.mainfile).os_path, logger=logger)
Markus Scheidgen's avatar
Markus Scheidgen committed
162

163
164
        self._parser_backend.openNonOverlappingSection('section_calculation_info')
        self._parser_backend.addValue('upload_id', self.upload_id)
165
166
        self._parser_backend.addValue('calc_id', self.calc_id)
        self._parser_backend.addValue('calc_hash', self.upload_files.calc_hash(self.mainfile))
167
168
169
        self._parser_backend.addValue('main_file', self.mainfile)
        self._parser_backend.addValue('parser_name', self.parser)

Markus Scheidgen's avatar
Markus Scheidgen committed
170
        if self._parser_backend.status[0] != 'ParseSuccess':
171
            logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
172
            error = self._parser_backend.status[1]
173
            self._parser_backend.addValue('parse_status', 'ParseFailure')
174
            self.fail(error, level=logging.DEBUG, **context)
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
        else:
            self._parser_backend.addValue('parse_status', 'ParseSuccess')

        self._parser_backend.closeNonOverlappingSection('section_calculation_info')

        self.add_processor_info(self.parser)

    @contextmanager
    def use_parser_backend(self, processor_name):
        self._parser_backend.reset_status()
        yield self._parser_backend
        self.add_processor_info(processor_name)

    def add_processor_info(self, processor_name: str) -> None:
        self._parser_backend.openContext('/section_calculation_info/0')
        self._parser_backend.openNonOverlappingSection('section_archive_processing_info')
        self._parser_backend.addValue('archive_processor_name', processor_name)

        if self._parser_backend.status[0] == 'ParseSuccess':
            warnings = getattr(self._parser_backend, '_warnings', [])
            if len(warnings) > 0:
                self._parser_backend.addValue('archive_processor_status', 'WithWarnings')
                self._parser_backend.addValue('archive_processor_warning_number', len(warnings))
                self._parser_backend.addArrayValues('archive_processor_warnings', [str(warning) for warning in warnings])
            else:
                self._parser_backend.addValue('archive_processor_status', 'Success')
        else:
            errors = self._parser_backend.status[1]
            self._parser_backend.addValue('archive_processor_error', str(errors))

        self._parser_backend.closeNonOverlappingSection('section_archive_processing_info')
        self._parser_backend.closeContext('/section_calculation_info/0')
Markus Scheidgen's avatar
Markus Scheidgen committed
207
208
209
210
211

    @task
    def normalizing(self):
        for normalizer in normalizers:
            normalizer_name = normalizer.__name__
212
213
            context = dict(normalizer=normalizer_name, step=normalizer_name)
            logger = self.get_calc_logger(**context)
Markus Scheidgen's avatar
Markus Scheidgen committed
214
215

            with utils.timer(
216
                    logger, 'normalizer executed', input_size=self.mainfile_file.size):
217
218
                with self.use_parser_backend(normalizer_name) as backend:
                    normalizer(backend).normalize(logger=logger)
Markus Scheidgen's avatar
Markus Scheidgen committed
219

220
221
            failed = self._parser_backend.status[0] != 'ParseSuccess'
            if failed:
222
                logger.error(self._parser_backend.status[1])
Markus Scheidgen's avatar
Markus Scheidgen committed
223
                error = self._parser_backend.status[1]
224
                self.fail(error, level=logging.WARNING, **context)
225
226
227
228
                break
            else:
                logger.debug(
                    'completed normalizer successfully', normalizer=normalizer_name)
Markus Scheidgen's avatar
Markus Scheidgen committed
229
230
231

    @task
    def archiving(self):
232
233
234
235
        logger = self.get_logger()

        additional = dict(
            mainfile=self.mainfile,
236
            upload_time=self.upload.upload_time,
237
238
            staging=True,
            restricted=False,
239
            user_id=self.upload.user_id,
240
            aux_files=list(self.upload_files.calc_files(self.mainfile, with_mainfile=False)))
241

242
        # persist the repository metadata
243
        with utils.timer(logger, 'indexed', step='index'):
244
            repo_calc = RepoCalc.create_from_backend(
245
246
                self._parser_backend,
                additional=additional,
247
                calc_id=self.calc_id,
248
249
                upload_id=self.upload_id)
            repo_calc.persist()
250

251
        # persist the archive
Markus Scheidgen's avatar
Markus Scheidgen committed
252
253
254
        with utils.timer(
                logger, 'archived', step='archive',
                input_size=self.mainfile_file.size) as log_data:
255
            with self.upload_files.archive_file(self.calc_id, 'wt') as out:
256
257
                self._parser_backend.write_json(out, pretty=True)

258
            log_data.update(archive_size=self.upload_files.archive_file_object(self.calc_id).size)
Markus Scheidgen's avatar
Markus Scheidgen committed
259
260
261
262
263
264

        # close loghandler
        if self._calc_proc_logwriter is not None:
            with utils.timer(
                    logger, 'archived log', step='archive_log',
                    input_size=self.mainfile_file.size) as log_data:
265
                self._calc_proc_logwriter_ctx.__exit__(None, None, None)  # pylint: disable=E1101
266
                self._calc_proc_logwriter = None
Markus Scheidgen's avatar
Markus Scheidgen committed
267

268
                log_data.update(log_size=self.upload_files.archive_log_file_object(self.calc_id).size)
Markus Scheidgen's avatar
Markus Scheidgen committed
269

Markus Scheidgen's avatar
Markus Scheidgen committed
270

271
class Upload(Chord, datamodel.Upload):
Markus Scheidgen's avatar
Markus Scheidgen committed
272
273
274
275
276
277
    """
    Represents uploads in the databases. Provides persistence access to the files storage,
    and processing state.

    Attributes:
        name: optional user provided upload name
278
        local_path: optional local path, e.g. for files that are already somewhere on the server
Markus Scheidgen's avatar
Markus Scheidgen committed
279
280
281
282
        additional_metadata: optional user provided additional meta data
        upload_id: the upload id generated by the database
        is_private: true if the upload and its derivitaves are only visible to the uploader
        upload_time: the timestamp when the system realised the upload
283
        user_id: the id of the user that created this upload
Markus Scheidgen's avatar
Markus Scheidgen committed
284
285
286
287
288
289
    """
    id_field = 'upload_id'

    upload_id = StringField(primary_key=True)

    name = StringField(default=None)
290
    local_path = StringField(default=None)
Markus Scheidgen's avatar
Markus Scheidgen committed
291
292
293
294
295
296
    additional_metadata = DictField(default=None)

    is_private = BooleanField(default=False)

    upload_time = DateTimeField()

297
    user_id = StringField(required=True)
Markus Scheidgen's avatar
Markus Scheidgen committed
298

299
300
    coe_repo_upload_id = IntField(default=None)

301
302
    _initiated_parsers = IntField(default=-1)

Markus Scheidgen's avatar
Markus Scheidgen committed
303
304
    meta: Any = {
        'indexes': [
305
            'user_id', 'status'
Markus Scheidgen's avatar
Markus Scheidgen committed
306
307
308
309
310
        ]
    }

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
311
        self._upload_files: ArchiveBasedStagingUploadFiles = None
Markus Scheidgen's avatar
Markus Scheidgen committed
312
313
314
315
316
317

    @classmethod
    def get(cls, id):
        return cls.get_by_id(id, 'upload_id')

    @classmethod
318
    def user_uploads(cls, user: coe_repo.User) -> List['Upload']:
Markus Scheidgen's avatar
Markus Scheidgen committed
319
        """ Returns all uploads for the given user. Currently returns all uploads. """
320
        return cls.objects(user_id=str(user.user_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
321

322
323
324
325
    @property
    def uploader(self):
        return coe_repo.User.from_user_id(self.user_id)

Markus Scheidgen's avatar
Markus Scheidgen committed
326
327
328
329
330
331
    def get_logger(self, **kwargs):
        logger = super().get_logger()
        logger = logger.bind(upload_id=self.upload_id, **kwargs)
        return logger

    def delete(self):
332
        if not (self.completed or self.current_task == 'uploading'):
Markus Scheidgen's avatar
Markus Scheidgen committed
333
            raise NotAllowedDuringProcessing()
334
335
        Calc.objects(upload_id=self.upload_id).delete()
        super().delete()
Markus Scheidgen's avatar
Markus Scheidgen committed
336
337
338
339
340
341
342

    @classmethod
    def create(cls, **kwargs) -> 'Upload':
        """
        Creates a new upload for the given user, a user given name is optional.
        It will populate the record with a signed url and pending :class:`UploadProc`.
        The upload will be already saved to the database.
343
344

        Arguments:
345
            user (coe_repo.User): The user that created the upload.
Markus Scheidgen's avatar
Markus Scheidgen committed
346
        """
347
        user: coe_repo.User = kwargs['user']
348
349
350
        del(kwargs['user'])
        if 'upload_id' not in kwargs:
            kwargs.update(upload_id=utils.create_uuid())
351
        kwargs.update(user_id=str(user.user_id))
Markus Scheidgen's avatar
Markus Scheidgen committed
352
        self = super().create(**kwargs)
353

Markus Scheidgen's avatar
Markus Scheidgen committed
354
        self._continue_with('uploading')
355

Markus Scheidgen's avatar
Markus Scheidgen committed
356
357
        return self

358
    def unstage(self, meta_data):
359
        self.get_logger().info('unstage')
360
361
362
363

        if not (self.completed or self.current_task == 'uploading'):
            raise NotAllowedDuringProcessing()

364
365
        self.delete()

Markus Scheidgen's avatar
Markus Scheidgen committed
366
        self.to(RepoUpload).unstage()
367
        coe_repo.Upload.add(self, meta_data)
Markus Scheidgen's avatar
Markus Scheidgen committed
368
369
        self.save()

370
371
372
        self.upload_files.pack()
        self.upload_files.delete()

Markus Scheidgen's avatar
Markus Scheidgen committed
373
374
375
376
377
378
379
380
381
    @process
    def process(self):
        self.extracting()
        self.parse_all()

    @task
    def uploading(self):
        pass

382
    @property
383
384
    def upload_files(self) -> ArchiveBasedStagingUploadFiles:
        if not self._upload_files:
385
            self._upload_files = ArchiveBasedStagingUploadFiles(self.upload_id, is_authorized=lambda: True, local_path=self.local_path)
386
        return self._upload_files
387

Markus Scheidgen's avatar
Markus Scheidgen committed
388
389
    @task
    def extracting(self):
390
391
392
393
394
395
        """
        Task performed before the actual parsing/normalizing. Extracting and bagging
        the uploaded files, computing all keys, create an *upload* entry in the NOMAD-coe
        repository db, etc.
        """
        # extract the uploaded file, this will also create a bagit bag.
Markus Scheidgen's avatar
Markus Scheidgen committed
396
397
        logger = self.get_logger()
        try:
Markus Scheidgen's avatar
Markus Scheidgen committed
398
399
            with utils.timer(
                    logger, 'upload extracted', step='extracting',
400
401
                    upload_size=self.upload_files.size):
                self.upload_files.extract()
402
        except KeyError:
403
            self.fail('process request for non existing upload', level=logging.ERROR)
Markus Scheidgen's avatar
Markus Scheidgen committed
404
405
            return

406
        # check if the file was already uploaded and processed before
Markus Scheidgen's avatar
Markus Scheidgen committed
407
        if self.to(RepoUpload).exists():
Markus Scheidgen's avatar
Markus Scheidgen committed
408
409
410
            self.fail('The same file was already uploaded and processed.', level=logging.INFO)
            return

411
    def match_mainfiles(self) -> Generator[Tuple[str, object], None, None]:
412
413
414
415
416
417
418
        """
        Generator function that matches all files in the upload to all parsers to
        determine the upload's mainfiles.

        Returns:
            Tuples of mainfile, filename, and parsers
        """
419
        for filename in self.upload_files.raw_file_manifest():
420
421
            for parser in parsers:
                try:
422
                    with self.upload_files.raw_file(filename) as mainfile_f:
423
                        if parser.is_mainfile(filename, lambda fn: mainfile_f):
424
                            yield filename, parser
425
                except Exception as e:
426
                    self.get_logger().error(
427
428
429
                        'exception while matching pot. mainfile',
                        mainfile=filename, exc_info=e)

Markus Scheidgen's avatar
Markus Scheidgen committed
430
431
    @task
    def parse_all(self):
432
        """
433
        Identified mainfile/parser combinations among the upload's files, creates
434
435
        respective :class:`Calc` instances, and triggers their processing.
        """
436
437
        logger = self.get_logger()

Markus Scheidgen's avatar
Markus Scheidgen committed
438
        # TODO: deal with multiple possible parser specs
Markus Scheidgen's avatar
Markus Scheidgen committed
439
440
        with utils.timer(
                logger, 'upload extracted', step='matching',
441
                upload_size=self.upload_files.size):
442
            total_calcs = 0
443
            for filename, parser in self.match_mainfiles():
444
                calc = Calc.create(
445
                    calc_id=self.upload_files.calc_id(filename),
446
447
448
449
450
                    mainfile=filename, parser=parser.name,
                    upload_id=self.upload_id)

                calc.process()
                total_calcs += 1
Markus Scheidgen's avatar
Markus Scheidgen committed
451

452
453
454
455
456
        # have to save the total_calcs information for chord management
        self.spwaned_childred(total_calcs)

    def join(self):
        self.cleanup()
Markus Scheidgen's avatar
Markus Scheidgen committed
457
458
459

    @task
    def cleanup(self):
460
461
462
463
464
        # TODO issue #83
        with utils.timer(
                self.get_logger(), 'pack staging upload', step='cleaning',
                upload_size=self.upload_files.size):
            pass
Markus Scheidgen's avatar
Markus Scheidgen committed
465
466

    @property
467
468
469
470
471
472
473
474
475
476
477
    def processed_calcs(self):
        return Calc.objects(upload_id=self.upload_id, status__in=[SUCCESS, FAILURE]).count()

    @property
    def total_calcs(self):
        return Calc.objects(upload_id=self.upload_id).count()

    @property
    def failed_calcs(self):
        return Calc.objects(upload_id=self.upload_id, status=FAILURE).count()

478
479
480
481
    @property
    def pending_calcs(self):
        return Calc.objects(upload_id=self.upload_id, status=PENDING).count()

482
483
    def all_calcs(self, start, end, order_by='mainfile'):
        return Calc.objects(upload_id=self.upload_id)[start:end].order_by(order_by)
484
485
486
487

    @property
    def calcs(self):
        return Calc.objects(upload_id=self.upload_id)