feat: add snjs package

packages/snjs/mocha/migrations/migration.test.js

@@ -0,0 +1,175 @@
+import * as Factory from '../lib/factory.js'
+chai.use(chaiAsPromised)
+const expect = chai.expect
+
+describe('migrations', () => {
+  const allMigrations = ['2.0.0', '2.0.15', '2.7.0', '2.20.0', '2.36.0', '2.42.0']
+
+  beforeEach(async () => {
+    localStorage.clear()
+  })
+
+  afterEach(async () => {
+    localStorage.clear()
+  })
+
+  it('version number is stored as string', async function () {
+    const application = await Factory.createInitAppWithFakeCrypto()
+    const version = await application.migrationService.getStoredSnjsVersion()
+    expect(typeof version).to.equal('string')
+    await Factory.safeDeinit(application)
+  })
+
+  it('should return correct required migrations if stored version is 1.0.0', async function () {
+    expect((await SNMigrationService.getRequiredMigrations('1.0.0')).length).to.equal(allMigrations.length)
+  })
+
+  it('should return correct required migrations if stored version is 2.0.0', async function () {
+    expect((await SNMigrationService.getRequiredMigrations('2.0.0')).length).to.equal(allMigrations.length - 1)
+  })
+
+  it('should return 0 required migrations if stored version is futuristic', async function () {
+    expect((await SNMigrationService.getRequiredMigrations('100.0.1')).length).to.equal(0)
+  })
+
+  it('after running base migration, legacy structure should set version as 1.0.0', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    /** Set up 1.0.0 structure with tell-tale storage key */
+    await application.deviceInterface.setRawStorageValue('migrations', JSON.stringify(['anything']))
+    await application.migrationService.runBaseMigrationPreRun()
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal('1.0.0')
+    await Factory.safeDeinit(application)
+  })
+
+  it('after running base migration, 2.0.0 structure set version as 2.0.0', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    /** Set up 2.0.0 structure with tell-tale storage key */
+    await application.deviceInterface.setRawStorageValue(
+      namespacedKey(application.identifier, 'last_migration_timestamp'),
+      'anything',
+    )
+    await application.migrationService.runBaseMigrationPreRun()
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal('2.0.0')
+    await Factory.safeDeinit(application)
+  })
+
+  it('after running base migration with no present storage values, should set version to current', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    await application.migrationService.runBaseMigrationPreRun()
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal(SnjsVersion)
+    await Factory.safeDeinit(application)
+  })
+
+  it('after running all migrations from a 1.0.0 installation, should set stored version to current', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    /** Set up 1.0.0 structure with tell-tale storage key */
+    await application.deviceInterface.setRawStorageValue('migrations', JSON.stringify(['anything']))
+    await application.prepareForLaunch({
+      receiveChallenge: () => {},
+    })
+    await application.launch(true)
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal(SnjsVersion)
+    await Factory.safeDeinit(application)
+  })
+
+  it('after running all migrations from a 2.0.0 installation, should set stored version to current', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    /** Set up 2.0.0 structure with tell-tale storage key */
+    await application.deviceInterface.setRawStorageValue('last_migration_timestamp', JSON.stringify(['anything']))
+    await application.prepareForLaunch({
+      receiveChallenge: () => {},
+    })
+    await application.launch(true)
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal(SnjsVersion)
+    await Factory.safeDeinit(application)
+  })
+
+  it('should be correct migration count coming from 1.0.0', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+    await application.deviceInterface.setRawStorageValue('migrations', 'anything')
+    await application.migrationService.runBaseMigrationPreRun()
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal('1.0.0')
+    const pendingMigrations = await SNMigrationService.getRequiredMigrations(
+      await application.migrationService.getStoredSnjsVersion(),
+    )
+    expect(pendingMigrations.length).to.equal(allMigrations.length)
+    expect(pendingMigrations[0].version()).to.equal('2.0.0')
+    await application.prepareForLaunch({
+      receiveChallenge: () => {},
+    })
+    await application.launch(true)
+    expect(await application.migrationService.getStoredSnjsVersion()).to.equal(SnjsVersion)
+    await Factory.safeDeinit(application)
+  })
+
+  it('2.20.0 remove mfa migration', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+
+    await application.prepareForLaunch({
+      receiveChallenge: () => {},
+    })
+    await application.launch(true)
+
+    const mfaItem = CreateDecryptedItemFromPayload(
+      new DecryptedPayload({
+        uuid: '123',
+        content_type: 'SF|MFA',
+        content: FillItemContent({
+          key: '123',
+        }),
+      }),
+    )
+    await application.mutator.insertItem(mfaItem)
+    await application.sync.sync()
+
+    expect(application.items.getItems('SF|MFA').length).to.equal(1)
+    expect(
+      (await application.diskStorageService.getAllRawPayloads()).filter((p) => p.content_type === 'SF|MFA').length,
+    ).to.equal(1)
+
+    /** Run migration */
+    const migration = new Migration2_20_0(application.migrationService.services)
+    await migration.handleStage(ApplicationStage.LoadedDatabase_12)
+
+    expect(application.items.getItems('SF|MFA').length).to.equal(0)
+    expect(
+      (await application.diskStorageService.getAllRawPayloads()).filter((p) => p.content_type === 'SF|MFA').length,
+    ).to.equal(0)
+
+    await Factory.safeDeinit(application)
+  })
+
+  it('2.42.0 remove no distraction theme', async function () {
+    const application = await Factory.createAppWithRandNamespace()
+
+    await application.prepareForLaunch({
+      receiveChallenge: () => {},
+    })
+    await application.launch(true)
+
+    const noDistractionItem = CreateDecryptedItemFromPayload(
+      new DecryptedPayload({
+        uuid: '123',
+        content_type: ContentType.Theme,
+        content: FillItemContent({
+          package_info: {
+            identifier: 'org.standardnotes.theme-no-distraction',
+          },
+        }),
+      }),
+    )
+    await application.mutator.insertItem(noDistractionItem)
+    await application.sync.sync()
+
+    expect(application.items.getItems(ContentType.Theme).length).to.equal(1)
+
+    /** Run migration */
+    const migration = new Migration2_42_0(application.migrationService.services)
+    await migration.handleStage(ApplicationStage.FullSyncCompleted_13)
+    await application.sync.sync()
+
+    expect(application.items.getItems(ContentType.Theme).length).to.equal(0)
+
+    await Factory.safeDeinit(application)
+  })
+})