RAD-5740: cache-recent-locations-in-websdk-with-variable-ttl #86

boonboonsiri · 2023-01-26T17:00:36Z

Requirements

Linear ticked is associated with PR
Tests have been added (if not, explain why)
Feature flags have been added and default to off in production
Docs have been updated (if applicable)
Internal docs have been updated
QA is done and documented below

Difficult to write test for. Tested manually:

QA details

Include screenshots, responses, or steps to verify the code works as expected

Can verify locally by setting up local sdk, or verify that it works using vercel:

https://frontend-git-boon-sdk-demo-branch-radarlabs.vercel.app/demo/js

Currently cached location time is 30 seconds. So go to link in safari, enter prompt for location.

After you can continuously reload for up to 30 seconds without being re-prompted for your location, but then after 30 seconds you'll get prompted again

I probably should have just installed loom on safari but here we are:

https://youtu.be/VU5nAQ74pyo

docs:
radarlabs/documentation#232

boonboonsiri · 2023-01-26T17:00:53Z

Ask about which branch to merge this into

boonboonsiri · 2023-01-26T18:58:39Z

You can get prompted like after which I believe is intended

boonboonsiri · 2023-01-26T19:35:50Z

Note time to live specifically exists for Track.trackOnce and not for all location request. Not that difficult to set this up for all location request (just need to move code)

kochis · 2023-01-27T14:51:46Z

src/index.js

    if (!publishableKey) {
      console.error('Radar "initialize" was called without a publishable key');
    }
    Storage.setItem(Storage.PUBLISHABLE_KEY, publishableKey);
