שמירה במטמון באמצעות Firebase

המטרה: שיפור הביצועים של מרכז הבקרה והימנעות מהגבלות קצב של API חיצוני על ידי הטמעה של מטמון בהתאמה אישית עבור המחבר.

ל-Looker Studio יש מערכת מטמון משלו לדוחות. כשיוצרים את המחבר, אפשר להטמיע מטמון בהתאמה אישית כדי להפיק דוחות מהר יותר ולהימנע מהגבלות קצב של APR.

לדוגמה, אתם יוצרים מחבר שמספק נתוני מזג אוויר היסטוריים מ-7 הימים האחרונים עבור מיקוד ספציפי. המחבר שלכם הופך לפופולרי מאוד, אבל ל-API החיצוני שממנו אתם מאחזרים את הנתונים יש מגבלות קפדניות על קצב הבקשות. ה-API מעדכן את הנתונים שלו רק פעם ביום, כך שאין צורך לאחזר את אותם נתונים כמה פעמים ביום עבור מיקוד ספציפי. בעזרת המדריך הזה, תוכלו להטמיע מטמון יומי לכל מיקוד.

דרישות

• מסד נתונים בזמן אמת ב-Firebase. אם אין לכם גישה לפרויקט כזה, אתם יכולים ליצור פרויקט ב-Google Cloud Platform‏ (GCP) ולפעול לפי השלבים במדריך תחילת העבודה כדי ליצור מופע משלכם של Firebase Realtime Database.
• חשבון שירות של GCP לקריאה ולכתיבה של נתונים מ-Firebase Realtime Database.
• מחבר של הקהילה שמביא נתונים ממקור.

מגבלות

• אי אפשר להשתמש בפתרון הזה עם שירותים מתקדמים של Looker Studio. כשמשתמשים ב-Looker Studio Advanced Services, לקוד המחבר ב-Apps Script אין גישה לנתונים. לכן אי אפשר לשמור את הנתונים במטמון באמצעות Apps Script.
• עורכים וצופים בדוחות לא יכולים לאפס את המטמון הספציפי הזה.

פתרון

הטמעה של חשבון שירות

1. יוצרים חשבון שירות בפרויקט Google Cloud.
2. מוודאים שלחשבון השירות הזה יש גישה ל-BigQuery בפרויקט בענן.
   • תפקידים נדרשים בניהול זהויות והרשאות גישה (IAM): Firebase Admin
3. מורידים את קובץ ה-JSON כדי לקבל את המפתחות של חשבונות השירות. מאחסנים את התוכן של הקובץ במאפייני הסקריפט של פרויקט המחבר. אחרי הוספת המפתחות, הם אמורים להיראות כך בממשק המשתמש של Apps Script:
   
4. כוללים את ספריית OAuth2 for Apps Script בפרויקט Apps Script.
5. מטמיעים את קוד OAuth2 הנדרש לחשבון השירות:

firestore-cache/src/firebase.js

הצגת הקוד ב-GitHub

var SERVICE_ACCOUNT_CREDS = 'SERVICE_ACCOUNT_CREDS';
var SERVICE_ACCOUNT_KEY = 'private_key';
var SERVICE_ACCOUNT_EMAIL = 'client_email';
var BILLING_PROJECT_ID = 'project_id';

var scriptProperties = PropertiesService.getScriptProperties();

/**
 * Copy the entire credentials JSON file from creating a service account in GCP.
 * Service account should have `Firebase Admin` IAM role.
 */
function getServiceAccountCreds() {
  return JSON.parse(scriptProperties.getProperty(SERVICE_ACCOUNT_CREDS));
}

