shopify-app-js 0.0.1-security → 1.0.1

package/packages/shopify-app-session-storage-sqlite/src/sqlite-migrator.ts

@@ -0,0 +1,34 @@
+import {
+  RdbmsSessionStorageMigrator,
+  RdbmsSessionStorageMigratorOptions,
+  MigrationOperation,
+} from '@shopify/shopify-app-session-storage';
+
+import {SqliteConnection} from './sqlite-connection';
+
+export class SqliteSessionStorageMigrator extends RdbmsSessionStorageMigrator {
+  constructor(
+    dbConnection: SqliteConnection,
+    opts: Partial<RdbmsSessionStorageMigratorOptions> = {},
+    migrations: MigrationOperation[],
+  ) {
+    super(dbConnection, opts, migrations);
+  }
+
+  async initMigrationPersistence(): Promise<void> {
+    const discardCreateTable = await this.connection.hasTable(
+      this.options.migrationDBIdentifier,
+    );
+
+    if (!discardCreateTable) {
+      const migration = `
+        CREATE TABLE ${this.options.migrationDBIdentifier} (
+          ${
+            this.getOptions().migrationNameColumnName
+          } varchar(255) NOT NULL PRIMARY KEY
+        );`;
+
+      await this.connection.query(migration, []);
+    }
+  }
+}

package/packages/shopify-app-session-storage-sqlite/src/sqlite.ts