+    if(options){


this will technically always be set since we have the default argument above

kochis · 2023-01-27T15:01:28Z

src/index.js

    if (!publishableKey) {
      console.error('Radar "initialize" was called without a publishable key');
    }
    Storage.setItem(Storage.PUBLISHABLE_KEY, publishableKey);
+    if(options){
+      let {locationTimeToLive} = options


use const instead of let if it's not being reassigned.

kochis · 2023-01-27T15:05:37Z

src/index.js

+    if(options){
+      let {locationTimeToLive} = options
+
+      if(locationTimeToLive && typeof(locationTimeToLive) === 'number'){


Maybe we should throw a warning if it's set but not a number, but also be more lenient and accept number strings.

if (locationTimeToLive) { const number = Number(locationTimeToLive); if (Number.isNaN(number)) { console.warn('Radar SDK: invalid number for option "locationTimeToLive"')); } else { Storage.setItem(Storage.LOCATION_TIME_TO_LIVE, locationTimeToLive) } }

kochis · 2023-01-27T15:14:20Z

src/navigator.js

+          Storage.setItem(Storage.LAST_LOCATION_TIME, Date.now())
+          Storage.setItem(Storage.LATITUDE, latitude)
+          Storage.setItem(Storage.LONGITUDE, longitude)
+          Storage.setItem(Storage.ACCURACY, accuracy)


I think we can just roll these all up into JSON and use one key instead of having the separate fields. Also maybe we should only cache it if the setting is enabled.

if (locationTimeToLive) { const lastLocation = { latitude, longitude, accuracy, updatedAt: Date.now() }; Storage.setItem(Storage.LAST_LOCATION, JSON.stringify(lastLocation)); }

And then when we read it out, we can do JSON.parse

if (locationTimeToLive) { try { const lastLocation = JSON.parse(Storage.getItem(Storage.LAST_LOCATION)); const { latitude, longitude, accuracy, updatedAt } = lastLocation; // check expiration stuff goes here } catch (e) { console.warn('Radar SDK: could not load cached location.'); } }

boonboonsiri · 2023-01-30T14:57:34Z

Okay changes made. Back at you @kochis

kochis · 2023-01-30T17:58:02Z

src/index.js

    if (!publishableKey) {
      console.error('Radar "initialize" was called without a publishable key');
    }
    Storage.setItem(Storage.PUBLISHABLE_KEY, publishableKey);
+
+    if(Object.keys(options).length === 0){
+      const {locationTimeToLive} = options


Lets actually name this cacheLocationMinutes. It's a bit more clear what it's used for (and the format it expects).

kochis · 2023-01-30T17:58:23Z

src/index.js

    if (!publishableKey) {
      console.error('Radar "initialize" was called without a publishable key');
    }
    Storage.setItem(Storage.PUBLISHABLE_KEY, publishableKey);
+
+    if(Object.keys(options).length === 0){


Is this check correct? I also don't think we need it (options will be {} by default).

https://stackoverflow.com/questions/6072590/how-to-match-an-empty-dictionary-in-javascript
That's apparently one of the ways to handle empty dictionary's in JS

Wait I see what you mean about it being 0. Which is really weird cause when I was testing it yesterday the code worked, but maybe it was just using old cache values and I didn't realize. Also yeah that's a good point that this is unneeded

I more so did it in case we have options in the future to avoid checking all the options upon first loading if there were no objects passed in by default, but right now since we have only one it is fine

kochis · 2023-01-30T17:58:46Z

src/navigator.js

@@ -8,6 +9,24 @@ class Navigator {
        return reject(STATUS.ERROR_LOCATION);
      }

+      let locationTimeToLive = parseFloat(Storage.getItem(Storage.LOCATION_TIME_TO_LIVE));


kochis · 2023-01-30T18:01:20Z

src/navigator.js

+          if (locationTimeToLive) {
+            const lastLocation = { latitude, longitude, accuracy, updatedAt: Date.now() };
+            Storage.setItem(Storage.LAST_LOCATION, JSON.stringify(lastLocation));
+          }


It probably makes sense to bake in the expiration here too.

if (locationTimeToLive) { const updatedAt = Date.now(); const expiresAt = updatedAt + (locationTimeToLive * 60 * 1000); // convert to ms const lastLocation = { latitude, longitude, accuracy, updatedAt, expiresAt }; Storage.setItem(Storage.LAST_LOCATION, JSON.stringify(lastLocation)); }

Then when we read it out, we just need to check

if (Date.now() < parseInt(lastLocation.expiresAt())) {

Yeah sure but then what's the point of storing updatedAt? Like either way you only have to store one or the other? I just happened to choose updatedAt vs expiresAt

corypisano · 2023-01-31T20:25:43Z

src/index.js

    if (!publishableKey) {
      console.error('Radar "initialize" was called without a publishable key');
    }
    Storage.setItem(Storage.PUBLISHABLE_KEY, publishableKey);
+
+
+    const {cacheLocationMinutes} = options


nit: space around the brackets { cacheLocationMinutes } for consistency, and semicolon at end

corypisano · 2023-01-31T20:30:53Z

src/index.js

+
+    const {cacheLocationMinutes} = options
+
+    if (cacheLocationMinutes) {


hm we might want an else that clears it if cachedLocationMinutes is not passed in. in the past, I've run into issues from local storage items getting set and sticking around unintended

for example if you call initialize with cachedLocationMinutes=5, then you want to turn it off or on a separate initialize it will stick around even if you don't pass in the field.

corypisano · 2023-01-31T20:46:25Z

src/navigator.js

+      const cacheLocationMinutes = parseFloat(Storage.getItem(Storage.CACHE_LOCATION_MINUTES));
+      if (cacheLocationMinutes) {
+        try {
+          const lastLocation = JSON.parse(Storage.getItem(Storage.LAST_LOCATION));


we should probably skip the rest if LAST_LOCATION is null, think it will error for the first call and go to the warn since there will be undefined fields

boonboonsiri · 2023-02-01T16:52:28Z

Back at you @corypisano

corypisano · 2023-02-02T19:21:30Z

cool i'll bump the sdk version, and just gonna fix some formatting (we should bring lint setup here but separate issue)

…bsdk-with-variable-ttl

Basic layout code to cache tiem

5a0e832

boonboonsiri self-assigned this Jan 26, 2023

boonboonsiri added 4 commits January 26, 2023 12:55

Added functionality to store values

3e3f9e8

Added functionality to store time to live in options

6580319

formatting

e15b2f8

Unix time in js is in fact in miliseconds plus fixing type casting

66000c6

set variable name

9ce606c

boonboonsiri mentioned this pull request Jan 26, 2023

RAD-5740 cache recent locations in websdk with variable ttl docs radarlabs/documentation#232

Merged

boonboonsiri added 3 commits January 26, 2023 15:45

fixes

1fdc0df

moved changes to be for all navigatin and not just track.trackOnce

2e25a54

formatting

08bb202

kochis reviewed Jan 27, 2023

View reviewed changes

Craig changes, store things differently, bug fixes

601fa42

kochis reviewed Jan 30, 2023

View reviewed changes

Craig review 2, renamed vars

a84c1ce

corypisano reviewed Jan 31, 2023

View reviewed changes

Cory review, formatting, etc

2c4c1ed

corypisano added 4 commits February 2, 2023 21:21

Merge branch 'master' into boon/RAD-5740-cache-recent-locations-in-we…

9648870

…bsdk-with-variable-ttl

lint

564908c

v3.5.1-beta

d890125

bump to v3.5.1

fba6bf3

corypisano approved these changes Feb 3, 2023

View reviewed changes

corypisano merged commit 2da1237 into master Feb 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RAD-5740: cache-recent-locations-in-websdk-with-variable-ttl #86

RAD-5740: cache-recent-locations-in-websdk-with-variable-ttl #86

boonboonsiri commented Jan 26, 2023 •

edited

Loading

boonboonsiri commented Jan 26, 2023

boonboonsiri commented Jan 26, 2023

boonboonsiri commented Jan 26, 2023

kochis Jan 27, 2023

boonboonsiri Jan 30, 2023

kochis Jan 27, 2023

boonboonsiri Jan 30, 2023

kochis Jan 27, 2023

boonboonsiri Jan 30, 2023

kochis Jan 27, 2023 •

edited

Loading

boonboonsiri Jan 30, 2023

boonboonsiri commented Jan 30, 2023

kochis Jan 30, 2023

boonboonsiri Jan 31, 2023

kochis Jan 30, 2023

boonboonsiri Jan 31, 2023

boonboonsiri Jan 31, 2023

boonboonsiri Jan 31, 2023

boonboonsiri Jan 31, 2023

kochis Jan 30, 2023

boonboonsiri Jan 31, 2023

kochis Jan 30, 2023

boonboonsiri Jan 31, 2023

corypisano Jan 31, 2023

boonboonsiri Feb 1, 2023

corypisano Jan 31, 2023

boonboonsiri Feb 1, 2023

corypisano Jan 31, 2023

boonboonsiri Feb 1, 2023

boonboonsiri commented Feb 1, 2023

corypisano commented Feb 2, 2023


		const {cacheLocationMinutes} = options

		if (cacheLocationMinutes) {

RAD-5740: cache-recent-locations-in-websdk-with-variable-ttl #86

RAD-5740: cache-recent-locations-in-websdk-with-variable-ttl #86

Conversation

boonboonsiri commented Jan 26, 2023 • edited Loading

Requirements

QA details

boonboonsiri commented Jan 26, 2023

boonboonsiri commented Jan 26, 2023

boonboonsiri commented Jan 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kochis Jan 27, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boonboonsiri commented Jan 30, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

boonboonsiri commented Feb 1, 2023

corypisano commented Feb 2, 2023

boonboonsiri commented Jan 26, 2023 •

edited

Loading

kochis Jan 27, 2023 •

edited

Loading