function getOauthService() {
  var serviceAccountCreds = getServiceAccountCreds();
  var serviceAccountKey = serviceAccountCreds[SERVICE_ACCOUNT_KEY];
  var serviceAccountEmail = serviceAccountCreds[SERVICE_ACCOUNT_EMAIL];

  return OAuth2.createService('FirebaseCache')
    .setAuthorizationBaseUrl('https://accounts.google.com/o/oauth2/auth')
    .setTokenUrl('https://accounts.google.com/o/oauth2/token')
    .setPrivateKey(serviceAccountKey)
    .setIssuer(serviceAccountEmail)
    .setPropertyStore(scriptProperties)
    .setCache(CacheService.getScriptCache())
    .setScope([
      'https://www.googleapis.com/auth/userinfo.email',
      'https://www.googleapis.com/auth/firebase.database'
    ]);
}

הטמעה של קוד לקריאה ולכתיבה מ-Firebase

תשתמשו ב-Firebase Database REST API כדי לקרוא ולכתוב במסד נתונים בזמן אמת של Firebase. הקוד הבא מטמיע את השיטות שנדרשות לגישה ל-API הזה.

הטמעה של getData()‎

המבנה של קוד getData() הקיים ללא שמירת נתונים במטמון צריך להיראות כך:

firestore-cache/src/without-caching.js

הצגת הקוד ב-GitHub

/*
 * This file is only to demonstrate how the `getData()` fucntion would look
 * like without the Firebase Realtime Database caching. It is not a part of
 * the connector code and should not be included in Apps Script / Clasp.
 */

function getData(request) {
  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var fetchedData = fetchAndParseData(request);
  var data = getFormattedData(fetchedData, requestedFields);

  return {
    schema: requestedFields.build(),
    rows: data
  };
}

כדי להשתמש באחסון במטמון בקוד getData(), פועלים לפי השלבים הבאים:

1. קובעים את הנתונים שצריך לשמור במטמון.

2. יוצרים מפתח ייחודי לאחסון יחידת הנתונים המינימלית במטמון.
   בדוגמה להטמעה, נעשה שימוש ב-zipcode מ-configparams כמפתח.
   אופציונלי: כדי ליצור מטמון לכל משתמש, יוצרים מפתח מורכב עם מפתח הבסיס וזהות המשתמש. יישום לדוגמה:
   js var baseKey = getBaseKey(request); var userEmail = Session.getEffectiveUser().getEmail(); var hasheduserEmail = getHashedValue(userEmail); var compositeKey = baseKey + hasheduserEmail;

3. אם יש נתונים במטמון, בודקים אם המטמון עדכני.
   בדוגמה, הנתונים שבמטמון של מיקוד ספציפי נשמרים עם התאריך הנוכחי. כשנתונים מאוחזרים מהמטמון, התאריך של המטמון נבדק מול התאריך הנוכחי.

   var cacheForZipcode = {
     data: <data being cached>,
     ymd: <current date in YYYYMMDD format>
   }
   

4. אם אין נתונים במטמון או שהנתונים במטמון לא עדכניים, מאחזרים נתונים מהמקור ומאחסנים אותם במטמון.

בדוגמה הבאה, main.js כולל קוד getData() עם הטמעה של שמירת נתונים במטמון.

קוד לדוגמה

הדוגמה הבאה היא דוגמה מלאה של מחבר שמשתמש ב-Firebase לצורך שמירת נתונים במטמון:

main.js

firestore-cache/src/main.js

הצגת הקוד ב-GitHub

// [start common_connector_code]
var cc = DataStudioApp.createCommunityConnector();

function getAuthType() {
  return cc
    .newAuthTypeResponse()
    .setAuthType(cc.AuthType.NONE)
    .build();
}

function getConfig(request) {
  var config = cc.getConfig();

  config
    .newTextInput()
    .setId('zipcode')
    .setName('Enter Zip Code')
    .setPlaceholder('eg. 95054');

  return config.build();
}

function getFields() {
  var fields = cc.getFields();
  var types = cc.FieldType;
  var aggregations = cc.AggregationType;

  fields
    .newDimension()
    .setId('zipcode')
    .setName('Zip code')
    .setType(types.TEXT);

  fields
    .newDimension()
    .setId('date')
    .setName('Date')
    .setType(types.YEAR_MONTH_DAY);

  fields
    .newMetric()
    .setId('temperature')
    .setName('Temperature (F)')
    .setType(types.NUMBER)
    .setIsReaggregatable(false);

  return fields;
}