@@ -0,0 +1,147 @@
+import {Session} from '@shopify/shopify-api';
+import {
+  SessionStorage,
+  RdbmsSessionStorageOptions,
+} from '@shopify/shopify-app-session-storage';
+import sqlite3 from 'sqlite3';
+
+import {SqliteConnection} from './sqlite-connection';
+import {migrationList} from './migrations';
+import {SqliteSessionStorageMigrator} from './sqlite-migrator';
+
+export interface SQLiteSessionStorageOptions
+  extends RdbmsSessionStorageOptions {}
+
+const defaultSQLiteSessionStorageOptions: SQLiteSessionStorageOptions = {
+  sessionTableName: 'shopify_sessions',
+  migratorOptions: {
+    migrationDBIdentifier: 'shopify_sessions_migrations',
+    migrationNameColumnName: 'migration_name',
+  },
+};
+
+export class SQLiteSessionStorage implements SessionStorage {
+  public readonly ready: Promise<void>;
+  private options: SQLiteSessionStorageOptions;
+  private db: SqliteConnection;
+  private internalInit: Promise<void>;
+  private migrator: SqliteSessionStorageMigrator;
+
+  constructor(
+    database: string | sqlite3.Database,
+    opts: Partial<SQLiteSessionStorageOptions> = {},
+  ) {
+    this.options = {...defaultSQLiteSessionStorageOptions, ...opts};
+    this.db = new SqliteConnection(database, this.options.sessionTableName);
+    this.internalInit = this.init();
+    this.migrator = new SqliteSessionStorageMigrator(
+      this.db,
+      this.options.migratorOptions,
+      migrationList,
+    );
+    this.ready = this.migrator.applyMigrations(this.internalInit);
+  }
+
+  public async storeSession(session: Session): Promise<boolean> {
+    await this.ready;
+
+    // Note milliseconds to seconds conversion for `expires` property
+    const entries = session
+      .toPropertyArray()
+      .map(([key, value]) =>
+        key === 'expires'
+          ? [key, Math.floor((value as number) / 1000)]
+          : [key, value],
+      );
+
+    const query = `
+      INSERT OR REPLACE INTO ${this.options.sessionTableName}
+      (${entries.map(([key]) => key).join(', ')})
+      VALUES (${entries
+        .map(() => `${this.db.getArgumentPlaceholder()}`)
+        .join(', ')});
+    `;
+
+    await this.db.query(
+      query,
+      entries.map(([_key, value]) => value),
+    );
+    return true;
+  }
+
+  public async loadSession(id: string): Promise<Session | undefined> {
+    await this.ready;
+    const query = `
+      SELECT * FROM ${this.options.sessionTableName}
+      WHERE id = ${this.db.getArgumentPlaceholder()};
+    `;
+    const rows = await this.db.query(query, [id]);
+    if (!Array.isArray(rows) || rows?.length !== 1) return undefined;
+    const rawResult = rows[0] as any;
+    return this.databaseRowToSession(rawResult);
+  }
+
+  public async deleteSession(id: string): Promise<boolean> {
+    await this.ready;
+    const query = `
+      DELETE FROM ${this.options.sessionTableName}
+      WHERE id = ${this.db.getArgumentPlaceholder()};
+    `;
+    await this.db.query(query, [id]);
+    return true;
+  }
+
+  public async deleteSessions(ids: string[]): Promise<boolean> {
+    await this.ready;
+    const query = `
+      DELETE FROM ${this.options.sessionTableName}
+      WHERE id IN (${ids
+        .map(() => `${this.db.getArgumentPlaceholder()}`)
+        .join(',')});
+    `;
+    await this.db.query(query, ids);
+    return true;
+  }
+
+  public async findSessionsByShop(shop: string): Promise<Session[]> {
+    await this.ready;
+    const query = `
+      SELECT * FROM ${this.options.sessionTableName}
+      WHERE shop = ${this.db.getArgumentPlaceholder()};
+    `;
+    const rows = await this.db.query(query, [shop]);
+    if (!Array.isArray(rows) || rows?.length === 0) return [];
+
+    const results: Session[] = rows.map((row: any) => {
+      return this.databaseRowToSession(row);
+    });
+    return results;
+  }
+
+  private async init() {
+    const hasSessionTable = await this.db.hasTable(
+      this.options.sessionTableName,
+    );
+    if (!hasSessionTable) {
+      const query = `
+        CREATE TABLE ${this.options.sessionTableName} (
+          id varchar(255) NOT NULL PRIMARY KEY,
+          shop varchar(255) NOT NULL,
+          state varchar(255) NOT NULL,
+          isOnline integer NOT NULL,
+          expires integer,
+          scope varchar(1024),
+          accessToken varchar(255),
+          onlineAccessInfo varchar(255)
+        );
+      `;
+      await this.db.query(query);
+    }
+  }
+
+  private databaseRowToSession(row: any): Session {
+    // convert seconds to milliseconds prior to creating Session object
+    if (row.expires) row.expires *= 1000;
+    return Session.fromPropertyArray(Object.entries(row));
+  }
+}

package/packages/shopify-app-session-storage-sqlite/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "outDir": "./build/ts",
+    "rootDir": "src"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["**/*.test.ts", "**/*.test.tsx", "**/test/*", "**/__tests__/*"]
+}

package/packages/shopify-app-session-storage-test-utils/CHANGELOG.md

