|
| 1 | +// Copyright 2018 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +package com.google.firebase.inappmessaging.internal; |
| 16 | + |
| 17 | +import android.os.Bundle; |
| 18 | +import androidx.annotation.GuardedBy; |
| 19 | +import androidx.annotation.NonNull; |
| 20 | +import androidx.annotation.Nullable; |
| 21 | +import com.google.firebase.analytics.connector.AnalyticsConnector; |
| 22 | +import com.google.firebase.inject.Deferred; |
| 23 | +import java.util.Collections; |
| 24 | +import java.util.HashSet; |
| 25 | +import java.util.List; |
| 26 | +import java.util.Map; |
| 27 | +import java.util.Set; |
| 28 | + |
| 29 | +/** |
| 30 | + * Proxy connector that delegates to analytics when it's available. |
| 31 | + * |
| 32 | + * <p>For a subset of functionality it also caches calls and propagates them to analytics once it |
| 33 | + * loads. |
| 34 | + */ |
| 35 | +public class ProxyAnalyticsConnector implements AnalyticsConnector { |
| 36 | + private volatile Object instance; |
| 37 | + |
| 38 | + public ProxyAnalyticsConnector(Deferred<AnalyticsConnector> analyticsConnector) { |
| 39 | + instance = analyticsConnector; |
| 40 | + analyticsConnector.whenAvailable(connectorProvider -> instance = connectorProvider.get()); |
| 41 | + } |
| 42 | + |
| 43 | + private AnalyticsConnector safeGet() { |
| 44 | + Object result = instance; |
| 45 | + if (result instanceof AnalyticsConnector) { |
| 46 | + return (AnalyticsConnector) result; |
| 47 | + } |
| 48 | + return null; |
| 49 | + } |
| 50 | + |
| 51 | + @Override |
| 52 | + public void logEvent(@NonNull String s, @NonNull String s1, @NonNull Bundle bundle) { |
| 53 | + AnalyticsConnector connector = safeGet(); |
| 54 | + if (connector != null) { |
| 55 | + connector.logEvent(s, s1, bundle); |
| 56 | + } |
| 57 | + } |
| 58 | + |
| 59 | + @Override |
| 60 | + public void setUserProperty(@NonNull String s, @NonNull String s1, @NonNull Object o) { |
| 61 | + AnalyticsConnector connector = safeGet(); |
| 62 | + if (connector != null) { |
| 63 | + connector.setUserProperty(s, s1, o); |
| 64 | + } |
| 65 | + } |
| 66 | + |
| 67 | + // Not implemented since it's not used by fiam |
| 68 | + @NonNull |
| 69 | + @Override |
| 70 | + public Map<String, Object> getUserProperties(boolean b) { |
| 71 | + return Collections.emptyMap(); |
| 72 | + } |
| 73 | + |
| 74 | + @NonNull |
| 75 | + @Override |
| 76 | + public AnalyticsConnectorHandle registerAnalyticsConnectorListener( |
| 77 | + @NonNull String s, @NonNull AnalyticsConnectorListener analyticsConnectorListener) { |
| 78 | + Object result = instance; |
| 79 | + if (result instanceof AnalyticsConnector) { |
| 80 | + return ((AnalyticsConnector) result) |
| 81 | + .registerAnalyticsConnectorListener(s, analyticsConnectorListener); |
| 82 | + } |
| 83 | + @SuppressWarnings("unchecked") |
| 84 | + Deferred<AnalyticsConnector> deferred = (Deferred<AnalyticsConnector>) result; |
| 85 | + return new ProxyAnalyticsConnectorHandle(s, analyticsConnectorListener, deferred); |
| 86 | + } |
| 87 | + |
| 88 | + // Not implemented since it's not used by fiam. |
| 89 | + @Override |
| 90 | + public void setConditionalUserProperty( |
| 91 | + @NonNull ConditionalUserProperty conditionalUserProperty) {} |
| 92 | + |
| 93 | + // Not implemented since it's not used by fiam. |
| 94 | + @Override |
| 95 | + public void clearConditionalUserProperty( |
| 96 | + @NonNull String s, @Nullable String s1, @Nullable Bundle bundle) {} |
| 97 | + |
| 98 | + // Not implemented since it's not used by fiam. |
| 99 | + @NonNull |
| 100 | + @Override |
| 101 | + public List<ConditionalUserProperty> getConditionalUserProperties( |
| 102 | + @NonNull String s, @Nullable String s1) { |
| 103 | + return Collections.emptyList(); |
| 104 | + } |
| 105 | + |
| 106 | + // Not implemented since it's not used by fiam. |
| 107 | + @Override |
| 108 | + public int getMaxUserProperties(@NonNull String s) { |
| 109 | + return 0; |
| 110 | + } |
| 111 | + |
| 112 | + private static class ProxyAnalyticsConnectorHandle implements AnalyticsConnectorHandle { |
| 113 | + private static final Object UNREGISTERED = new Object(); |
| 114 | + |
| 115 | + @GuardedBy("this") |
| 116 | + private Set<String> eventNames = new HashSet<>(); |
| 117 | + |
| 118 | + private volatile Object instance; |
| 119 | + |
| 120 | + private ProxyAnalyticsConnectorHandle( |
| 121 | + String s, |
| 122 | + AnalyticsConnectorListener listener, |
| 123 | + Deferred<AnalyticsConnector> analyticsConnector) { |
| 124 | + analyticsConnector.whenAvailable( |
| 125 | + connectorProvider -> { |
| 126 | + Object result = instance; |
| 127 | + if (result == UNREGISTERED) { |
| 128 | + return; |
| 129 | + } |
| 130 | + AnalyticsConnector connector = connectorProvider.get(); |
| 131 | + // Now that analytics is available: |
| 132 | + |
| 133 | + // register the listener with analytics. |
| 134 | + AnalyticsConnectorHandle handle = |
| 135 | + connector.registerAnalyticsConnectorListener(s, listener); |
| 136 | + instance = handle; |
| 137 | + |
| 138 | + // propagate registered event names to analytics. |
| 139 | + synchronized (ProxyAnalyticsConnectorHandle.this) { |
| 140 | + if (!eventNames.isEmpty()) { |
| 141 | + handle.registerEventNames(eventNames); |
| 142 | + eventNames = new HashSet<>(); |
| 143 | + } |
| 144 | + } |
| 145 | + }); |
| 146 | + } |
| 147 | + |
| 148 | + @Override |
| 149 | + public void unregister() { |
| 150 | + Object result = instance; |
| 151 | + if (result == UNREGISTERED) { |
| 152 | + return; |
| 153 | + } |
| 154 | + |
| 155 | + if (result != null) { |
| 156 | + AnalyticsConnectorHandle handle = (AnalyticsConnectorHandle) result; |
| 157 | + handle.unregister(); |
| 158 | + } |
| 159 | + instance = UNREGISTERED; |
| 160 | + synchronized (this) { |
| 161 | + eventNames.clear(); |
| 162 | + } |
| 163 | + } |
| 164 | + |
| 165 | + @Override |
| 166 | + public void registerEventNames(@NonNull Set<String> set) { |
| 167 | + Object result = instance; |
| 168 | + if (result == UNREGISTERED) { |
| 169 | + return; |
| 170 | + } |
| 171 | + |
| 172 | + if (result != null) { |
| 173 | + AnalyticsConnectorHandle handle = (AnalyticsConnectorHandle) result; |
| 174 | + handle.registerEventNames(set); |
| 175 | + return; |
| 176 | + } |
| 177 | + synchronized (this) { |
| 178 | + eventNames.addAll(set); |
| 179 | + } |
| 180 | + } |
| 181 | + |
| 182 | + @Override |
| 183 | + public void unregisterEventNames() { |
| 184 | + Object result = instance; |
| 185 | + if (result == UNREGISTERED) { |
| 186 | + return; |
| 187 | + } |
| 188 | + if (result != null) { |
| 189 | + AnalyticsConnectorHandle handle = (AnalyticsConnectorHandle) result; |
| 190 | + handle.unregisterEventNames(); |
| 191 | + return; |
| 192 | + } |
| 193 | + synchronized (this) { |
| 194 | + eventNames.clear(); |
| 195 | + } |
| 196 | + } |
| 197 | + } |
| 198 | +} |
0 commit comments