Merge 9570f71 into 57739ae

Author: ChaoqunCHEN

packages-exp/installations-exp/.eslintrc.js

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2020 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
+ *
+ *   http://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.
+ */
+
+module.exports = {
+  extends: '../../config/.eslintrc.js',
+  parserOptions: {
+    project: 'tsconfig.json',
+    // to make vscode-eslint work with monorepo
+    // https://github.com/typescript-eslint/typescript-eslint/issues/251#issuecomment-463943250
+    tsconfigRootDir: __dirname
+  }
+};

packages-exp/installations-exp/karma.conf.js

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright 2019 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
+ *
+ *   http://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.
+ */
+
+const karmaBase = require('../../config/karma.base');
+
+const files = [`src/**/*.test.ts`];
+
+module.exports = function (config) {
+  const karmaConfig = {
+    ...karmaBase,
+    // files to load into karma
+    files,
+    // frameworks to use
+    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
+    frameworks: ['mocha']
+  };
+
+  config.set(karmaConfig);
+};
+
+module.exports.files = files;

packages-exp/installations-exp/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@firebase/installations-exp",
+  "version": "0.0.800",
+  "private": true,
+  "author": "Firebase <[email protected]> (https://firebase.google.com/)",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "esm2017": "dist/index.esm2017.js",
+  "types": "dist/src/index.d.ts",
+  "license": "Apache-2.0",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
+    "build": "rollup -c",
+    "build:deps": "lerna run --scope @firebase/installations-exp --include-dependencies build",
+    "dev": "rollup -c -w",
+    "test": "yarn type-check && yarn test:karma && yarn lint",
+    "test:ci": "node ../../scripts/run_tests_in_ci.js",
+    "test:karma": "karma start --single-run",
+    "test:debug": "karma start --browsers=Chrome --auto-watch",
+    "type-check": "tsc -p . --noEmit",
+    "serve": "yarn serve:build && yarn serve:host",
+    "serve:build": "rollup -c test-app/rollup.config.js",
+    "serve:host": "http-server -c-1 test-app",
+    "prepare": "yarn build"
+  },
+  "repository": {
+    "directory": "packages-exp/installations-exp",
+    "type": "git",
+    "url": "https://github.com/firebase/firebase-js-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/firebase/firebase-js-sdk/issues"
+  },
+  "devDependencies": {
+    "@firebase/app-exp": "0.0.800",
+    "rollup": "2.26.5",
+    "rollup-plugin-commonjs": "10.1.0",
+    "rollup-plugin-json": "4.0.0",
+    "rollup-plugin-node-resolve": "5.2.0",
+    "rollup-plugin-typescript2": "0.27.1",
+    "rollup-plugin-uglify": "6.0.4",
+    "typescript": "4.0.2"
+  },
+  "peerDependencies": {
+    "@firebase/app-exp": "0.x",
+    "@firebase/app-types-exp": "0.x"
+  },
+  "dependencies": {
+    "@firebase/installations-types-exp": "0.0.800",
+    "@firebase/util": "0.3.1",
+    "@firebase/component": "0.1.18",
+    "idb": "3.0.2",
+    "tslib": "^1.11.1"
+  }
+}

packages-exp/installations-exp/rollup.config.js

@@ -0,0 +1,70 @@
+/**
+ * @license
+ * Copyright 2019 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
+ *
+ *   http://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.
+ */
+
+import json from 'rollup-plugin-json';
+import typescriptPlugin from 'rollup-plugin-typescript2';
+import pkg from './package.json';
+import typescript from 'typescript';
+
+const deps = Object.keys({ ...pkg.peerDependencies, ...pkg.dependencies });
+
+/**
+ * ES5 Builds
+ */
+const es5BuildPlugins = [typescriptPlugin({ typescript }), json()];
+
+const es5Builds = [
+  {
+    input: 'src/index.ts',
+    output: [
+      { file: pkg.main, format: 'cjs', sourcemap: true },
+      { file: pkg.module, format: 'es', sourcemap: true }
+    ],
+    plugins: es5BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  }
+];
+
+/**
+ * ES2017 Builds
+ */
+const es2017BuildPlugins = [
+  typescriptPlugin({
+    typescript,
+    tsconfigOverride: {
+      compilerOptions: {
+        target: 'es2017'
+      }
+    }
+  }),
+  json({ preferConst: true })
+];
+
+const es2017Builds = [
+  {
+    input: 'src/index.ts',
+    output: {
+      file: pkg.esm2017,
+      format: 'es',
+      sourcemap: true
+    },
+    plugins: es2017BuildPlugins,
+    external: id => deps.some(dep => id === dep || id.startsWith(`${dep}/`))
+  }
+];
+
+export default [...es5Builds, ...es2017Builds];

packages-exp/installations-exp/src/api/delete-installation.test.ts