@@ -0,0 +1,185 @@
+# @shopify/shopify-app-session-storage-test-utils
+
+## 2.0.1
+
+### Patch Changes
+
+- 02a8341: Updated dependency on `@shopify/shopify-api` to 9.3.1
+- 321d6a4: Update @shopify/shopify-api to 9.3.2
+- Updated dependencies [02a8341]
+- Updated dependencies [321d6a4]
+  - @shopify/shopify-app-session-storage@2.1.1
+
+## 2.0.0
+
+### Minor Changes
+
+- 64e0246: Update shopify-api version to 9.2.0
+
+### Patch Changes
+
+- f5742c1: Updated dependency on `@shopify/shopify-api`
+- Updated dependencies [f5742c1]
+- Updated dependencies [64e0246]
+  - @shopify/shopify-app-session-storage@2.1.0
+
+## 1.0.4
+
+### Patch Changes
+
+- b4eeb24: Improved and simplified package.json dependencies
+- b998c30: Bump shopify-api version from 9.0.1 to 9.0.2
+- Updated dependencies [b4eeb24]
+- Updated dependencies [b998c30]
+  - @shopify/shopify-app-session-storage@2.0.4
+
+## 1.0.3
+
+### Patch Changes
+
+- Updated dependencies [d3e4b5e]
+  - @shopify/shopify-app-session-storage@2.0.3
+
+## 1.0.2
+
+### Patch Changes
+
+- 3685bd4: Bump shopify-api to ^8.1.1
+- Updated dependencies [3685bd4]
+  - @shopify/shopify-app-session-storage@2.0.2
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [6d12840]
+  - @shopify/shopify-app-session-storage@2.0.1
+
+## 1.0.0
+
+### Patch Changes
+
+- f50a78f: Dropping node 14 support
+- a69d6fc: Updating dependency on @shopify/shopify-api to v.8.0.1
+- Updated dependencies [f837060]
+- Updated dependencies [a69d6fc]
+  - @shopify/shopify-app-session-storage@2.0.0
+
+## 0.1.10
+
+### Patch Changes
+
+- 616388d: Updating dependency on @shopify/shopify-api to 7.7.0
+- Updated dependencies [616388d]
+  - @shopify/shopify-app-session-storage@1.1.10
+
+## 0.1.9
+
+### Patch Changes
+
+- 5b862fe: Upgraded shopify-api dependency to 7.6.0
+- Updated dependencies [5b862fe]
+  - @shopify/shopify-app-session-storage@1.1.9
+
+## 0.1.8
+
+### Patch Changes
+
+- 346b623: Updating dependency on @shopify/shopify-api
+- Updated dependencies [346b623]
+  - @shopify/shopify-app-session-storage@1.1.8
+
+## 0.1.7
+
+### Patch Changes
+
+- 13b9048: Updating @shopify/shopify-api dependency to the latest version
+- Updated dependencies [13b9048]
+  - @shopify/shopify-app-session-storage@1.1.7
+
+## 0.1.6
+
+### Patch Changes
+
+- 32296d7: Update @shopify/shopify-api dependency to 7.5.0
+- Updated dependencies [32296d7]
+  - @shopify/shopify-app-session-storage@1.1.6
+
+## 0.1.5
+
+### Patch Changes
+
+- 93e9126: Updating @shopify/shopify-api dependency
+- Updated dependencies [93e9126]
+  - @shopify/shopify-app-session-storage@1.1.5
+
+## 0.1.4
+
+### Patch Changes
+
+- b3453ff: Bumping @shopify/shopify-api dependency to latest version
+- Updated dependencies [b3453ff]
+  - @shopify/shopify-app-session-storage@1.1.4
+
+## 0.1.3
+
+### Patch Changes
+
+- e1d4f4f: Add @shopify/shopify-api as a peerDependencies entry for each session-storage package, to avoid API library conflicts (e.g., scopesArray.map error). Should help avoid issues like #93
+- 1d007e8: Bumps [@shopify/shopify-api](https://github.com/Shopify/shopify-api-js) from 7.0.0 to 7.1.0. See `@shopify/shopify-api`'s [changelog](https://github.com/Shopify/shopify-api-js/blob/main/packages/shopify-api/CHANGELOG.md) for more details.
+- Updated dependencies [e1d4f4f]
+- Updated dependencies [1d007e8]
+  - @shopify/shopify-app-session-storage@1.1.3
+
+## 0.1.2
+
+### Patch Changes
+
+- e4f3415: Bump @shopify/shopify-api from 6.2.0 to 7.0.0. See [changelog](https://github.com/Shopify/shopify-api-js/blob/main/packages/shopify-api/CHANGELOG.md) for details.
+- Updated dependencies [e4f3415]
+  - @shopify/shopify-app-session-storage@1.1.2
+
+## 0.1.1
+
+### Patch Changes
+
+- 97346b3: Fix #132: mysql migrator was unable to detect already applied migrations
+- Updated dependencies [97346b3]
+  - @shopify/shopify-app-session-storage@1.1.1
+
+## 0.1.0
+
+### Minor Changes
+
+- becc305: Migrations capabilities that can handle persistence changes for all session storage implementations
+
+### Patch Changes
+
+- 8f5749f: Increase size of 'scope' column to 1024 for session storage implementation for RDBMS
+- b6501b0: Bump typescript to 4.9.5
+- Updated dependencies [b6501b0]
+- Updated dependencies [becc305]
+  - @shopify/shopify-app-session-storage@1.1.0
+
+## 0.0.3
+
+### Patch Changes
+
+- 222b755: Updating @shopify/shopify-api to v6.1.0
+- Updated dependencies [222b755]
+  - @shopify/shopify-app-session-storage@1.0.2
+
+## 0.0.2
+
+### Patch Changes
+
+- 866b50c: Update dependencies on shopify-api v6.0.2
+- Updated dependencies [866b50c]
+  - @shopify/shopify-app-session-storage@1.0.1
+
+## 0.0.1
+
+### Patch Changes
+
+- Updated dependencies [62c2c31]
+  - @shopify/shopify-app-session-storage@1.0.0

package/packages/shopify-app-session-storage-test-utils/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/packages/shopify-app-session-storage-test-utils/loom.config.ts

@@ -0,0 +1,27 @@
+import {createPackage} from '@shopify/loom';
+import {buildLibrary} from '@shopify/loom-plugin-build-library';
+
+export default createPackage((pkg) => {
+  pkg.entry({root: './src/index.ts'});
+  pkg.use(
+    buildLibrary({
+      // Required. A browserslist string for specifying your target output.
+      // Use browser targets (e.g. `'defaults'`) if your package targets the browser,
+      // node targets (e.g. `'node 12.22'`) if your package targets node
+      // or both (e.g.`'defaults, node 12.22'`) if your package targets both
+      targets: 'node 16',
+      // Optional. Defaults to false. Defines if commonjs outputs should be generated.
+      commonjs: true,
+      // Optional. Defaults to false. Defines if esmodules outputs should be generated.
+      esmodules: false,
+      // Optional. Defaults to false. Defines if esnext outputs should be generated.
+      esnext: false,
+      // Optional. Defaults to true. Defines if entrypoints should be written at
+      // the root of the repository. You can disable this if you have a single
+      // entrypoint or if your package uses the `exports` key in package.json
+      rootEntrypoints: false,
+      // Optional. Defaults to 'node'. Defines if the jest environment should be 'node' or 'jsdom'.
+      jestTestEnvironment: 'node',
+    }),
+  );
+});

package/packages/shopify-app-session-storage-test-utils/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@shopify/shopify-app-session-storage-test-utils",
+  "version": "2.0.1",
+  "description": "Utilities for testing Shopify App Session Storage",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Shopify/shopify-app-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Shopify/shopify-app-js/issues"
+  },
+  "homepage": "https://github.com/Shopify/shopify-app-js/tree/main/packages/shopify-app-session-storage-test-utils",
+  "author": "Shopify Inc.",
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "yarn tsc --build --clean"
+  },
+  "private": true,
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "keywords": [
+    "shopify",
+    "node",
+    "app",
+    "graphql",
+    "rest",
+    "webhook",
+    "Admin API",
+    "Storefront API",
+    "session storage",
+    "test utilities"
+  ],
+  "dependencies": {},
+  "peerDependencies": {
+    "@shopify/shopify-api": "^9.3.2",
+    "@shopify/shopify-app-session-storage": "^2.1.1"
+  },
+  "devDependencies": {},
+  "files": [
+    "build/*",
+    "!bundle/*",
+    "!tsconfig.tsbuildinfo",
+    "!node_modules"
+  ]
+}