function getSchema(request) {
  return {
    schema: getFields().build()
  };
}
// [end common_connector_code]

// [start caching_implementation]
function getData(request) {
  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var cacheUpdateNeeded = true;
  var url = buildFirebaseUrl(request.configParams.zipcode);
  var cache = firebaseCache('get', url);

  if (cache) {
    var currentYmd = getCurrentYmd();
    cacheUpdateNeeded = currentYmd > cache.ymd;
  }

  if (cacheUpdateNeeded) {
    var fetchedData = fetchAndParseData(request);
    cache = {};
    cache.data = fetchedData;
    cache.ymd = currentYmd;
    firebaseCache('delete', url);
    firebaseCache('post', url, cache);
  }

  var data = getFormattedData(cache.data, requestedFields);

  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  var cache = getCachedData(request);
  var data = getFormattedData(cache, requestedFields);

  return {
    schema: requestedFields.build(),
    rows: data
  };
}

function getCachedData(request) {
  var cacheUpdateNeeded = true;
  var url = buildFirebaseUrl(request.configParams.zipcode);
  var cachedData = getFromCache(url);
  var currentYmd = getCurrentYmd();

  if (cachedData) {
    cacheUpdateNeeded = currentYmd > cachedData.ymd;
  }

  if (cacheUpdateNeeded) {
    var fetchedData = fetchAndParseData(request);
    freshData = {};
    freshData.data = fetchedData;
    freshData.ymd = currentYmd;
    deleteFromCache(url);
    putInCache(url, freshData);
    cachedData = freshData;
  }

  return cachedData.data;
}

function getCurrentYmd() {
  var currentDate = new Date();
  var year = currentDate.getFullYear();
  var month = ('0' + (currentDate.getMonth() + 1)).slice(-2);
  var date = ('0' + currentDate.getDate()).slice(-2);
  var currentYmd = year + month + date;
  return currentYmd;
}

// [end caching_implementation]

// [start common_getdata_implementation]
function fetchAndParseData(request) {
  // TODO: Connect to your own API endpoint and parse the fetched data.
  // To keep this example simple, we are returning dummy data instead of
  // connecting to an enpoint. This does not affect the caching.
  var parsedData = sampleData;
  return parsedData;
}

function getFormattedData(fetchedData, requestedFields) {
  var data = fetchedData.map(function(rowData) {
    return formatData(rowData, requestedFields);
  });
  return data;
}

function formatData(rowData, requestedFields) {
  var row = requestedFields.asArray().map(function(requestedField) {
    switch (requestedField.getId()) {
      case 'date':
        return rowData.date;
      case 'zipcode':
        return rowData.zipcode;
      case 'temperature':
        return rowData.temperature;
      default:
        return '';
    }
  });
  return {values: row};
}
// [end common_getdata_implementation]

var sampleData = [
  {
    date: '20190601',
    zipcode: '95054',
    temperature: 80
  },
  {
    date: '20190602',
    zipcode: '95054',
    temperature: 82
  },
  {
    date: '20190603',
    zipcode: '95054',
    temperature: 82
  },
  {
    date: '20190604',
    zipcode: '95054',
    temperature: 85
  },
  {
    date: '20190605',
    zipcode: '95054',
    temperature: 84
  },
  {
    date: '20190606',
    zipcode: '95054',
    temperature: 83
  },
  {
    date: '20190607',
    zipcode: '95054',
    temperature: 81
  }
];

firebase.js

firestore-cache/src/firebase.js

הצגת הקוד ב-GitHub

// [start firebase_access_implementation]

var FIREBASE_REALTIME_DB_BASE_URL = '.firebaseio.com';
var FIREBASE_REALTIME_DB_COLLECTION = '/cache';

/**
 * Returns the URL for a file in a firebase database.
 *
 * @param {string} fileName The filename in the database
 * @returns {string} The url for the file in the database
 */
