summaryrefslogtreecommitdiff
path: root/java/com/google/android/libraries/mobiledatadownload/internal/logging/DownloadStateLogger.java
blob: 85b13a9280ebde0d9c521bae6ee5c9bdbe315a9b (plain)
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
/*
 * Copyright 2022 Google LLC
 *
 * 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.
 */
package com.google.android.libraries.mobiledatadownload.internal.logging;

import com.google.errorprone.annotations.CheckReturnValue;
import com.google.mobiledatadownload.LogEnumsProto.MddClientEvent;
import com.google.mobiledatadownload.LogProto.DataDownloadFileGroupStats;
import com.google.mobiledatadownload.internal.MetadataProto.DataFileGroupBookkeeping;
import com.google.mobiledatadownload.internal.MetadataProto.DataFileGroupInternal;

/** Helper logger to log the events associated with an MDD Download or Import operation. */
@CheckReturnValue
public final class DownloadStateLogger {
  private static final String TAG = "FileGroupStatusLogger";

  /** The type of operation for which the logger will log events. */
  public enum Operation {
    DOWNLOAD,
    IMPORT,
  };

  private final EventLogger eventLogger;
  private final Operation operation;

  private DownloadStateLogger(EventLogger eventLogger, Operation operation) {
    this.eventLogger = eventLogger;
    this.operation = operation;
  }

  public static DownloadStateLogger forDownload(EventLogger eventLogger) {
    return new DownloadStateLogger(eventLogger, Operation.DOWNLOAD);
  }

  public static DownloadStateLogger forImport(EventLogger eventLogger) {
    return new DownloadStateLogger(eventLogger, Operation.IMPORT);
  }

  /** Gets the operation associated with this logger. */
  public Operation getOperation() {
    return operation;
  }

  public void logStarted(DataFileGroupInternal fileGroup) {
    switch (operation) {
      case DOWNLOAD:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
      case IMPORT:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
    }
  }

  public void logPending(DataFileGroupInternal fileGroup) {
    switch (operation) {
      case DOWNLOAD:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
      case IMPORT:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
    }
  }

  public void logFailed(DataFileGroupInternal fileGroup) {
    switch (operation) {
      case DOWNLOAD:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
      case IMPORT:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
    }
  }

  public void logComplete(DataFileGroupInternal fileGroup) {
    switch (operation) {
      case DOWNLOAD:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        logDownloadLatency(fileGroup);
        break;
      case IMPORT:
        logEventWithDataFileGroup(MddClientEvent.Code.EVENT_CODE_UNSPECIFIED, fileGroup);
        break;
    }
  }

  private void logDownloadLatency(DataFileGroupInternal fileGroup) {
    // This operation only makes sense for download operation, exit early if it's not the download
    // operation.
    if (operation != Operation.DOWNLOAD) {
      return;
    }

    DataDownloadFileGroupStats fileGroupDetails =
        DataDownloadFileGroupStats.newBuilder()
            .setOwnerPackage(fileGroup.getOwnerPackage())
            .setFileGroupName(fileGroup.getGroupName())
            .setFileGroupVersionNumber(fileGroup.getFileGroupVersionNumber())
            .setFileCount(fileGroup.getFileCount())
            .setBuildId(fileGroup.getBuildId())
            .setVariantId(fileGroup.getVariantId())
            .build();

    DataFileGroupBookkeeping bookkeeping = fileGroup.getBookkeeping();
    long newFilesReceivedTimestamp = bookkeeping.getGroupNewFilesReceivedTimestamp();
    long downloadStartedTimestamp = bookkeeping.getGroupDownloadStartedTimestampInMillis();
    long downloadCompleteTimestamp = bookkeeping.getGroupDownloadedTimestampInMillis();

    Void downloadLatency = null;

    eventLogger.logMddDownloadLatency(fileGroupDetails, downloadLatency);
  }

  private void logEventWithDataFileGroup(
      MddClientEvent.Code code, DataFileGroupInternal fileGroup) {
    eventLogger.logEventSampled(
        code,
        fileGroup.getGroupName(),
        fileGroup.getFileGroupVersionNumber(),
        fileGroup.getBuildId(),
        fileGroup.getVariantId());
  }
}