File size: 11,201 Bytes
1cd137c
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582

import json
from pathlib import Path

import duckdb
import pandas as pd

# Configuration

DB_PATH = "compliments_reference_db.duckdb"

OUTPUT_DIR = Path("data/phase_1")
VALIDATION_DIR = OUTPUT_DIR / "validation"
STATISTICS_DIR = OUTPUT_DIR / "statistics"

VERSION = "1.0.0"
RULES_VERSION = "1.0.0"


# Input / output schema

INPUT_COLUMNS = [
    "retailer_product_id",
    "product_name",
    "brand",
    "retailer",
    "upc",
    "size",
    "price",
    "price_currency",
    "is_available",
    "source",
    "source_url",
    "scraped_at",
    "product_id",
    "private_label",
    "image_url",
    "product_url",
    "category",
]


# Technical columns added by dlt.
# They are not part of the retailer business schema.

DLT_METADATA_COLUMNS = [
    "_dlt_load_id",
    "_dlt_id",
]


OUTPUT_COLUMNS = [
    "external_id",
    "source_retailer",
    "title",
    "brand",
    "barcode",
    "description",
    "ingredients_text",
    "nutrition_text",
    "image_url",
    "size_amount",
    "size_unit",
    "price",
    "currency",
    "scraped_at",
]


REQUIRED_COLUMNS = [
    "external_id",
    "source_retailer",
    "title",
]


OPTIONAL_OUTPUT_COLUMNS = [
    "brand",
    "barcode",
    "description",
    "ingredients_text",
    "nutrition_text",
    "image_url",
    "size_amount",
    "size_unit",
    "price",
    "currency",
    "scraped_at",
]


# Reading

def load_raw_products() -> pd.DataFrame:
    """Load raw product data from DuckDB."""

    connection = duckdb.connect(DB_PATH)

    try:
        df = connection.sql(
            "SELECT * FROM raw.raw_products"
        ).df()
    finally:
        connection.close()

    return df


# Schema validation

def validate_input_schema(df: pd.DataFrame) -> dict:
    """
    Validate the schema received from the ingestion layer.

    dlt technical metadata columns are ignored because they are not
    part of the retailer business schema.
    """

    actual_columns = set(df.columns)

    missing_columns = [
        column
        for column in INPUT_COLUMNS
        if column not in actual_columns
    ]

    new_columns = [
        column
        for column in df.columns
        if column not in INPUT_COLUMNS
        and column not in DLT_METADATA_COLUMNS
    ]

    return {
        "expected_columns": INPUT_COLUMNS,
        "actual_columns": list(df.columns),
        "missing_columns": missing_columns,
        "new_columns": new_columns,
        "schema_valid": len(missing_columns) == 0,
    }


# Generic boundary mapping

def map_to_phase1_schema(
    df: pd.DataFrame,
) -> pd.DataFrame:
    """
    Map the common ingestion schema to the Phase 1 contract schema.

    This mapping is generic and does not contain retailer-specific logic.
    """

    result = pd.DataFrame(index=df.index)

    result["external_id"] = df["retailer_product_id"]

    result["source_retailer"] = df["retailer"]

    result["title"] = df["product_name"]

    result["brand"] = df["brand"]

    result["barcode"] = df["upc"]

    # These fields are not available in the current ingestion schema.
    result["description"] = None
    result["ingredients_text"] = None
    result["nutrition_text"] = None

    result["image_url"] = df["image_url"]

    # Size remains preserved in the ingestion layer as one source value.
    # Parsing it into amount/unit is intentionally not done here.
    result["size_amount"] = None
    result["size_unit"] = None

    result["price"] = df["price"]

    result["currency"] = df["price_currency"]

    result["scraped_at"] = df["scraped_at"]

    return result


# Validation

def validate_required_columns(
    df: pd.DataFrame,
) -> dict:
    """Check that all required Phase 1 columns exist."""

    return {
        column: column in df.columns
        for column in REQUIRED_COLUMNS
    }


def validate_missing_required_values(
    df: pd.DataFrame,
) -> dict:
    """Check required fields for missing values."""

    result = {}

    for column in REQUIRED_COLUMNS:
        result[column] = int(
            df[column].isna().sum()
        )

    return result


def validate_duplicates(
    df: pd.DataFrame,
) -> dict:
    """
    Detect duplicate product identifiers within a retailer.
    """

    duplicate_mask = df.duplicated(
        subset=[
            "source_retailer",
            "external_id",
        ],
        keep=False,
    )

    duplicate_rows = int(
        duplicate_mask.sum()
    )

    if duplicate_rows == 0:
        duplicate_groups = 0
    else:
        duplicate_groups = int(
            df.loc[duplicate_mask]
            .groupby(
                [
                    "source_retailer",
                    "external_id",
                ]
            )
            .ngroups
        )

    return {
        "duplicate_rows": duplicate_rows,
        "duplicate_groups": duplicate_groups,
    }


def validate_data_types(
    df: pd.DataFrame,
) -> dict:
    """
    Validate the important data types required by the contract.
    """

    return {
        "external_id_is_string_like": (
            pd.api.types.is_string_dtype(
                df["external_id"]
            )
        ),
        "source_retailer_is_string_like": (
            pd.api.types.is_string_dtype(
                df["source_retailer"]
            )
        ),
        "title_is_string_like": (
            pd.api.types.is_string_dtype(
                df["title"]
            )
        ),
        "price_is_numeric": (
            pd.api.types.is_numeric_dtype(
                df["price"]
            )
        ),
    }


