Adding Util class for FIrebaseInstallations APIs. #676
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // Copyright 2019 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.firebase.installation; | ||
ankitaj224 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import androidx.test.runner.AndroidJUnit4; | ||
| import org.junit.FixMethodOrder; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.MethodSorters; | ||
|
|
||
| /** | ||
| * Instrumented test, which will execute on an Android device. | ||
| * | ||
| * @see <a href="http://d.android.com/tools/testing">Testing documentation</a> | ||
| */ | ||
| @RunWith(AndroidJUnit4.class) | ||
| @FixMethodOrder(MethodSorters.NAME_ASCENDING) | ||
| public class FirebaseInstallationInstrumentedTest {} | ||
ankitaj224 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright 2019 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.firebase.installations; | ||
ankitaj224 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import androidx.annotation.NonNull; | ||
| import com.google.firebase.FirebaseException; | ||
|
|
||
| /** The class for all Exceptions thrown by {@link FirebaseInstallations}. */ | ||
| public class FirebaseInstallationException extends FirebaseException { | ||
ankitaj224 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| public enum Status { | ||
| SDK_INTERNAL_ERROR, | ||
|
|
||
|
There was a problem hiding this comment. I suggest to sync with mertcan@ or Rayo about what status we want to expose to dev There was a problem hiding this comment. @andirayo or @mmermerkaya Whats the high level exception code to be shown to developers in case FIS requests fail? Currently, I have SDK_INTERNAL_ERROR. There was a problem hiding this comment. I would check with Mertcan's Web-SDK or Maksym's iOS-SDK, but as far as I remember (without checking) I think we are pretty explicit with our error messages. |
||
| CLIENT_ERROR | ||
| } | ||
|
|
||
| @NonNull private final Status status; | ||
|
|
||
| public FirebaseInstallationException(@NonNull Status status) { | ||
| this.status = status; | ||
| } | ||
|
|
||
| public FirebaseInstallationException(@NonNull String message, @NonNull Status status) { | ||
| super(message); | ||
| this.status = status; | ||
| } | ||
|
|
||
| public FirebaseInstallationException( | ||
| @NonNull String message, @NonNull Status status, @NonNull Throwable cause) { | ||
| super(message, cause); | ||
| this.status = status; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the status status for the operation that failed. | ||
|
|
||
| * | ||
| * @return the status for the FirebaseInstallationsException | ||
| */ | ||
| @NonNull | ||
| public Status getStatus() { | ||
| return status; | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| // Copyright 2019 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.firebase.installations; | ||
|
|
||
| import androidx.annotation.NonNull; | ||
| import java.nio.charset.Charset; | ||
| import java.util.UUID; | ||
|
|
||
| /** Util methods used for {@link FirebaseInstallations} */ | ||
| class Utils { | ||
|
|
||
| /** | ||
| * 1 Byte with the first 4 header-bits set to the identifying FID prefix 0111 (0x7). Use this | ||
| * constant to create FIDs or check the first byte of FIDs. This prefix is also used in legacy | ||
| * Instance-IDs | ||
| */ | ||
| public static final byte FID_4BIT_PREFIX = Byte.parseByte("01110000", 2); | ||
|
|
||
| /** | ||
| * Byte mask to remove the 4 header-bits of a given Byte. Use this constant with Java's Binary AND | ||
| * Operator in order to remove the first 4 bits of a Byte and replacing it with the FID prefix. | ||
| */ | ||
| public static final byte REMOVE_PREFIX_MASK = Byte.parseByte("00001111", 2); | ||
|
|
||
| /** Length of new-format FIDs. */ | ||
|
There was a problem hiding this comment. maybe add " (as introduced 2019)" |
||
| public static final int FID_LENGTH = 22; | ||
|
|
||
| /** | ||
| * Creates a random FID of valid format without checking if the FID is already in use by any | ||
| * Firebase Installation. | ||
| * | ||
| * <p>Note: Even though this method does not check with the FIS database if the returned FID is | ||
| * already in use, the probability of collision is extremely and negligibly small! | ||
| * | ||
| * @return random FID value | ||
| */ | ||
| @NonNull | ||
| public static String createRandomFid() { | ||
| // A valid FID has exactly 22 base64 characters, which is 132 bits, or 16.5 bytes. | ||
| // We create 17 random bytes and ignore the last base64 character later. | ||
| byte[] bytes = UUID.randomUUID().toString().substring(0, 17).getBytes(Charset.defaultCharset()); | ||
|
There was a problem hiding this comment. @diwu-arete Please check if this is inline with the comments on the doc There was a problem hiding this comment. I think this is the right thing to do, and your encoding logic also looks good to me. But definitely please ping Rayo to take a look at these key logic. There was a problem hiding this comment. @andirayo Can you please review the random fid generation logic? Thanks. There was a problem hiding this comment. This does NOT look good to me. I don't know what #randomUUID() does, or more precisely I don't know what #toString() does, but I fear that this may return the default UUID format containing dashes ("-"). ======================= ======================= There was a problem hiding this comment. Thanks for detailed explanation. As discussed through emails, I have implemented the FID creation as per Maksyms approach and now creates 2^128 FIDs. wdyt of this approach? |
||
|
|
||
| // Replace the first 4 random bits with the constant FID header of 0x7 (0b0111). | ||
| bytes[0] = (byte) (FID_4BIT_PREFIX | (bytes[0] & REMOVE_PREFIX_MASK)); | ||
|
|
||
| return encodeFidBase64UrlSafe(bytes); | ||
| } | ||
|
|
||
| /** | ||
| * Converts a given byte-array (assumed to be an FID value) to base64-url-safe encoded | ||
| * String-representation. | ||
| * | ||
| * <p>Note: The returned String has at most 22 characters, the length of FIDs. Thus, it is | ||
| * recommended to deliver a byte-array containing at least 16.5 bytes. | ||
| * | ||
| * @param rawValue FID value to be encoded | ||
| * @return (22-character or shorter) String containing the base64-encoded value | ||
| */ | ||
| private static String encodeFidBase64UrlSafe(byte[] rawValue) { | ||
| return new String( | ||
|
There was a problem hiding this comment. Again, I don't know enough of what is actually happening here, but why do we have to call "new String" here? There was a problem hiding this comment. android.util.Base64.encode returns bytes. |
||
| android.util.Base64.encode( | ||
| rawValue, | ||
| android.util.Base64.URL_SAFE | ||
| | android.util.Base64.NO_PADDING | ||
| | android.util.Base64.NO_WRAP), | ||
| Charset.defaultCharset()) | ||
| .substring(0, FID_LENGTH); | ||
| } | ||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.