function buildFirebaseUrl(fileName) {
  var serviceAccountCreds = getServiceAccountCreds();
  var projectId = serviceAccountCreds[BILLING_PROJECT_ID];

  if (fileName) {
    fileName = '/' + fileName;
  }
  var urlElements = [
    'https://',
    projectId,
    FIREBASE_REALTIME_DB_BASE_URL,
    FIREBASE_REALTIME_DB_COLLECTION,
    fileName,
    '.json'
  ];
  var url = urlElements.join('');
  return url;
}

/**
 * Generic method for handling the Firebase Realtime Database REST API.
 * For `get`: returns the data at the given url.
 * For `post`: posts the data in in firestore db at the given url and returns `undefined`.
 * For `delete`: deletes the data at the given url and returns `undefined`.
 *
 * @param {string} method Method for the REST API: `get`, `post`, or `delete`
 * @param {string} url REST endpoint
 * @param {string} [data] Data to be stored for `post` method
 * @returns {undefined|object} Returns data from the REST endpoint for `get`
 *          method. For other methods, returns `undefined`.
 */
function firebaseCache(method, url, data) {
  var oAuthToken = getOauthService().getAccessToken();

  var responseOptions = {
    headers: {
      Authorization: 'Bearer ' + oAuthToken
    },
    method: method,
    contentType: 'application/json'
  };

  // Add payload for post method
  if (method === 'post') {
    responseOptions['payload'] = JSON.stringify(data);
  }

  var response = UrlFetchApp.fetch(url, responseOptions);

  // Return value only for `get`.
  if (method === 'get') {
    var responseObject = JSON.parse(response);
    if (responseObject === null) {
      return null;
    } else {
      var autoKey = Object.keys(responseObject)[0];
      var returnValue = responseObject[autoKey];
    }
    return returnValue;
  }
}

function getFromCache(url) {
  return firebaseCache('get', url);
}

function deleteFromCache(url) {
  return firebaseCache('delete', url);
}

function putInCache(url, data) {
  return firebaseCache('put', url, data);
}

// [end firebase_access_implementation]

var SERVICE_ACCOUNT_CREDS = 'SERVICE_ACCOUNT_CREDS';
var SERVICE_ACCOUNT_KEY = 'private_key';
var SERVICE_ACCOUNT_EMAIL = 'client_email';
var BILLING_PROJECT_ID = 'project_id';

var scriptProperties = PropertiesService.getScriptProperties();

/**
 * Copy the entire credentials JSON file from creating a service account in GCP.
 * Service account should have `Firebase Admin` IAM role.
 */
function getServiceAccountCreds() {
  return JSON.parse(scriptProperties.getProperty(SERVICE_ACCOUNT_CREDS));
}

function getOauthService() {
  var serviceAccountCreds = getServiceAccountCreds();
  var serviceAccountKey = serviceAccountCreds[SERVICE_ACCOUNT_KEY];
  var serviceAccountEmail = serviceAccountCreds[SERVICE_ACCOUNT_EMAIL];

  return OAuth2.createService('FirebaseCache')
    .setAuthorizationBaseUrl('https://accounts.google.com/o/oauth2/auth')
    .setTokenUrl('https://accounts.google.com/o/oauth2/token')
    .setPrivateKey(serviceAccountKey)
    .setIssuer(serviceAccountEmail)
    .setPropertyStore(scriptProperties)
    .setCache(CacheService.getScriptCache())
    .setScope([
      'https://www.googleapis.com/auth/userinfo.email',
      'https://www.googleapis.com/auth/firebase.database'
    ]);
}

מקורות מידע נוספים

המחבר של חוויית המשתמש ב-Chrome‏ (CrUX) מאפשר ליצור לוח בקרה שמבוסס על טבלת BigQuery בגודל של כ-20GB, עבור אלפי משתמשים. המחבר הזה משתמש ב-Firebase Realtime Database יחד עם Apps Script Cache Service לגישה לשמירת נתונים במטמון בשתי שכבות. פרטים על ההטמעה זמינים בקוד.