@teambit/cache 0.0.932 → 0.0.933

package/cache.aspect.ts

@@ -0,0 +1,7 @@
+import { Aspect } from '@teambit/harmony';
+
+export const CacheAspect = Aspect.create({
+  id: 'teambit.harmony/cache',
+  dependencies: [],
+  defaultConfig: {},
+});

package/cache.main.runtime.ts

@@ -0,0 +1,66 @@
+import { MainRuntime } from '@teambit/cli';
+import { Logger, LoggerAspect, LoggerMain } from '@teambit/logger';
+import { CACHE_ROOT } from '@teambit/legacy/dist/constants';
+import cacache from 'cacache';
+
+import { CacheAspect } from './cache.aspect';
+
+export type CacheConfig = {
+  cacheDirectory: string;
+};
+
+export class CacheMain {
+  static runtime = MainRuntime;
+
+  constructor(
+    /**
+     * extension config
+     */
+    readonly config: CacheConfig,
+
+    /**
+     * logger extension.
+     */
+    private readonly logger: Logger
+  ) {}
+
+  static dependencies = [LoggerAspect];
+
+  static defaultConfig = {
+    cacheDirectory: CACHE_ROOT,
+  };
+
+  async set(key: string, data: any, ttl?: number): Promise<boolean> {
+    this.logger.debug(`put cache to ${key} with data ${data}`);
+    const expire = ttl ? new Date().getTime() + ttl : null;
+    return cacache
+      .put(this.globalCacheFolder, key, JSON.stringify({ data, expire }))
+      .then(() => true)
+      .catch(() => false);
+  }
+
+  async get<T>(key: string): Promise<T | undefined> {
+    this.logger.debug(`get cache for ${key}`);
+    return cacache
+      .get(this.globalCacheFolder, key)
+      .then(async (cacheObject) => {
+        const { data, expire } = JSON.parse(cacheObject.data.toString());
+        if (expire && new Date().getTime() > expire) {
+          return cacache.rm(this.globalCacheFolder, key);
+        }
+        return data;
+      })
+      .catch(() => undefined);
+  }
+
+  private get globalCacheFolder() {
+    return this.config.cacheDirectory;
+  }
+
+  static async provider([loggerFactory]: [LoggerMain], config: CacheConfig) {
+    const logger = loggerFactory.createLogger(CacheAspect.id);
+    return new CacheMain(config, logger);
+  }
+}
+
+CacheAspect.addRuntime(CacheMain);

package/cache.spec.ts

@@ -0,0 +1,32 @@
+import { v4 } from 'uuid';
+import { rmdirSync } from 'fs';
+import { expect } from 'chai';
+import { Logger } from '@teambit/logger';
+import { CacheMain } from './cache.main.runtime';
+
+describe('Cache Aspect', () => {
+  const cacheDirectory = `/tmp/bit/${v4()}`;
+  const cache = new CacheMain({ cacheDirectory }, new Logger('cache.main.runtime'));
+  it('it should set cache with ttl', async () => {
+    await cache.set('_foo', 'bar', 1000);
+    const data = await cache.get('_foo');
+    expect(data).to.equal('bar');
+  });
+
+  // this test is flaky, it fails often on CircleCI.
+  // it('it should expire cache', async () => {
+  //   await cache.set('_foo', 'bar', 1);
+  //   const data = await cache.get('_foo');
+  //   expect(data).to.equal(null);
+  // });
+
+  it('it should set cache without expire ttl', async () => {
+    await cache.set('_foo', 'bar');
+    const data = await cache.get('_foo');
+    expect(data).to.equal('bar');
+  });
+
+  afterAll(() => {
+    rmdirSync(cacheDirectory, { recursive: true });
+  });
+});

package/dist/cache.composition.d.ts

@@ -1,2 +1,2 @@
-import React from 'react';
-export declare const Logo: () => React.JSX.Element;
+/// <reference types="react" />
+export declare const Logo: () => JSX.Element;

package/dist/cache.main.runtime.d.ts

@@ -1,5 +1,5 @@
 import { Logger, LoggerMain } from '@teambit/logger';
