From d77e86ef29302bc79c78be039b7fa012b1945b2d Mon Sep 17 00:00:00 2001 From: Erik Macik Date: Mon, 15 Jul 2019 10:55:36 -0700 Subject: [PATCH 01/10] Adding code comments to remoteConfig.ts source --- src/providers/remoteConfig.ts | 48 +++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 11 deletions(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index cd32e5423..6042890bf 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -35,9 +35,13 @@ export const provider = 'google.firebase.remoteconfig'; export const service = 'firebaseremoteconfig.googleapis.com'; /** - * Handle all updates (including rollbacks) that affect a Remote Config project. - * @param handler A function that takes the updated Remote Config template - * version metadata as an argument. + * Registers a function that triggers on Firebase Remote Config template + * update events. + * + * @param handler A function that takes the updated Remote Config + * template version metadata as an argument. + * + * @return A Cloud Function which you can export and deploy. */ export function onUpdate( handler: ( @@ -97,8 +101,8 @@ export class UpdateBuilder { } /** - * Interface representing a Remote Config template version metadata object that - * was emitted when the project was updated. + * An interface representing a Remote Config template version metadata object + * emitted when a project is updated. */ export interface TemplateVersion { /** The version number of the updated Remote Config template. */ @@ -107,27 +111,49 @@ export interface TemplateVersion { /** When the template was updated in format (ISO8601 timestamp). */ updateTime: string; - /** Metadata about the account that performed the update. */ + /** + * Metadata about the account that performed the update, of + * type [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser). + */ updateUser: RemoteConfigUser; - /** A description associated with the particular Remote Config template. */ + /** A description associated with this Remote Config template version. */ description: string; - /** The origin of the caller. */ + /** + * The origin of the caller, either the Firebase console or the Remote Config + * REST API. See [`RemoteConfigUpdateOrigin`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdateorigin) + * for valid values. + */ updateOrigin: string; - /** The type of update action that was performed. */ + /** + * The type of update action that was performed, whether forced, + * incremental, or a rollback operation. See + * [`RemoteConfigUpdateType`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdatetype) + * for valid values. + */ updateType: string; /** - * The version number of the Remote Config template that was rolled back to, - * if the update was a rollback. + * The version number of the Remote Config template that was this update rolled + * back to, if the update was a rollback. */ rollbackSource?: number; } +/** + * An interface representing metadata for a Remote Config account + * that performed an update. Contains the same fields as + * [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser). + */ export interface RemoteConfigUser { + /** Name of the Remote Config account that performed an update. */ name?: string; + + /** Email address of the Remote Config account that performed an update. */ email: string; + + /** Image URL of the Remote Config account that performed an update. */ imageUrl?: string; } From 8ebf53fe85fc1594fc06c5d06e9a8bef844b4936 Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:09:51 -0700 Subject: [PATCH 02/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 6042890bf..919ae8cc9 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -144,7 +144,7 @@ export interface TemplateVersion { /** * An interface representing metadata for a Remote Config account - * that performed an update. Contains the same fields as + * that performed the update. Contains the same fields as * [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser). */ export interface RemoteConfigUser { From a3ae6b6df891215c632eb71034f8d93c80de617a Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:10:10 -0700 Subject: [PATCH 03/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 919ae8cc9..ebfc3c1f1 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -148,7 +148,7 @@ export interface TemplateVersion { * [`RemoteConfigUser`](/docs/reference/remote-config/rest/v1/Version#remoteconfiguser). */ export interface RemoteConfigUser { - /** Name of the Remote Config account that performed an update. */ + /** Name of the Remote Config account that performed the update. */ name?: string; /** Email address of the Remote Config account that performed an update. */ From e5ba3f95e4f7a65b07fd07b6047ec5d4af3b1631 Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:10:17 -0700 Subject: [PATCH 04/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index ebfc3c1f1..73adf26b9 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -151,7 +151,7 @@ export interface RemoteConfigUser { /** Name of the Remote Config account that performed the update. */ name?: string; - /** Email address of the Remote Config account that performed an update. */ + /** Email address of the Remote Config account that performed the update. */ email: string; /** Image URL of the Remote Config account that performed an update. */ From 346ce0079208753475bb9ed8b66ba094e48c104c Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:10:28 -0700 Subject: [PATCH 05/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 73adf26b9..a1b10c02d 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -154,6 +154,6 @@ export interface RemoteConfigUser { /** Email address of the Remote Config account that performed the update. */ email: string; - /** Image URL of the Remote Config account that performed an update. */ + /** Image URL of the Remote Config account that performed the update. */ imageUrl?: string; } From 9a4686bcfcd7a8176d4b41a400324813c202d055 Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:10:45 -0700 Subject: [PATCH 06/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index a1b10c02d..477c7c69d 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -121,7 +121,7 @@ export interface TemplateVersion { description: string; /** - * The origin of the caller, either the Firebase console or the Remote Config + * The origin of the caller - either the Firebase console or the Remote Config * REST API. See [`RemoteConfigUpdateOrigin`](/docs/reference/remote-config/rest/v1/Version#remoteconfigupdateorigin) * for valid values. */ From c6c69093612ff531c81a082d24a7fb57913c2065 Mon Sep 17 00:00:00 2001 From: Erik Macik <42585523+esmacik@users.noreply.github.com> Date: Mon, 15 Jul 2019 15:10:59 -0700 Subject: [PATCH 07/10] Update src/providers/remoteConfig.ts Co-Authored-By: Diana Tkachenko <31747099+thechenky@users.noreply.github.com> --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 477c7c69d..5d1152562 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -41,7 +41,7 @@ export const service = 'firebaseremoteconfig.googleapis.com'; * @param handler A function that takes the updated Remote Config * template version metadata as an argument. * - * @return A Cloud Function which you can export and deploy. + * @return A Cloud Function that you can export and deploy. */ export function onUpdate( handler: ( From 681a308b93c8bdea02f6e635834ee79e08e8776b Mon Sep 17 00:00:00 2001 From: Erik Macik Date: Mon, 15 Jul 2019 15:40:05 -0700 Subject: [PATCH 08/10] Revised wording for TemplateVersion.rollBackSource --- src/providers/remoteConfig.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 5d1152562..59771c28b 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -136,8 +136,9 @@ export interface TemplateVersion { updateType: string; /** - * The version number of the Remote Config template that was this update rolled - * back to, if the update was a rollback. + * + * The version number of the Remote config template that this update rolled back to. + * Only applies of this update was a rollback. */ rollbackSource?: number; } From beb2e293ada04e1f34ba6208ec8d2560ee4c8021 Mon Sep 17 00:00:00 2001 From: Erik Macik Date: Mon, 15 Jul 2019 15:45:56 -0700 Subject: [PATCH 09/10] Adding only npm run format:fix, everything else is the same as my previous commit --- src/providers/remoteConfig.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 59771c28b..39846a1ad 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -136,7 +136,7 @@ export interface TemplateVersion { updateType: string; /** - * + * * The version number of the Remote config template that this update rolled back to. * Only applies of this update was a rollback. */ From 099e30ef42089caf62fb2f1b51d06eba62719b62 Mon Sep 17 00:00:00 2001 From: Erik Macik Date: Mon, 15 Jul 2019 16:27:08 -0700 Subject: [PATCH 10/10] Fixed some small typos found by Diana, 'if' and 'Config' --- src/providers/remoteConfig.ts | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/providers/remoteConfig.ts b/src/providers/remoteConfig.ts index 39846a1ad..f15716c17 100644 --- a/src/providers/remoteConfig.ts +++ b/src/providers/remoteConfig.ts @@ -136,9 +136,8 @@ export interface TemplateVersion { updateType: string; /** - * - * The version number of the Remote config template that this update rolled back to. - * Only applies of this update was a rollback. + * The version number of the Remote Config template that this update rolled back to. + * Only applies if this update was a rollback. */ rollbackSource?: number; }