apigee-edge-js/lib/cache.js

nodejs library for the administration API for Apigee (Edge and X and hybrid).

// cache.js
// ------------------------------------------------------------------
// Copyright 2018-2023 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
//
//     https://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.
//
/* jshint strict:implied, esversion:9, node:true */

const utility = require("./utility.js"),
  common = require("./common.js"),
  promiseWrap = require("./promiseWrap.js"),
  request = require("postman-request"),
  urljoin = require("url-join"),
  sprintf = require("sprintf-js").sprintf;

function Cache(conn) {
  this.conn = conn;
}

Cache.prototype.get = promiseWrap(function (options, cb) {
  if (!cb) {
    cb = options;
    options = {};
  }
  const conn = this.conn,
    name = options.name || options.cache || options.cacheName,
    env = options.env || options.environment;
  if (!env) {
    return cb(new Error("missing environment name for cache"));
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.url = options.name
      ? urljoin(conn.urlBase, "environments", env, "caches", name)
      : urljoin(conn.urlBase, "environments", env, "caches");
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("GET %s", requestOptions.url));
    }
    request.get(requestOptions, common.callback(conn, [200], cb));
  });
});

Cache.prototype.create = promiseWrap(function (options, cb) {
  // POST :mgmtserver/v1/o/:orgname/e/:env/caches?name=whatev
  // Authorization: :apigee-auth
  // Content-type: application/json
  //
  // { .... }
  const conn = this.conn,
    name = options.name || options.cache || options.cacheName,
    env = options.env || options.environment;
  if (conn.isGoogle()) {
    return cb(null, "not supported on gaambo");
  }
  if (!env) {
    return cb(new Error("missing environment name for cache"));
  }
  if (!name) {
    return cb(new Error("missing name for cache"));
  }
  if (conn.verbosity > 0) {
    utility.logWrite(sprintf("Create Cache %s", name));
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.url =
      urljoin(conn.urlBase, "environments", env, "caches") + "?name=" + name;
    requestOptions.headers["content-type"] = "application/json";
    requestOptions.body = JSON.stringify({
      description: "cache for general purpose use",
      distributed: true,
      expirySettings: {
        timeoutInSec: { value: 86400 },
        valuesNull: false
      },
      compression: {
        minimumSizeInKB: 1024
      },
      persistent: false,
      skipCacheIfElementSizeInKBExceeds: "2048",
      diskSizeInMB: 0,
      overflowToDisk: false,
      maxElementsOnDisk: 1,
      maxElementsInMemory: 3000000,
      inMemorySizeInKB: 8000
    });
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("POST %s", requestOptions.url));
    }
    request.post(requestOptions, common.callback(conn, [201], cb));
  });
});

Cache.prototype.del = promiseWrap(function (options, cb) {
  // DELETE :mgmtserver/v1/o/:orgname/e/:env/caches/:cachename
  // Authorization: :apigee-auth
  const conn = this.conn,
    name = options.name || options.cache || options.cacheName,
    env = options.env || options.environment;
  if (conn.isGoogle()) {
    return cb(null, "not supported on gaambo");
  }
  if (!env) {
    return cb(new Error("missing environment name for cache"));
  }
  if (!name) {
    return cb(new Error("missing name for cache"));
  }
  if (conn.verbosity > 0) {
    utility.logWrite(sprintf("Delete Cache %s", name));
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.url = urljoin(
      conn.urlBase,
      "environments",
      env,
      "caches",
      name
    );
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("DELETE %s", requestOptions.url));
    }
    request.del(requestOptions, common.callback(conn, [200], cb));
  });
});

Cache.prototype.clear = promiseWrap(function (options, cb) {
  // POST :mgmtserver/v1/o/:orgname/e/:env/caches/:cachename/entries?action=clear
  // Authorization: :apigee-auth
  const conn = this.conn,
    name = options.name || options.cache || options.cacheName,
    env = options.env || options.environment;
  if (!env) {
    return cb(new Error("missing environment name for cache"));
  }
  if (!name) {
    return cb(new Error("missing name for cache"));
  }
  if (conn.verbosity > 0) {
    utility.logWrite(sprintf("Clear Cache %s", name));
  }
  common.insureFreshToken(conn, function (requestOptions) {
    requestOptions.url =
      urljoin(conn.urlBase, "environments", env, "caches", name, "entries") +
      "?action=clear";
    requestOptions.headers["content-type"] = "application/octet-stream";
    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("POST %s", requestOptions.url));
    }
    request.post(requestOptions, common.callback(conn, [200], cb));
  });
});

module.exports = Cache;