@@ -0,0 +1,131 @@
+/**
+ * @license
+ * Copyright 2019 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
+ *
+ *   http://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.
+ */
+
+import { expect } from 'chai';
+import { SinonStub, stub } from 'sinon';
+import * as deleteInstallationRequestModule from '../functions/delete-installation-request';
+import { get, set } from '../helpers/idb-manager';
+import {
+  FirebaseInstallations,
+  AppConfig
+} from '@firebase/installations-types-exp';
+import {
+  InProgressInstallationEntry,
+  RegisteredInstallationEntry,
+  RequestStatus,
+  UnregisteredInstallationEntry
+} from '../interfaces/installation-entry';
+import { getFakeInstallations } from '../testing/fake-generators';
+import '../testing/setup';
+import { ErrorCode } from '../util/errors';
+import { sleep } from '../util/sleep';
+import { deleteInstallation } from './delete-installation';
+
+const FID = 'children-of-the-damned';
+
+describe('deleteInstallation', () => {
+  let installations: FirebaseInstallations;
+  let deleteInstallationRequestSpy: SinonStub<
+    [AppConfig, RegisteredInstallationEntry],
+    Promise<void>
+  >;
+
+  beforeEach(() => {
+    installations = getFakeInstallations();
+
+    deleteInstallationRequestSpy = stub(
+      deleteInstallationRequestModule,
+      'deleteInstallationRequest'
+    ).callsFake(
+      () => sleep(100) // Request would take some time
+    );
+  });
+
+  it('resolves without calling server API if there is no installation', async () => {
+    await expect(deleteInstallation(installations)).to.be.fulfilled;
+    expect(deleteInstallationRequestSpy).not.to.have.been.called;
+  });
+
+  it('deletes and resolves without calling server API if the installation is unregistered', async () => {
+    const entry: UnregisteredInstallationEntry = {
+      registrationStatus: RequestStatus.NOT_STARTED,
+      fid: FID
+    };
+    await set(installations.appConfig, entry);
+
+    await expect(deleteInstallation(installations)).to.be.fulfilled;
+    expect(deleteInstallationRequestSpy).not.to.have.been.called;
+    await expect(get(installations.appConfig)).to.eventually.be.undefined;
+  });
+
+  it('rejects without calling server API if the installation is pending', async () => {
+    const entry: InProgressInstallationEntry = {
+      fid: FID,
+      registrationStatus: RequestStatus.IN_PROGRESS,
+      registrationTime: Date.now() - 3 * 1000
+    };
+    await set(installations.appConfig, entry);
+
+    await expect(deleteInstallation(installations)).to.be.rejectedWith(
+      ErrorCode.DELETE_PENDING_REGISTRATION
+    );
+    expect(deleteInstallationRequestSpy).not.to.have.been.called;
+  });
+
+  it('rejects without calling server API if the installation is registered and app is offline', async () => {
+    const entry: RegisteredInstallationEntry = {
+      fid: FID,
+      registrationStatus: RequestStatus.COMPLETED,
+      refreshToken: 'refreshToken',
+      authToken: {
+        token: 'authToken',
+        expiresIn: 123456,
+        requestStatus: RequestStatus.COMPLETED,
+        creationTime: Date.now()
+      }
+    };
+    await set(installations.appConfig, entry);
+    stub(navigator, 'onLine').value(false);
+
+    await expect(deleteInstallation(installations)).to.be.rejectedWith(
+      ErrorCode.APP_OFFLINE
+    );
+    expect(deleteInstallationRequestSpy).not.to.have.been.called;
+  });
+
+  it('deletes and resolves after calling server API if the installation is registered', async () => {
+    const entry: RegisteredInstallationEntry = {
+      fid: FID,
+      registrationStatus: RequestStatus.COMPLETED,
+      refreshToken: 'refreshToken',
+      authToken: {
+        token: 'authToken',
+        expiresIn: 123456,
+        requestStatus: RequestStatus.COMPLETED,
+        creationTime: Date.now()
+      }
+    };
+    await set(installations.appConfig, entry);
+
+    await expect(deleteInstallation(installations)).to.be.fulfilled;
+    expect(deleteInstallationRequestSpy).to.have.been.calledOnceWith(
+      installations.appConfig,
+      entry
+    );
+    await expect(get(installations.appConfig)).to.eventually.be.undefined;
+  });
+});

packages-exp/installations-exp/src/api/delete-installation.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2019 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
+ *
+ *   http://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.
+ */
+
+import { deleteInstallationRequest } from '../functions/delete-installation-request';
+import { remove, update } from '../helpers/idb-manager';
+import { RequestStatus } from '../interfaces/installation-entry';
+import { ERROR_FACTORY, ErrorCode } from '../util/errors';
+import { FirebaseInstallations } from '@firebase/installations-types-exp';
+
+export async function deleteInstallation(
+  installations: FirebaseInstallations
+): Promise<void> {
+  const { appConfig } = installations;
+
+  const entry = await update(appConfig, oldEntry => {
+    if (oldEntry && oldEntry.registrationStatus === RequestStatus.NOT_STARTED) {
+      // Delete the unregistered entry without sending a deleteInstallation request.
+      return undefined;
+    }
+    return oldEntry;
+  });
+
+  if (entry) {
+    if (entry.registrationStatus === RequestStatus.IN_PROGRESS) {
+      // Can't delete while trying to register.
+      throw ERROR_FACTORY.create(ErrorCode.DELETE_PENDING_REGISTRATION);
+    } else if (entry.registrationStatus === RequestStatus.COMPLETED) {
+      if (!navigator.onLine) {
+        throw ERROR_FACTORY.create(ErrorCode.APP_OFFLINE);
+      } else {
+        await deleteInstallationRequest(appConfig, entry);
+        await remove(appConfig);
+      }
+    }
+  }
+}