-export declare type CacheConfig = {
+export type CacheConfig = {
     cacheDirectory: string;
 };
 export declare class CacheMain {

package/dist/{preview-1703505948637.js → preview-1703647408454.js}

@@ -1,5 +1,5 @@
-import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cache@0.0.932/dist/cache.composition.js';
-import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cache@0.0.932/dist/cache.docs.mdx';
+import * as compositions_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cache@0.0.933/dist/cache.composition.js';
+import * as overview_0 from '/home/circleci/Library/Caches/Bit/capsules/8891be5ad3d35bfc38b9cd90c0e05b598a5a55af/teambit.harmony_cache@0.0.933/dist/cache.docs.mdx';
 
 export const compositions = [compositions_0];
 export const overview = [overview_0];

package/index.ts

@@ -0,0 +1,2 @@
+export type { CacheMain } from './cache.main.runtime';
+export { CacheAspect } from './cache.aspect';

package/package.json

@@ -1,38 +1,34 @@
 {
   "name": "@teambit/cache",
-  "version": "0.0.932",
+  "version": "0.0.933",
   "homepage": "https://bit.cloud/teambit/harmony/cache",
   "main": "dist/index.js",
   "componentId": {
     "scope": "teambit.harmony",
     "name": "cache",
-    "version": "0.0.932"
+    "version": "0.0.933"
   },
   "dependencies": {
     "cacache": "15.0.5",
-    "core-js": "^3.0.0",
-    "@babel/runtime": "7.20.0",
     "@teambit/harmony": "0.4.6",
-    "@teambit/cli": "0.0.839",
-    "@teambit/logger": "0.0.932"
+    "@teambit/cli": "0.0.840",
+    "@teambit/logger": "0.0.933"
   },
   "devDependencies": {
-    "@types/react": "^17.0.8",
     "@types/cacache": "12.0.1",
     "@types/chai": "4.2.15",
     "@types/uuid": "8.3.4",
     "chai": "4.3.0",
     "uuid": "8.3.2",
     "@types/mocha": "9.1.0",
-    "@types/node": "12.20.4",
-    "@types/react-dom": "^17.0.5",
-    "@types/jest": "^26.0.0",
-    "@types/testing-library__jest-dom": "5.9.5"
+    "@types/jest": "^29.2.2",
+    "@types/testing-library__jest-dom": "^5.9.5",
+    "@teambit/harmony.envs.core-aspect-env": "0.0.13"
   },
   "peerDependencies": {
-    "@teambit/legacy": "1.0.624",
-    "react": "^16.8.0 || ^17.0.0",
-    "react-dom": "^16.8.0 || ^17.0.0"
+    "react": "^17.0.0 || ^18.0.0",
+    "@types/react": "^18.2.12",
+    "@teambit/legacy": "1.0.624"
   },
   "license": "Apache-2.0",
   "optionalDependencies": {},
@@ -46,7 +42,7 @@
   },
   "private": false,
   "engines": {
-    "node": ">=12.22.0"
+    "node": ">=16.0.0"
   },
   "repository": {
     "type": "git",
@@ -55,12 +51,9 @@
   "keywords": [
     "bit",
     "bit-aspect",
+    "bit-core-aspect",
     "components",
     "collaboration",
-    "web",
-    "react",
-    "react-components",
-    "angular",
-    "angular-components"
+    "web"
   ]
 }

package/tsconfig.json

@@ -1,38 +1,33 @@
 {
   "compilerOptions": {
     "lib": [
-      "es2019",
-      "DOM",
-      "ES6",
-      "DOM.Iterable",
-      "ScriptHost"
+      "esnext",
+      "dom",
+      "dom.Iterable"
     ],
-    "target": "es2015",
-    "module": "CommonJS",
-    "jsx": "react",
-    "allowJs": true,
-    "composite": true,
+    "target": "es2020",
+    "module": "es2020",
+    "jsx": "react-jsx",
     "declaration": true,
     "sourceMap": true,
-    "skipLibCheck": true,
     "experimentalDecorators": true,
-    "outDir": "dist",
+    "skipLibCheck": true,
     "moduleResolution": "node",
     "esModuleInterop": true,
-    "rootDir": ".",
     "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "emitDecoratorMetadata": true,
-    "allowSyntheticDefaultImports": true,
-    "strictPropertyInitialization": false,
-    "strict": true,
-    "noImplicitAny": false,
-    "preserveConstEnums": true
+    "allowJs": true,
+    "outDir": "dist",
+    "emitDeclarationOnly": true
   },
   "exclude": [
+    "artifacts",
+    "public",
     "dist",
+    "node_modules",
+    "package.json",
     "esm.mjs",
-    "package.json"
+    "**/*.cjs",
+    "./dist"
   ],
   "include": [
     "**/*",

package/types/asset.d.ts

@@ -5,12 +5,12 @@ declare module '*.png' {
 declare module '*.svg' {
   import type { FunctionComponent, SVGProps } from 'react';
 
-  export const ReactComponent: FunctionComponent<SVGProps<SVGSVGElement> & { title?: string }>;
+  export const ReactComponent: FunctionComponent<
+    SVGProps<SVGSVGElement> & { title?: string }
+  >;
   const src: string;
   export default src;
 }
-
-// @TODO Gilad
 declare module '*.jpg' {
   const value: any;
   export = value;
@@ -27,3 +27,15 @@ declare module '*.bmp' {
   const value: any;
   export = value;
 }
+declare module '*.otf' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff' {
+  const value: any;
+  export = value;
+}
+declare module '*.woff2' {
+  const value: any;
+  export = value;
+}