feat(rc): Add Remote Config Version Management API #920

lahirumaramba · 2020-06-24T17:45:55Z

RELEASE NOTES: Added version management support for admin.remoteConfig() API. This API now supports listVersions(), getTemplateAtVersion(), and rollback() operations to help developers programmatically manage their Remote Config templates.

* Get remote config template by version number

* Refactor unit tests

* Add Remote Config Rollback operation * Update docs and move etag validation to a helper function * Update docs * Introduce a util to create a template from API response * PR fixes

* Remote Config: Add list versions operation * Add version Impl and other PR fixes * PR fixes * Imrpoved unit tests and some code clean up * Fix code formatting

* Add version meta data to RC templates * PR fixes * Use assertion to unwrap template.version

lahirumaramba · 2020-06-24T17:47:05Z

Integration tests will be added once we merge #914

egilmorez

Some things for you to look at, thanks Lahiru!

egilmorez · 2020-06-24T18:19:57Z

src/index.d.ts

@@ -878,6 +878,11 @@ declare namespace admin.remoteConfig {
     * ETag of the current Remote Config template (readonly).
     */
    readonly etag: string;
+
+    /**
+     * Version information of the current Remote Config template.


Does this return just a number?

I lean toward "information for" unless it's just a "version number of"

Thanks! It is not just a number. Changed to information for.

egilmorez · 2020-06-24T18:21:07Z

src/index.d.ts

+   * Interface representing a Remote Config template version.
+   * Output only, except for the version description. Contains metadata about a particular
+   * version of the Remote Config template. All fields are set at the time the specified Remote
+   * Config template was published. A version's description field may be specified in


Suggest "is published"

egilmorez · 2020-06-24T18:21:57Z

src/index.d.ts

+
+    /**
+     * The timestamp of when this version of the Remote Config template was written to the
+     * Remote Config server.


Suggest "backend" instead of server, unless it's inaccurate. We use backend a lot in the guide docs.

Thanks. backend makes more sense here.

egilmorez · 2020-06-24T18:22:52Z

src/index.d.ts

+    updateTime?: string;
+
+    /**
+     * The source of origin of the template update action.


Suggest just "origin"

egilmorez · 2020-06-24T18:27:57Z

src/index.d.ts

+     */
+    description?: string;
+
+    /**


Suggest a bit of a rewrite:

"The version number of
the Remote Config template that has become the current version due to a rollback. Only present if this version is the result of a rollback."

Is this accurate? :)

This is accurate! Thanks. Updated.

egilmorez · 2020-06-24T18:31:53Z

src/index.d.ts

+    pageToken?: string;
+
+    /** 
+     * Specify the newest version number to include in the results.


Suggest "Specifies" here and below.

egilmorez · 2020-06-24T18:33:24Z

src/index.d.ts

+    * A rollback is equivalent to getting a previously published Remote Config
+    * template and re-publishing it using a force update.
+    * 
+    * @param versionNumber The version number of the Remote Config template to rollback to.


Suggest "roll back to"

egilmorez · 2020-06-24T18:33:48Z

src/index.d.ts

+    * 
+    * @param versionNumber The version number of the Remote Config template to rollback to.
+    *    The specified version number must be lower than the current version number, and not have
+    *    been deleted due to staleness.


What's the limit on this? 300 versions/90 days?

Might be good to mention here, not sure. It's right below as well :)

Added 300 versions/90 days text here as well

egilmorez · 2020-06-24T18:35:19Z

src/index.d.ts

+    /**
+    * Gets a list of Remote Config template versions that have been published, sorted in reverse 
+    * chronological order. Only the last 300 versions are stored.
+    * All versions that correspond to non-active Remote Config templates (i.e., all except the 


Suggest "that is, all except . . ."

egilmorez · 2020-06-24T18:35:38Z

src/index.d.ts

+    * template that is being fetched by clients) are also deleted if they are older than 90 days.
+    * 
+    * @param options Optional {@link admin.remoteConfig.ListVersionsOptions `ListVersionsOptions`}
+    *    object for getting a list of tempalte versions.


Good catch! Thanks!

- Update Remote Config Docstrings in index.d.ts

egilmorez

Thanks Lahiru! All good from a docs perspective.

lahirumaramba added 6 commits May 7, 2020 14:20

Get remote config template by version number (#874)

e7af8bb

* Get remote config template by version number

Refactor unit tests for Remote Config (#884)

773add8

* Refactor unit tests

Add Remote Config Rollback operation (#885)

5762470

* Add Remote Config Rollback operation * Update docs and move etag validation to a helper function * Update docs * Introduce a util to create a template from API response * PR fixes

Remote Config Add list versions operation (#896)

bde53cc

* Remote Config: Add list versions operation * Add version Impl and other PR fixes * PR fixes * Imrpoved unit tests and some code clean up * Fix code formatting

Add a separate function to get a Template with version (#902)

16b20f1

Add version meta data to RC templates (#906)

cf10110

* Add version meta data to RC templates * PR fixes * Use assertion to unwrap template.version

lahirumaramba added the release-note label Jun 24, 2020

lahirumaramba requested a review from hiranya911 June 24, 2020 17:46

lahirumaramba assigned hiranya911 Jun 24, 2020

lahirumaramba requested a review from egilmorez June 24, 2020 17:46

lahirumaramba assigned egilmorez Jun 24, 2020

egilmorez reviewed Jun 24, 2020

View reviewed changes

Update Remote Config Docstrings in index.d.ts

a1e589f

- Update Remote Config Docstrings in index.d.ts

egilmorez approved these changes Jun 24, 2020

View reviewed changes

lahirumaramba unassigned egilmorez Jun 24, 2020

Merge branch 'master' into remote-config-vc

0438241

hiranya911 approved these changes Jun 25, 2020

View reviewed changes

hiranya911 assigned lahirumaramba and unassigned hiranya911 Jun 25, 2020

lahirumaramba merged commit eec3660 into master Jun 25, 2020

k-azadzoi mentioned this pull request Sep 5, 2024

[Snyk] Upgrade firebase-admin from 8.12.1 to 8.13.0 k-azadzoi/plogalong#5

Open

feat(rc): Add Remote Config Version Management API #920

feat(rc): Add Remote Config Version Management API #920

Uh oh!

Conversation

lahirumaramba commented Jun 24, 2020

Uh oh!

lahirumaramba commented Jun 24, 2020

Uh oh!

egilmorez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

egilmorez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!