# Statistics

def calculate_null_statistics(
    df: pd.DataFrame,
) -> pd.DataFrame:
    """
    Calculate null count and null percentage for every column.
    """

    total_rows = len(df)

    statistics = []

    for column in df.columns:
        null_count = int(
            df[column].isna().sum()
        )

        null_percentage = (
            (null_count / total_rows) * 100
            if total_rows > 0
            else 0.0
        )

        statistics.append(
            {
                "column": column,
                "total_rows": total_rows,
                "null_count": null_count,
                "null_percentage": round(
                    null_percentage,
                    2,
                ),
            }
        )

    return pd.DataFrame(statistics)


# Quality status

def determine_quality_status(
    report: dict,
    null_statistics: pd.DataFrame,
) -> str:
    """
    Determine the overall Phase 1 quality status.

    FAIL:
        A critical validation issue exists.

    WARNING:
        Required data is valid, but optional data is missing
        or a non-technical schema change was detected.

    PASS:
        No critical or warning conditions were detected.
    """

    missing_required = report[
        "missing_required_values"
    ]

    if any(
        count > 0
        for count in missing_required.values()
    ):
        return "FAIL"

    duplicates = report["duplicates"]

    if duplicates["duplicate_rows"] > 0:
        return "FAIL"

    data_types = report["data_types"]

    if not all(data_types.values()):
        return "FAIL"

    schema = report["input_schema"]

    if not schema["schema_valid"]:
        return "FAIL"

    warning_columns = []

    for _, row in null_statistics.iterrows():
        if (
            row["column"] in OPTIONAL_OUTPUT_COLUMNS
            and row["null_count"] > 0
        ):
            warning_columns.append(
                row["column"]
            )

    if warning_columns:
        return "WARNING"

    if schema["new_columns"]:
        return "WARNING"

    return "PASS"


# Report

def build_validation_report(
    df: pd.DataFrame,
    raw_df: pd.DataFrame,
    null_statistics: pd.DataFrame,
) -> dict:
    """Build the complete Phase 1 validation report."""

    input_schema = validate_input_schema(
        raw_df
    )

    required_columns = (
        validate_required_columns(df)
    )

    missing_required = (
        validate_missing_required_values(df)
    )

    duplicates = validate_duplicates(df)

    data_types = validate_data_types(df)

    report = {
        "phase": "phase_1_validation",
        "version": VERSION,
        "rules_version": RULES_VERSION,
        "row_count": len(df),
        "column_count": len(df.columns),
        "input_schema": input_schema,
        "required_columns": required_columns,
        "missing_required_values": missing_required,
        "duplicates": duplicates,
        "data_types": data_types,
        "null_statistics": null_statistics.to_dict(
            orient="records"
        ),
    }

    report["quality_status"] = (
        determine_quality_status(
            report,
            null_statistics,
        )
    )

    return report


# Main

def run_phase1() -> None:
    """Execute Phase 1 validation."""

    OUTPUT_DIR.mkdir(
        parents=True,
        exist_ok=True,
    )

    VALIDATION_DIR.mkdir(
        parents=True,
        exist_ok=True,
    )

    STATISTICS_DIR.mkdir(
        parents=True,
        exist_ok=True,
    )

    print("Loading raw products...")

    raw_df = load_raw_products()

    print(f"Raw rows: {len(raw_df)}")

    print("Validating input schema...")

    input_schema = validate_input_schema(
        raw_df
    )

    if not input_schema["schema_valid"]:
        print(
            "Phase 1 failed: input schema is invalid."
        )

        print(
            "Missing columns:",
            input_schema["missing_columns"],
        )

        return

    print(
        "Mapping ingestion schema to Phase 1 schema..."
    )

    validated_df = map_to_phase1_schema(
        raw_df
    )

    print("Running validation...")

    null_statistics = (
        calculate_null_statistics(
            validated_df
        )
    )

    report = build_validation_report(
        validated_df,
        raw_df,
        null_statistics,
    )

    print(
        f"Quality status: "
        f"{report['quality_status']}"
    )

    output_path = (
        OUTPUT_DIR
        / "validated_products.parquet"
    )

    statistics_path = (
        STATISTICS_DIR
        / "null_statistics.csv"
    )

    report_path = (
        VALIDATION_DIR
        / "validation_report.json"
    )

    print(
        "Saving validated products..."
    )

    validated_df.to_parquet(
        output_path,
        index=False,
    )

    print(
        "Saving null statistics..."
    )

    null_statistics.to_csv(
        statistics_path,
        index=False,
    )

    print(
        "Saving validation report..."
    )

    with open(
        report_path,
        "w",
    ) as file:
        json.dump(
            report,
            file,
            indent=2,
            default=str,
        )

    print()
    print("Phase 1 completed.")
    print(
        f"Validated rows: {len(validated_df)}"
    )
    print(
        f"Quality status: "
        f"{report['quality_status']}"
    )
    print(
        f"Output: {output_path}"
    )
    print(
        f"Null statistics: "
        f"{statistics_path}"
    )
    print(
        f"Validation report: "
        f"{report_path}"
    )


if __name__ == "__main__":
    run_phase1()