This example demonstrates how to add a cache to an aspect engine.The fiftyone.pipeline.engines module comes with an implementation of a Least Recently Used (lru) cache that can be used in place of the custom cache created in this example.
To construct the lru cache pass in a size (in entries) parameter to its constructor.
let lruCache = new engine.lruCache(100);
/* *********************************************************************
* This Original Work is copyright of 51 Degrees Mobile Experts Limited.
* Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
* Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
*
* This Original Work is licensed under the European Union Public Licence
* (EUPL) v.1.2 and is subject to its terms as set out below.
*
* If a copy of the EUPL was not distributed with this file, You can obtain
* one at https://opensource.org/licenses/EUPL-1.2.
*
* The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
* amended by the European Commission) shall be deemed incompatible for
* the purposes of the Work and the provisions of the compatibility
* clause in Article 5 of the EUPL shall not apply.
*
* If using the Work as, or as part of, a network application, by
* including the attribution notice(s) required under Article 5 of the EUPL
* in the end user terms of the application under an appropriate heading,
* such notice(s) shall fulfill the requirements of that article.
* ********************************************************************* */
const pipeline = require('fiftyone.pipeline.core');
// Note that this example is designed to be run from within the
// source repository. If this code has been copied to run standalone
// then you'll need to replace the require below with the commented
// out version below it.
const engine = require('..');
// const engine = require("fiftyone.pipeline.engines");
// This is a very simple cache that uses an in memory JavaScript object
constructor (size) {
super();
this.cache = {};
}
get (cachekey) {
if (this.cache[cachekey]) {
// Log out whether something has been fetched
// from cache to demonstrate the example
console.log('Fetched from cache');
return this.cache[cachekey];
}
}
put (cachekey, value) {
this.cache[cachekey] = value;
}
}
// A custom engine to test the caching, note the instance of the
// evidenceKeyFilter class which is used to determine which evidence
// is used by the flowElement and in turn the pipeline.
const cacheTest = new engine.Engine({
dataKey: 'cacheTest',
cache: new MyCustomCache(),
evidenceKeyFilter: new pipeline
.BasicListEvidenceKeyFilter(['cookie.my-user-id']),
processInternal: function (flowData) {
const engine = this;
return new Promise(function (resolve, reject) {
const data = new pipeline
.ElementDataDictionary(
{ flowElement: engine, contents: { hello: 'world' } });
flowData.setElementData(data);
resolve();
});
},
properties: {
hello: {
type: 'string'
}
}
});
const cachePipeline = new pipeline.PipelineBuilder().add(cacheTest).build();
const flowData = cachePipeline.createFlowData();
const processFlowDataWithUserId = function (userID) {
flowData.evidence.add('cookie.my-user-id', userID);
return flowData.process();
};
// Run the same evidence through the pipeline twice,
// second time should be fetched from the cache
processFlowDataWithUserId('112').then(() => processFlowDataWithUserId('112'));